<img width="1113" alt="Screen Shot 2021-12-10 at 1 09 09 PM" src="https://user-images.githubusercontent.com/7674553/145641621-a7dabe78-da92-4f0a-bbd2-54ccf7f34b57.png">
# dbt-firebolt
The [dbt](https://www.getdbt.com) adapter for [Firebolt](https://www.firebolt.io/). dbt-firebolt offers the following benefits to Firebolt customers:
* SQL-based data transformation
* Life cycle management for native Firebolt objects (fact tables, dimension tables, primary indexes, aggregating indexes, join indexes, etc.)
* Declarative, version-controlled data modeling
* Auto-generated data lineage and documentation
dbt-firebolt supports dbt 1.0+.
## Installation
Install the dbt-firebolt package from PyPI:
```
pip install dbt-firebolt
```
## Setup
#### Connecting to Firebolt
To connect to Firebolt from dbt, you'll need to add a new Firebolt profile to your `profiles.yml` file. Please see the [dbt documentation on Firebolt profiles](https://docs.getdbt.com/reference/warehouse-profiles/firebolt-profile#connecting-to-firebolt) to set it up.
#### Setup Recommendations
For the best experience we recommend that you make the following changes to your dbt project:
* [Set an explicit value for `quote_columns`](https://docs.getdbt.com/reference/resource-configs/firebolt-configs#setting-quote_columns)
* [Add the `generate_alias_name` macro to your project](https://docs.getdbt.com/reference/warehouse-profiles/firebolt-profile#supporting-concurrent-development)
## Feature Support
The table below shows which dbt and Firebolt features are supported by the adapter. dbt-firebolt is under active development and will be gradually unlocking more features over time.
| Feature | Supported |
|------------------------------|--------------------|
| Table materializations | :white_check_mark: |
| Ephemeral materializations | :white_check_mark: |
| View materializations | :white_check_mark: |
| Incremental materializations - append | :white_check_mark: |
| Incremental materializations - insert_overwrite | :white_check_mark: |
| Incremental materializations - delete+insert | :white_check_mark: |
| Incremental materializations - merge | :x: |
| Snapshots | :x: |
| Seeds | :white_check_mark: |
| Tests | :white_check_mark: |
| Documentation | :white_check_mark: |
| Custom schemas | :x: (see [workaround](https://docs.getdbt.com/reference/warehouse-profiles/firebolt-profile#supporting-concurrent-development)) |
| Custom databases | :x: |
| Source freshness | :white_check_mark: |
| External tables | :white_check_mark: |
| Primary indexes | :white_check_mark: |
| Aggregating indexes | :white_check_mark: |
| Join indexes | :x: (syntax supported, but not effective) |
## Constraints support
More on constraints in [Platform constraint support](https://docs.getdbt.com/docs/collaborate/govern/model-contracts#platform-constraint-support)
| Constraint type | Support | Platform enforcement |
|-----------------|---------|----------------------|
| not_null | :white_check_mark: Supported | :white_check_mark: Enforced |
| primary_key | :x: Not Supported | :x: Not enforced |
| foreign_key | :x: Not Supported | :x: Not enforced |
| unique | :white_check_mark: Supported | :x: Not enforced |
| check | :x: Not supported | :x: Not enforced |
## Using dbt-firebolt
For information on configuring dbt models and external tables for Firebolt, see the [dbt documentation for Firebolt configurations](https://docs.getdbt.com/reference/resource-configs/firebolt-configs).
## Contributing
See: [CONTRIBUTING.MD](https://github.com/firebolt-db/dbt-firebolt/tree/main/CONTRIBUTING.MD)
## Changelog
See our [changelog](CHANGELOG.md) or our release history for more information.
Raw data
{
"_id": null,
"home_page": "https://github.com/firebolt-db/dbt-firebolt",
"name": "dbt-firebolt",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Firebolt",
"author_email": "support@firebolt.io",
"download_url": "https://files.pythonhosted.org/packages/71/b8/da4c27179beacdb794786dc47b939b0b2c7a6592e3aaa9c76941edfed6e0/dbt_firebolt-1.6.1.tar.gz",
"platform": null,
"description": "<img width=\"1113\" alt=\"Screen Shot 2021-12-10 at 1 09 09 PM\" src=\"https://user-images.githubusercontent.com/7674553/145641621-a7dabe78-da92-4f0a-bbd2-54ccf7f34b57.png\">\n\n\n# dbt-firebolt\n\nThe [dbt](https://www.getdbt.com) adapter for [Firebolt](https://www.firebolt.io/). dbt-firebolt offers the following benefits to Firebolt customers:\n* SQL-based data transformation\n* Life cycle management for native Firebolt objects (fact tables, dimension tables, primary indexes, aggregating indexes, join indexes, etc.)\n* Declarative, version-controlled data modeling\n* Auto-generated data lineage and documentation\n\ndbt-firebolt supports dbt 1.0+.\n\n\n## Installation\n\nInstall the dbt-firebolt package from PyPI:\n ```\n pip install dbt-firebolt\n ```\n\n\n## Setup\n\n#### Connecting to Firebolt\n\nTo connect to Firebolt from dbt, you'll need to add a new Firebolt profile to your `profiles.yml` file. Please see the [dbt documentation on Firebolt profiles](https://docs.getdbt.com/reference/warehouse-profiles/firebolt-profile#connecting-to-firebolt) to set it up.\n\n#### Setup Recommendations\n\nFor the best experience we recommend that you make the following changes to your dbt project:\n* [Set an explicit value for `quote_columns`](https://docs.getdbt.com/reference/resource-configs/firebolt-configs#setting-quote_columns)\n* [Add the `generate_alias_name` macro to your project](https://docs.getdbt.com/reference/warehouse-profiles/firebolt-profile#supporting-concurrent-development)\n\n\n## Feature Support\n\nThe table below shows which dbt and Firebolt features are supported by the adapter. dbt-firebolt is under active development and will be gradually unlocking more features over time.\n\n| Feature | Supported |\n|------------------------------|--------------------|\n| Table materializations | :white_check_mark: |\n| Ephemeral materializations | :white_check_mark: |\n| View materializations | :white_check_mark: |\n| Incremental materializations - append | :white_check_mark: |\n| Incremental materializations - insert_overwrite | :white_check_mark: |\n| Incremental materializations - delete+insert | :white_check_mark: |\n| Incremental materializations - merge | :x: |\n| Snapshots | :x: |\n| Seeds | :white_check_mark: |\n| Tests | :white_check_mark: |\n| Documentation | :white_check_mark: |\n| Custom schemas | :x: (see [workaround](https://docs.getdbt.com/reference/warehouse-profiles/firebolt-profile#supporting-concurrent-development)) |\n| Custom databases | :x: |\n| Source freshness | :white_check_mark: |\n| External tables | :white_check_mark: |\n| Primary indexes | :white_check_mark: |\n| Aggregating indexes | :white_check_mark: |\n| Join indexes | :x: (syntax supported, but not effective) |\n\n\n## Constraints support\n\nMore on constraints in [Platform constraint support](https://docs.getdbt.com/docs/collaborate/govern/model-contracts#platform-constraint-support)\n\n\n| Constraint type | Support | Platform enforcement |\n|-----------------|---------|----------------------|\n| not_null | :white_check_mark: Supported | :white_check_mark: Enforced |\n| primary_key | :x: Not Supported | :x: Not enforced |\n| foreign_key | :x: Not Supported | :x: Not enforced |\n| unique | :white_check_mark: Supported | :x: Not enforced |\n| check | :x: Not supported | :x: Not enforced |\n\n\n## Using dbt-firebolt\n\nFor information on configuring dbt models and external tables for Firebolt, see the [dbt documentation for Firebolt configurations](https://docs.getdbt.com/reference/resource-configs/firebolt-configs).\n\n## Contributing\n\nSee: [CONTRIBUTING.MD](https://github.com/firebolt-db/dbt-firebolt/tree/main/CONTRIBUTING.MD)\n\n## Changelog\n\nSee our [changelog](CHANGELOG.md) or our release history for more information.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "The Firebolt adapter plugin for dbt (data build tool)",
"version": "1.6.1",
"project_urls": {
"Bug Tracker": "https://github.com/firebolt-db/dbt-firebolt/issues",
"Homepage": "https://github.com/firebolt-db/dbt-firebolt"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "aaa31c907c1b56696e8867426627f0a8fd274dd024212b584072a9fffec70ddc",
"md5": "4e259e3081f0e78fc763b74c35e17e4b",
"sha256": "3912e838c906300c24515801a0f4f969db366fa291c7c8e56bd5f53070c55e7a"
},
"downloads": -1,
"filename": "dbt_firebolt-1.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4e259e3081f0e78fc763b74c35e17e4b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 39416,
"upload_time": "2024-03-04T14:50:57",
"upload_time_iso_8601": "2024-03-04T14:50:57.205479Z",
"url": "https://files.pythonhosted.org/packages/aa/a3/1c907c1b56696e8867426627f0a8fd274dd024212b584072a9fffec70ddc/dbt_firebolt-1.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "71b8da4c27179beacdb794786dc47b939b0b2c7a6592e3aaa9c76941edfed6e0",
"md5": "f592c9cddf74ae666b1c75aa10484b0d",
"sha256": "9da3a255045a78013b8e38c6ae49e961cc9bb32f96be48d19b019f646b4ead22"
},
"downloads": -1,
"filename": "dbt_firebolt-1.6.1.tar.gz",
"has_sig": false,
"md5_digest": "f592c9cddf74ae666b1c75aa10484b0d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 27609,
"upload_time": "2024-03-04T14:50:59",
"upload_time_iso_8601": "2024-03-04T14:50:59.007120Z",
"url": "https://files.pythonhosted.org/packages/71/b8/da4c27179beacdb794786dc47b939b0b2c7a6592e3aaa9c76941edfed6e0/dbt_firebolt-1.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-04 14:50:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "firebolt-db",
"github_project": "dbt-firebolt",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "dbt-firebolt"
}
JSON
