Introduce retries to `databricks psql` command by anton-107 · Pull Request #3492 · databricks/cli

anton-107 · 2025-08-26T14:13:51Z

Why

Sometimes the connection to the database instance might fail, which can be remediated with a retry. This change makes the command to retry the connection 3 times by default.

To disable the retries users can set a max-retries value to zero:

$ databricks psql my-instance --max-retries 0

Tests

Added a new acceptance test, modified and existing acceptance test; ran manual tests on Mac and Windows

eng-dev-ecosystem-bot · 2025-08-26T14:29:37Z

Run: 17299828292

	Env	✅pass	🔄flaky	🙈skip
🔄	aws linux	299	9	504
🔄	aws windows	303	6	503
✅	aws-ucws linux	421		401
✅	aws-ucws windows	422		400
🔄	azure linux	302	6	503
🔄	azure windows	305	4	502
🔄	azure-ucws linux	413	8	400
✅	azure-ucws windows	422		399
🔄	gcp linux	298	9	505
🔄	gcp windows	303	5	504

36 failing tests:

Test Name	aws linux	aws windows	azure linux	azure windows	azure-ucws linux	gcp linux	gcp windows
TestAccept	✅pass	✅pass	✅pass	🔄flaky	✅pass	✅pass	✅pass
TestAccept/bundle/deploy/dashboard/simple	✅pass	✅pass	✅pass	✅pass	✅pass	✅pass	🔄flaky
TestAccept/bundle/deploy/pipeline/allow-duplicate-names	✅pass	✅pass	✅pass	✅pass	✅pass	🔄flaky	✅pass
TestAccept/bundle/deploy/pipeline/allow-duplicate-names/DATABRICKS_CLI_DEPLOYMENT=terraform	✅pass	✅pass	✅pass	✅pass	✅pass	🔄flaky	✅pass
TestAccept/bundle/deployment/bind/job/job-spark-python-task	✅pass	✅pass	✅pass	✅pass	✅pass	✅pass	🔄flaky
TestAccept/bundle/destroy/jobs-and-pipeline	✅pass	✅pass	🔄flaky	✅pass	✅pass	✅pass	✅pass
TestAccept/bundle/destroy/jobs-and-pipeline/DATABRICKS_CLI_DEPLOYMENT=terraform	✅pass	✅pass	🔄flaky	✅pass	✅pass	✅pass	✅pass
TestAccept/bundle/resources/pipelines/update	✅pass	✅pass	🔄flaky	✅pass	✅pass	🔄flaky	✅pass
TestAccept/bundle/resources/pipelines/update/DATABRICKS_CLI_DEPLOYMENT=direct-exp	🔄flaky	🔄flaky	✅pass	✅pass	✅pass	✅pass	🔄flaky
TestAccept/bundle/resources/pipelines/update/DATABRICKS_CLI_DEPLOYMENT=terraform	🔄flaky	🔄flaky	🔄flaky	✅pass	✅pass	🔄flaky	🔄flaky
TestAccept/bundle/templates/default-python/combinations/classic	🔄flaky	✅pass	✅pass	✅pass	✅pass	🔄flaky	✅pass
TestAccept/bundle/templates/default-python/combinations/classic/DATABRICKS_CLI_DEPLOYMENT=terraform/DLT=no/NBOOK=yes/PY=yes	🔄flaky	✅pass	✅pass	✅pass	✅pass	✅pass	✅pass
TestAccept/bundle/templates/default-python/combinations/classic/DATABRICKS_CLI_DEPLOYMENT=terraform/DLT=yes/NBOOK=yes/PY=yes	✅pass	✅pass	✅pass	✅pass	✅pass	🔄flaky	✅pass
TestAccept/bundle/templates/default-python/integration_classic	✅pass	✅pass	🔄flaky	✅pass	✅pass	✅pass	✅pass
TestAccept/bundle/templates/default-python/integration_classic/DATABRICKS_CLI_DEPLOYMENT=direct-exp/UV_PYTHON=3.10	✅pass	🔄flaky	✅pass	✅pass	✅pass	✅pass	✅pass
TestAccept/bundle/templates/default-python/integration_classic/DATABRICKS_CLI_DEPLOYMENT=direct-exp/UV_PYTHON=3.11	🔄flaky	✅pass	✅pass	✅pass	✅pass	✅pass	✅pass
TestAccept/bundle/templates/default-python/integration_classic/DATABRICKS_CLI_DEPLOYMENT=direct-exp/UV_PYTHON=3.9	✅pass	✅pass	✅pass	✅pass	✅pass	🔄flaky	✅pass
TestAccept/bundle/templates/default-python/integration_classic/DATABRICKS_CLI_DEPLOYMENT=terraform/UV_PYTHON=3.10	✅pass	✅pass	✅pass	✅pass	✅pass	🔄flaky	✅pass
TestAccept/bundle/templates/default-python/integration_classic/DATABRICKS_CLI_DEPLOYMENT=terraform/UV_PYTHON=3.11	🔄flaky	✅pass	✅pass	✅pass	✅pass	🔄flaky	✅pass
TestAccept/bundle/templates/default-python/integration_classic/DATABRICKS_CLI_DEPLOYMENT=terraform/UV_PYTHON=3.12	🔄flaky	🔄flaky	✅pass	✅pass	✅pass	✅pass	✅pass
TestAccept/bundle/templates/default-python/integration_classic/DATABRICKS_CLI_DEPLOYMENT=terraform/UV_PYTHON=3.9	✅pass	✅pass	🔄flaky	✅pass	✅pass	✅pass	✅pass
TestAccept/selftest/record_cloud/pipeline-crud	🔄flaky	✅pass	✅pass	✅pass	✅pass	✅pass	✅pass
TestAccept/selftest/record_cloud/pipeline-crud/DATABRICKS_CLI_DEPLOYMENT=direct-exp	🔄flaky	✅pass	✅pass	✅pass	✅pass	✅pass	✅pass
TestAccept/selftest/record_cloud/workspace-file-io	✅pass	🔄flaky	✅pass	🔄flaky	✅pass	✅pass	✅pass
TestAccept/selftest/record_cloud/workspace-file-io/DATABRICKS_CLI_DEPLOYMENT=direct-exp	✅pass	✅pass	✅pass	🔄flaky	✅pass	✅pass	✅pass
TestAccept/selftest/record_cloud/workspace-file-io/DATABRICKS_CLI_DEPLOYMENT=terraform	✅pass	🔄flaky	✅pass	✅pass	✅pass	✅pass	✅pass
TestFsLsForNonexistingDir	✅pass	✅pass	✅pass	✅pass	🔄flaky	✅pass	✅pass
TestFsLsForNonexistingDir/uc-volumes	🙈skip	🙈skip	🙈skip	🙈skip	🔄flaky	🙈skip	🙈skip
TestFsLsOnEmptyDir	✅pass	✅pass	✅pass	✅pass	🔄flaky	✅pass	✅pass
TestFsLsOnEmptyDir/uc-volumes	🙈skip	🙈skip	🙈skip	🙈skip	🔄flaky	🙈skip	🙈skip
TestFsLsOnFile	✅pass	✅pass	✅pass	✅pass	🔄flaky	✅pass	✅pass
TestFsLsOnFile/uc-volumes	🙈skip	🙈skip	🙈skip	🙈skip	🔄flaky	🙈skip	🙈skip
TestFsLsWithAbsolutePaths	✅pass	✅pass	✅pass	✅pass	🔄flaky	✅pass	✅pass
TestFsLsWithAbsolutePaths/uc-volumes	🙈skip	🙈skip	🙈skip	🙈skip	🔄flaky	🙈skip	🙈skip
TestGenerateFromExistingPipelineAndDeploy	✅pass	✅pass	✅pass	🔄flaky	✅pass	✅pass	✅pass
TestLockUnlockWithoutAllowsLockFileNotExist	✅pass	✅pass	✅pass	✅pass	✅pass	✅pass	🔄flaky

