Python package for querying and connecting to databases.
Project description
dbrequests
dbrequests is a python package built for easy use of raw SQL within python and pandas projects.
It uses ideas from records and is built using sqlalchemy-engines, but is more heavily integrated with pandas. It aims to reproduce the pilosophy behind the R-package dbtools.
Database support includes RedShift, Postgres, MySQL, SQLite, Oracle, and MS-SQL (drivers not included).
Usage
Send queries and bulk queries
Easy sending of raw sql and output as pandas DataFrames, with creds or the url of the database:
from dbrequests import Database
db = Database(creds=creds)
df = db.send_query("""
SELECT * FROM test;
""")
df # table test as pandas DataFrame
You can put the sql query in a file and direct send_query
to the file. The sql-file may be parametrized:
SELECT {col1}, {col2} FROM test;
from dbrequests import Database
db = Database(creds=creds, sql_dir = '/path/to/dir/')
db.send_query('select', col1='id', col2='name')
df # table test, including columns 'id', 'name' as pandas DataFrame
You can also pass arguments to pandas read_sql
-Function:
from dbrequests import Database
db = Database(creds=creds, sql_dir = '/path/to/dir/')
db.send_query('select', col1='id', col2='name', index_col='id')
df # table test, including column 'name' as pandas DataFrame with index 'id'
You may also send queries with no table as output to the database via send_bulk_query
, which exhibits the same behavior as send_query
:
db.send_bulk_query('drop test from test;')
Send data
Easy sending of pandas Dataframes in multiple modes:
db.send_data(df, 'table', mode='insert')
Supported modes are:
- 'insert': Appending new records. Duplicate primary keys will result in errors (sql insert into).
- 'truncate': Delete the table and completely rewrite it (sql truncate and insert into).
- 'replace': Replace records with duplicate primary keys (sql replace into).
- 'update': Update records with duplicate primary keys (sql insert into duplicate key update).
Uitilities
- Database.get_table_names will give existing tables in the database
- Parameters such es
chunksize
forpandas.to_sql
may be given to the wrapper functionsend_data
and are handed over to pandas. The same is true forsend_query
. - For transactions the context manager
transaction
may be of use.
Installation
The package can be installed via pip:
pip install git+https://github.com/INWTlab/dbrequests.git
Publication on pypi will soon follow.
Version 1.0
- implemented send_data and send_query wrappers for pandas sql-functionality
Version 1.0.8
- renamed to dbrequests
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for dbrequests-1.0.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cd280550e190e21022b9d6ceff5630dec0cac761a7cdf2b0b4514464c4066eeb |
|
MD5 | e6c86836e9fcefd18b0d40e6ee6f99c3 |
|
BLAKE2b-256 | b0c2b94d3b160649db3bb341250893416f1664339c1bb729d0601598c134eae8 |