Skip to main content

Quickstart

Get a SDP-META pipeline running using the DAB path with the --quickstart flag.

Steps

1. Install

pip install databricks-labs-sdp-meta
databricks labs install sdp-meta

2. Authenticate

databricks auth login --host YOUR_WORKSPACE_URL

3. Scaffold a bundle

databricks labs sdp-meta bundle-init --quickstart

Creates a bundle directory with job definition, pipeline definition, runner notebook, and a sample onboarding file.

4. Edit variables

Open resources/variables.yml and set at minimum:

  • uc_catalog_name — your Unity Catalog catalog name
  • sdp_meta_schema — schema where DataflowSpec tables will be created
  • bronze_target_schema — schema for Bronze output tables
  • sdp_meta_dependency — a PyPI coordinate (databricks-labs-sdp-meta==0.1.0) or /Volumes/... wheel path
warning

--quickstart leaves sdp_meta_dependency set to __SET_ME__. bundle-validate rejects this placeholder, so you must set a real value before deploying.

5. Validate

databricks labs sdp-meta bundle-validate

6. Deploy

databricks bundle deploy

7. Run the onboarding job

databricks bundle run onboarding

8. Start the pipeline

databricks bundle run pipelines

9. Verify

Open the pipeline in the Databricks UI (Workflows → Lakeflow Spark Declarative Pipelines) and confirm it reaches Completed status. Bronze output tables should appear in <bronze_target_schema> in your Unity Catalog. If the pipeline stays in Running or transitions to Failed, check the event log in the pipeline UI for the root cause.

For all bundle options — scaffolding modes, split vs combined pipelines, adding flows, CI/CD setup — see Declarative Automation Bundles.