DbtCLI

yaml
type: "io.kestra.plugin.dbt.cli.dbtcli"

Examples

yaml
id: dbt_build
namespace: company.team

tasks:
  - id: dbt
    type: io.kestra.plugin.core.flow.WorkingDirectory
    tasks:
      - id: cloneRepository
        type: io.kestra.plugin.git.Clone
        url: https://github.com/kestra-io/dbt-example
        branch: main

      - id: dbt-build
        type: io.kestra.plugin.dbt.cli.DbtCLI
        containerImage: ghcr.io/kestra-io/dbt-duckdb:latest
        taskRunner:
          type: io.kestra.plugin.scripts.runner.docker.Docker
        commands:
          - dbt build
        profiles: |
          my_dbt_project:
            outputs:
              dev:
                type: duckdb
                path: ":memory:"
            target: dev

yaml
id: dbt_build
namespace: company.team

tasks:
  - id: sync
    type: io.kestra.plugin.git.SyncNamespaceFiles
    url: https://github.com/kestra-io/dbt-example
    branch: master
    namespace: "{{ flow.namespace }}"
    gitDirectory: dbt
    dryRun: false

  - id: dbt_build
    type: io.kestra.plugin.dbt.cli.DbtCLI
    containerImage: ghcr.io/kestra-io/dbt-duckdb:latest
    namespaceFiles:
      enabled: true
      exclude:
        - profiles.yml
    taskRunner:
      type: io.kestra.plugin.scripts.runner.docker.Docker
    commands:
      - dbt build
    profiles: |
      my_dbt_project:
        outputs:
          prod:
            type: duckdb
            path: ":memory:"
            schema: main
            threads: 8
        target: prod

yaml
id: dbt_custom_dependencies
namespace: company.team

inputs:
  - id: dbt_version
    type: STRING
    defaults: "dbt-duckdb==1.6.0"

tasks:
  - id: git
    type: io.kestra.plugin.core.flow.WorkingDirectory
    tasks:
      - id: clone_repository
        type: io.kestra.plugin.git.Clone
        url: https://github.com/kestra-io/dbt-example
        branch: main

      - id: dbt
        type: io.kestra.plugin.dbt.cli.DbtCLI
        taskRunner:
          type: io.kestra.plugin.scripts.runner.docker.Docker
          memory:
            memory: 1GB
        containerImage: python:3.11-slim
        beforeCommands:
          - pip install uv
          - uv venv --quiet
          - . .venv/bin/activate --quiet
          - uv pip install --quiet {{ inputs.dbt_version }}
        commands:
          - dbt deps
          - dbt build
        profiles: |
          my_dbt_project:
            outputs:
              dev:
                type: duckdb
                path: ":memory:"
                fixed_retries: 1
                threads: 16
                timeout_seconds: 300
            target: dev

yaml
id: dwh_and_analytics
namespace: company.team

tasks:
  - id: dbt
    type: io.kestra.plugin.core.flow.WorkingDirectory
    tasks:
    - id: clone_repository
      type: io.kestra.plugin.git.Clone
      url: https://github.com/kestra-io/dbt-example
      branch: master

    - id: dbt_build
      type: io.kestra.plugin.dbt.cli.DbtCLI
      taskRunner:
        type: io.kestra.plugin.scripts.runner.docker.Docker
      containerImage: ghcr.io/kestra-io/dbt-duckdb:latest
      commands:
        - dbt deps --project-dir dbt --target prod
        - dbt build --project-dir dbt --target prod
      projectDir: dbt
      profiles: |
        my_dbt_project:
          outputs:
            dev:
              type: duckdb
              path: dbt.duckdb
              extensions:
                - parquet
              fixed_retries: 1
              threads: 16
              timeout_seconds: 300
            prod:
              type: duckdb
              path: dbt2.duckdb
              extensions: 
                - parquet
              fixed_retries: 1
              threads: 16
              timeout_seconds: 300
          target: dev

yaml
id: dbt_defer
namespace: company.team
inputs:
  - id: dbt_command
    type: SELECT
    allowCustomValue: true
    defaults: dbt build --project-dir dbt --target prod --no-partial-parse
    values:
      - dbt build --project-dir dbt --target prod --no-partial-parse
      - dbt build --project-dir dbt --target prod --no-partial-parse --select state:modified+ --defer --state ./target

tasks:
  - id: dbt
    type: io.kestra.plugin.core.flow.WorkingDirectory
    tasks:
      - id: clone_repository
        type: io.kestra.plugin.git.Clone
        url: https://github.com/kestra-io/dbt-example
        branch: master

      - id: dbt_build
        type: io.kestra.plugin.dbt.cli.DbtCLI
        taskRunner:
          type: io.kestra.plugin.scripts.runner.docker.Docker
          delete: true
        containerImage: ghcr.io/kestra-io/dbt-duckdb:latest
        loadManifest:
          key: manifest.json
          namespace: "{{ flow.namespace }}"
        storeManifest:
          key: manifest.json
          namespace: "{{ flow.namespace }}"
        projectDir: dbt
        commands:
          - "{{ inputs.dbt_command }}"
        profiles: |
          my_dbt_project:
            outputs:
              dev:
                type: duckdb
                path: ":memory:"
                fixed_retries: 1
                threads: 16
                timeout_seconds: 300
              prod:
                type: duckdb
                path: dbt2.duckdb
                extensions:
                  - parquet
                fixed_retries: 1
                threads: 16
                timeout_seconds: 300
            target: dev

