Skip to main content

Run dbt Command

Executes a dbt command using Databricks Workflows

Category: Enrich Lakehouse Table | Tags: Enrichment

How it works

Run dbt command '<<dbtCommand>>'

To use this activity within the API, use an ActivityCode of RUN-DBT.

Example JSON​

An example of what the Task Config would look like for a task using this activity. Some of these variables would be set at the group level to avoid duplication between tasks.

{
  "DbtCommand": "",
  "DbtProjectRepoUrl": "",
  "DbtProjectRepoBranch": "main",
  "DbtProjectRepoProvider": "<<azureDevOpsServices>>"
}

Variable Reference​

The following variables are supported:

  • DatabricksClusterId (Optional) - The Databricks Cluster to use for this task.

  • DbtCommand (Required) - The dbt command to run in databricks. Must start with 'dbt' e.g. dbt run -m model_name

  • DbtProjectDirectory (Optional) - Optional relative path to a subdirectory within your repo containing the dbt project.

  • DbtProjectRepoBranch (Required) - The branch in your repo to checkout when performing a run.

  • DbtProjectRepoProvider (Required) - A string identifier for the provider of your dbt repository.

  • DbtProjectRepoUrl (Required) - Url used to get the dbt project from your source control provider.

  • ExtractControlVariableName (Optional) - For incremental loads only, the name to assign the Extract Control variable in State Config for the ExtractControl value derived from the Extract Control Query above.

  • ExtractControlVariableSeedValue (Optional) - The initial value to set for the Extract Control variable in State Config - this will have no impact beyond the original seeding of the Extract Control variable in State Config.

  • IsFederated (Optional) - Makes task available to other Insight Factories within this organisation.

  • Links (Optional) - NULL

  • MaximumNumberOfAttemptsAllowed (Optional) - The total number of times the running of this Task can be attempted.

  • MinutesToWaitBeforeNextAttempt (Optional) - If a Task run fails, the number of minutes to wait before re-attempting the Task.