Run a Task via CLI

How to run a task in DBND's CLI.

To run any command in DBND, use the following command pattern:
dbnd COMMAND [ARGS]

To list the available DBND commands, run dbnd --help.
To display arguments for any DBND command, use the --help argument.

Orchestration CLI Reference

CommandDescription
runRun a task or a pipeline
project-initInitialize the project structure
show-configsShow and search configurations.
show-tasksShow and search a tasks.
ipythonGet iPython shell with Databand's context

dbnd run Command Usage

dbnd_run Command Options

CommandDescriptionExample
-s, --setSets a configuration value--set task_name.task_parameter=value
--set-configSets a configuration value (key=value)
-r, --set-rootSets a main task parameter value without specifying task name. Allows to override specific parameters.dbnd run calculate_alpha --set-root alpha=0.5 In this example, alpha is overridden.
-o, --overrideOverrides a configuration value (key=value). Has higher priority than any config source.
--confDefines a list of files to read from.
-m, --moduleLoads modules dynamically. Allows to add a path of a module where DBND can search for tasks/pipelines.dbnd run dbnd_sanity_check --module /path/to/module.py
-v, --verboseMakes the logging output more verbose.
--describeDescribes the current run.
--envTask environment: local/aws/aws_prod/gcp/prod [default: local]
--parallelRuns specific tasks in parallel.
--task-versionSets a task version; it directly affects the task signature.
--project-nameName of this Databand project.
--descriptionSets description of the run.dbnd run dbnd_sanity_check --description some_description
--task-nameSets name of the task.dbnd run dbnd_sanity_check --task-name my_name
--override-run-uidUse predefined uid for run.dbnd run dbnd_sanity_check --override-run-uid 00000000-0000-0000-0000-000000000000
--helpIs used for dynamic loading of modules

Running only specific tasks (according to regex):

You can use --set run.selected_tasks_regex=task_name_regex
You can also give it a list of regular expressions, and it will run all the tasks which conforms with those regular expressions: --set run.selected_tasks_regex="['regex1', 'regex2', ..]"
Note: running tasks like this will also run all of the tasks your diluted run depends on


Did this page help you?