Back to Datahub

README

metadata-ingestion/docs/sources/hex/README.md

1.7.03.3 KB
Original Source

Overview

Hex is a collaborative data workspace where teams build interactive notebooks combining SQL, Python, and visualizations.

The DataHub integration emits Hex Projects (Dashboards) and Components (Charts) along with workspace containers, ownership, tags from Collections/Status/Categories, usage statistics, and upstream lineage to the warehouses Hex queries. It also emits per-project run history, and per-project context documents for AI agent retrieval (opt-in via include_context_documents). Upstream lineage is produced directly from Hex's own APIs (SQL parsing by default; Hex's queriedTables API can be enabled on Hex Enterprise workspaces) — no warehouse ingestion dependency is required.

Concept Mapping

Hex ConceptDataHub ConceptNotes
"hex"Data Platform
WorkspaceContainerParent container for all projects and components in the workspace.
ProjectDashboardSubtype Project. Carries usage statistics, last refresh time from run history, and upstream lineage edges to warehouse datasets.
ComponentChartSubtype Component. Reusable shared cell group with its own visualization; linked to importing projects via DashboardInfo.charts.
CollectionTagEmitted as hex:collection:<name> when collections_as_tags is enabled.
StatusTagEmitted as hex:status:<name> when status_as_tag is enabled.
CategoryTagEmitted as hex:category:<name> when categories_as_tags is enabled.
Project DocDocumentOne per Project and per Component when include_context_documents is enabled. Hidden from global search; linked to the Dashboard/Chart for AI agents.

Other Hex concepts are not mapped to DataHub entities yet.