- Requires Python
>=3.7 pip install firebolt-sdk
For reference and tutorials, see the Firebolt Python SDK reference.
These parameters are used to connect to a Firebolt database:
- engine_url - url for an engine to make requests to. Can be retrieved from Web UI, or from engine attribute
endpoint - database - name of the database to make queries to
- username - account username
- password - account password
Optional parameters
- api_endpoint - api hostname for logging in. Defaults to
api.app.firebolt.io.
See PEP-249 for the DB API reference and specifications. An example jupyter notebook is included to illustrate the use of the Firebolt API.
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]"
See: CONTRIBUTING.MD
The Firebolt DB API is licensed under the Apache License Version 2.0 software license.