Skip to main content

​
Overview

​
Tool Name

dbt_action

​
Purpose

The dbt_action tool lets you operate DBT projects programmatically. Use it to initialize projects, run and test models, compile SQL, install packages, generate documentation, and coordinate multi-environment deployments.

​
Functions Available

  1. dbt_action: Executes DBT operations for project management, model execution, testing, docs, snapshots, seeds, and dependency management. Controlled by the action parameter.

​
Key Features

Run and Test

Execute model runs and tests with targets, selectors, and parallel threads.

Compile and Document

Compile SQL for inspection and generate searchable documentation sites.

Packages and Artifacts

Install dependencies, seed data, snapshot state, and clean build outputs.

Multi-Env Targets

Switch profiles and targets for development, staging, and production.

Selective Execution

Use selectors to run only what you need for faster iteration.

​
Input Parameters for Each Function

​
dbt_action

Parameters
NameDefinitionFormat
actionOperation to perform. Common values: init, run, test, compile, docs, seed, snapshot, clean, deps.String (required)
project_pathPath to the DBT project directory.String
profiles_dirDirectory containing profiles.yml.String
targetTarget environment defined in profiles.yml.String
modelsSpecific model or list of models to run or test.String or List
selectDBT selection syntax to include nodes.String
excludeDBT selection syntax to exclude nodes.String
varsVariables to pass to DBT.Object
threadsDegree of parallelism.Integer
full_refreshForce full refresh for incremental models.Boolean
fail_fastStop on first failure.Boolean
store_failuresPersist test failures to the database.Boolean
project_nameName when creating a new project (for init).String
database_adapterAdapter for new projects (for init).String
Use select and exclude to scope execution for quick feedback during development.

​
Use Cases

  1. Automated Transformations Schedule run in CI to keep curated models fresh.
  2. Data Quality Gates Execute test on pull requests and block merges on failure.
  3. Documentation Portals Generate docs and publish the site for analysts and stakeholders.
  4. Incremental Model Hygiene Trigger full_refresh during backfills or schema changes.
  5. Dependency Management Pin versions and run deps to ensure reproducible builds.

​
Workflow/How It Works

  1. Step 1: Initialize or Point to a Project Use action: init for a new project or set project_path for an existing one.
  2. Step 2: Configure Profiles and Targets Provide profiles_dir and target for warehouse connections.
  3. Step 3: Install Packages Run deps to install packages from packages.yml.
  4. Step 4: Run and Test Execute run with select or models, then test to validate results.
  5. Step 5: Compile and Document Use compile to inspect SQL, then docs to build the catalog and site.
  6. Step 6: Operate and Maintain Use seed, snapshot, and clean as needed for datasets and state.

​
Integration Relevance

  • data_connector_tools for connectivity checks and schema exploration.
  • git_action to version models, macros, and tests.
  • file_manager_tools to store artifacts and publish generated docs.
  • project_manager_tools to track DBT tasks and milestones.
  • databricks_action when models rely on Databricks execution.

​
Configuration Details

  • Ensure profiles.yml contains correct credentials for each target.
  • Tune threads based on warehouse capacity and model complexity.
  • Pin package versions in packages.yml for reproducible builds.
  • Keep environment variables and vars consistent across environments.
DBT runs execute SQL on your warehouse. Choose the correct target, set threads responsibly, and use full_refresh only when necessary.

​
Limitations or Notes

  1. Requires DBT CLI availability in the execution environment.
  2. Large graphs can consume significant compute, scope with select.
  3. Adapter features vary by warehouse; validate per adapter.
  4. Network and warehouse quotas can impact execution times.

​
Output

  • Command Execution: Logs with status, timings, and summary counts.
  • Model Results: Per model status and row counts.
  • Test Results: Pass or fail with failure details.
  • Docs and Compile: Generated site files and compiled SQL outputs.
  • Errors: Structured messages with hints for resolution.