cmd/psql/psql.go

libs/lakebase/connect.go

…r them

libs/lakebase/connect.go

libs/lakebase/connect_test.go

acceptance/cmd/psql/failing-connection/script

libs/lakebase/connect.go

## Release v0.267.0 ### CLI * Introduce retries to `databricks psql` command ([#3492](#3492)) * Add rule files for coding agents working on the CLI code base ([#3245](#3245)) ### Dependency updates * Upgrade TF provider to 1.88.0 ([#3529](#3529)) * Upgrade Go SDK to 0.82.0 ### Bundles * Update default-python template to make DB Connect work out of the box for unit tests, using uv to install dependencies ([#3254](#3254)) * Add support for `TaskRetryMode` for continuous jobs ([#3529](#3529)) * Add support for specifying database instance as an application resource ([#3529](#3529)) * Allow referencing job libraries outside bundle root without the need to specify sync root ([#2842](#2842)) * Add top level `run_as` support for Lakeflow Declarative Pipelines ([#3307](#3307))

anton-107 temporarily deployed to test-trigger-is August 26, 2025 14:13 — with GitHub Actions Inactive

anton-107 temporarily deployed to test-trigger-is August 26, 2025 14:16 — with GitHub Actions Inactive

anton-107 marked this pull request as ready for review August 26, 2025 14:18

