openlineage-dbt


Nameopenlineage-dbt JSON
Version 1.29.0 PyPI version JSON
download
home_pageNone
SummaryOpenLineage integration with dbt
upload_time2025-02-25 16:32:32
maintainerNone
docs_urlNone
authorOpenLineage
requires_python>=3.8
licenseNone
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-2025 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/ff/7f/dd86e113d4b177cddc7b7cc8fd6d8f3af12ef411baa27480a651d475f611/openlineage_dbt-1.29.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-2025 contributors to the OpenLineage project\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "OpenLineage integration with dbt",
    "version": "1.29.0",
    "project_urls": null,
    "split_keywords": [
        "openlineage"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "6b40f646f783cb141182a74daa0f096c0d4ba9683a5ebb86d56d200ac536a6be",
                "md5": "44272fe2f2651a284347446e65532b27",
                "sha256": "21b57e982dde66ea5f79998956cc52adf536ccf375cb9be7588a1954005cf426"
            },
            "downloads": -1,
            "filename": "openlineage_dbt-1.29.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "44272fe2f2651a284347446e65532b27",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 6527,
            "upload_time": "2025-02-25T16:32:18",
            "upload_time_iso_8601": "2025-02-25T16:32:18.353020Z",
            "url": "https://files.pythonhosted.org/packages/6b/40/f646f783cb141182a74daa0f096c0d4ba9683a5ebb86d56d200ac536a6be/openlineage_dbt-1.29.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ff7fdd86e113d4b177cddc7b7cc8fd6d8f3af12ef411baa27480a651d475f611",
                "md5": "49ea33ecb6b9d18c193e80f01d0ff2f4",
                "sha256": "393c079de4f5ad0dc71fc0cf5c5654633455f24c28ec5b4a0def5e47fc655279"
            },
            "downloads": -1,
            "filename": "openlineage_dbt-1.29.0.tar.gz",
            "has_sig": false,
            "md5_digest": "49ea33ecb6b9d18c193e80f01d0ff2f4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 6225,
            "upload_time": "2025-02-25T16:32:32",
            "upload_time_iso_8601": "2025-02-25T16:32:32.566257Z",
            "url": "https://files.pythonhosted.org/packages/ff/7f/dd86e113d4b177cddc7b7cc8fd6d8f3af12ef411baa27480a651d475f611/openlineage_dbt-1.29.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-25 16:32:32",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "openlineage-dbt"
}
        
Elapsed time: 1.18489s