Run
type: "io.kestra.plugin.dbt.cli.Run"
Invoke dbt
run
command
# Properties
# 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
- Type: DockerOptions
- Dynamic: ❓
- Required: ❌
Docker options when using runner
DOCKER
# env
- Type: object
- SubType: string
- Dynamic: ✔️
- Required: ❌
Additional environnements variable to add for current process.
# exclude
- Type: array
- SubType: string
- Dynamic: ✔️
- Required: ❌
Specify the models to exclude
# 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.
# 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 supplied by user that make it simpler organize code.
Describe a files map that will be written and usable in execution context. In python execution context is in a temp folder, for bash scripts, you can reach files using a workingDir variable like 'source /myfile.sh'
# interpreter
- Type: string
- Dynamic: ❌
- Required: ✔️
- Default:
/bin/sh
- Min length:
1
Interpreter to used
# interpreterArgs
- Type: array
- SubType: string
- Dynamic: ❌
- Required: ❌
- Default:
[-c]
Interpreter args used
# 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 {{ outputs.task-id.files.first }}
# outputsFiles
🔒 Deprecated
- Type: array
- SubType: string
- Dynamic: ❌
- Required: ❌
Deprecated Output file
use outputFiles
# runner
Type: string
Dynamic: ❌
Required: ✔️
Default:
PROCESS
Possible Values:
PROCESS
DOCKER
Runner to use
# 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.
# warningOnStdErr
- Type: boolean
- Dynamic: ❌
- Required: ✔️
- Default:
true
Use
WARNING
state if any stdErr is sent
# 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
# 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
# image
- Type: string
- Dynamic: ✔️
- Required: ✔️
- Min length:
1
Docker image to use
# networkMode
- Type: string
- Dynamic: ✔️
- Required: ❌
Docker network mode to use
# 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