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>
If your password contains % or / characters they need to be sanitised as per https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls
my_pass = "0920%/2"
import urllib.parse
new_pass = urllib.parse.quote_plus(my_pass)
Quick Start
import urllib.parse
from sqlalchemy import create_engine
password = urllib.parse.quote_plus("your_password_here")
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
import urllib.parse
from sqlalchemy import text
from sqlalchemy.ext.asyncio import create_async_engine
password = urllib.parse.quote_plus("your_password_here")
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.3.0.tar.gz
(10.6 kB
view hashes)
Built Distribution
Close
Hashes for firebolt_sqlalchemy-0.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d4bebbada15338e0bb5386e4bf9fb37cac3f2b82c0b4f826bfec7265ec75d09f |
|
MD5 | b5e5a7d06b1b6cd4f486eb84be6fe0e5 |
|
BLAKE2b-256 | 8c24abdd3920848ddc3581bc9601b3297f537558f7d0c42c5e45daf2247f964f |
Close
Hashes for firebolt_sqlalchemy-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bd3a9b58a961027b8e85f3d563564e96b05f42f5dc07ad344396d06babda693e |
|
MD5 | 09cdac76ee62a1d99d5154a9ffa42444 |
|
BLAKE2b-256 | 47ee9c069ef5a4d17944e79d96dcbc1419985eaae687ab84eff9075a1f706abe |