Skip to main content
Version: Next

CLI Ingestion

Installing the CLI

Make sure you have installed DataHub CLI before following this guide.

# Requires Python 3.8+
python3 -m pip install --upgrade pip wheel setuptools
python3 -m pip install --upgrade acryl-datahub
# validate that the install was successful
datahub version
# If you see "command not found", try running this instead: python3 -m datahub version

Check out the CLI Installation Guide for more installation options and troubleshooting tips.

After that, install the required plugin for the ingestion.

pip install 'acryl-datahub[datahub-rest]'  # install the required plugin

Check out the alternative installation options for more reference.

Configuring a Recipe

Create a recipe.yml file that defines the source and sink for metadata, as shown below.

# my_reipe.yml
type: <source_name>
option_1: <value>

type: <sink_type_name>

For more information and examples on configuring recipes, please refer to Recipes.

Ingesting Metadata

You can run ingestion using datahub ingest like below.

datahub ingest -c <path_to_recipe_file.yml>


Please refer the following pages for advanced guids on CLI ingestion.

:::Tip Compatibility DataHub server uses a 3 digit versioning scheme, while the CLI uses a 4 digit scheme. For example, if you're using DataHub server version 0.10.0, you should use CLI version 0.10.0.x, where x is a patch version. We do this because we do CLI releases at a much higher frequency than server releases, usually every few days vs twice a month.

For ingestion sources, any breaking changes will be highlighted in the release notes. When fields are deprecated or otherwise changed, we will try to maintain backwards compatibility for two server releases, which is about 4-6 weeks. The CLI will also print warnings whenever deprecated options are used. :::