Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve OpenLineage documentation #1431

Merged
merged 3 commits into from
Dec 27, 2024
Merged

Improve OpenLineage documentation #1431

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0d29e0b
Improve OpenLineage documentation
tatiana Dec 27, 2024
296694a
🎨 [pre-commit.ci] Auto format from pre-commit.com hooks
pre-commit-ci[bot] Dec 27, 2024
87904c5
Merge branch 'main' into improve-openlineage-docs
tatiana Dec 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions docs/configuration/lineage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ Configuring Lineage
===================

Since Cosmos 1.1, it uses internally the `openlineage-integration-common <https://github.com/OpenLineage/OpenLineage/tree/main/integration/common>`_
to parse artifacts generated with dbt commands and create lineage events. This feature is only available for the local
and virtualenv execution methods (read `execution modes <../getting_started/execution-modes.html>`_ for more information).
to parse artefacts generated with dbt commands and create lineage events.

To emit lineage events, Cosmos can use one of the following:

Expand All @@ -15,6 +14,27 @@ To emit lineage events, Cosmos can use one of the following:
No change to the user DAG files is required to use OpenLineage.


Known limitations
-----------------

This feature is only available for the local
and virtualenv execution methods (read `execution modes <../getting_started/execution-modes.html>`_ for more information).

Additionally, since Cosmos uses the open-source `openlineage-integration-common <https://github.com/OpenLineage/OpenLineage/tree/main/integration/common>`_, it relies on this library to support specific dbt adapters. As of 27 December 2024, the version 1.26.0 of this package supports:

* Athena
* BigQuery
* Databricks
* DuckDB
* Dremio
* Postgres
* Redshift
* Snowflake
* Spark
* SQLServer

Contributions are also welcome in the `OpenLineage project <https://github.com/OpenLineage/OpenLineage/blob/main/integration/common/openlineage/common/provider/dbt/processor.py#L36C1-L47C22>`_ to support more adaptors.

Installation
------------

Expand Down
Loading