The datahub utility Centrally track all your metadata assets pushing metadata to datahub.

Getting Started #

Prerequisites #

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration #

  1. Add the datahub utility to your project using meltano add :

    meltano add utility datahub
  2. Configure the settings below using meltano config .

Next steps #

  1. Add a source and sink

Add additional metadata sources #

You should override the pip url in your meltano config to include each of the plugins you want to use with the ingestion framework

  1. Find the datahub plugin definition in your meltano.yml project file
  2. Update the pip_url property to include the desired extras (plugins):

    utilities:
    - name: datahub
      variant: datahub-project
      pip_url: acryl-datahub[rest,mongodb,metabase,bigquery,bigquery-usage,dbt]
    
  3. Re-install the plugin:

    meltano install utility datahub
    

The next time you run datahub cli, you will be able to ingest metadata with the appropriate source definition as seen here.

This plugin ships with a dbt ingestion recipe via its file-bundle.

If you run into any issues, learn how to get help.

Settings #

The settings for utility datahub that are known to Meltano are documented below. To quickly find the setting you're looking for, use the Table of Contents at the top of the page.

GMS Host (gms_host) #

URL of DataHub GMS endpoint. Typically this is something like your-server:8000 where your-server is the server IP or domain name. If using metadata service authentication enabled in the image env (recommended), then this should instead point to your frontend which acts as a proxy for the GMS service. datahub.yourdomain.com/api/gms

How to use #

Manage this setting using meltano config or an environment variable:

meltano config datahub set gms_host <gms_host>

export DATAHUB_GMS_HOST=<gms_host>

GMS Token (gms_token) #

Bearer token used for authentication. AKA Personal Access Token. Not needed if contacting GMS service directly.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config datahub set gms_token <gms_token>

export DATAHUB_GMS_TOKEN=<gms_token>

Commands #

The datahub utility supports the following commands that can be used with meltano invoke :

ingest-dbt #

  • Equivalent to: datahub ingest run --config ${MELTANO_PROJECT_ROOT}/utilities/datahub/dbt.dhub.yml

Push dbt metadata to datahub

How to use #

Run this command using meltano invoke:

meltano invoke datahub:ingest-dbt [additional arguments...]

Looking for help? #

If you're having trouble getting the datahub utility to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the #plugins-general channel.

Found an issue on this page? #

This page is generated from a YAML file that you can contribute changes to. Edit it on GitHub!