Skip to content

Promote Vault integration out of beta #2107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rolandwalker merged 1 commit into from
Aug 7, 2026
Merged

Promote Vault integration out of beta #2107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Features
---------
* Always clean favorite queries on save and fetch.
* Give a clearer message on a Vault connection if the user is not logged in.
* Promote Vault integration out of beta status.


Bugfixes
Expand Down
4 changes: 2 additions & 2 deletions mycli/cli_runner.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -455,7 +455,7 @@ def run_from_cli_args(cli_args: 'CliArgs', client_factory: ClientFactory) -> Non

if cli_args.vault_secret:
vault_secret = cli_args.vault_secret
vault_config = mycli.config.get('vault_beta', {})
vault_config = mycli.config.get('vault', {})
vault_address = cli_args.vault_address or os.environ.get('VAULT_ADDR') or vault_config.get('address') or None
vault_mount = cli_args.vault_mount or vault_config.get('default_mount') or None
vault_password_field = cli_args.vault_password_field or vault_config.get('default_password_field') or DEFAULT_VAULT_PASSWORD_FIELD
Expand All @@ -477,7 +477,7 @@ def load_vault_password() -> str | None:
password_candidates.add_loader('vault', load_vault_password)

if cli_args.user is None and cli_args.vault_secret:
vault_config = mycli.config.get('vault_beta', {})
vault_config = mycli.config.get('vault', {})
vault_address = cli_args.vault_address or os.environ.get('VAULT_ADDR') or vault_config.get('address') or None
vault_mount = cli_args.vault_mount or vault_config.get('default_mount') or None
vault_username_field = cli_args.vault_username_field or vault_config.get('default_username_field') or DEFAULT_VAULT_USERNAME_FIELD
Expand Down
10 changes: 5 additions & 5 deletions mycli/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,23 +107,23 @@ class CliArgs:
)
vault_address: str | None = clickdc.option(
type=str,
help='EXPERIMENTAL "vault kv get" integration: value for $VAULT_ADDR if unset in the environment or ~/.myclirc.',
help='"vault kv get" integration: value for $VAULT_ADDR if unset in the environment or ~/.myclirc.',
)
vault_mount: str | None = clickdc.option(
type=str,
help='EXPERIMENTAL "vault kv get" integration: value for -mount if unset in ~/.myclirc.',
help='"vault kv get" integration: value for -mount if unset in ~/.myclirc.',
)
vault_secret: str | None = clickdc.option(
type=str,
help='EXPERIMENTAL "vault kv get" integration: secret name.',
help='"vault kv get" integration: secret name.',
)
vault_password_field: str | None = clickdc.option(
type=str,
help='EXPERIMENTAL "vault kv get" integration: field containing the password.',
help='"vault kv get" integration: field containing the password.',
)
vault_username_field: str | None = clickdc.option(
type=str,
help='EXPERIMENTAL "vault kv get" integration: field containing the username.',
help='"vault kv get" integration: field containing the username.',
)
ssl_mode: str = clickdc.option(
type=click.Choice(['auto', 'on', 'off']),
Expand Down
2 changes: 1 addition & 1 deletion mycli/myclirc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,7 +394,7 @@ ssh_options = -a -o ServerAliveInterval=60 -o ExitOnForwardFailure=yes -o IPQoS=
# auto means: port if on Windows, socket otherwise.
tunnel_method = auto

[vault_beta]
[vault]
# Path to the vault executable used for Vault integration.
vault_executable = vault

Expand Down
2 changes: 1 addition & 1 deletion mycli/packages/special/dsn_aliases.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ def _query_param_defaults(self) -> dict[str, Any]:

main_config = self.config.get('main', {})
connection_config = self.config.get('connection', {})
vault_config = self.config.get('vault_beta', {})
vault_config = self.config.get('vault', {})
return {
'character_set': connection_config.get('default_character_set') or DEFAULT_CHARSET,
'keepalive_ticks': self.mycli.default_keepalive_ticks,
Expand Down
2 changes: 1 addition & 1 deletion test/myclirc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,7 +394,7 @@ ssh_options = -a -o ServerAliveInterval=60 -o ExitOnForwardFailure=yes -o IPQoS=
# auto means: port if on Windows, socket otherwise.
tunnel_method = auto

[vault_beta]
[vault]
# Path to the vault executable used for Vault integration.
vault_executable = vault

Expand Down
8 changes: 4 additions & 4 deletions test/pytests/test_cli_runner.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ def default_config() -> dict[str, Any]:
return {
'main': {'use_keyring': 'false'},
'connection': {'default_keepalive_ticks': 0},
'vault_beta': {},
'vault': {},
'alias_dsn': {},
'init-commands': {},
'alias_dsn.init-commands': {},
Expand Down Expand Up @@ -964,7 +964,7 @@ def test_run_from_cli_args_reads_password_from_vault_when_password_is_missing(
client = DummyMyCli(
config={
**default_config(),
'vault_beta': {
'vault': {
'vault_executable': '/opt/bin/vault',
'address': 'https://vault.config',
'default_mount': 'kv',
Expand Down Expand Up @@ -1005,7 +1005,7 @@ def test_run_from_cli_args_reads_username_from_vault_when_user_is_missing(
client = DummyMyCli(
config={
**default_config(),
'vault_beta': {
'vault': {
'vault_executable': '/opt/bin/vault',
'address': 'https://vault.config',
'default_mount': 'kv',
Expand Down Expand Up @@ -1110,7 +1110,7 @@ def test_run_from_cli_args_prefers_vault_cli_values_and_env_address(
client = DummyMyCli(
config={
**default_config(),
'vault_beta': {
'vault': {
'vault_executable': '/opt/bin/vault',
'address': 'https://vault.config',
'default_mount': 'config-mount',
Expand Down
4 changes: 2 additions & 2 deletions test/pytests/test_dsn_aliases.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,7 @@ def test_dsn_more_adds_non_default_runtime_parameters_in_sorted_order() -> None:
'default_ssl_ca': '/default-ca.pem',
'default_ssl_verify_server_cert': 'False',
},
'vault_beta': {
'vault': {
'address': 'https://default-vault',
'default_mount': 'kv',
'default_password_field': 'password',
Expand Down Expand Up @@ -435,7 +435,7 @@ def test_dsn_more_omits_empty_false_and_active_default_parameters() -> None:
'default_ssl_mode': 'on',
'default_ssl_verify_server_cert': 'True',
},
'vault_beta': {
'vault': {
'address': 'https://default-vault',
'default_mount': 'kv',
'default_password_field': 'secret',
Expand Down
Loading