| Name | openlineage-dbt JSON |
| Version |
1.26.0
JSON |
| download |
| home_page | None |
| Summary | OpenLineage integration with dbt |
| upload_time | 2024-12-20 16:38:38 |
| maintainer | None |
| docs_url | None |
| author | OpenLineage |
| requires_python | >=3.8 |
| license | None |
| keywords |
openlineage
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# OpenLineage dbt integration
Wrapper script for automatic metadata collection from dbt
## Features
**Metadata**
* Model run lifecycle
* Model inputs / outputs
## Requirements
- [Python >= 3.8](https://www.python.org/downloads)
- [dbt >= 0.20](https://www.getdbt.com/)
Right now, `openlineage-dbt` only supports `bigquery`, `snowflake`, `spark` and `redshift` dbt adapters.
## Installation
```bash
$ pip3 install openlineage-dbt
```
To install from source, run:
```bash
$ pip install .
```
## Configuration
### `HTTP` Backend Environment Variables
`openlineage-dbt` uses the OpenLineage client to push data to the OpenLineage backend.
The OpenLineage client depends on environment variables:
* `OPENLINEAGE_URL` - point to service which will consume OpenLineage events
* `OPENLINEAGE_API_KEY` - set if consumer of OpenLineage events requires `Bearer` authentication key
* `OPENLINEAGE_NAMESPACE` - set if you are using something other than the `default` namespace for job namespace.
### Logging
In addition to conventional logging approaches, the OpenLineage dbt wrapper script provides an alternative way of configuring its logging behavior. By setting the `OPENLINEAGE_DBT_LOGGING` environment variable, you can establish the logging level for the `openlineage.dbt` and its child modules.
You can also set log level of `dbtol` which is deprecated.
## Usage
To begin collecting dbt metadata with OpenLineage, replace `dbt run` with `dbt-ol run`.
Additional table and column level metadata will be available if `catalog.json`, a result of running `dbt docs generate`, will be found in the target directory.
If you need to send events without running the job you can use the command `dbt-ol send-events`, it will send the metadata of your last run without running the job.
----
SPDX-License-Identifier: Apache-2.0\
Copyright 2018-2024 contributors to the OpenLineage project
Raw data
{
"_id": null,
"home_page": null,
"name": "openlineage-dbt",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "openlineage",
"author": "OpenLineage",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/2e/e1/a9f585949a7aceada0df9708571614ba51d031c52b9606124424cb28f0cc/openlineage_dbt-1.26.0.tar.gz",
"platform": null,
"description": "# OpenLineage dbt integration\n\nWrapper script for automatic metadata collection from dbt\n\n## Features\n\n**Metadata**\n\n* Model run lifecycle\n* Model inputs / outputs\n\n## Requirements\n\n- [Python >= 3.8](https://www.python.org/downloads)\n- [dbt >= 0.20](https://www.getdbt.com/)\n\nRight now, `openlineage-dbt` only supports `bigquery`, `snowflake`, `spark` and `redshift` dbt adapters.\n\n## Installation\n\n```bash\n$ pip3 install openlineage-dbt\n```\n\nTo install from source, run:\n\n```bash\n$ pip install .\n```\n\n## Configuration\n\n\n### `HTTP` Backend Environment Variables\n\n`openlineage-dbt` uses the OpenLineage client to push data to the OpenLineage backend.\n\nThe OpenLineage client depends on environment variables:\n\n* `OPENLINEAGE_URL` - point to service which will consume OpenLineage events\n* `OPENLINEAGE_API_KEY` - set if consumer of OpenLineage events requires `Bearer` authentication key\n* `OPENLINEAGE_NAMESPACE` - set if you are using something other than the `default` namespace for job namespace.\n\n\n### Logging\n\nIn addition to conventional logging approaches, the OpenLineage dbt wrapper script provides an alternative way of configuring its logging behavior. By setting the `OPENLINEAGE_DBT_LOGGING` environment variable, you can establish the logging level for the `openlineage.dbt` and its child modules.\n\nYou can also set log level of `dbtol` which is deprecated.\n\n## Usage\n\nTo begin collecting dbt metadata with OpenLineage, replace `dbt run` with `dbt-ol run`.\n\nAdditional table and column level metadata will be available if `catalog.json`, a result of running `dbt docs generate`, will be found in the target directory.\n\nIf you need to send events without running the job you can use the command `dbt-ol send-events`, it will send the metadata of your last run without running the job.\n\n----\nSPDX-License-Identifier: Apache-2.0\\\nCopyright 2018-2024 contributors to the OpenLineage project\n",
"bugtrack_url": null,
"license": null,
"summary": "OpenLineage integration with dbt",
"version": "1.26.0",
"project_urls": null,
"split_keywords": [
"openlineage"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0b90a18dbbad99fc6d9e0b635dd03cc779ddd3c3ce6affa94bde566efda8a7aa",
"md5": "8a75c6ad403c6119b96c4d6c288ddc96",
"sha256": "bfdbc0b21b24124534eb8a5889609f55b70a97a5d7b56a971b1c46a5f58687d8"
},
"downloads": -1,
"filename": "openlineage_dbt-1.26.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8a75c6ad403c6119b96c4d6c288ddc96",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 5286,
"upload_time": "2024-12-20T16:38:23",
"upload_time_iso_8601": "2024-12-20T16:38:23.717628Z",
"url": "https://files.pythonhosted.org/packages/0b/90/a18dbbad99fc6d9e0b635dd03cc779ddd3c3ce6affa94bde566efda8a7aa/openlineage_dbt-1.26.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2ee1a9f585949a7aceada0df9708571614ba51d031c52b9606124424cb28f0cc",
"md5": "faee4e21b55c8ae238244cbf5664d551",
"sha256": "17e91107ba946d3392d6874511c8e312ff798ac2c35be42ee5c663b25c142350"
},
"downloads": -1,
"filename": "openlineage_dbt-1.26.0.tar.gz",
"has_sig": false,
"md5_digest": "faee4e21b55c8ae238244cbf5664d551",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 5424,
"upload_time": "2024-12-20T16:38:38",
"upload_time_iso_8601": "2024-12-20T16:38:38.924012Z",
"url": "https://files.pythonhosted.org/packages/2e/e1/a9f585949a7aceada0df9708571614ba51d031c52b9606124424cb28f0cc/openlineage_dbt-1.26.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-20 16:38:38",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "openlineage-dbt"
}
