Commands
This page provides documentation for our command line tools.
bf¶
CLI for managing Databricks Workflows
Usage:
Options:
bundle¶
CLI for proxying to databricks bundles cli.
Usage:
Options:
cdktf¶
CLI for proxying to cdktf cli.
Usage:
Options:
deploy¶
CLI for deploying workflow projects.
Usage:
Options:
--auto-approve Auto approve brickflow pipeline without
being prompted to approve.
--deploy-mode [cdktf|bundle] Which deployment framework to use to deploy.
[default: cdktf]
--force-acquire-lock Force acquire lock for databricks bundles
deploy.
-p, --profile TEXT The databricks profile to use for
authenticating to databricks during
deployment.
--git-provider TEXT The github provider for brickflow this is
used for configuring github on DBX jobs.
--git-ref TEXT The commit/tag/branch to use in github.
-r, --repo-url TEXT The github url in which to run brickflow
with.
-e, --env TEXT Set the environment value, certain tags
[TBD] get added to the workflows based on
this value.
-w, --workflow TEXT Provide the workflow file names which you
want to deploy, each file name separated by
space! Example: bf deploy -p DEFAULT -l -w
wf1.py -w wf2.py
-wd, --workflows-dir DIRECTORY Provide the workflow directory that has to
be deployed
-l, --local-mode Set the environment flag to local and other
components [TBD] are disabled in local mode.
--help Show this message and exit.
destroy¶
CLI for destroying workflow projects.
Usage:
Options:
--auto-approve Auto approve brickflow pipeline without
being prompted to approve.
--deploy-mode [cdktf|bundle] Which deployment framework to use to deploy.
[default: cdktf]
--force-acquire-lock Force acquire lock for databricks bundles
destroy.
-p, --profile TEXT The databricks profile to use for
authenticating to databricks during
deployment.
--git-provider TEXT The github provider for brickflow this is
used for configuring github on DBX jobs.
--git-ref TEXT The commit/tag/branch to use in github.
-r, --repo-url TEXT The github url in which to run brickflow
with.
-e, --env TEXT Set the environment value, certain tags
[TBD] get added to the workflows based on
this value.
-w, --workflow TEXT Provide the workflow file names which you
want to deploy, each file name separated by
space! Example: bf deploy -p DEFAULT -l -w
wf1.py -w wf2.py
-wd, --workflows-dir DIRECTORY Provide the workflow directory that has to
be deployed
-l, --local-mode Set the environment flag to local and other
components [TBD] are disabled in local mode.
--help Show this message and exit.
diff¶
CLI for identifying diff in projects (only cdktf supported).
Usage:
Options:
-p, --profile TEXT The databricks profile to use for
authenticating to databricks during
deployment.
--git-provider TEXT The github provider for brickflow this is
used for configuring github on DBX jobs.
--git-ref TEXT The commit/tag/branch to use in github.
-r, --repo-url TEXT The github url in which to run brickflow
with.
-e, --env TEXT Set the environment value, certain tags
[TBD] get added to the workflows based on
this value.
-w, --workflow TEXT Provide the workflow file names which you
want to deploy, each file name separated by
space! Example: bf deploy -p DEFAULT -l -w
wf1.py -w wf2.py
-wd, --workflows-dir DIRECTORY Provide the workflow directory that has to
be deployed
-l, --local-mode Set the environment flag to local and other
components [TBD] are disabled in local mode.
--help Show this message and exit.
docs¶
Use to open docs in your browser...
Usage:
Options:
init¶
Initialize your project with Brickflow...
Usage:
Options:
-n, --project-name TEXT
-g, --git-https-url TEXT Provide the github URL for your project,
example: https://github.com/nike-eda-
apla/brickflow
-wd, --workflows-dir DIRECTORY
-bfv, --brickflow-version TEXT
-sev, --spark-expectations-version TEXT
--help Show this message and exit.
projects¶
Manage one to many brickflow projects
Usage:
Options:
add¶
Adds a project to the brickflow-multi-project.yml file and a entrypoint.py file in workflows dir
Usage:
Options:
--name TEXT Name of the project
--path-from-repo-root-to-project-root DIRECTORY
Path from repo root to project root
--path-project-root-to-workflows-dir TEXT
Path from project root to workflows dir
--deployment-mode [bundle] Deployment mode
-g, --git-https-url TEXT Provide the github URL for your project,
example: https://github.com/nike-eda-
apla/brickflow
-bfv, --brickflow-version TEXT
-sev, --spark-expectations-version TEXT
--skip-entrypoint Skip creating entrypoint.py file
--help Show this message and exit.
deploy¶
Deploy projects in the brickflow-multi-project.yml file
Usage:
Options:
--force-acquire-lock Force acquire lock for databricks bundles destroy.
--skip-libraries Skip automatically adding brickflow libraries.
--auto-approve Auto approve brickflow pipeline without being prompted
to approve.
-p, --profile TEXT The databricks profile to use for authenticating to
databricks during deployment.
--project [] Select the project of workflows you would like to
deploy.
-e, --env TEXT Set the environment value, certain tags [TBD] get
added to the workflows based on this value.
--help Show this message and exit.
destroy¶
Destroy projects in the brickflow-multi-project.yml file
Usage:
Options:
--force-acquire-lock Force acquire lock for databricks bundles destroy.
--skip-libraries Skip automatically adding brickflow libraries.
--auto-approve Auto approve brickflow pipeline without being prompted
to approve.
-p, --profile TEXT The databricks profile to use for authenticating to
databricks during deployment.
--project [] Select the project of workflows you would like to
deploy.
-e, --env TEXT Set the environment value, certain tags [TBD] get
added to the workflows based on this value.
--help Show this message and exit.
list¶
Lists all projects in the brickflow-multi-project.yml file
Usage:
Options:
remove¶
Removes a project from the brickflow-multi-project.yml file
Usage:
Options:
synth¶
Synth the bundle.yml for project
Usage:
Options:
--skip-libraries Skip automatically adding brickflow libraries.
-p, --profile TEXT The databricks profile to use for authenticating to
databricks during deployment.
--project [] Select the project of workflows you would like to
deploy.
-e, --env TEXT Set the environment value, certain tags [TBD] get added
to the workflows based on this value.
--help Show this message and exit.
sync¶
Synchronize your bundle tree to databricks workspace (only supported by bundle deployment mode).
Usage:
Options:
--deploy-mode [bundle] Which deployment framework to use to deploy.
[default: bundle]
--watch Enable filewatcher to sync files over.
--full Run a full sync.
--interval-duration TEXT File system polling interval (for --watch).
--debug TEXT File system polling interval (for --watch).
-p, --profile TEXT The databricks profile to use for
authenticating to databricks during
deployment.
--git-provider TEXT The github provider for brickflow this is
used for configuring github on DBX jobs.
--git-ref TEXT The commit/tag/branch to use in github.
-r, --repo-url TEXT The github url in which to run brickflow
with.
-e, --env TEXT Set the environment value, certain tags
[TBD] get added to the workflows based on
this value.
-w, --workflow TEXT Provide the workflow file names which you
want to deploy, each file name separated by
space! Example: bf deploy -p DEFAULT -l -w
wf1.py -w wf2.py
-wd, --workflows-dir DIRECTORY Provide the workflow directory that has to
be deployed
-l, --local-mode Set the environment flag to local and other
components [TBD] are disabled in local mode.
--help Show this message and exit.