From bb83f219c9c138f532e3388bb47dfef1133e783f Mon Sep 17 00:00:00 2001 From: Rada Kamysheva Date: Wed, 17 Jun 2026 08:00:54 +0000 Subject: [PATCH] Fix generated pipeline README to use --refresh instead of --select The README scaffolded for pipeline projects documented `databricks bundle run --select ` to run a single transformation, but `bundle run` has no `--select` flag and fails with "unknown flag: --select". Use the supported `--refresh
` flag instead and regenerate the affected acceptance golden outputs. Fixes #5252 --- NEXT_CHANGELOG.md | 1 + .../my_default_python/src/my_default_python_etl/README.md | 2 +- .../my_default_python/src/my_default_python_etl/README.md | 2 +- .../src/my_lakeflow_pipelines_etl/README.md | 2 +- .../src/my_lakeflow_pipelines_etl/README.md | 2 +- .../output/lakeflow_project/src/lakeflow_project_etl/README.md | 2 +- .../my_python_project/src/my_python_project_etl/README.md | 2 +- .../sql/output/my_sql_project/src/my_sql_project_etl/README.md | 2 +- .../{{.project_name}}/src/{{.project_name}}_etl/README.md.tmpl | 2 +- 9 files changed, 9 insertions(+), 8 deletions(-) diff --git a/NEXT_CHANGELOG.md b/NEXT_CHANGELOG.md index a6afadbd0a3..88557eadf5b 100644 --- a/NEXT_CHANGELOG.md +++ b/NEXT_CHANGELOG.md @@ -23,6 +23,7 @@ * Ignore unity catalog managed schema property defaults to avoid unnecessary drift ([#5195](https://github.com/databricks/cli/pull/5195)). * Add Postgres role as a bundle resource ([#5467](https://github.com/databricks/cli/pull/5467)). * direct: Stop spurious recreate/rename on redeploy when the backend normalizes a resource's name-based ID (e.g. Unity Catalog lowercasing a schema or volume name) ([#5599](https://github.com/databricks/cli/pull/5599)). +* Fix the generated pipeline README to suggest `databricks bundle run --refresh
` for running a single transformation; the previously documented `--select` flag is not supported by `bundle run` ([#5252](https://github.com/databricks/cli/issues/5252)). ### Dependency updates diff --git a/acceptance/bundle/templates/default-python/classic/output/my_default_python/src/my_default_python_etl/README.md b/acceptance/bundle/templates/default-python/classic/output/my_default_python/src/my_default_python_etl/README.md index 17f7212f888..5b41468debe 100644 --- a/acceptance/bundle/templates/default-python/classic/output/my_default_python/src/my_default_python_etl/README.md +++ b/acceptance/bundle/templates/default-python/classic/output/my_default_python/src/my_default_python_etl/README.md @@ -15,6 +15,6 @@ To get started, go to the `transformations` folder -- most of the relevant sourc * Take a look at the sample called "sample_trips_my_default_python.py" to get familiar with the syntax. Read more about the syntax at https://docs.databricks.com/dlt/python-ref.html. * If you're using the workspace UI, use `Run file` to run and preview a single transformation. -* If you're using the CLI, use `databricks bundle run my_default_python_etl --select sample_trips_my_default_python` to run a single transformation. +* If you're using the CLI, use `databricks bundle run my_default_python_etl --refresh sample_trips_my_default_python` to run a single transformation. For more tutorials and reference material, see https://docs.databricks.com/dlt. diff --git a/acceptance/bundle/templates/default-python/serverless/output/my_default_python/src/my_default_python_etl/README.md b/acceptance/bundle/templates/default-python/serverless/output/my_default_python/src/my_default_python_etl/README.md index 17f7212f888..5b41468debe 100644 --- a/acceptance/bundle/templates/default-python/serverless/output/my_default_python/src/my_default_python_etl/README.md +++ b/acceptance/bundle/templates/default-python/serverless/output/my_default_python/src/my_default_python_etl/README.md @@ -15,6 +15,6 @@ To get started, go to the `transformations` folder -- most of the relevant sourc * Take a look at the sample called "sample_trips_my_default_python.py" to get familiar with the syntax. Read more about the syntax at https://docs.databricks.com/dlt/python-ref.html. * If you're using the workspace UI, use `Run file` to run and preview a single transformation. -* If you're using the CLI, use `databricks bundle run my_default_python_etl --select sample_trips_my_default_python` to run a single transformation. +* If you're using the CLI, use `databricks bundle run my_default_python_etl --refresh sample_trips_my_default_python` to run a single transformation. For more tutorials and reference material, see https://docs.databricks.com/dlt. diff --git a/acceptance/bundle/templates/lakeflow-pipelines/python/output/my_lakeflow_pipelines/src/my_lakeflow_pipelines_etl/README.md b/acceptance/bundle/templates/lakeflow-pipelines/python/output/my_lakeflow_pipelines/src/my_lakeflow_pipelines_etl/README.md index c675a73a2c0..a11175dec16 100644 --- a/acceptance/bundle/templates/lakeflow-pipelines/python/output/my_lakeflow_pipelines/src/my_lakeflow_pipelines_etl/README.md +++ b/acceptance/bundle/templates/lakeflow-pipelines/python/output/my_lakeflow_pipelines/src/my_lakeflow_pipelines_etl/README.md @@ -15,6 +15,6 @@ To get started, go to the `transformations` folder -- most of the relevant sourc * Take a look at the sample called "sample_trips_my_lakeflow_pipelines.py" to get familiar with the syntax. Read more about the syntax at https://docs.databricks.com/dlt/python-ref.html. * If you're using the workspace UI, use `Run file` to run and preview a single transformation. -* If you're using the CLI, use `databricks bundle run my_lakeflow_pipelines_etl --select sample_trips_my_lakeflow_pipelines` to run a single transformation. +* If you're using the CLI, use `databricks bundle run my_lakeflow_pipelines_etl --refresh sample_trips_my_lakeflow_pipelines` to run a single transformation. For more tutorials and reference material, see https://docs.databricks.com/dlt. diff --git a/acceptance/bundle/templates/lakeflow-pipelines/sql/output/my_lakeflow_pipelines/src/my_lakeflow_pipelines_etl/README.md b/acceptance/bundle/templates/lakeflow-pipelines/sql/output/my_lakeflow_pipelines/src/my_lakeflow_pipelines_etl/README.md index c675a73a2c0..a11175dec16 100644 --- a/acceptance/bundle/templates/lakeflow-pipelines/sql/output/my_lakeflow_pipelines/src/my_lakeflow_pipelines_etl/README.md +++ b/acceptance/bundle/templates/lakeflow-pipelines/sql/output/my_lakeflow_pipelines/src/my_lakeflow_pipelines_etl/README.md @@ -15,6 +15,6 @@ To get started, go to the `transformations` folder -- most of the relevant sourc * Take a look at the sample called "sample_trips_my_lakeflow_pipelines.py" to get familiar with the syntax. Read more about the syntax at https://docs.databricks.com/dlt/python-ref.html. * If you're using the workspace UI, use `Run file` to run and preview a single transformation. -* If you're using the CLI, use `databricks bundle run my_lakeflow_pipelines_etl --select sample_trips_my_lakeflow_pipelines` to run a single transformation. +* If you're using the CLI, use `databricks bundle run my_lakeflow_pipelines_etl --refresh sample_trips_my_lakeflow_pipelines` to run a single transformation. For more tutorials and reference material, see https://docs.databricks.com/dlt. diff --git a/acceptance/pipelines/e2e/output/lakeflow_project/src/lakeflow_project_etl/README.md b/acceptance/pipelines/e2e/output/lakeflow_project/src/lakeflow_project_etl/README.md index 1fd2a85b68b..041f340d6d3 100644 --- a/acceptance/pipelines/e2e/output/lakeflow_project/src/lakeflow_project_etl/README.md +++ b/acceptance/pipelines/e2e/output/lakeflow_project/src/lakeflow_project_etl/README.md @@ -15,6 +15,6 @@ To get started, go to the `transformations` folder -- most of the relevant sourc * Take a look at the sample called "sample_trips_lakeflow_project.py" to get familiar with the syntax. Read more about the syntax at https://docs.databricks.com/dlt/python-ref.html. * If you're using the workspace UI, use `Run file` to run and preview a single transformation. -* If you're using the CLI, use `databricks bundle run lakeflow_project_etl --select sample_trips_lakeflow_project` to run a single transformation. +* If you're using the CLI, use `databricks bundle run lakeflow_project_etl --refresh sample_trips_lakeflow_project` to run a single transformation. For more tutorials and reference material, see https://docs.databricks.com/dlt. diff --git a/acceptance/pipelines/init/python/output/my_python_project/src/my_python_project_etl/README.md b/acceptance/pipelines/init/python/output/my_python_project/src/my_python_project_etl/README.md index 7e6ec71d7d0..e2361401fb9 100644 --- a/acceptance/pipelines/init/python/output/my_python_project/src/my_python_project_etl/README.md +++ b/acceptance/pipelines/init/python/output/my_python_project/src/my_python_project_etl/README.md @@ -15,6 +15,6 @@ To get started, go to the `transformations` folder -- most of the relevant sourc * Take a look at the sample called "sample_trips_my_python_project.py" to get familiar with the syntax. Read more about the syntax at https://docs.databricks.com/dlt/python-ref.html. * If you're using the workspace UI, use `Run file` to run and preview a single transformation. -* If you're using the CLI, use `databricks bundle run my_python_project_etl --select sample_trips_my_python_project` to run a single transformation. +* If you're using the CLI, use `databricks bundle run my_python_project_etl --refresh sample_trips_my_python_project` to run a single transformation. For more tutorials and reference material, see https://docs.databricks.com/dlt. diff --git a/acceptance/pipelines/init/sql/output/my_sql_project/src/my_sql_project_etl/README.md b/acceptance/pipelines/init/sql/output/my_sql_project/src/my_sql_project_etl/README.md index 6df39890722..f74a15e6296 100644 --- a/acceptance/pipelines/init/sql/output/my_sql_project/src/my_sql_project_etl/README.md +++ b/acceptance/pipelines/init/sql/output/my_sql_project/src/my_sql_project_etl/README.md @@ -15,6 +15,6 @@ To get started, go to the `transformations` folder -- most of the relevant sourc * Take a look at the sample called "sample_trips_my_sql_project.py" to get familiar with the syntax. Read more about the syntax at https://docs.databricks.com/dlt/python-ref.html. * If you're using the workspace UI, use `Run file` to run and preview a single transformation. -* If you're using the CLI, use `databricks bundle run my_sql_project_etl --select sample_trips_my_sql_project` to run a single transformation. +* If you're using the CLI, use `databricks bundle run my_sql_project_etl --refresh sample_trips_my_sql_project` to run a single transformation. For more tutorials and reference material, see https://docs.databricks.com/dlt. diff --git a/libs/template/templates/default/template/{{.project_name}}/src/{{.project_name}}_etl/README.md.tmpl b/libs/template/templates/default/template/{{.project_name}}/src/{{.project_name}}_etl/README.md.tmpl index dce58668879..6adc0a43d39 100644 --- a/libs/template/templates/default/template/{{.project_name}}/src/{{.project_name}}_etl/README.md.tmpl +++ b/libs/template/templates/default/template/{{.project_name}}/src/{{.project_name}}_etl/README.md.tmpl @@ -15,6 +15,6 @@ To get started, go to the `transformations` folder -- most of the relevant sourc * Take a look at the sample called "sample_trips_{{.project_name}}.py" to get familiar with the syntax. Read more about the syntax at https://docs.databricks.com/dlt/python-ref.html. * If you're using the workspace UI, use `Run file` to run and preview a single transformation. -* If you're using the CLI, use `databricks bundle run {{.project_name}}_etl --select sample_trips_{{.project_name}}` to run a single transformation. +* If you're using the CLI, use `databricks bundle run {{.project_name}}_etl --refresh sample_trips_{{.project_name}}` to run a single transformation. For more tutorials and reference material, see https://docs.databricks.com/dlt.