Reference#
CLI Reference#
This article intends to provide reference documentation for dltflow CLI commands.
Initialize#
help="Create a templated project?",
is_flag=True,
default=False,
) @click.option( “–overwrite”, “-o”, help=”Overwrite existing config file”, is_flag=True, default=True, show_default=True, ) @click.option( “–shared”, “-d”, help=”DBFS location to store the project”, is_flag=True, default=True, show_default=True, ) def init( profile: str, project_name: str = “my_project”, config_path: str = “conf”, workflows_path: str = “workflows”, build_template: bool = False, overwrite: bool = True, dbfs_location: str = None, shared: bool = True, ): # pragma: no cover “”” Initialize a new dltflow project.
This cli command is used to help initialize a dltflow project. At a minimum,
it will create a `dltflow` config file in the current directory.
dltflow init --help
>>> Usage: dltflow init [OPTIONS]
Initialize the project with a dltflow.yml file.
Optionally start your project with a template.
Options:
-p, --profile TEXT Databricks profile to use
-n, --project-name TEXT Name of the project
-c, --config-path TEXT Path to configuration directory
-w, --workflows-path TEXT Path to workflows directory
-t, --build-template Create a templated project?
-o, --overwrite Overwrite existing config file [default: True]
-d, --shared DBFS location to store the project [default:
True]
--help Show this message and exit.
Deployment#
dltflow deploy-py-dlt --help
>>> Usage: dltflow deploy-py-dlt [OPTIONS]
Deploy a DLT pipeline.
Options:
--deployment-file TEXT [required]
--environment TEXT [required]
--as-individual Overrides project settings. Useful for developers as
their experimenting with getting their code fully
function. The impact of this flag is that any
derived DLT pipelines created with have a prefix
name of [{profile}_{user_name}] -- this is to not
overwrite any existing pipelines with logic that is
not yet fully baked..
--help Show this message and exit.