Onkar Ravgan 14fa96958f
Added dbt workflow docs (#9493)
* Added dbt workflow docs

* added dbt small case

* Fixed review comments
2022-12-22 13:11:18 +00:00

3.7 KiB

title slug
Ingest Owner from dbt /connectors/ingestion/workflows/dbt/ingest-dbt-owner

Ingest Owner from dbt

Ingest the model/table owner information from dbt manifest.json or catalog.json file into openmetadata tables.

The owner can be a user or a team in OpenMetadata.

Follow the link here to add the owner to the dbt project's schema.yml file

Requirements

1. Owner information in manifest.json file

Openmetadata fetches the owner information from the manifest.json file. Below is a sample manifest.json file node containing owner information under node_name->metadata->owner.

"model.jaffle_shop.orders": {
			"metadata": {
				"type": "BASE TABLE",
				"schema": "dbt_jaffle",
				"name": "orders",
				"database": "dev",
				"comment": null,
				"owner": "openmetadata_team"
			}
}

2. Owner information in catalog.json file

Openmetadata fetches the owner information from the catalog.json file. Below is a sample catalog.json file node containing owner information under node_name->metadata->owner.

"model.jaffle_shop.customers": {
      "metadata": {
        "type": "BASE TABLE",
        "schema": "dbt_jaffle",
        "name": "customers",
        "database": "dev",
        "comment": null,
        "owner": "openmetadata"
      },
}

3. Adding the User or Team to OpenMetadata

The user or team which will be set as the entity owner should be first created in OpenMetadata.

While linking the owner from manifest.json or catalog.json files to the entity, OpenMetadata first searches for the user if it is present. If the user is not present it searches for the team

Following steps shows adding a User to OpenMetadata:

  1. Click on the Users section from homepage click-users-page

  2. Click on the Add User button click-add-user

  3. Enter the details as shown for the user

If the owner's name in manifest.json or catalog.json file is openmetadata, you need to enter openmetadata@youremail.com in the email id section of add user form as shown below.

add-user-dbt

Following steps shows adding a Team to OpenMetadata:

  1. Click on the Teams section from homepage click-teams-page

  2. Click on the Add Team button click-add-team

  3. Enter the details as shown for the team

If the owner's name in manifest.json or catalog.json file is openmetadata, you need to enter openmetadata in the name section of add team form as shown below.

add-team-dbt

Linking the Owner to the table

After runing the ingestion workflow with dbt you can see the created user or team getting linked to the table as it's owner as it was specified in the manifest.json or catalog.json file.

linked-user

If a table already has a owner linked to it, owner from the dbt will not update the current owner.