← GSP for DataHub

Getting Started with gsp-datahub-sidecar

Start with the workflow below to install the sidecar, run a dry-run lineage check, and emit recovered lineage into DataHub. For a complete worked example, see the BigQuery lineage page.

What this guide will cover

  1. Prerequisites — Python 3.9+, a running DataHub instance, BigQuery SQL files or audit log exports
  2. Install the sidecar — pip install from GitHub, verify the CLI
  3. Configure your backend — anonymous (zero config), authenticated (API key), or self-hosted (Docker)
  4. Scan your SQL — point the sidecar at a directory of .sql files or a BigQuery audit log export
  5. Review in dry-run mode — inspect recovered lineage before emitting
  6. Emit to DataHub — push lineage MCPs to your DataHub GMS endpoint
  7. Verify in the UI — search for your tables, open the Lineage tab, confirm column-level relationships
  8. Automate with cron or Airflow — schedule recurring scans

Try the quick start now

The BigQuery lineage page includes a working 3-command quick start you can run today.

Quick Start →