firebolt-sdk

Welcome to firebolt-sdk’s documentation!

Installation

Requires Python >=3.7
pip install firebolt-sdk

Connection parameters

These parameters are used to connect to a Firebolt database:

engine_url - url for a Firebolt engine to make requests to. This can be retrieved from our web interface, or from the engine attribute endpoint
database - the name of the database to receive queries
username - Firebolt account username
password - Firebolt account password

Optional parameters

api_endpoint - api hostname for logging in. Defaults to api.app.firebolt.io.

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.

Optional features

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.

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.

Note

This project is under active development