Skip to content

Introduce "psql" command to connect to Lakebase instances - #3128

Merged
anton-107 merged 23 commits into
mainfrom
anton-107/lakebase-connect
Jul 16, 2025
Merged

Introduce "psql" command to connect to Lakebase instances#3128
anton-107 merged 23 commits into
mainfrom
anton-107/lakebase-connect

Conversation

@anton-107

@anton-107anton-107 commented Jun 26, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

Changes

Adds "databricks psql" command to Databricks CLI

Usage:
databricks psql <your db instance name>

Command also supports auto-complete and selector for the instance name:
databricks psql<ENTER> for drop-down
databricks psql <TAB><TAB> for auto-complete

Why

Lakebase provides API calls to fetch database credentials, but then it is up to the user to run their psql client and provide those credentials there. This change allows users to connect to their Lakebase instance with a single command

Tests

Manual local tests via building the CLI and running the introduced command against Databricks workspace
Local-only acceptance test added for Linux and Darwin platforms
Manual end-to-end test on Windows platform

@anton-107
anton-107force-pushed the anton-107/lakebase-connect branch from 27ae1f5 to ef52279CompareJuly 9, 2025 10:52
@eng-dev-ecosystem-bot

eng-dev-ecosystem-bot commented Jul 9, 2025•
edited
Loading

Copy link
Copy Markdown
Collaborator

Run: 16316416168

Env✅‌pass🙈‌skip
✅‌aws linux302424
✅‌aws windows303423
✅‌aws-ucws linux408324
✅‌aws-ucws windows409323
✅‌azure linux302423
✅‌azure windows303422
✅‌azure-ucws linux410321
✅‌azure-ucws windows411320
✅‌gcp linux301425
✅‌gcp windows302424

denik
denik reviewed Jul 9, 2025
View reviewed changes
Comment threadlibs/lakebase/connect.go Outdated
Comment threadlibs/lakebase/connect.go Outdated
@anton-107anton-107 changed the title Introduce "connect" command to connect to Lakebase instancesIntroduce "psql" command to connect to Lakebase instancesJul 9, 2025
@anton-107
anton-107force-pushed the anton-107/lakebase-connect branch from dd6e12c to d0aeebfCompareJuly 9, 2025 13:18
@anton-107
anton-107 marked this pull request as ready for review July 9, 2025 15:16
shreyas-goenka
shreyas-goenka reviewed Jul 10, 2025
View reviewed changes

@shreyas-goenkashreyas-goenka left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please update the PR description. It refers to the databricks connect command.