Properties

commands *array

SubType string

beforeCommands array

SubType string

containerImage string

Default ghcr.io/kestra-io/dbt

env object

SubType string

failFast booleanstring

Default true

inputFiles objectstring

interpreter array

SubType string

Default ["/bin/sh","-c"]

loadManifest DbtCLI-KvStoreManifest

logFormat string

Default JSON

Possible Values

JSONTEXTDEBUGNONE

namespaceFiles NamespaceFiles

outputFiles array

SubType string

parseRunResults booleanstring

Default true

profiles string

projectDir string

storeManifest DbtCLI-KvStoreManifest

targetOS string

Default AUTO

Possible Values

LINUXWINDOWSAUTO

taskRunner Docker Process Batch Kubernetes Batch Batch CloudRun

Outputs

exitCode integer

Default 0

outputFiles object

SubType string

taskRunner TaskRunnerDetailResult

vars object

Definitions

io.kestra.plugin.ee.kubernetes.runner.SideCar

image string

Default busybox

io.kestra.plugin.scripts.runner.docker.Cpu

cpus numberstring

io.kestra.plugin.ee.kubernetes.runner.Kubernetes-Resource

cpu string

memory string

io.kestra.plugin.ee.kubernetes.runner.Kubernetes-Resources

limit Kubernetes-Resource

request Kubernetes-Resource

Credentials for a private container registry.

auth string

identityToken string

password string

registry string

registryToken string

username string

io.kestra.plugin.ee.azure.batch.models.ComputeNodeIdentityReference

resourceId string

io.kestra.plugin.ee.gcp.runner.Batch-ComputeResource

bootDisk string

cpu string

memory string

io.kestra.plugin.ee.aws.runner.Batch-Resources

request *Batch-Resource

io.kestra.plugin.ee.kubernetes.models.OAuthTokenProvider

output string

task Task

io.kestra.core.models.tasks.NamespaceFiles

enabled booleanstring

Default true

exclude array

SubType string

folderPerNamespace booleanstring

Default false

ifExists string

Default OVERWRITE

Possible Values

OVERWRITEFAILWARNIGNORE

include array

SubType string

namespaces array

SubType string

Default ["{{flow.namespace}}"]

io.kestra.plugin.dbt.cli.DbtCLI-KvStoreManifest

key *string

namespace *string

Task runner that executes a task inside a pod in a Kubernetes cluster.

type *object

config Connection

containerSpec object

delete booleanstring

Default true

fileSideCarSpec object

fileSidecar SideCar

Default

{
  "image": "busybox"
}

labels object

namespace string

Default default

nodeSelector object

podSpec object

pullPolicy string

Default ALWAYS

Possible Values

IF_NOT_PRESENTALWAYSNEVER

resources Kubernetes-Resources

resume booleanstring

Default true

serviceAccountName string

version string

Validation RegExp \d+\.\d+\.\d+(-[a-zA-Z0-9-]+)?|([a-zA-Z0-9]+)

waitForLogs string

Default PT5S

Format duration

waitUntilCompletion string

Default PT1H

Format duration

waitUntilRunning string

Default PT10M

Format duration

io.kestra.core.models.tasks.runners.TaskRunnerDetailResult

Task runner that executes a task inside a job in Azure Batch.

accessKey *string

account *string

endpoint *string

poolId *string

type *object

blobStorage BlobStorageForBatch

completionCheckInterval string

Default PT5S

Format duration

delete booleanstring

Default true

registry ContainerRegistry

resume booleanstring

Default true

streamLogs booleanstring

Default false

version string

Validation RegExp \d+\.\d+\.\d+(-[a-zA-Z0-9-]+)?|([a-zA-Z0-9]+)

waitUntilCompletion string

Default PT1H

Format duration

io.kestra.plugin.ee.gcp.runner.Batch-LifecyclePolicyAction

exitCodes array

SubType integer

Task runner that executes a task inside a job in Google Cloud Run.

region *string

type *object

bucket string

completionCheckInterval string

Default PT5S

Format duration

delete booleanstring

Default true

projectId string

resume booleanstring

Default true

scopes array

SubType string

Default ["https://www.googleapis.com/auth/cloud-platform"]

serviceAccount string

version string

Validation RegExp \d+\.\d+\.\d+(-[a-zA-Z0-9-]+)?|([a-zA-Z0-9]+)

waitForLogInterval string

Default PT5S

Format duration

waitUntilCompletion string

Default PT1H

Format duration

io.kestra.plugin.ee.gcp.runner.Batch-LifecyclePolicy

