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}][?account_name={name}}]
engine_name
is optional. If omitted, Firebolt will use the default engine for the database.
account_name
is optional. If omitted a default account will be used for connection.
Examples:
firebolt://email@domain:password@sample_database
firebolt://email@domain:password@sample_database/sample_engine
If a different account name is required, it can be specified in the connection string
firebolt://email@domain:password@sample_database/sample_engine?account_name=my_account
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
Built Distribution
Hashes for firebolt_sqlalchemy-0.5.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c002368a86d9f545784928abb11b7efbf037abfc840b6ebaed9d4c8b4f984b99 |
|
MD5 | 3336b1ea02def5798d798b16d34c40b5 |
|
BLAKE2b-256 | 4d732f343af3eda375bb0557098f4afd1b35e7d67bffaf061e786e0ff5c12a0a |
Hashes for firebolt_sqlalchemy-0.5.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4ccb2c7ee88e6f31d5929fbf3355c113538755f9a9cb398b495ebe28a4a264b2 |
|
MD5 | 1ca75136ded267716124fa1d0eb58f99 |
|
BLAKE2b-256 | 9402fa480f4f8a34c80b6f08211bff7f7cae131b2e085cf8f1843306144477ca |