Improve missing cluster ID guidance - #1545
Open
TangoEnSkai wants to merge 1 commit into
Open
Conversation
Signed-off-by: TangoEnSkai <21152231+TangoEnSkai@users.noreply.github.com>
|
If integration tests don't run automatically, an authorized user can run them manually by following the instructions below: Trigger: Inputs:
Checks will be approved automatically on success. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Improves the error shown when a remote DBUtils operation requires a cluster but no cluster ID is configured.
Fixes #51.
Why
The existing error says that
cluster_idis required, but it does not tell users how to provide it. Users can otherwise miss the supported configuration argument and environment variable even though both are documented elsewhere.What changed
Interface changes
None.
Behavioral changes
Config(cluster_id="...")andDATABRICKS_CLUSTER_ID.Internal changes
How is this tested?
uv run pytest tests/test_dbutils.py -q(19 passed)uv run ruff format --check databricks/sdk/dbutils.py tests/test_dbutils.pygit diff --check