# firebolt-sdk
[](https://github.com/firebolt-db/firebolt-python-sdk/actions/workflows/nightly.yml)
[](https://github.com/firebolt-db/firebolt-python-sdk/actions/workflows/unit-tests.yml)
[](https://github.com/firebolt-db/firebolt-python-sdk/actions/workflows/code-check.yml)
[](https://github.com/firebolt-db/firebolt-python-sdk/actions/workflows/security-scan.yml)
[](https://github.com/firebolt-db/firebolt-python-sdk/actions/workflows/integration-tests.yml)
### Installation
* Requires Python `>=3.8`
* `pip install "firebolt-sdk>=1.0.0a1"`
## Documentation
For reference and tutorials, see the [Firebolt Python SDK reference](https://python-sdk.docs.firebolt.io/).
## 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](https://www.python.org/dev/peps/pep-0249) for the DB API reference and specifications. An example [jupyter notebook](https://github.com/firebolt-db/firebolt-sdk/tree/main/examples/dbapi.ipynb) 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](https://peps.python.org/pep-0249/#threadsafety).
### Some keywords are not allowed as SET parameters
```Python
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](https://pypi.org/project/ciso8601/) package. In order to install firebolt-sdk with `ciso8601` support, run `pip install "firebolt-sdk[ciso8601]"`
## Contributing
See: [CONTRIBUTING.MD](https://github.com/firebolt-db/firebolt-sdk/tree/main/CONTRIBUTING.MD)
## License
The Firebolt DB API is licensed under the [Apache License Version 2.0](https://github.com/firebolt-db/firebolt-sdk/tree/main/LICENSE) software license.
Raw data
{
"_id": null,
"home_page": "https://github.com/firebolt-db/firebolt-sdk",
"name": "firebolt-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Firebolt",
"author_email": "support@firebolt.io",
"download_url": "https://files.pythonhosted.org/packages/cd/cc/41a3ae013c6cf0b80b364407f698ecbb001255ac89422b2890cc22527e43/firebolt_sdk-1.4.4.tar.gz",
"platform": null,
"description": "# firebolt-sdk\n[](https://github.com/firebolt-db/firebolt-python-sdk/actions/workflows/nightly.yml)\n[](https://github.com/firebolt-db/firebolt-python-sdk/actions/workflows/unit-tests.yml)\n[](https://github.com/firebolt-db/firebolt-python-sdk/actions/workflows/code-check.yml)\n[](https://github.com/firebolt-db/firebolt-python-sdk/actions/workflows/security-scan.yml)\n[](https://github.com/firebolt-db/firebolt-python-sdk/actions/workflows/integration-tests.yml)\n\n\n\n### Installation\n\n* Requires Python `>=3.8`\n* `pip install \"firebolt-sdk>=1.0.0a1\"`\n\n## Documentation\n\nFor reference and tutorials, see the [Firebolt Python SDK reference](https://python-sdk.docs.firebolt.io/).\n\n## Connection parameters\nThese parameters are used to connect to a Firebolt database:\n- **account_name** - name of firebolt account\n- **client_id** - credentials client id\n- **cliend_secret** - credentials client secret\n- **database [Optional]** - name of the database to connect to\n- **engine_name [Optional]** - name of the engine to connect to\n\n## Examples\nSee [PEP-249](https://www.python.org/dev/peps/pep-0249) for the DB API reference and specifications. An example [jupyter notebook](https://github.com/firebolt-db/firebolt-sdk/tree/main/examples/dbapi.ipynb) is included to illustrate the use of the Firebolt API.\n\n## Special considerations\n### Cursor objects should not be shared between threads\nCursor 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](https://peps.python.org/pep-0249/#threadsafety).\n\n### Some keywords are not allowed as SET parameters\n\n```Python\ncursor.execute(\"SET parameter=value\")\n```\nThis 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`.\n\n## Optional features\n### Faster datetime with ciso8601\nBy 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](https://pypi.org/project/ciso8601/) package. In order to install firebolt-sdk with `ciso8601` support, run `pip install \"firebolt-sdk[ciso8601]\"`\n\n## Contributing\n\nSee: [CONTRIBUTING.MD](https://github.com/firebolt-db/firebolt-sdk/tree/main/CONTRIBUTING.MD)\n\n## License\nThe Firebolt DB API is licensed under the [Apache License Version 2.0](https://github.com/firebolt-db/firebolt-sdk/tree/main/LICENSE) software license.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Python SDK for Firebolt",
"version": "1.4.4",
"project_urls": {
"Bug Tracker": "https://github.com/firebolt-db/firebolt-sdk/issues",
"Homepage": "https://github.com/firebolt-db/firebolt-sdk"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b7b7e510a938973fd1e5b348b7d6dbbefbb52c1f61a5ee776cd3595e5939d564",
"md5": "9f4616571abb1e22898415ed964214a1",
"sha256": "446708c413cfa6e2109d7115e7fd8aa9e88f007b7e6686ff5bda11f1a41ca355"
},
"downloads": -1,
"filename": "firebolt_sdk-1.4.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9f4616571abb1e22898415ed964214a1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 88904,
"upload_time": "2024-05-06T11:23:27",
"upload_time_iso_8601": "2024-05-06T11:23:27.060803Z",
"url": "https://files.pythonhosted.org/packages/b7/b7/e510a938973fd1e5b348b7d6dbbefbb52c1f61a5ee776cd3595e5939d564/firebolt_sdk-1.4.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cdcc41a3ae013c6cf0b80b364407f698ecbb001255ac89422b2890cc22527e43",
"md5": "92b536f1664961f3e6ef60365f7c90e7",
"sha256": "8e8f3bc6272d0b0f0b648f67b270e89ecdcd5e213aba4647aedfb9d485b417c2"
},
"downloads": -1,
"filename": "firebolt_sdk-1.4.4.tar.gz",
"has_sig": false,
"md5_digest": "92b536f1664961f3e6ef60365f7c90e7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 62976,
"upload_time": "2024-05-06T11:23:28",
"upload_time_iso_8601": "2024-05-06T11:23:28.530424Z",
"url": "https://files.pythonhosted.org/packages/cd/cc/41a3ae013c6cf0b80b364407f698ecbb001255ac89422b2890cc22527e43/firebolt_sdk-1.4.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-06 11:23:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "firebolt-db",
"github_project": "firebolt-sdk",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "firebolt-sdk"
}
JSON
