Skip to content

README single transformation command fails #5252

@Toroi01

Description

@Toroi01

Describe the issue

The generated README for projects created with databricks bundle init default-python contains an outdated command for running a single task.

The README at src/my_project_etl/README.md suggests:

databricks bundle run my_project_etl --select sample_trips_my_project

With Databricks CLI v0.299.2, this fails with:

Error: unknown flag: --select

It appears the --select flag is no longer supported (or was renamed), but the generated template documentation was not updated accordingly.

Steps to reproduce

  1. Generate a new project:

    databricks bundle init default-python
  2. Open src/my_project_etl/README.md

  3. Run the documented command:

    databricks bundle run my_project_etl --select sample_trips_my_project
  4. Observe the error:

    Error: unknown flag: --select
    

Expected behavior

The generated README should contain a command compatible with current Databricks CLI versions.

Actual behavior

The documented command fails because the CLI does not recognize the --select flag.

Environment

  • Databricks CLI version: v0.299.2
  • OS: WSL2 with Ubuntu 24.04.2 LTS

Regression

Unknown. I have only tested this behavior with Databricks CLI v0.299.2.

Additional context

I found that the following command works instead:

databricks bundle run my_project_etl --refresh sample_trips_my_project

Although I am not sure whether this is the intended replacement for --select.

Metadata

Metadata

Assignees

No one assigned

    Labels

    CLICLI related issues

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions