Build
type: "io.kestra.plugin.dbt.cli.Build"
Invoke dbt
build
command
Examples
Invoke dbt
build
command
namespace: io.kestra.tests
id: dbt-build
tasks:
- id: working-directory
type: io.kestra.core.tasks.flows.WorkingDirectory
tasks:
- id: cloneRepository
type: io.kestra.plugin.git.Clone
url: https://github.com/kestra-io/dbt-demo
branch: main
- id: dbt-build
type: io.kestra.plugin.dbt.cli.Build
runner: DOCKER
dbtPath: /usr/local/bin/dbt
docker:
image: ghcr.io/kestra-io/dbt-duckdb
profiles: |
jaffle_shop:
outputs:
dev:
type: duckdb
path: ':memory:'
extensions:
- parquet
target: dev
Properties
runner
- Type: string
- Dynamic: ❌
- Required: ✔️
- Default:
PROCESS
- Possible Values:
PROCESS
DOCKER
Runner to use
dbtPath
- Type: string
- Dynamic: ✔️
- Required: ❌
- Default:
./bin/dbt
The path to the dbt CLI
debug
- Type: boolean
- Dynamic: ❌
- Required: ❌
- Default:
false
Display debug logging during dbt execution.
Useful for debugging and making bug reports.
docker
- Type: DockerOptions
- Dynamic: ❌
- Required: ❌
- Default:
{image=ghcr.io/kestra-io/dbt, pullPolicy=ALWAYS}
Docker options for the
DOCKER
runner
env
- Type: object
- SubType: string
- Dynamic: ✔️
- Required: ❌
Additional environment variables for the current process.
exclude
- Type: array
- SubType: string
- Dynamic: ✔️
- Required: ❌
List of models to exclude
failFast
- Type: boolean
- Dynamic: ❌
- Required: ❌
- Default:
false
Stop execution at the first failure.
fullRefresh
- Type: boolean
- Dynamic: ❌
- Required: ❌
- Default:
false
Whether dbt will drop incremental models and fully-recalculate the incremental table from the model definition.
inputFiles
- Type:objectstring
- Dynamic: ✔️
- Required: ❌
The files to create on the local filesystem. Can be a map or a JSON object.
namespaceFiles
- Type: NamespaceFiles
- Dynamic: ❌
- Required: ❌
Inject namespace files
Inject namespace files to this task. When enabled, it will, by default, load all namespace files into the working directory. However, you can use the include
or exclude
properties to limit which namespace files will be injected.
outputFiles
- Type: array
- SubType: string
- Dynamic: ✔️
- Required: ❌
The files from the local filesystem to send to the internal storage.
Must be a list of Glob expressions relative to the current working directory, some examples: my-dir/**
, my-dir/*/**
or my-dir/my-file.txt
parseRunResults
- Type: boolean
- Dynamic: ❌
- Required: ❌
- Default:
true
Parse run result
Parsing run result to display duration of each task inside dbt
profiles
- Type: string
- Dynamic: ✔️
- Required: ❌
The
profiles.yml
file content
If a profile.yml
file already exist in the current working directory, setting this property will generate an error.
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: ❌
List of 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 the number of threads to use while executing models.
warnError
- Type: boolean
- Dynamic: ❌
- Required: ❌
- Default:
false
When dbt would normally warn, 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 entire Flow Execution
outputFiles
- Type: object
- SubType: string
The output files URI in Kestra internal storage
vars
- Type: object
The value extracted from the output of the executed
commands
Definitions
NamespaceFiles
enabled
- Type: boolean
- Dynamic: ❌
- Required: ❌
- Default:
true
Whether to enable namespace files to be loaded into the working directory. If explicitly set to
true
in a task, it will load all Namespace Files into the task's working directory. Note that this property is by default set totrue
so that you can specify only theinclude
andexclude
properties to filter the files to load without having to explicitly setenabled
totrue
.
exclude
- Type: array
- SubType: string
- Dynamic: ❌
- Required: ❌
A list of filters to exclude matching glob patterns. This allows you to exclude a subset of the Namespace Files from being downloaded at runtime. You can combine this property together with
include
to only inject a subset of files that you need into the task's working directory.
include
- Type: array
- SubType: string
- Dynamic: ❌
- Required: ❌
A list of filters to include only matching glob patterns. This allows you to only load a subset of the Namespace Files into the working directory.
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 key/value pairs.
These options are passed directly to the driver.
Credentials
auth
- Type: string
- Dynamic: ✔️
- Required: ❌
The registry auth.
The auth
field is a base64-encoded authentication string of username:password
or a token.
identityToken
- Type: string
- Dynamic: ✔️
- Required: ❌
The identity token.
password
- Type: string
- Dynamic: ✔️
- Required: ❌
The registry password.
registry
- Type: string
- Dynamic: ✔️
- Required: ❌
The registry url.
if not defined, the registry will be extracted from the image name.
registryToken
- Type: string
- Dynamic: ✔️
- Required: ❌
The registry token.
username
- Type: string
- Dynamic: ✔️
- Required: ❌
The registry username.
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 resources 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 the memory.
DockerOptions
image
- Type: string
- Dynamic: ✔️
- Required: ✔️
- Min length:
1
Docker image to use
config
- Type: object
- Dynamic: ✔️
- Required: ❌
Docker config file
Docker configuration file that can set access credentials to private container registries. Usually located in ~/.docker/config.json
cpu
- Type: Cpu
- Dynamic: ❌
- Required: ❌
Limits the CPU usage to a given maximum threshold value.
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.
credentials
- Type: Credentials
- Dynamic: ✔️
- Required: ❌
Credentials for a private container registry.
deviceRequests
- Type: array
- SubType: DeviceRequest
- Dynamic: ❌
- Required: ❌
A list of device requests to be sent to device drivers
entryPoint
- Type: array
- SubType: string
- Dynamic: ✔️
- Required: ❌
Docker entrypoint to use
extraHosts
- Type: array
- SubType: string
- Dynamic: ✔️
- Required: ❌
Extra hostname mappings to the container network interface configuration
host
- Type: string
- Dynamic: ✔️
- Required: ❌
Docker api uri
memory
- Type: Memory
- Dynamic: ❌
- Required: ❌
Limits memory usage to a given maximum threshold value.
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 e.g.
host
,none
, etc.
pullPolicy
- Type: object
- Dynamic: ❓
- Required: ❌
shmSize
- Type: string
- Dynamic: ✔️
- Required: ❌
Size of
/dev/shm
in bytes.
The size must be greater than 0. If omitted the system uses 64MB.
user
- Type: string
- Dynamic: ✔️
- Required: ❌
User within the container
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 enable them on server configuration by setting kestra.tasks.scripts.docker.volume-enabled
to true
Cpu
cpus
- Type: integer
- Dynamic: ❌
- Required: ❌
The maximum amount of 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