governance

Custom Governance Connector

This connector assigns custom ownership, tagging information, and descriptions to tables.

Setup

No special setup is required.

Config File

Create a YAML config file based on the following template.

Note: The ownership types and tags must be first created on Metaphor for the assignment to take effect.

Required Configurations

datasets:
  - id:
      platform: <data_platform>
      name: <dataset_name>
      account: <snowflake_account> # only for Snowflake
    ownerships:
      - type: <ownership_type>
        email: <owner_email>
      ...
    tags:
      - <tag_name>
      ...
    column_tags:
      - column: <column_name>
        tags:
          - <tag_name>
          ...
      ...
    descriptions:
      - description: <description_text>
        email: <author_email>
      ...
    column_descriptions:
      - column_name: <column_name>
        descriptions:
          - description: <description_text>
            email: <author_email>
          ...
      ...
  ...

Note: You only need to specify account if the platform is SNOWFLAKE.

Optional Configurations

Output Destination

See Output Config for more information.

Examples

Here's an example on how to assign alice@test.com and bob@test.com as owners of a BigQuery table.

datasets:
  - id:
      platform: BIGQUERY
      name: project.db.table1
    ownerships:
      - type: Data Steward
        email: bob@test.com
      - type: 
        email: alice@test.com

Here's another example showing how to tag a Snowflake table as golden, and the email column as pii.

datasets:
  - id:
      platform: SNOWFLAKE
      account: test_account
      name: database.schema.table1
    tags:
      - golden
    column_tags:
      - column: email
        tags:
          - pii

The following example shows how to add a description to a Redshift table.

datasets:
  - id:
      platform: REDSHIFT
      name: database.schema.table1
    descriptions:
      - description: A fancy description for the table
        email: charlie@test.com

Testing

Follow the Installation instructions to install metaphor-connectors in your environment (or virtualenv).

Run the following command to test the connector locally:

metaphor custom.governance <config_file>

Manually verify the output after the run finishes.