Skip to main content

firebolt-sdk

Nightly code check Unit tests Code quality checks Firebolt Security Scan Integration tests Coverage

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.

Metadata

Release files for firebolt-sdk 1.20.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for firebolt-sdk 1.20.0
File Size Uploaded Provenance Actions
firebolt_sdk-1.20.0.tar.gz 93.2 kB Without provenance Details for firebolt_sdk-1.20.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for firebolt-sdk 1.20.0
File Interpreter ABI Platform Actions
firebolt_sdk-1.20.0-py3-none-any.whl Python 3 none any Details for firebolt_sdk-1.20.0-py3-none-any.whl

Total release size: 217.3 kB

Release files / firebolt_sdk-1.20.0.tar.gz

Download URL firebolt_sdk-1.20.0.tar.gz
Size 93.2 kB
Tags Source
SHA-256 checksum
How to use checksums
0e63fcae77dae692344ee241b68e7b54d12d4447e0a356ee1c15b5ac76c488bc
BLAKE2b-256 checksum
How to use checksums
8c83d62fdc658b53d6dd0089ba975ae5e3ae341f5ced0b0e07aebc5106bca2f8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.10

Release files / firebolt_sdk-1.20.0-py3-none-any.whl

Download URL firebolt_sdk-1.20.0-py3-none-any.whl
Size 124.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ed71de237d70c56ec81239b830857ed67c23bb1f4aab243e182b45151bf2d077
BLAKE2b-256 checksum
How to use checksums
08a2d2872b9564dc7dab97f89ff445e470f92bc486d7819404a59757828ecf3b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.10

Security for firebolt-sdk 1.20.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.20.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page