Name | openlineage-dbt JSON |
Version |
1.35.0
JSON |
| download |
home_page | None |
Summary | OpenLineage integration with dbt |
upload_time | 2025-07-11 13:30:13 |
maintainer | None |
docs_url | None |
author | OpenLineage |
requires_python | >=3.9 |
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` supports only these dbt adapters:
* `bigquery`
* `snowflake`
* `spark` (`thrift` and `odbc`, but not `local`)
* `redshift`
* `athena`
* `glue`
* `postgres`
* `clickhouse`
* `trino`
* `databricks`
* `sqlserver`
* `dremio`
* `duckdb`
## Installation
```bash
$ pip3 install openlineage-dbt
```
To install from source, run:
```bash
$ pip install .
```
## Configuration
### Transport
`openlineage-dbt` uses the OpenLineage Python client to push data to the OpenLineage backend, so any way of configuring Python client will work here as well:
```ini
OPENLINEAGE_URL=http://localhost:5000
OPENLINEAGE_API_KEY=abc
```
dbt integration-specific environment variables:
* `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` Python module but this 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-2025 contributors to the OpenLineage project
Raw data
{
"_id": null,
"home_page": null,
"name": "openlineage-dbt",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "openlineage",
"author": "OpenLineage",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/aa/fb/c32b5cef257223fd7a3195ebce16469c6583db76fa9d20e6063d0c6ce4be/openlineage_dbt-1.35.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` supports only these dbt adapters:\n\n* `bigquery`\n* `snowflake`\n* `spark` (`thrift` and `odbc`, but not `local`)\n* `redshift`\n* `athena`\n* `glue`\n* `postgres`\n* `clickhouse`\n* `trino`\n* `databricks`\n* `sqlserver`\n* `dremio`\n* `duckdb`\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### Transport\n\n`openlineage-dbt` uses the OpenLineage Python client to push data to the OpenLineage backend, so any way of configuring Python client will work here as well:\n\n```ini\nOPENLINEAGE_URL=http://localhost:5000\nOPENLINEAGE_API_KEY=abc\n```\n\ndbt integration-specific environment variables:\n\n* `OPENLINEAGE_NAMESPACE` - set if you are using something other than the `default` namespace for job namespace.\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` Python module but this 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-2025 contributors to the OpenLineage project\n",
"bugtrack_url": null,
"license": null,
"summary": "OpenLineage integration with dbt",
"version": "1.35.0",
"project_urls": null,
"split_keywords": [
"openlineage"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "8df175a68eb70c1e30fc7a7837043d165f7fd2eca07733203f1e4ed49966d1b6",
"md5": "a756a1df35354dce9afdcaf93e025db5",
"sha256": "df53ee60d125e0a85589de1cac4e2cbad7670cd90328bf46d2c12121625f76fb"
},
"downloads": -1,
"filename": "openlineage_dbt-1.35.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a756a1df35354dce9afdcaf93e025db5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 5881,
"upload_time": "2025-07-11T13:30:04",
"upload_time_iso_8601": "2025-07-11T13:30:04.464038Z",
"url": "https://files.pythonhosted.org/packages/8d/f1/75a68eb70c1e30fc7a7837043d165f7fd2eca07733203f1e4ed49966d1b6/openlineage_dbt-1.35.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "aafbc32b5cef257223fd7a3195ebce16469c6583db76fa9d20e6063d0c6ce4be",
"md5": "0710c36cac8bcb05a09ada47ba3982e5",
"sha256": "bb743c6d9b0263d8d0a27a7c209de1bbf06a95a804560bcecfcb6bf8a9e5c8e1"
},
"downloads": -1,
"filename": "openlineage_dbt-1.35.0.tar.gz",
"has_sig": false,
"md5_digest": "0710c36cac8bcb05a09ada47ba3982e5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 7303,
"upload_time": "2025-07-11T13:30:13",
"upload_time_iso_8601": "2025-07-11T13:30:13.414415Z",
"url": "https://files.pythonhosted.org/packages/aa/fb/c32b5cef257223fd7a3195ebce16469c6583db76fa9d20e6063d0c6ce4be/openlineage_dbt-1.35.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-11 13:30:13",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "openlineage-dbt"
}