action string

Possible Values

ACTION_UNSPECIFIEDRETRY_TASKFAIL_TASKUNRECOGNIZED

actionCondition Batch-LifecyclePolicyAction

io.kestra.plugin.ee.gcp.runner.Batch-NetworkInterface

network *string

subnetwork string

io.kestra.plugin.ee.aws.runner.Batch-Resource

cpu *string

memory *string

io.kestra.plugin.ee.kubernetes.models.Connection

apiVersion string

Default v1

caCertData string

caCertFile string

clientCertData string

clientCertFile string

clientKeyAlgo string

Default RSA

clientKeyData string

clientKeyFile string

clientKeyPassphrase string

disableHostnameVerification booleanstring

keyStoreFile string

keyStorePassphrase string

masterUrl string

Default https://kubernetes.default.svc

namespace string

oauthToken string

oauthTokenProvider OAuthTokenProvider

password string

trustCerts booleanstring

trustStoreFile string

trustStorePassphrase string

username string

io.kestra.plugin.ee.azure.storage.blob.models.BlobStorageForBatch

containerName *string

connectionString string

endpoint string

sharedKeyAccountAccessKey string

sharedKeyAccountName string

Task runner that executes a task as a subprocess on the Kestra host.

type *object

version string

Validation RegExp \d+\.\d+\.\d+(-[a-zA-Z0-9-]+)?|([a-zA-Z0-9]+)

Task runner that executes a task inside a job in Google Cloud Batch.

region *string

type *object

bucket string

completionCheckInterval string

Default PT5S

Format duration

computeResource Batch-ComputeResource

delete booleanstring

Default true

entryPoint array

SubType string

lifecyclePolicies array

SubType

machineType string

Default e2-medium

maxCreateJobRetryCount integerstring

Default 2

maxRetryCount integer

Minimum >= 0

Maximum <= 10

networkInterfaces array

SubType

projectId string

reservation string

resume booleanstring

Default true

scopes array

SubType string

Default ["https://www.googleapis.com/auth/cloud-platform"]

serviceAccount string

version string

Validation RegExp \d+\.\d+\.\d+(-[a-zA-Z0-9-]+)?|([a-zA-Z0-9]+)

waitForLogInterval string

Default PT5S

Format duration

waitUntilCompletion string

Default PT1H

Format duration

io.kestra.plugin.scripts.runner.docker.Memory

kernelMemory string

memory string

memoryReservation string

memorySwap string

memorySwappiness string

oomKillDisable booleanstring

io.kestra.plugin.ee.azure.batch.models.ContainerRegistry

identityReference ComputeNodeIdentityReference

password string

registryServer string

userName string

io.kestra.plugin.scripts.exec.scripts.models.DockerOptions

image *string

Min length 1

config stringobject

cpu Cpu

credentials Credentials

deviceRequests array

SubType

entryPoint array

SubType string

extraHosts array

SubType string

host string

memory Memory

networkMode string

privileged booleanstring

pullPolicy string

Default IF_NOT_PRESENT

Possible Values

IF_NOT_PRESENTALWAYSNEVER

shmSize string

user string

volumes array

SubType string

Run a task in a Docker container.

type *object

config stringobject

cpu Cpu

credentials Credentials

delete booleanstring

Default true

deviceRequests array

SubType

entryPoint array

SubType string

Default

[
  ""
]

extraHosts array

SubType string

fileHandlingStrategy string

Default VOLUME

Possible Values

MOUNTVOLUME

host string

killGracePeriod string

Default PT0S

Format duration

memory Memory

networkMode string

portBindings array

SubType string

privileged booleanstring

pullPolicy string

Default IF_NOT_PRESENT

Possible Values

IF_NOT_PRESENTALWAYSNEVER

shmSize string

user string

version string

Validation RegExp \d+\.\d+\.\d+(-[a-zA-Z0-9-]+)?|([a-zA-Z0-9]+)

volumes array

SubType string

wait booleanstring

Default true

A request for devices to be sent to device drivers.

capabilities array

SubType array

count integerstring

deviceIds array

SubType string

driver string

options object

SubType string

Task runner that executes a task inside a job in AWS Batch.

computeEnvironmentArn *string

region *string

type *object

accessKeyId string

bucket string

completionCheckInterval string

Default PT5S

Format duration

delete booleanstring

Default true

endpointOverride string

executionRoleArn string

jobQueueArn string

resources Batch-Resources

Default

{
  "request": {
    "memory": "2048",
    "cpu": "1"
  }
}

resume booleanstring

Default true

secretKeyId string

sessionToken string

stsEndpointOverride string

stsRoleArn string

stsRoleExternalId string

stsRoleSessionDuration string

Default PT15M

Format duration

stsRoleSessionName string

taskRoleArn string

version string

Validation RegExp \d+\.\d+\.\d+(-[a-zA-Z0-9-]+)?|([a-zA-Z0-9]+)

waitUntilCompletion string

Default PT1H

Format duration

​Dbt​C​L​I

DbtCLI