Seed Seed

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

Invoke dbt seed command

Examples

Invoke a build command on bigquery

yaml
id: dbt-run
namespace: io.kestra.tests

tasks:
  - id: worker
    type: io.kestra.core.tasks.flows.Worker
    tasks:
      - id: bash
        type: io.kestra.core.tasks.scripts.Bash
        commands:
          - git clone https://github.com/<< organization >>/dbt-project .
        dockerOptions:
          image: bitnami/git:latest
        inputFiles:
          sa.json: |
            { service account json key }
        warningOnStdErr: false
      - id: dbt-setup
        type: io.kestra.plugin.dbt.cli.Setup
        dockerOptions:
          image: python:3.9
        profiles:
          unit-kestra:
            outputs:
              dev:
                type: bigquery
                dataset: <<dataset>>
                fixed_retries: 1
                keyfile: sa.json
                location: US
                method: service-account
                priority: interactive
                project: <<project>>
                threads: 1
                timeout_seconds: 300
            target: dev
        requirements:
          - dbt-bigquery
        runner: DOCKER
      - id: dbt-build
        type: io.kestra.plugin.dbt.cli.Build
        dockerOptions:
          image: python:3.9
        runner: DOCKER

Properties

exitOnFailed

  • Type: boolean
  • Dynamic:
  • Required: ✔️
  • Default: true

Exit if any non true return value

This tells bash that it should exit the script if any statement returns a non-true return value. The benefit of using -e is that it prevents errors snowballing into serious issues when they could have been caught earlier.

interpreter

  • Type: string
  • Dynamic:
  • Required: ✔️
  • Default: /bin/sh
  • Min length: 1

Interpreter to used

runner

  • Type: string
  • Dynamic:
  • Required: ✔️
  • Default: PROCESS
  • Possible Values:
    • PROCESS
    • DOCKER

Runner to use

warningOnStdErr

  • Type: boolean
  • Dynamic:
  • Required: ✔️
  • Default: true

Use WARNING state if any stdErr is sent

dbtPath

  • Type: string
  • Dynamic: ✔️
  • Required:

The path to dbt cli

debug

  • Type: boolean
  • Dynamic:
  • Required:

Display debug logging during dbt execution.

Useful for debugging and making bug reports.

dockerOptions

Docker options when using runner DOCKER

env

  • Type: object
  • SubType: string
  • Dynamic: ✔️
  • Required:

Additional environments variable to add for current process.

exclude

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required:

Specify the models to exclude

failFast

  • Type: boolean
  • Dynamic:
  • Required:

Stop execution upon a first failure.

files

🔒 Deprecated

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required:

The list of files that will be uploaded to internal storage,

use outputFiles property instead

fullRefresh

  • Type: boolean
  • Dynamic:
  • Required:

If specified, dbt will drop incremental models and fully-recalculate the incremental table from the model definition.

inputFiles

  • Type: object
  • SubType: string
  • Dynamic: ✔️
  • Required:

Input files are extra files that will be available in the script working directory.

You can define the files as map or a JSON string.Each file can be defined inlined or can reference a file from Kestra's internal storage.

interpreterArgs

  • Type: array
  • SubType: string
  • Dynamic:
  • Required:
  • Default: [-c]

Interpreter args used

outputDirs

  • Type: array
  • SubType: string
  • Dynamic:
  • Required:

Output dirs list that will be uploaded to internal storage

List of key that will generate temporary directories. On the command, just can use with special variable named outputDirs.key. If you add a files with ["myDir"], you can use the special vars echo 1 >> {[ outputDirs.myDir }}/file1.txt and echo 2 >> {[ outputDirs.myDir }}/file2.txt and both files will be uploaded to internal storage. Then you can used them on others tasks using null

outputFiles

  • Type: array
  • SubType: string
  • Dynamic:
  • Required:

Output file list that will be uploaded to internal storage

List of key that will generate temporary files. On the command, just can use with special variable named outputFiles.key. If you add a files with ["first"], you can use the special vars echo 1 >> {[ outputFiles.first }} and you used on others tasks using null

outputsFiles

🔒 Deprecated

  • Type: array
  • SubType: string
  • Dynamic:
  • Required:

Deprecated Output file

use outputFiles

projectDir

  • Type: string
  • Dynamic:
  • Required:

Which directory to look in for the dbt_project.yml file.

Default is the current working directory and its parents.

select

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required:

Specify the nodes to include

selector

  • Type: string
  • Dynamic: ✔️
  • Required:

The selector name to use, as defined in selectors.yml

target

  • Type: string
  • Dynamic: ✔️
  • Required:

Which target to load for the given profile

thread

  • Type: integer
  • Dynamic:
  • Required:

Specify number of threads to use while executing models.

warnError

  • Type: boolean
  • Dynamic:
  • Required:

If dbt would normally warn, instead raise an exception.