anton-107 requested review from andrewnester, denik, pietern and shreyas-goenka as code owners August 26, 2025 14:18

denik reviewed Aug 26, 2025

View reviewed changes

cmd/psql/psql.go Outdated Show resolved Hide resolved

libs/lakebase/connect.go Outdated Show resolved Hide resolved

libs/lakebase/connect.go Outdated Show resolved Hide resolved

anton-107 added 6 commits August 27, 2025 11:26

introduce retries to databricks psql command

6467a9d

add acceptance tests for retries in databricks psql command

d6e0008

update NEXT_CHANGELOG.md

72fb5ae

refactor: remove the Enabled field

4912b2b

refactor: remove the isRetryableConnectionError method

66d52d5

add a comment on retryable errors and why we are not using the SDK fo…

7dbc8ba

…r them

anton-107 force-pushed the anton-107/psql-retries branch from 0879a63 to 7dbc8ba Compare August 27, 2025 09:44

anton-107 temporarily deployed to test-trigger-is August 27, 2025 09:44 — with GitHub Actions Inactive

anton-107 requested a review from denik August 27, 2025 09:44

denik reviewed Aug 27, 2025

View reviewed changes

refactor: remove constants with defaults; remove superfluous unit test

d9cbf89

anton-107 temporarily deployed to test-trigger-is August 27, 2025 11:34 — with GitHub Actions Inactive

refactor: RetryConfig is a struct, not a pointer

b2c8140

anton-107 temporarily deployed to test-trigger-is August 27, 2025 11:35 — with GitHub Actions Inactive

anton-107 added 4 commits August 27, 2025 13:40

rename tryPsqlInteractive to attemptConnection

1bebd21

minor refactoring

e877c45

make lint

a00df4e

fix off-by-one error with custom number of retries

3ea4328

anton-107 temporarily deployed to test-trigger-is August 27, 2025 11:54 — with GitHub Actions Inactive

anton-107 requested a review from denik August 27, 2025 11:55

Merge branch 'main' into anton-107/psql-retries

9a8a495

anton-107 temporarily deployed to test-trigger-is August 28, 2025 15:01 — with GitHub Actions Inactive

denik approved these changes Aug 29, 2025

View reviewed changes

anton-107 added this pull request to the merge queue Aug 29, 2025

Merged via the queue into main with commit b2c1182 Aug 29, 2025
13 checks passed

anton-107 deleted the anton-107/psql-retries branch August 29, 2025 11:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce retries to `databricks psql` command #3492

Introduce retries to `databricks psql` command #3492
anton-107 merged 13 commits intomainfrom
anton-107/psql-retries

anton-107 commented Aug 26, 2025 •

edited

Loading

Uh oh!

eng-dev-ecosystem-bot commented Aug 26, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

anton-107 commented Aug 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Why

Tests

Uh oh!

eng-dev-ecosystem-bot commented Aug 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

anton-107 commented Aug 26, 2025 •

edited

Loading

eng-dev-ecosystem-bot commented Aug 26, 2025 •

edited

Loading