Skip to content

Commit bdd167a

Browse files
docs: add info about altering alias command not supporting change of credential type
1 parent 4cccc38 commit bdd167a

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

modules/ROOT/pages/database-administration/aliases/manage-aliases-standard-databases.adoc

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -593,7 +593,7 @@ SHOW ALIAS `remote-northwind-2021` FOR DATABASE YIELD name, properties
593593

594594
You can alter both local and remote database aliases using the `ALTER ALIAS` command.
595595
For all aliases, the command allows you to change the target database and properties of the database alias.
596-
For remote aliases, the command also allows you to change the URL, user credentials, default language, or driver settings of the database alias.
596+
For remote aliases, the command also allows you to change the URL, stored native credentials, default language, or driver settings of the database alias.
597597
The required privileges are described in the xref:authentication-authorization/dbms-administration.adoc#access-control-dbms-administration-alias-management[The DBMS ALIAS MANAGEMENT privileges].
598598
Only the clauses used will be altered.
599599

@@ -645,9 +645,9 @@ ALTER ALIAS `remote-northwind`
645645
SET DATABASE TARGET `northwind-graph-2020` AT "neo4j+s://other-location:7687"
646646
----
647647

648-
=== Alter a remote database alias credentials and driver settings
648+
=== Alter a remote database alias stored native credentials and driver settings
649649

650-
You can change the user credentials and driver settings of a remote database alias using the `USER`, `PASSWORD`, and `DRIVER` subclauses of the `SET DATABASE` clause of the `ALTER ALIAS` command.
650+
You can change the stored native credentials and driver settings of a remote database alias using the `USER`, `PASSWORD`, and `DRIVER` subclauses of the `SET DATABASE` clause of the `ALTER ALIAS` command.
651651
For example:
652652

653653
.Query
@@ -669,6 +669,17 @@ All driver settings are replaced by the new ones.
669669
In this case, by not repeating the driver setting `connection_pool_max_size`, the value will be deleted and fall back to the default value.
670670
====
671671

672+
[role=label--new-2025.10]
673+
=== Alter a remote database alias credential type
674+
675+
Changing the type of credentials used by a remote database alias, `STORED NATIVE CREDENTIALS` or `OIDC CREDENTIAL FORWARDING`, by using the `ALTER ALIAS` command is currently not supported.
676+
To change the type of credentials, the remote database alias needs to be dropped and replaced with a new one.
677+
678+
[IMPORTANT]
679+
====
680+
Any associated privileges, driver settings and other properties will be lost when dropping the alias and need to be respecified for the new one. See xref:authentication-authorization/database-administration.adoc[Database privileges] on how to manage access to the remote database alias and other privileges.
681+
====
682+
672683
=== Remove all custom driver settings from a remote database alias
673684

674685
You can remove all custom driver settings from a remote database alias by setting the `DRIVER` clause to an empty map `{}`.

0 commit comments

Comments
 (0)