Comment threadcmd/psql/psql.go
Comment threadlibs/lakebase/connect.go Outdated
Comment threadlibs/lakebase/connect.go Outdated
Comment threadlibs/lakebase/connect.go
Comment threadlibs/lakebase/connect.go
Comment threadlibs/lakebase/connect.go
Comment threadacceptance/cmd/psql/script Outdated
Comment threadacceptance/cmd/psql/echo-arguments.sh
@anton-107
anton-107force-pushed the anton-107/lakebase-connect branch from 7820548 to f400e10CompareJuly 11, 2025 13:35
@anton-107anton-107 added the Bug Something isn't working label Jul 11, 2025
anton-107and others added 20 commits July 16, 2025 11:59
@anton-107
do not use default dbname if it is provided in extra args
6f21257
@anton-107
do not use default port if it is provided in extra args
84ad8ba
@anton-107
remove test for condition when psql is not found in path
9e8153d
@anton-107
acceptance test should use fake psql command
967236b
@anton-107
change the path in the acc script so that fake psql is found in path …
2e08e8c
…first
@anton-107
Disable psql test on Windows runners (#3241)
2fc6e37
## Changes
<!-- Brief summary of your changes that is easy to understand -->
## Why
<!-- Why are these changes needed? Provide the context that the reviewer
might be missing.
For example, were there any decisions behind the change that are not
reflected in the code itself? -->
## Tests
<!-- How have you tested the changes? -->
<!-- If your PR needs to be included in the release notes for next
release,
add a separate entry in NEXT_CHANGELOG.md as part of your PR. -->
@anton-107
set echo-arguments.sh as executable
2d8e3cc
@anton-107
improve parameters validation + add tests
8e87091
@anton-107
improve error messaging
4f3284d
@anton-107
add NEXT_CHANGELOG.md
abb336d
@anton-107
omit Args field for psql command
92ed62f
@anton-107
omit Args field for psql command
4d71f3b
@anton-107@pietern
Update NEXT_CHANGELOG.md
c853383
Co-authored-by: Pieter Noordhuis <pieter.noordhuis@databricks.com>
@anton-107
replace printing errors with returning formatted errors from connect.go
b868d6f
@anton-107
use cmdio.LogString to output lines
e28dbb0
@anton-107
change output lines for status and postgres version
d78ff0e
@anton-107
change output lines for status and postgres version, fix the spacing
9c0632e
@anton-107
show drop-down with instances name in case the instance name is not s…
d864462
…pecified
@anton-107
add completions for psql command (#3257)
b7e8e33
@anton-107
only try to connect if database instance is in AVAILABLE state
99cda31
@anton-107
anton-107force-pushed the anton-107/lakebase-connect branch from 7b1be11 to 99cda31CompareJuly 16, 2025 09:59
@anton-107
anton-107 merged commit f98d891 into mainJul 16, 2025
12 of 13 checks passed
@anton-107
anton-107 deleted the anton-107/lakebase-connect branch July 16, 2025 10:26
deco-sdk-taggingBot added a commit that referenced this pull request Jul 16, 2025
@deco-sdk-tagging
[Release] Release v0.260.0
78c0234
## Release v0.260.0
### Notable Changes
* Added support for creating SQL warehouses in DABs ([#3129](#3129))
### Dependency updates
* Upgrade Go SDK to 0.75.0 ([#3256](#3256))
### CLI
* Add `databricks psql` command to connect to Lakebase with a single command ([#3128](#3128))
### Bundles
* Jobs that use cluster policy default values for their cluster configuration now correctly update those defaults on every deployment ([#3255](#3255)).
* Add upper and lower helper methods for bundle templates ([#3242](#3242))
@anton-107anton-107 mentioned this pull request Jul 17, 2025
Merged
github-merge-queueBot pushed a commit that referenced this pull request Jul 18, 2025
@anton-107
Change execv to use current directory as a working directory if no di…
a338fdb
…rectory is provided (#3267)
## Why
<!-- Why are these changes needed? Provide the context that the reviewer
might be missing.
For example, were there any decisions behind the change that are not
reflected in the code itself? -->
This is a follow-up for the comment in the previous PR #3128 :
#3128 (comment)
## Tests
<!-- How have you tested the changes? -->
- Existing acceptance test on cmd/psql is still passing even though the
production code is not specifying a directory
- Manually checked that when executed with `pwd` the process prints
current working directory on Mac and on Windows
<!-- If your PR needs to be included in the release notes for next
release,
add a separate entry in NEXT_CHANGELOG.md as part of your PR. -->
denik pushed a commit that referenced this pull request May 20, 2026
@anton-107@pietern
Introduce "psql" command to connect to Lakebase instances (#3128)
741a94e
## Changes
<!-- Brief summary of your changes that is easy to understand -->
Adds "databricks psql" command to Databricks CLI
Usage:
`databricks psql <your db instance name>`
Command also supports auto-complete and selector for the instance name:
`databricks psql<ENTER>` for drop-down
`databricks psql<TAB><TAB>` for auto-complete
## Why
<!-- Why are these changes needed? Provide the context that the reviewer
might be missing.
For example, were there any decisions behind the change that are not
reflected in the code itself? -->
Lakebase provides API calls to fetch database credentials, but then it
is up to the user to run their `psql` client and provide those
credentials there. This change allows users to connect to their Lakebase
instance with a single command
## Tests
<!-- How have you tested the changes? -->
Manual local tests via building the CLI and running the introduced
command against Databricks workspace
Local-only acceptance test added for Linux and Darwin platforms
Manual end-to-end test on Windows platform
<!-- If your PR needs to be included in the release notes for next
release,
add a separate entry in NEXT_CHANGELOG.md as part of your PR. -->
---------
Co-authored-by: Pieter Noordhuis <pieter.noordhuis@databricks.com>
denik pushed a commit that referenced this pull request May 20, 2026
@deco-sdk-tagging
[Release] Release v0.260.0
8e439cf
## Release v0.260.0
### Notable Changes
* Added support for creating SQL warehouses in DABs ([#3129](#3129))
### Dependency updates
* Upgrade Go SDK to 0.75.0 ([#3256](#3256))
### CLI
* Add `databricks psql` command to connect to Lakebase with a single command ([#3128](#3128))
### Bundles
* Jobs that use cluster policy default values for their cluster configuration now correctly update those defaults on every deployment ([#3255](#3255)).
* Add upper and lower helper methods for bundle templates ([#3242](#3242))
denik pushed a commit that referenced this pull request May 20, 2026
@anton-107
Change execv to use current directory as a working directory if no di…
0cc6044
…rectory is provided (#3267)
## Why
<!-- Why are these changes needed? Provide the context that the reviewer
might be missing.
For example, were there any decisions behind the change that are not
reflected in the code itself? -->
This is a follow-up for the comment in the previous PR #3128 :
#3128 (comment)
## Tests
<!-- How have you tested the changes? -->
- Existing acceptance test on cmd/psql is still passing even though the
production code is not specifying a directory
- Manually checked that when executed with `pwd` the process prints
current working directory on Mac and on Windows
<!-- If your PR needs to be included in the release notes for next
release,
add a separate entry in NEXT_CHANGELOG.md as part of your PR. -->
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pieternpieternpietern approved these changes
@andrewnesterandrewnesterAwaiting requested review from andrewnester
@denikdenikAwaiting requested review from denik
@shreyas-goenkashreyas-goenkaAwaiting requested review from shreyas-goenka

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@anton-107@eng-dev-ecosystem-bot@pietern@denik@shreyas-goenka