Support tab completion for profiles #572
Merged
Conversation
This file contains 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
pietern
approved these changes
Jul 12, 2023
libs/databrickscfg/profiles.go
Outdated
| @@ -99,3 +100,11 @@ func LoadProfiles(path string, fn ProfileMatchFunction) (file string, profiles P | |||
|
|
|||
| return | |||
| } | |||
|
|
|||
| func ProfileCompletion(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) { | |||
| _, profiles, err := LoadProfiles(DefaultPath, func(p Profile) bool { return true }) | |||
There was a problem hiding this comment.
What you suggest should be easy. You can traverse cmd all the way to root and figure out of any of the parts is account. If so, we complete account profiles, otherwise workspace profiles.
There was a problem hiding this comment.
I see. I think to make this actually work, we need to do a slightly more subtle change:
- If no command group is set at all, complete with both profile types.
- If the command group is "accounts", complete with account profiles only.
- Otherwise, complete with workspace profiles only.
There was a problem hiding this comment.
Otherwise, databricks --profile <TAB> would only show workspace profiles.
There was a problem hiding this comment.
Indeed. Can also be a follow up, either way works.
There was a problem hiding this comment.
Just tried it, and args is always empty even if there are arguments supplied. I guess the values supplied to args are only in the context of the command that the flag is defined on... I just refactored this function for now. In the future, we can autogenerate the --profile flag in command groups.
There was a problem hiding this comment.
It is, but the cmd should be the command for which the completion is triggered.
Merged
nfx
added a commit
that referenced
this pull request
Jul 18, 2023
* Add development runs ([#522](#522)). * Support tab completion for profiles ([#572](#572)). * Correctly use --profile flag passed for all bundle commands ([#571](#571)). * Disallow notebooks in paths where files are expected ([#573](#573)). * Improve auth login experience ([#570](#570)). * Remove base path checks during sync ([#576](#576)). * First look for databricks.yml before falling back to bundle.yml ([#580](#580)). * Integrate with auto-release infra ([#581](#581)). API Changes: * Removed `databricks metastores maintenance` command. * Added `databricks metastores enable-optimization` command. * Added `databricks tables update` command. * Changed `databricks account settings delete-personal-compute-setting` command with new required argument order. * Changed `databricks account settings read-personal-compute-setting` command with new required argument order. * Added `databricks clean-rooms` command group. OpenAPI SHA: 850a075ed9758d21a6bc4409506b48c8b9f93ab4, Date: 2023-07-18 Dependency updates: * Bump golang.org/x/term from 0.9.0 to 0.10.0 ([#567](#567)). * Bump golang.org/x/oauth2 from 0.9.0 to 0.10.0 ([#566](#566)). * Bump golang.org/x/mod from 0.11.0 to 0.12.0 ([#568](#568)). * Bump github.com/databricks/databricks-sdk-go from 0.12.0 to 0.13.0 ([#585](#585)).
nfx
added a commit
that referenced
this pull request
Jul 18, 2023
* Add development runs ([#522](#522)). * Support tab completion for profiles ([#572](#572)). * Correctly use --profile flag passed for all bundle commands ([#571](#571)). * Disallow notebooks in paths where files are expected ([#573](#573)). * Improve auth login experience ([#570](#570)). * Remove base path checks during sync ([#576](#576)). * First look for databricks.yml before falling back to bundle.yml ([#580](#580)). * Integrate with auto-release infra ([#581](#581)). API Changes: * Removed `databricks metastores maintenance` command. * Added `databricks metastores enable-optimization` command. * Added `databricks tables update` command. * Changed `databricks account settings delete-personal-compute-setting` command with new required argument order. * Changed `databricks account settings read-personal-compute-setting` command with new required argument order. * Added `databricks clean-rooms` command group. OpenAPI SHA: 850a075ed9758d21a6bc4409506b48c8b9f93ab4, Date: 2023-07-18 Dependency updates: * Bump golang.org/x/term from 0.9.0 to 0.10.0 ([#567](#567)). * Bump golang.org/x/oauth2 from 0.9.0 to 0.10.0 ([#566](#566)). * Bump golang.org/x/mod from 0.11.0 to 0.12.0 ([#568](#568)). * Bump github.com/databricks/databricks-sdk-go from 0.12.0 to 0.13.0 ([#585](#585)).
nfx
added a commit
that referenced
this pull request
Jul 18, 2023
* Add development runs ([#522](#522)). * Support tab completion for profiles ([#572](#572)). * Correctly use --profile flag passed for all bundle commands ([#571](#571)). * Disallow notebooks in paths where files are expected ([#573](#573)). * Improve auth login experience ([#570](#570)). * Remove base path checks during sync ([#576](#576)). * First look for databricks.yml before falling back to bundle.yml ([#580](#580)). * Integrate with auto-release infra ([#581](#581)). API Changes: * Removed `databricks metastores maintenance` command. * Added `databricks metastores enable-optimization` command. * Added `databricks tables update` command. * Changed `databricks account settings delete-personal-compute-setting` command with new required argument order. * Changed `databricks account settings read-personal-compute-setting` command with new required argument order. * Added `databricks clean-rooms` command group. OpenAPI SHA: 850a075ed9758d21a6bc4409506b48c8b9f93ab4, Date: 2023-07-18 Dependency updates: * Bump golang.org/x/term from 0.9.0 to 0.10.0 ([#567](#567)). * Bump golang.org/x/oauth2 from 0.9.0 to 0.10.0 ([#566](#566)). * Bump golang.org/x/mod from 0.11.0 to 0.12.0 ([#568](#568)). * Bump github.com/databricks/databricks-sdk-go from 0.12.0 to 0.13.0 ([#585](#585)).
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.
Changes
Currently,
databricks --profile <TAB>autocompletes with the shell default behavior, listing files in the local directory. This is not a great experience. Especially given that the suggested profile names for accounts are so long, it can be cumbersome to type them out by hand. This PR configures autocompletion for--profileto inspect the profiles of ~/.databrickscfg.One potential improvement is to filter the response based on whether the command is known to be account-level or workspace-level.
Tests
Manual test.
