firebolt-sdk
Installation
- Requires Python
>=3.10 pip install "firebolt-sdk>=1.0.0a1"
Documentation
For reference and tutorials, see the Firebolt Python SDK reference.
Connection parameters
These parameters are used to connect to a Firebolt database:
- account_name - name of firebolt account
- client_id - credentials client id
- cliend_secret - credentials client secret
- database [Optional] - name of the database to connect to
- engine_name [Optional] - name of the engine to connect to
Examples
See PEP-249 for the DB API reference and specifications. An example jupyter notebook is included to illustrate the use of the Firebolt API.
Special considerations
Cursor objects should not be shared between threads
Cursor is not thread-safe and should not be shared across threads. In a multi-threaded environment you can share a Connection, but each thread would need to keep its own Cursor. This corresponds to a thread safety 2 in the DBApi specification.
Some keywords are not allowed as SET parameters
cursor.execute("SET parameter=value")
This will error out if you try to set account_id, output_format, database, engine. These are special keywords that should not be set directly. To switch between databases and engines use USE DATABASE/ENGINE.
Optional features
Faster datetime with ciso8601
By default, firebolt-sdk uses datetime module to parse date and datetime values, which might be slow for a large amount of operations. In order to speed up datetime operations, it's possible to use ciso8601 package. In order to install firebolt-sdk with ciso8601 support, run pip install "firebolt-sdk[ciso8601]"
Contributing
See: CONTRIBUTING.MD
License
The Firebolt DB API is licensed under the Apache License Version 2.0 software license.
1 maintainer
Metadata
1 maintainer
Release files for firebolt-sdk 1.19.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| firebolt_sdk-1.19.0.tar.gz | 90.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| firebolt_sdk-1.19.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 210.6 kB
Release files / firebolt_sdk-1.19.0.tar.gz
| Download URL | firebolt_sdk-1.19.0.tar.gz |
|---|---|
| Size | 90.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1c3980dbf7a209718ec5777781e62d53a49c302773a4fef74864e1ca3cb20a94
|
|
BLAKE2b-256 checksum How to use checksums |
7d34c630e6e246333db6ffe9018e51715860da9470017f74042e3a18ef6935f3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.8
|
Release files / firebolt_sdk-1.19.0-py3-none-any.whl
| Download URL | firebolt_sdk-1.19.0-py3-none-any.whl |
|---|---|
| Size | 120.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d3fa6c4d224b8b47e5c866bdb0f9258856ead5f1212143c0a1b1444dbf53367c
|
|
BLAKE2b-256 checksum How to use checksums |
a617338f4cd9448a6e610a40a1f5c22c3a9ad85e3f38703fa888b9f997ba0adb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.8
|
