Datahub

datahub from datahub-project

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
    :
  2. meltano add utility datahub
  3. Configure the datahub settings using
    meltano config
    :
  4. meltano config datahub set --interactive

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.

Capabilities

This plugin currently has no capabilities defined. If you know the capabilities required by this plugin, please contribute!

Settings

The datahub settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

GMS Host (gms_host)

  • Environment variable: DATAHUB_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

GMS Token (gms_token)

  • Environment variable: DATAHUB_GMS_TOKEN

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

Commands

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

ingest-dbt

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

Push dbt metadata to datahub

meltano invoke datahub:ingest-dbt [args...]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

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.

Install

meltano add utility datahub

Maintenance Status

  • Maintenance Status
  • Stars
  • Forks
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • DataHub

Meltano Stats

  • Total Executions (Last 3 Months)
  • Projects (Last 3 Months)

Keywords

  • metadata