mirror of https://github.com/databricks/cli.git
Include help output for bundle commands in acceptance tests (#2178)
## Changes This includes a change to the defaults for the output directory flags of the "generate" commands. These defaults included the expanded working directory. This can be omitted because it is implied.
This commit is contained in:
Pieter Noordhuis
GitHub
parent
cff4f09cc8
commit
0d5193a62c
|
|
@ -0,0 +1,21 @@
|
|||
|
||||
>>> $CLI bundle deploy --help
|
||||
Deploy bundle
|
||||
|
||||
Usage:
|
||||
databricks bundle deploy [flags]
|
||||
|
||||
Flags:
|
||||
--auto-approve Skip interactive approvals that might be required for deployment.
|
||||
-c, --cluster-id string Override cluster in the deployment with the given cluster ID.
|
||||
--fail-on-active-runs Fail if there are running jobs or pipelines in the deployment.
|
||||
--force Force-override Git branch validation.
|
||||
--force-lock Force acquisition of deployment lock.
|
||||
-h, --help help for deploy
|
||||
|
||||
Global Flags:
|
||||
--debug enable debug logging
|
||||
-o, --output type output type: text or json (default text)
|
||||
-p, --profile string ~/.databrickscfg profile
|
||||
-t, --target string bundle target to use (if applicable)
|
||||
--var strings set values for variables defined in bundle config. Example: --var="foo=bar"
|
||||
|
|
@ -0,0 +1 @@
|
|||
trace $CLI bundle deploy --help
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
|
||||
>>> $CLI bundle deployment --help
|
||||
Deployment related commands
|
||||
|
||||
Usage:
|
||||
databricks bundle deployment [command]
|
||||
|
||||
Available Commands:
|
||||
bind Bind bundle-defined resources to existing resources
|
||||
unbind Unbind bundle-defined resources from its managed remote resource
|
||||
|
||||
Flags:
|
||||
-h, --help help for deployment
|
||||
|
||||
Global Flags:
|
||||
--debug enable debug logging
|
||||
-o, --output type output type: text or json (default text)
|
||||
-p, --profile string ~/.databrickscfg profile
|
||||
-t, --target string bundle target to use (if applicable)
|
||||
--var strings set values for variables defined in bundle config. Example: --var="foo=bar"
|
||||
|
||||
Use "databricks bundle deployment [command] --help" for more information about a command.
|
||||
|
|
@ -0,0 +1 @@
|
|||
trace $CLI bundle deployment --help
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
|
||||
>>> $CLI bundle destroy --help
|
||||
Destroy deployed bundle resources
|
||||
|
||||
Usage:
|
||||
databricks bundle destroy [flags]
|
||||
|
||||
Flags:
|
||||
--auto-approve Skip interactive approvals for deleting resources and files
|
||||
--force-lock Force acquisition of deployment lock.
|
||||
-h, --help help for destroy
|
||||
|
||||
Global Flags:
|
||||
--debug enable debug logging
|
||||
-o, --output type output type: text or json (default text)
|
||||
-p, --profile string ~/.databrickscfg profile
|
||||
-t, --target string bundle target to use (if applicable)
|
||||
--var strings set values for variables defined in bundle config. Example: --var="foo=bar"
|
||||
|
|
@ -0,0 +1 @@
|
|||
trace $CLI bundle destroy --help
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
|
||||
>>> $CLI bundle generate dashboard --help
|
||||
Generate configuration for a dashboard
|
||||
|
||||
Usage:
|
||||
databricks bundle generate dashboard [flags]
|
||||
|
||||
Flags:
|
||||
-s, --dashboard-dir string directory to write the dashboard representation to (default "src")
|
||||
--existing-id string ID of the dashboard to generate configuration for
|
||||
--existing-path string workspace path of the dashboard to generate configuration for
|
||||
-f, --force force overwrite existing files in the output directory
|
||||
-h, --help help for dashboard
|
||||
--resource string resource key of dashboard to watch for changes
|
||||
-d, --resource-dir string directory to write the configuration to (default "resources")
|
||||
--watch watch for changes to the dashboard and update the configuration
|
||||
|
||||
Global Flags:
|
||||
--debug enable debug logging
|
||||
--key string resource key to use for the generated configuration
|
||||
-o, --output type output type: text or json (default text)
|
||||
-p, --profile string ~/.databrickscfg profile
|
||||
-t, --target string bundle target to use (if applicable)
|
||||
--var strings set values for variables defined in bundle config. Example: --var="foo=bar"
|
||||
|
|
@ -0,0 +1 @@
|
|||
trace $CLI bundle generate dashboard --help
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
|
||||
>>> $CLI bundle generate job --help
|
||||
Generate bundle configuration for a job
|
||||
|
||||
Usage:
|
||||
databricks bundle generate job [flags]
|
||||
|
||||
Flags:
|
||||
-d, --config-dir string Dir path where the output config will be stored (default "resources")
|
||||
--existing-job-id int Job ID of the job to generate config for
|
||||
-f, --force Force overwrite existing files in the output directory
|
||||
-h, --help help for job
|
||||
-s, --source-dir string Dir path where the downloaded files will be stored (default "src")
|
||||
|
||||
Global Flags:
|
||||
--debug enable debug logging
|
||||
--key string resource key to use for the generated configuration
|
||||
-o, --output type output type: text or json (default text)
|
||||
-p, --profile string ~/.databrickscfg profile
|
||||
-t, --target string bundle target to use (if applicable)
|
||||
--var strings set values for variables defined in bundle config. Example: --var="foo=bar"
|
||||
|
|
@ -0,0 +1 @@
|
|||
trace $CLI bundle generate job --help
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
|
||||
>>> $CLI bundle generate pipeline --help
|
||||
Generate bundle configuration for a pipeline
|
||||
|
||||
Usage:
|
||||
databricks bundle generate pipeline [flags]
|
||||
|
||||
Flags:
|
||||
-d, --config-dir string Dir path where the output config will be stored (default "resources")
|
||||
--existing-pipeline-id string ID of the pipeline to generate config for
|
||||
-f, --force Force overwrite existing files in the output directory
|
||||
-h, --help help for pipeline
|
||||
-s, --source-dir string Dir path where the downloaded files will be stored (default "src")
|
||||
|
||||
Global Flags:
|
||||
--debug enable debug logging
|
||||
--key string resource key to use for the generated configuration
|
||||
-o, --output type output type: text or json (default text)
|
||||
-p, --profile string ~/.databrickscfg profile
|
||||
-t, --target string bundle target to use (if applicable)
|
||||
--var strings set values for variables defined in bundle config. Example: --var="foo=bar"
|
||||
|
|
@ -0,0 +1 @@
|
|||
trace $CLI bundle generate pipeline --help
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
|
||||
>>> $CLI bundle generate --help
|
||||
Generate bundle configuration
|
||||
|
||||
Usage:
|
||||
databricks bundle generate [command]
|
||||
|
||||
Available Commands:
|
||||
app Generate bundle configuration for a Databricks app
|
||||
dashboard Generate configuration for a dashboard
|
||||
job Generate bundle configuration for a job
|
||||
pipeline Generate bundle configuration for a pipeline
|
||||
|
||||
Flags:
|
||||
-h, --help help for generate
|
||||
--key string resource key to use for the generated configuration
|
||||
|
||||
Global Flags:
|
||||
--debug enable debug logging
|
||||
-o, --output type output type: text or json (default text)
|
||||
-p, --profile string ~/.databrickscfg profile
|
||||
-t, --target string bundle target to use (if applicable)
|
||||
--var strings set values for variables defined in bundle config. Example: --var="foo=bar"
|
||||
|
||||
Use "databricks bundle generate [command] --help" for more information about a command.
|
||||
|
|
@ -0,0 +1 @@
|
|||
trace $CLI bundle generate --help
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
|
||||
>>> $CLI bundle init --help
|
||||
Initialize using a bundle template.
|
||||
|
||||
TEMPLATE_PATH optionally specifies which template to use. It can be one of the following:
|
||||
- default-python: The default Python template for Notebooks / Delta Live Tables / Workflows
|
||||
- default-sql: The default SQL template for .sql files that run with Databricks SQL
|
||||
- dbt-sql: The dbt SQL template (databricks.com/blog/delivering-cost-effective-data-real-time-dbt-and-databricks)
|
||||
- mlops-stacks: The Databricks MLOps Stacks template (github.com/databricks/mlops-stacks)
|
||||
- a local file system path with a template directory
|
||||
- a Git repository URL, e.g. https://github.com/my/repository
|
||||
|
||||
See https://docs.databricks.com/en/dev-tools/bundles/templates.html for more information on templates.
|
||||
|
||||
Usage:
|
||||
databricks bundle init [TEMPLATE_PATH] [flags]
|
||||
|
||||
Flags:
|
||||
--branch string Git branch to use for template initialization
|
||||
--config-file string JSON file containing key value pairs of input parameters required for template initialization.
|
||||
-h, --help help for init
|
||||
--output-dir string Directory to write the initialized template to.
|
||||
--tag string Git tag to use for template initialization
|
||||
--template-dir string Directory path within a Git repository containing the template.
|
||||
|
||||
Global Flags:
|
||||
--debug enable debug logging
|
||||
-o, --output type output type: text or json (default text)
|
||||
-p, --profile string ~/.databrickscfg profile
|
||||
-t, --target string bundle target to use (if applicable)
|
||||
--var strings set values for variables defined in bundle config. Example: --var="foo=bar"
|
||||
|
|
@ -0,0 +1 @@
|
|||
trace $CLI bundle init --help
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
|
||||
>>> $CLI bundle open --help
|
||||
Open a resource in the browser
|
||||
|
||||
Usage:
|
||||
databricks bundle open [flags]
|
||||
|
||||
Flags:
|
||||
--force-pull Skip local cache and load the state from the remote workspace
|
||||
-h, --help help for open
|
||||
|
||||
Global Flags:
|
||||
--debug enable debug logging
|
||||
-o, --output type output type: text or json (default text)
|
||||
-p, --profile string ~/.databrickscfg profile
|
||||
-t, --target string bundle target to use (if applicable)
|
||||
--var strings set values for variables defined in bundle config. Example: --var="foo=bar"
|
||||
|
|
@ -0,0 +1 @@
|
|||
trace $CLI bundle open --help
|
||||
|
|
@ -0,0 +1,57 @@
|
|||
|
||||
>>> $CLI bundle run --help
|
||||
Run the job or pipeline identified by KEY.
|
||||
|
||||
The KEY is the unique identifier of the resource to run. In addition to
|
||||
customizing the run using any of the available flags, you can also specify
|
||||
keyword or positional arguments as shown in these examples:
|
||||
|
||||
databricks bundle run my_job -- --key1 value1 --key2 value2
|
||||
|
||||
Or:
|
||||
|
||||
databricks bundle run my_job -- value1 value2 value3
|
||||
|
||||
If the specified job uses job parameters or the job has a notebook task with
|
||||
parameters, the first example applies and flag names are mapped to the
|
||||
parameter names.
|
||||
|
||||
If the specified job does not use job parameters and the job has a Python file
|
||||
task or a Python wheel task, the second example applies.
|
||||
|
||||
Usage:
|
||||
databricks bundle run [flags] KEY
|
||||
|
||||
Job Flags:
|
||||
--params stringToString comma separated k=v pairs for job parameters (default [])
|
||||
|
||||
Job Task Flags:
|
||||
Note: please prefer use of job-level parameters (--param) over task-level parameters.
|
||||
For more information, see https://docs.databricks.com/en/workflows/jobs/create-run-jobs.html#pass-parameters-to-a-databricks-job-task
|
||||
--dbt-commands strings A list of commands to execute for jobs with DBT tasks.
|
||||
--jar-params strings A list of parameters for jobs with Spark JAR tasks.
|
||||
--notebook-params stringToString A map from keys to values for jobs with notebook tasks. (default [])
|
||||
--pipeline-params stringToString A map from keys to values for jobs with pipeline tasks. (default [])
|
||||
--python-named-params stringToString A map from keys to values for jobs with Python wheel tasks. (default [])
|
||||
--python-params strings A list of parameters for jobs with Python tasks.
|
||||
--spark-submit-params strings A list of parameters for jobs with Spark submit tasks.
|
||||
--sql-params stringToString A map from keys to values for jobs with SQL tasks. (default [])
|
||||
|
||||
Pipeline Flags:
|
||||
--full-refresh strings List of tables to reset and recompute.
|
||||
--full-refresh-all Perform a full graph reset and recompute.
|
||||
--refresh strings List of tables to update.
|
||||
--refresh-all Perform a full graph update.
|
||||
--validate-only Perform an update to validate graph correctness.
|
||||
|
||||
Flags:
|
||||
-h, --help help for run
|
||||
--no-wait Don't wait for the run to complete.
|
||||
--restart Restart the run if it is already running.
|
||||
|
||||
Global Flags:
|
||||
--debug enable debug logging
|
||||
-o, --output type output type: text or json (default text)
|
||||
-p, --profile string ~/.databrickscfg profile
|
||||
-t, --target string bundle target to use (if applicable)
|
||||
--var strings set values for variables defined in bundle config. Example: --var="foo=bar"
|
||||
|
|
@ -0,0 +1 @@
|
|||
trace $CLI bundle run --help
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
|
||||
>>> $CLI bundle schema --help
|
||||
Generate JSON Schema for bundle configuration
|
||||
|
||||
Usage:
|
||||
databricks bundle schema [flags]
|
||||
|
||||
Flags:
|
||||
-h, --help help for schema
|
||||
|
||||
Global Flags:
|
||||
--debug enable debug logging
|
||||
-o, --output type output type: text or json (default text)
|
||||
-p, --profile string ~/.databrickscfg profile
|
||||
-t, --target string bundle target to use (if applicable)
|
||||
--var strings set values for variables defined in bundle config. Example: --var="foo=bar"
|
||||
|
|
@ -0,0 +1 @@
|
|||
trace $CLI bundle schema --help
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
|
||||
>>> $CLI bundle summary --help
|
||||
Summarize resources deployed by this bundle
|
||||
|
||||
Usage:
|
||||
databricks bundle summary [flags]
|
||||
|
||||
Flags:
|
||||
--force-pull Skip local cache and load the state from the remote workspace
|
||||
-h, --help help for summary
|
||||
|
||||
Global Flags:
|
||||
--debug enable debug logging
|
||||
-o, --output type output type: text or json (default text)
|
||||
-p, --profile string ~/.databrickscfg profile
|
||||
-t, --target string bundle target to use (if applicable)
|
||||
--var strings set values for variables defined in bundle config. Example: --var="foo=bar"
|
||||
|
|
@ -0,0 +1 @@
|
|||
trace $CLI bundle summary --help
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
|
||||
>>> $CLI bundle sync --help
|
||||
Synchronize bundle tree to the workspace
|
||||
|
||||
Usage:
|
||||
databricks bundle sync [flags]
|
||||
|
||||
Flags:
|
||||
--full perform full synchronization (default is incremental)
|
||||
-h, --help help for sync
|
||||
--interval duration file system polling interval (for --watch) (default 1s)
|
||||
--output type type of the output format
|
||||
--watch watch local file system for changes
|
||||
|
||||
Global Flags:
|
||||
--debug enable debug logging
|
||||
-p, --profile string ~/.databrickscfg profile
|
||||
-t, --target string bundle target to use (if applicable)
|
||||
--var strings set values for variables defined in bundle config. Example: --var="foo=bar"
|
||||
|
|
@ -0,0 +1 @@
|
|||
trace $CLI bundle sync --help
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
|
||||
>>> $CLI bundle validate --help
|
||||
Validate configuration
|
||||
|
||||
Usage:
|
||||
databricks bundle validate [flags]
|
||||
|
||||
Flags:
|
||||
-h, --help help for validate
|
||||
|
||||
Global Flags:
|
||||
--debug enable debug logging
|
||||
-o, --output type output type: text or json (default text)
|
||||
-p, --profile string ~/.databrickscfg profile
|
||||
-t, --target string bundle target to use (if applicable)
|
||||
--var strings set values for variables defined in bundle config. Example: --var="foo=bar"
|
||||
|
|
@ -0,0 +1 @@
|
|||
trace $CLI bundle validate --help
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
|
||||
>>> $CLI bundle --help
|
||||
Databricks Asset Bundles let you express data/AI/analytics projects as code.
|
||||
|
||||
Online documentation: https://docs.databricks.com/en/dev-tools/bundles/index.html
|
||||
|
||||
Usage:
|
||||
databricks bundle [command]
|
||||
|
||||
Available Commands:
|
||||
deploy Deploy bundle
|
||||
deployment Deployment related commands
|
||||
destroy Destroy deployed bundle resources
|
||||
generate Generate bundle configuration
|
||||
init Initialize using a bundle template
|
||||
open Open a resource in the browser
|
||||
run Run a job or pipeline update
|
||||
schema Generate JSON Schema for bundle configuration
|
||||
summary Summarize resources deployed by this bundle
|
||||
sync Synchronize bundle tree to the workspace
|
||||
validate Validate configuration
|
||||
|
||||
Flags:
|
||||
-h, --help help for bundle
|
||||
--var strings set values for variables defined in bundle config. Example: --var="foo=bar"
|
||||
|
||||
Global Flags:
|
||||
--debug enable debug logging
|
||||
-o, --output type output type: text or json (default text)
|
||||
-p, --profile string ~/.databrickscfg profile
|
||||
-t, --target string bundle target to use (if applicable)
|
||||
|
||||
Use "databricks bundle [command] --help" for more information about a command.
|
||||
|
|
@ -0,0 +1 @@
|
|||
trace $CLI bundle --help
|
||||
|
|
@ -36,8 +36,8 @@ func NewGenerateAppCommand() *cobra.Command {
|
|||
cmd.Flags().StringVar(&appName, "existing-app-name", "", `App name to generate config for`)
|
||||
cmd.MarkFlagRequired("existing-app-name")
|
||||
|
||||
cmd.Flags().StringVarP(&configDir, "config-dir", "d", filepath.Join("resources"), `Directory path where the output bundle config will be stored`)
|
||||
cmd.Flags().StringVarP(&sourceDir, "source-dir", "s", filepath.Join("src", "app"), `Directory path where the app files will be stored`)
|
||||
cmd.Flags().StringVarP(&configDir, "config-dir", "d", "resources", `Directory path where the output bundle config will be stored`)
|
||||
cmd.Flags().StringVarP(&sourceDir, "source-dir", "s", "src/app", `Directory path where the app files will be stored`)
|
||||
cmd.Flags().BoolVarP(&force, "force", "f", false, `Force overwrite existing files in the output directory`)
|
||||
|
||||
cmd.RunE = func(cmd *cobra.Command, args []string) error {
|
||||
|
|
|
|||
|
|
@ -441,8 +441,8 @@ func NewGenerateDashboardCommand() *cobra.Command {
|
|||
cmd.Flags().MarkHidden("existing-dashboard-id")
|
||||
|
||||
// Output flags.
|
||||
cmd.Flags().StringVarP(&d.resourceDir, "resource-dir", "d", "./resources", `directory to write the configuration to`)
|
||||
cmd.Flags().StringVarP(&d.dashboardDir, "dashboard-dir", "s", "./src", `directory to write the dashboard representation to`)
|
||||
cmd.Flags().StringVarP(&d.resourceDir, "resource-dir", "d", "resources", `directory to write the configuration to`)
|
||||
cmd.Flags().StringVarP(&d.dashboardDir, "dashboard-dir", "s", "src", `directory to write the dashboard representation to`)
|
||||
cmd.Flags().BoolVarP(&d.force, "force", "f", false, `force overwrite existing files in the output directory`)
|
||||
|
||||
// Exactly one of the lookup flags must be provided.
|
||||
|
|
|
|||
|
|
@ -32,13 +32,8 @@ func NewGenerateJobCommand() *cobra.Command {
|
|||
cmd.Flags().Int64Var(&jobId, "existing-job-id", 0, `Job ID of the job to generate config for`)
|
||||
cmd.MarkFlagRequired("existing-job-id")
|
||||
|
||||
wd, err := os.Getwd()
|
||||
if err != nil {
|
||||
wd = "."
|
||||
}
|
||||
|
||||
cmd.Flags().StringVarP(&configDir, "config-dir", "d", filepath.Join(wd, "resources"), `Dir path where the output config will be stored`)
|
||||
cmd.Flags().StringVarP(&sourceDir, "source-dir", "s", filepath.Join(wd, "src"), `Dir path where the downloaded files will be stored`)
|
||||
cmd.Flags().StringVarP(&configDir, "config-dir", "d", "resources", `Dir path where the output config will be stored`)
|
||||
cmd.Flags().StringVarP(&sourceDir, "source-dir", "s", "src", `Dir path where the downloaded files will be stored`)
|
||||
cmd.Flags().BoolVarP(&force, "force", "f", false, `Force overwrite existing files in the output directory`)
|
||||
|
||||
cmd.RunE = func(cmd *cobra.Command, args []string) error {
|
||||
|
|
|
|||
|
|
@ -32,13 +32,8 @@ func NewGeneratePipelineCommand() *cobra.Command {
|
|||
cmd.Flags().StringVar(&pipelineId, "existing-pipeline-id", "", `ID of the pipeline to generate config for`)
|
||||
cmd.MarkFlagRequired("existing-pipeline-id")
|
||||
|
||||
wd, err := os.Getwd()
|
||||
if err != nil {
|
||||
wd = "."
|
||||
}
|
||||
|
||||
cmd.Flags().StringVarP(&configDir, "config-dir", "d", filepath.Join(wd, "resources"), `Dir path where the output config will be stored`)
|
||||
cmd.Flags().StringVarP(&sourceDir, "source-dir", "s", filepath.Join(wd, "src"), `Dir path where the downloaded files will be stored`)
|
||||
cmd.Flags().StringVarP(&configDir, "config-dir", "d", "resources", `Dir path where the output config will be stored`)
|
||||
cmd.Flags().StringVarP(&sourceDir, "source-dir", "s", "src", `Dir path where the downloaded files will be stored`)
|
||||
cmd.Flags().BoolVarP(&force, "force", "f", false, `Force overwrite existing files in the output directory`)
|
||||
|
||||
cmd.RunE = func(cmd *cobra.Command, args []string) error {
|
||||
|
|
|
|||
Loading…
Reference in New Issue