Skip to main content

DataHub SDK and CLI

DataHub's ingestion framework and CLI — pull metadata from 50+ data sources into your catalog, or push it programmatically from your own pipelines and applications.

Pull-based integrations crawl your data systems on a schedule: Snowflake, BigQuery, dbt, Looker, Airflow, and many more.

Push-based integrations let you emit metadata directly from code as it happens: Python SDK, Java SDK, Spark, Great Expectations, and others.

What you can do

  • Pull metadata from databases, warehouses, BI tools, and orchestrators using 50+ ready-made connectors
  • Push metadata programmatically using the Python or Java SDK
  • Transform and filter metadata in transit using built-in transformers
  • Schedule and manage ingestion pipelines via CLI or the DataHub UI
  • Automate lineage, ownership, tags, and documentation across your data assets

Supported sources

Snowflake · BigQuery · Redshift · dbt · Databricks · Looker · Tableau · Power BI · Airflow · Spark · Kafka · PostgreSQL · MySQL · Hive · Glue · S3 · Iceberg · Unity Catalog · Sigma · Mode · Superset · Metabase · and many more

Installation

pip install acryl-datahub
datahub version

Quickstart

Pull metadata from a source (recipe)

# snowflake_recipe.yml
source:
  type: snowflake
  config:
    account_id: my_account
    username: my_user
    password: my_password
    role: DATAHUB_ROLE
    warehouse: COMPUTE_WH

sink:
  type: datahub-rest
  config:
    server: http://localhost:8080
datahub ingest -c snowflake_recipe.yml

Emit metadata from code (SDK)

from datahub.sdk import DataHubClient, Dataset

client = DataHubClient.from_env()

dataset = Dataset(platform="snowflake", name="mydb.schema.table")
dataset.set_description("My table description")
dataset.set_owners(["urn:li:corpuser:jane"])

client.entities.upsert(dataset)

Ingest via the DataHub UI

No CLI required — configure and run ingestion directly from the DataHub UI under Ingestion → Create new source.

Ingestion methods

Method Best for
CLI + YAML recipe Scheduled batch ingestion, CI/CD pipelines
Python SDK Programmatic or event-driven metadata emission
Java SDK JVM-based integrations (Spark, Flink, etc.)
UI Ingestion One-click setup, no code required

Key CLI commands

datahub init                          # Connect to a DataHub instance (interactive)
datahub init --username datahub --password datahub  # Quickstart with local defaults
datahub ingest -c recipe.yml          # Run an ingestion pipeline
datahub search "my table"             # Search for entities by keyword
datahub search "*" --filter platform=snowflake --filter entity_type=dataset
datahub graphql --list-operations     # Explore all available GraphQL operations
datahub graphql --query "{ me { corpUser { urn } } }"  # Run a GraphQL query
datahub get --urn <urn>               # Fetch metadata for an entity
datahub delete --urn <urn>            # Delete a metadata entity
datahub timeline --urn <urn>          # View metadata change history

Links

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

acryl_datahub-1.7.0.9.tar.gz (4.5 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

acryl_datahub-1.7.0.9-py3-none-any.whl (5.3 MB view details)

Uploaded Python 3

File details

Details for the file acryl_datahub-1.7.0.9.tar.gz.

File metadata

  • Download URL: acryl_datahub-1.7.0.9.tar.gz
  • Upload date:
  • Size: 4.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.10.21

File hashes

Hashes for acryl_datahub-1.7.0.9.tar.gz
Algorithm Hash digest
SHA256 c00f50677e508ca2466e3fd1334c4ea48f3aeb656b16128952596c70dbc6f14c
MD5 eea40676ab0493af527d558cc1bf7ba7
BLAKE2b-256 2af2c683bf25f5f8c3ad399cc1c73983c744a6ced692607f9769944746b80af2

See more details on using hashes here.

File details

Details for the file acryl_datahub-1.7.0.9-py3-none-any.whl.

File metadata

File hashes

Hashes for acryl_datahub-1.7.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 118d4e57612618853cd75f4e6758863888f30fdea8ecd317789c9fffe401896e
MD5 e50a3cf9cd178479c55afcf92421c179
BLAKE2b-256 09787d1ec0b52ea97459a705bb5b7c8c749a1b4a0305e3eb443b1e09eefcded9

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

1.7.0.9 This release

2 files

1.7.0.8

2 files

1.7.0.7

2 files

1.7.0.6

2 files

1.7.0.5

2 files

1.7.0.4

2 files

1.7.0.3

2 files

1.7.0.2

2 files

1.7.0.1rc1

2 files

1.7.0

2 files

1.6.0.17

2 files

1.6.0.16

2 files

1.6.0.15

2 files

1.6.0.14

2 files

1.6.0.13

2 files

1.6.0.12

2 files

1.6.0.11

2 files

1.6.0.10

2 files

1.6.0.9.post1

2 files

1.6.0.9

2 files

1.6.0.8.post1

2 files

1.6.0.8

2 files

1.6.0.6

2 files

1.6.0.5

2 files

1.6.0.4.post1

2 files

1.6.0.4

2 files

1.6.0.3

2 files

1.6.0.2

2 files

1.6.0.1

2 files

1.6.0.post1

2 files

1.6.0

2 files

1.5.0.19

2 files

1.5.0.18

2 files

1.5.0.17

2 files

1.5.0.16

2 files

1.5.0.15

2 files

1.5.0.14

2 files

1.5.0.13.post1

2 files

1.5.0.13

2 files

1.5.0.12

2 files

1.5.0.11

2 files

1.5.0.10

2 files

1.5.0.9

2 files

1.5.0.8

2 files

1.5.0.7

2 files

1.5.0.6

2 files

1.5.0.5

2 files

1.5.0.4

2 files

1.5.0.3

2 files

1.5.0.2

2 files

1.5.0.1

2 files

1.5.0

2 files

1.4.0.9

2 files

1.4.0.8

2 files

1.4.0.7

2 files

1.4.0.6

2 files

1.4.0.5

2 files

1.4.0.4

2 files

1.4.0.3

2 files

1.4.0.2

2 files

1.4.0.1

2 files

1.4.0

2 files

1.3.1.10

2 files

1.3.1.9

2 files

1.3.1.8

2 files

1.3.1.7.post3

2 files

1.3.1.7.post2

2 files

1.3.1.7.post1

2 files

1.3.1.7

2 files

1.3.1.6

2 files

1.3.1.5

2 files

1.3.1.4.post1

2 files

1.3.1.4

2 files

1.3.1.3

2 files

1.3.1.2

2 files

1.3.1.1.post1

2 files

1.3.1.1

2 files

1.3.1.post1

2 files

1.3.1

2 files

1.3.0

2 files

1.2.0.10

2 files

1.2.0.9.post1

2 files

1.2.0.9

2 files

1.2.0.8

2 files

1.2.0.7

2 files

1.2.0.6.post1

2 files

1.2.0.6

2 files

1.2.0.5

2 files

1.2.0.4

2 files

1.2.0.3

2 files

1.2.0.2

2 files

1.2.0.1

2 files

1.2.0

2 files

1.1.0.5

2 files

1.1.0.4

2 files

1.1.0.3

2 files

1.1.0.2

2 files

1.1.0.1

2 files

1.1.0

2 files

1.0.0.3

2 files

1.0.0.2

2 files

1.0.0.1

2 files

1.0.0

2 files

0.15.0.5

2 files

0.15.0.4

2 files

0.15.0.3

2 files

0.15.0.2

2 files

0.15.0.1

2 files

0.15.0

2 files

0.14.1.12

2 files

0.14.1.11

2 files

0.14.1.10

2 files

0.14.1.9

2 files

0.14.1.8

2 files

0.14.1.7

2 files

0.14.1.6

2 files

0.14.1.5

2 files

0.14.1.3

2 files

0.14.1.2

2 files

0.14.1.1

2 files

0.14.1

2 files

0.14.0.6rc3

2 files

0.14.0.5

2 files

0.14.0.4

2 files

0.14.0.3

2 files

0.14.0.2

2 files

0.14.0.1

2 files

0.14.0

2 files

0.13.3.6

2 files

0.13.3.5

2 files

0.13.3.4

2 files

0.13.3.3

2 files

0.13.3.2

2 files

0.13.3.1

2 files

0.13.3

2 files

0.13.2.4

2 files

0.13.2.3

2 files

0.13.2.2

2 files

0.13.2.1

2 files

0.13.2

2 files

0.13.1.3

2 files

0.13.1.2

2 files

0.13.1.1

2 files

0.13.1

2 files

0.13.0

2 files

0.12.1.5

2 files

0.12.1.4

2 files

0.12.1.3

2 files

0.12.1.2

2 files

0.12.1.1

2 files

0.12.1.0

2 files

0.12.0.5

2 files

0.12.0.4

2 files

0.12.0.3

2 files

0.12.0.2

2 files

0.12.0.1

2 files

0.12.0

2 files

0.11.0.5

2 files

0.11.0.4

2 files

0.11.0.3

2 files

0.11.0.2

2 files

0.11.0.1

2 files

0.11.0

2 files

0.10.5.5

2 files

0.10.5.4

2 files

0.10.5.3

2 files

0.10.5.2

2 files

0.10.5.1

2 files

0.10.5

2 files

0.10.4.3

2 files

0.10.4.2

2 files

0.10.4.1

2 files

0.10.4

2 files

0.10.3.2

2 files

0.10.3.1

2 files

0.10.3

2 files

0.10.2.3

2 files

0.10.2.2

2 files

0.10.2.1

2 files

0.10.2

2 files

0.10.1.2

2 files

0.10.1.1

2 files

0.10.1

2 files

0.10.0.7

2 files

0.10.0.6

2 files

0.10.0.5

2 files

0.10.0.4

2 files

0.10.0.3

2 files

0.10.0.2

2 files

0.10.0.1

2 files

0.10.0

2 files

0.9.6.4

2 files

0.9.6.3

2 files

0.9.6.2

2 files

0.9.6.1

2 files

0.9.6

2 files

0.9.5.2

2 files

0.9.5

2 files

0.9.4.1

2 files

0.9.4

2 files

0.9.3.2

2 files

0.9.3.1

2 files

0.9.3

2 files

0.9.2.5

2 files

0.9.2.4

2 files

0.9.2.3

2 files

0.9.2.2

2 files

0.9.2.1

2 files

0.9.2

2 files

0.9.1

2 files

0.9.0.5

2 files

0.9.0.4

2 files

0.9.0.3

2 files

0.9.0.2

2 files

0.9.0.1

2 files

0.9.0

2 files

0.8.45.2

2 files

0.8.45.1

2 files

0.8.45

2 files

0.8.44.5

2 files

0.8.44.4

2 files

0.8.44.3

2 files

0.8.44.3rc4

2 files

0.8.44.2

2 files

0.8.44.1

2 files

0.8.44

2 files

0.8.44rc1

2 files

0.8.44rc0

2 files

0.8.43.6

2 files

0.8.43.5

2 files

0.8.43.4

2 files

0.8.43.3

2 files

0.8.43.2

2 files

0.8.43.1

2 files

0.8.43

2 files

0.8.42

2 files

0.8.41.2

2 files

0.8.41.1

2 files

0.8.41

2 files

0.8.40.3

2 files

0.8.40.2

2 files

0.8.40.1

2 files

0.8.40

2 files

0.8.39

2 files

0.8.38.5

2 files

0.8.38.4

2 files

0.8.38.3

2 files

0.8.38.2

2 files

0.8.38.1

2 files

0.8.38

2 files

0.8.37

2 files

0.8.36

2 files

0.8.35.7

2 files

0.8.35.6

2 files

0.8.35.5

2 files

0.8.35.4

2 files

0.8.35.3

2 files

0.8.35.2

2 files

0.8.35.1

2 files

0.8.35

2 files

0.8.34.2

2 files

0.8.34.1

2 files

0.8.34

2 files

0.8.33.3

2 files

0.8.33.2

2 files

0.8.33.1

2 files

0.8.33

2 files

0.8.32.7

2 files

0.8.32.6

2 files

0.8.32.5

2 files

0.8.32.4

2 files

0.8.32.3

2 files

0.8.32.2

2 files

0.8.32.1

2 files

0.8.32

2 files

0.8.31.6

2 files

0.8.31.5

2 files

0.8.31.4

2 files

0.8.31.3

2 files

0.8.31.2

2 files

0.8.31.1

2 files

0.8.31

2 files

0.8.30.0

3 files

0.8.29.2

2 files

0.8.29.1

2 files

0.8.29

2 files

0.8.28.1

2 files

0.8.28.0

3 files

0.8.27.2

2 files

0.8.27.1

2 files

0.8.27

2 files

0.8.26.8

2 files

0.8.26.7

2 files

0.8.26.6

2 files

0.8.26.5

2 files

0.8.26.4

2 files

0.8.26.3

2 files

0.8.26.2

2 files

0.8.26.1

2 files

0.8.26.0

2 files

0.8.25.2

2 files

0.8.25.1

2 files

0.8.25

3 files

0.8.24.3

2 files

0.8.24.2

2 files

0.8.24.1

2 files

0.8.24.0

2 files

0.8.23.1

2 files

0.8.23.0

2 files

0.8.22.1

2 files

0.8.21.0

2 files

0.8.20.0

2 files

0.8.19.1

2 files

0.8.19.0

2 files

0.8.18.1

2 files

0.8.18

3 files

0.8.17.7

2 files

0.8.17.6

2 files

0.8.17.5

2 files

0.8.17.4

2 files

0.8.17.3

2 files

0.8.17.2

2 files

0.8.17.1

2 files

0.8.17.0

2 files

0.8.16.12

2 files

0.8.16.11

2 files

0.8.16.9

2 files

0.8.16.8

2 files

0.8.16.7

2 files

0.8.16.6

2 files

0.8.16.5

2 files

0.8.16.4

2 files

0.8.16.3

2 files

0.8.16.2

2 files

0.8.16.1

2 files

0.8.16.0

2 files

0.8.15.10

2 files

0.8.15.9

2 files

0.8.15.8

2 files

0.8.15.7

2 files

0.8.15.6

2 files

0.8.15.5

2 files

0.8.15.4

2 files

0.8.15.3

2 files

0.8.15.2

2 files

0.8.15.1

2 files

0.8.15.0

2 files

0.8.14.2

2 files

0.8.14.1

2 files

0.8.14.0

2 files

0.8.13.1

2 files

0.8.13.0

2 files

0.8.12.0

2 files

0.8.11.1

2 files

0.8.11.0

2 files

0.8.10.2

2 files

0.8.10.1

2 files

0.8.10.0

2 files

0.8.9.0

2 files

0.8.8.4

2 files

0.8.8.3

2 files

0.8.8.2

2 files

0.8.8.1

2 files

0.8.8.0

2 files

0.8.7.0

2 files

0.8.6.5

2 files

0.8.6.4

2 files

0.8.6.3

2 files

0.8.6.2

2 files

0.8.6.1

2 files

0.8.6.0

2 files

0.8.5.2

2 files

0.8.5.1

2 files

0.8.5.0

2 files

0.8.4.0

2 files

0.8.3.3

2 files

0.8.3.2

2 files

0.8.3.1

2 files

0.8.3.0

2 files

0.8.1.2

2 files

0.8.1.1

2 files

0.8.1.0

2 files

0.4.0

2 files

0.3.4

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

0.0.5

2 files

0.0.4

2 files

0.0.3

2 files

0.0.2

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page