Sqlalchemy adapter for Firebolt
Project description
firebolt-sqlalchemy
The Firebolt dialect for SQLAlchemy. firebolt-sqlalchemy
uses Firebolt's Python SDK which implements PEP 249.
Installation
Requires Python >=3.7.
pip install firebolt-sqlalchemy
Connecting
Connection strings use the following structure:
firebolt://{username}:{password}@{database}[/{engine_name}]
engine_name
is optional. If omitted, Firebolt will use the default engine for the database.
Examples:
firebolt://email@domain:password@sample_database
firebolt://email@domain:password@sample_database/sample_engine
To override the API URL (e.g. for dev testing):
export FIREBOLT_BASE_URL=<your_url>
Quick Start
from sqlalchemy import create_engine
engine = create_engine("firebolt://email@domain:password@sample_database/sample_engine")
connection = engine.connect()
connection.execute("CREATE FACT TABLE example(dummy int) PRIMARY INDEX dummy")
connection.execute("INSERT INTO example(dummy) VALUES (11)")
result = connection.execute("SELECT * FROM example")
for item in result.fetchall():
print(item)
AsyncIO extension
from sqlalchemy import text
from sqlalchemy.ext.asyncio import create_async_engine
engine = create_async_engine("asyncio+firebolt://email@domain:password@sample_database/sample_engine")
async with engine.connect() as conn:
await conn.execute(
text(f"INSERT INTO example(dummy) VALUES (11)")
)
result = await conn.execute(
text(f"SELECT * FROM example")
)
print(result.fetchall())
await engine.dispose()
Limitations
- Transactions are not supported since Firebolt database does not support them at this time.
- Parametrised calls to execute and executemany are not implemented.
Contributing
See: CONTRIBUTING.MD
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
firebolt_sqlalchemy-0.2.0.tar.gz
(10.3 kB
view hashes)
Built Distribution
Close
Hashes for firebolt_sqlalchemy-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 11748788188e2aa589271dc695e005a71efad15c19d12a8fe3ee48152a220a99 |
|
MD5 | 074a66655bb55f5342860077513fa093 |
|
BLAKE2b-256 | a62c373d894ff11266f5cc20ee55474d6f0a8a6ee2936177ba1bab584126ebf4 |
Close
Hashes for firebolt_sqlalchemy-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6507696e3790b77a511d05a4268660535d68f73ce2e8cd0c2021b0a5e291accb |
|
MD5 | 0980cb5467425d6635bea0cd9009a3cd |
|
BLAKE2b-256 | 432c1a4d8b767d337728f642678634f45920f3347c11b334d9d89bf1c5b91aa7 |