Examples include --models that selects nothing, deprecations, configurations with no associated models, invalid test configurations, and missing sources/refs in tests.

Outputs

exitCode

  • Type: integer
  • Default: 0

The exit code of the whole execution

files

🔒 Deprecated

  • Type: object
  • SubType: string

Deprecated output files

use outputFiles

outputFiles

  • Type: object
  • SubType: string

The output files uri in Kestra internal storage

stdErrLineCount

  • Type: integer
  • Default: 0

The standard error line count

stdOutLineCount

  • Type: integer
  • Default: 0

The standard output line count

vars

  • Type: object

The value extract from output of the commands

Definitions

DockerOptions-Memory

kernelMemory

  • Type: string
  • Dynamic: ✔️
  • Required:

The maximum amount of kernel memory the container can use.

The minimum allowed value is 4m. Because kernel memory cannot be swapped out, a container which is starved of kernel memory may block host machine resources, which can have side effects on the host machine and on other containers. See --kernel-memory details.

memory

  • Type: string
  • Dynamic: ✔️
  • Required:

The maximum amount of memory the container can use.

That is, you must set the value to at least 6 megabytes.

memoryReservation

  • Type: string
  • Dynamic: ✔️
  • Required:

Allows you to specify a soft limit smaller than --memory which is activated when Docker detects contention or low memory on the host machine.

If you use memoryReservation, it must be set lower than memory for it to take precedence. Because it is a soft limit, it does not guarantee that the container doesn’t exceed the limit.

memorySwap

  • Type: string
  • Dynamic: ✔️
  • Required:

The amount of memory this container is allowed to swap to disk

If memory and memorySwap are set to the same value, this prevents containers from using any swap. This is because memorySwap is the amount of combined memory and swap that can be used, while memory is only the amount of physical memory that can be used.

memorySwappiness

  • Type: string
  • Dynamic: ✔️
  • Required:

The amount of memory this container is allowed to swap to disk

By default, the host kernel can swap out a percentage of anonymous pages used by a container. You can set memorySwappiness to a value between 0 and 100, to tune this percentage.

oomKillDisable

  • Type: boolean
  • Dynamic:
  • Required:

By default, if an out-of-memory (OOM) error occurs, the kernel kills processes in a container.

To change this behavior, use the oomKillDisable option. Only disable the OOM killer on containers where you have also set the memory option. If the memory flag is not set, the host can run out of memory and the kernel may need to kill the host system’s processes to free memory.

DockerOptions

image

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️
  • Min length: 1

Docker image to use

cpu

Limits cpu usage.

By default, each container’s access to the host machine’s CPU cycles is unlimited. You can set various constraints to limit a given container’s access to the host machine’s CPU cycles.

deviceRequests

A list of request for devices to be sent to device drivers

dockerConfig

  • Type: string
  • Dynamic: ✔️
  • Required:

Docker config file

Full file that can be used to configure private registries, ...

dockerHost

  • Type: string
  • Dynamic: ✔️
  • Required:

Docker api uri

entryPoint

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required:

Docker entrypoint to use

extraHosts

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required:

Docker extra host to use

memory

Limits memory usage.

Docker can enforce hard memory limits, which allow the container to use no more than a given amount of user or system memory, or soft limits, which allow the container to use as much memory as it needs unless certain conditions are met, such as when the kernel detects low memory or contention on the host machine. Some of these options have different effects when used alone or when more than one option is set.

networkMode

  • Type: string
  • Dynamic: ✔️
  • Required:

Docker network mode to use

pullImage

  • Type: boolean
  • Dynamic:
  • Required:
  • Default: true

Is a pull of image must be done before starting the container

Mostly used for local image with registry

user

  • Type: string
  • Dynamic: ✔️
  • Required:

Docker user to use

volumes

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required:

List of volumes to mount

Must be a valid mount expression as string, example : /home/user:/app

Volumes mount are disabled by default for security reasons, you must enabled on server configuration with kestra.tasks.scripts.docker.volume-enabled to true

DockerOptions-Cpu

cpus

  • Type: integer
  • Dynamic:
  • Required:

Specify how much of the available CPU resources a container can use.

For instance, if the host machine has two CPUs and you set cpus:"1.5", the container is guaranteed at most one and a half of the CPUs

DockerOptions-DeviceRequest

capabilities

  • Type: array
  • SubType: array
  • Dynamic:
  • Required:

A list of capabilities; an OR list of AND lists of capabilities.

count

  • Type: integer
  • Dynamic:
  • Required:

A request for devices to be sent to device drivers

deviceIds

  • Type: array
  • SubType: string
  • Dynamic:
  • Required:

A request for devices to be sent to device drivers

driver

  • Type: string
  • Dynamic:
  • Required:

A request for devices to be sent to device drivers

options

  • Type: object
  • SubType: string
  • Dynamic:
  • Required:

Driver-specific options, specified as a key/value pairs.

These options are passed directly to the driver.