+
Skip to content

[26.3.x] Mark options for additional datasources as preview #40840

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
merged 2 commits into from
Jul 2, 2025
Merged

[26.3.x] Mark options for additional datasources as preview #40840

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0e51aee
Mark options for additional datasources as preview
mabartos Jul 1, 2025
0fd152b
Update docs/documentation/upgrading/topics/changes/changes-26_3_1.adoc
mabartos Jul 2, 2025
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
8 changes: 8 additions & 0 deletions docs/documentation/upgrading/topics/changes/changes-26_3_1.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
// ------------------------ Notable changes ------------------------ //
== Notable changes

Notable changes where an internal behavior changed to prevent common misconfigurations, fix bugs or simplify running {project_name}.

=== Options for additional datasources marked as preview

In the 26.3.0 release, the newly added options for configuring additional datasources were missing a preview label. This has been now corrected as the work on this feature continues over a few next releases.
4 changes: 4 additions & 0 deletions docs/documentation/upgrading/topics/changes/changes.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
[[migration-changes]]
== Migration Changes

=== Migrating to 26.3.1

include::changes-26_3_1.adoc[leveloffset=2]

=== Migrating to 26.3.0

include::changes-26_3_0.adoc[leveloffset=2]
Expand Down
2 changes: 1 addition & 1 deletion quarkus/config-api/src/main/java/org/keycloak/config/OptionCategory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ public enum OptionCategory {
CACHE("Cache", 10, ConfigSupportLevel.SUPPORTED),
CONFIG("Config", 15, ConfigSupportLevel.SUPPORTED),
DATABASE("Database", 20, ConfigSupportLevel.SUPPORTED),
DATABASE_DATASOURCES("Database - additional datasources", 21, ConfigSupportLevel.SUPPORTED),
DATABASE_DATASOURCES("Database - additional datasources", 21, ConfigSupportLevel.PREVIEW),
TRANSACTION("Transaction",30, ConfigSupportLevel.SUPPORTED),
FEATURE("Feature", 40, ConfigSupportLevel.SUPPORTED),
HOSTNAME_V2("Hostname v2", 50, ConfigSupportLevel.SUPPORTED),
Expand Down
62 changes: 32 additions & 30 deletions ...it/cli/dist/approvals/cli/help/HelpCommandDistTest.testBootstrapAdminService.approved.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,52 +70,54 @@ Database:
--db-username <username>
The username of the database user.

Database - additional datasources:
Database - additional datasources (Preview):

--db-active-<datasource> <true|false>
Deactivate specific named datasource <datasource>. Default: true.
Preview: Deactivate specific named datasource <datasource>. Default: true.
--db-driver-<datasource> <driver>
Used for named <datasource>. The fully qualified class name of the JDBC
driver. If not set, a default driver is set accordingly to the chosen
Preview: Used for named <datasource>. The fully qualified class name of the
JDBC driver. If not set, a default driver is set accordingly to the chosen
database.
--db-kind-<datasource> <vendor>
Used for named <datasource>. The database vendor. In production mode the
default value of 'dev-file' is deprecated, you should explicitly specify the
db instead. Possible values are: dev-file, dev-mem, mariadb, mssql, mysql,
oracle, postgres. Default: dev-file.
Preview: Used for named <datasource>. The database vendor. In production mode
the default value of 'dev-file' is deprecated, you should explicitly specify
the db instead. Possible values are: dev-file, dev-mem, mariadb, mssql,
mysql, oracle, postgres. Default: dev-file.
--db-password-<datasource> <password>
Used for named <datasource>. The password of the database user.
Preview: Used for named <datasource>. The password of the database user.
--db-pool-initial-size-<datasource> <size>
Used for named <datasource>. The initial size of the connection pool.
Preview: Used for named <datasource>. The initial size of the connection pool.
--db-pool-max-size-<datasource> <size>
Used for named <datasource>. The maximum size of the connection pool. Default:
100.
Preview: Used for named <datasource>. The maximum size of the connection pool.
Default: 100.
--db-pool-min-size-<datasource> <size>
Used for named <datasource>. The minimal size of the connection pool.
Preview: Used for named <datasource>. The minimal size of the connection pool.
--db-schema-<datasource> <schema>
Used for named <datasource>. The database schema to be used.
Preview: Used for named <datasource>. The database schema to be used.
--db-url-database-<datasource> <dbname>
Used for named <datasource>. Sets the database name of the default JDBC URL of
the chosen vendor. If the `db-url` option is set, this option is ignored.
Preview: Used for named <datasource>. Sets the database name of the default
JDBC URL of the chosen vendor. If the `db-url` option is set, this option is
ignored.
--db-url-full-<datasource> <jdbc-url>
Used for named <datasource>. The full database JDBC URL. If not provided, a
default URL is set based on the selected database vendor. For instance, if
using 'postgres', the default JDBC URL would be 'jdbc:postgresql:
//localhost/keycloak'.
Preview: Used for named <datasource>. The full database JDBC URL. If not
provided, a default URL is set based on the selected database vendor. For
instance, if using 'postgres', the default JDBC URL would be 'jdbc:
postgresql://localhost/keycloak'.
--db-url-host-<datasource> <hostname>
Used for named <datasource>. Sets the hostname of the default JDBC URL of the
chosen vendor. If the `db-url` option is set, this option is ignored.
Preview: Used for named <datasource>. Sets the hostname of the default JDBC
URL of the chosen vendor. If the `db-url` option is set, this option is
ignored.
--db-url-port-<datasource> <port>
Used for named <datasource>. Sets the port of the default JDBC URL of the
chosen vendor. If the `db-url` option is set, this option is ignored.
Preview: Used for named <datasource>. Sets the port of the default JDBC URL of
the chosen vendor. If the `db-url` option is set, this option is ignored.
--db-url-properties-<datasource> <properties>
Used for named <datasource>. Sets the properties of the default JDBC URL of
the chosen vendor. Make sure to set the properties accordingly to the format
expected by the database vendor, as well as appending the right character at
the beginning of this property value. If the `db-url` option is set, this
option is ignored.
Preview: Used for named <datasource>. Sets the properties of the default JDBC
URL of the chosen vendor. Make sure to set the properties accordingly to the
format expected by the database vendor, as well as appending the right
character at the beginning of this property value. If the `db-url` option is
set, this option is ignored.
--db-username-<datasource> <username>
Used for named <datasource>. The username of the database user.
Preview: Used for named <datasource>. The username of the database user.

Transaction:

Expand Down
62 changes: 32 additions & 30 deletions ...ak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testBootstrapAdminUser.approved.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,52 +72,54 @@ Database:
--db-username <username>
The username of the database user.

Database - additional datasources:
Database - additional datasources (Preview):

--db-active-<datasource> <true|false>
Deactivate specific named datasource <datasource>. Default: true.
Preview: Deactivate specific named datasource <datasource>. Default: true.
--db-driver-<datasource> <driver>
Used for named <datasource>. The fully qualified class name of the JDBC
driver. If not set, a default driver is set accordingly to the chosen
Preview: Used for named <datasource>. The fully qualified class name of the
JDBC driver. If not set, a default driver is set accordingly to the chosen
database.
--db-kind-<datasource> <vendor>
Used for named <datasource>. The database vendor. In production mode the
default value of 'dev-file' is deprecated, you should explicitly specify the
db instead. Possible values are: dev-file, dev-mem, mariadb, mssql, mysql,
oracle, postgres. Default: dev-file.
Preview: Used for named <datasource>. The database vendor. In production mode
the default value of 'dev-file' is deprecated, you should explicitly specify
the db instead. Possible values are: dev-file, dev-mem, mariadb, mssql,
mysql, oracle, postgres. Default: dev-file.
--db-password-<datasource> <password>
Used for named <datasource>. The password of the database user.
Preview: Used for named <datasource>. The password of the database user.
--db-pool-initial-size-<datasource> <size>
Used for named <datasource>. The initial size of the connection pool.
Preview: Used for named <datasource>. The initial size of the connection pool.
--db-pool-max-size-<datasource> <size>
Used for named <datasource>. The maximum size of the connection pool. Default:
100.
Preview: Used for named <datasource>. The maximum size of the connection pool.
Default: 100.
--db-pool-min-size-<datasource> <size>
Used for named <datasource>. The minimal size of the connection pool.
Preview: Used for named <datasource>. The minimal size of the connection pool.
--db-schema-<datasource> <schema>
Used for named <datasource>. The database schema to be used.
Preview: Used for named <datasource>. The database schema to be used.
--db-url-database-<datasource> <dbname>
Used for named <datasource>. Sets the database name of the default JDBC URL of
the chosen vendor. If the `db-url` option is set, this option is ignored.
Preview: Used for named <datasource>. Sets the database name of the default
JDBC URL of the chosen vendor. If the `db-url` option is set, this option is
ignored.
--db-url-full-<datasource> <jdbc-url>
Used for named <datasource>. The full database JDBC URL. If not provided, a
default URL is set based on the selected database vendor. For instance, if
using 'postgres', the default JDBC URL would be 'jdbc:postgresql:
//localhost/keycloak'.
Preview: Used for named <datasource>. The full database JDBC URL. If not
provided, a default URL is set based on the selected database vendor. For
instance, if using 'postgres', the default JDBC URL would be 'jdbc:
postgresql://localhost/keycloak'.
--db-url-host-<datasource> <hostname>
Used for named <datasource>. Sets the hostname of the default JDBC URL of the
chosen vendor. If the `db-url` option is set, this option is ignored.
Preview: Used for named <datasource>. Sets the hostname of the default JDBC
URL of the chosen vendor. If the `db-url` option is set, this option is
ignored.
--db-url-port-<datasource> <port>
Used for named <datasource>. Sets the port of the default JDBC URL of the
chosen vendor. If the `db-url` option is set, this option is ignored.
Preview: Used for named <datasource>. Sets the port of the default JDBC URL of
the chosen vendor. If the `db-url` option is set, this option is ignored.
--db-url-properties-<datasource> <properties>
Used for named <datasource>. Sets the properties of the default JDBC URL of
the chosen vendor. Make sure to set the properties accordingly to the format
expected by the database vendor, as well as appending the right character at
the beginning of this property value. If the `db-url` option is set, this
option is ignored.
Preview: Used for named <datasource>. Sets the properties of the default JDBC
URL of the chosen vendor. Make sure to set the properties accordingly to the
format expected by the database vendor, as well as appending the right
character at the beginning of this property value. If the `db-url` option is
set, this option is ignored.
--db-username-<datasource> <username>
Used for named <datasource>. The username of the database user.
Preview: Used for named <datasource>. The username of the database user.

Transaction:

Expand Down
14 changes: 7 additions & 7 deletions ...rg/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testBuildHelp.approved.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,17 @@ Database:
--db-driver <driver> The fully qualified class name of the JDBC driver. If not set, a default
driver is set accordingly to the chosen database.

Database - additional datasources:
Database - additional datasources (Preview):

--db-driver-<datasource> <driver>
Used for named <datasource>. The fully qualified class name of the JDBC
driver. If not set, a default driver is set accordingly to the chosen
Preview: Used for named <datasource>. The fully qualified class name of the
JDBC driver. If not set, a default driver is set accordingly to the chosen
database.
--db-kind-<datasource> <vendor>
Used for named <datasource>. The database vendor. In production mode the
default value of 'dev-file' is deprecated, you should explicitly specify the
db instead. Possible values are: dev-file, dev-mem, mariadb, mssql, mysql,
oracle, postgres. Default: dev-file.
Preview: Used for named <datasource>. The database vendor. In production mode
the default value of 'dev-file' is deprecated, you should explicitly specify
the db instead. Possible values are: dev-file, dev-mem, mariadb, mssql,
mysql, oracle, postgres. Default: dev-file.

Transaction:

Expand Down
Loading
Loading
点击 这是indexloc提供的php浏览器服务，不要输入任何密码和下载