CLI¶
kedro databricks¶
Databricks Asset Bundle commands
These commands are used to manage Databricks Asset Bundles in a Kedro project. They allow you to initialize, bundle, deploy, run, and destroy Databricks asset bundles.
Usage:
Options:
Subcommands
- bundle: Databricks Asset Bundle commands
- deploy: Deploy the Databricks Asset Bundle.
- destroy: Databricks Asset Bundle Destroy commands
- init: Initialize a Kedro project for Databricks Asset Bundles.
- run: Databricks Asset Bundle Run commands
- version: No description was provided with this command.
kedro databricks bundle¶
Databricks Asset Bundle commands
Usage:
Options:
--default-key TEXT Key to use for default overrides in `kedro
databricks bundle`
--overwrite Overwrite existing initialization
-g, --resource-generator TEXT Generator used to create resources. Options
are 'node' (create a job for each node) or
'pipeline' (create a single job for the
entire pipeline).
-e, --env TEXT Kedro configuration environment name.
Defaults to `local`.
-c, --conf-source TEXT Path of a directory where project
configuration is stored.
-p, --pipeline TEXT Name of the registered pipeline to run. If
not set, the '__default__' pipeline is run.
-r, --params TEXT Specify extra parameters that you want to
pass to the context initialiser. Items must
be separated by comma, keys - by colon or
equals sign, example:
param1=value1,param2=value2. Each parameter
is split by the first comma, so parameter
values are allowed to contain colons,
parameter keys are not. To pass a nested
dictionary as parameter, separate keys by
'.', example: param_group.param1:value1.
--help Show this message and exit.
kedro databricks deploy¶
Deploy the Databricks Asset Bundle.
This function deploys the Databricks Asset Bundle in the current project directory. It also creates a Databricks configuration file and a Databricks target configuration file.
Usage:
Options:
-e, --env TEXT Kedro configuration environment name.
Defaults to `local`.
-b, --bundle / --no-bundle Bundle the project before deploying
--default-key TEXT Key to use for default overrides in `kedro
databricks bundle`
-g, --resource-generator TEXT Generator used to create resources. Options
are 'node' (create a job for each node) or
'pipeline' (create a single job for the
entire pipeline).
-c, --conf-source TEXT Path of a directory where project
configuration is stored.
-p, --pipeline TEXT Name of the registered pipeline to run. If
not set, the '__default__' pipeline is run.
-r, --params TEXT Specify extra parameters that you want to
pass to the context initialiser. Items must
be separated by comma, keys - by colon or
equals sign, example:
param1=value1,param2=value2. Each parameter
is split by the first comma, so parameter
values are allowed to contain colons,
parameter keys are not. To pass a nested
dictionary as parameter, separate keys by
'.', example: param_group.param1:value1.
--runtime-params TEXT Specify extra parameters that you want to
pass to the context initialiser. Items must
be separated by comma, keys - by colon or
equals sign, example:
param1=value1,param2=value2. Each parameter
is split by the first comma, so parameter
values are allowed to contain colons,
parameter keys are not. To pass a nested
dictionary as parameter, separate keys by
'.', example: param_group.param1:value1.
(forwarded to the bundle command). Renamed to
`--params` (DEPRECATED)
--help Show this message and exit.
kedro databricks destroy¶
Databricks Asset Bundle Destroy commands
Usage:
Options:
-e, --env TEXT Kedro configuration environment name. Defaults to `local`.
--help Show this message and exit.
kedro databricks init¶
Initialize a Kedro project for Databricks Asset Bundles.
Usage:
Options:
--catalog TEXT Set the catalog for Databricks targets
--schema TEXT Set the schema for Databricks targets
--default-key TEXT Key to use for default overrides in `kedro
databricks bundle`
-e, --env TEXT Kedro configuration environment name.
Defaults to `local`.
-c, --conf-source TEXT Path of a directory where project
configuration is stored.
-g, --resource-generator TEXT Generator used to create resources. Options
are 'node' (create a job for each node) or
'pipeline' (create a single job for the
entire pipeline).
--regex-prefix TEXT Prefix to use for discovering regex workflow
or task overrides. Must end in ':'
--overwrite Overwrite existing initialization
--help Show this message and exit.
kedro databricks run¶
Databricks Asset Bundle Run commands
Usage:
Options:
-e, --env TEXT Kedro configuration environment name. Defaults to `local`.
--help Show this message and exit.
kedro databricks version¶
Usage:
Options: