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

* Mark options for additional datasources as preview

Closes #40838

Signed-off-by: Martin Bartoš <mabartos@redhat.com>

* Update docs/documentation/upgrading/topics/changes/changes-26_3_1.adoc

Co-authored-by: Václav Muzikář <vaclav@muzikari.cz>
Signed-off-by: Martin Bartoš <mabartos@redhat.com>

---------

Signed-off-by: Martin Bartoš <mabartos@redhat.com>
Co-authored-by: Václav Muzikář <vaclav@muzikari.cz>
This commit is contained in:
Martin Bartoš 2025-07-02 15:55:30 +02:00 committed by GitHub
parent 154b8ed1f9
commit 379a765886
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
20 changed files with 520 additions and 476 deletions

View File

@ -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.

View File

@ -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]

View File

@ -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),

View File

@ -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:

View File

@ -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:

View File

@ -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:

View File

@ -65,52 +65,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:

View File

@ -65,52 +65,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:

View File

@ -65,52 +65,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:

View File

@ -65,52 +65,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:

View File

@ -107,52 +107,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:

View File

@ -158,52 +158,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:

View File

@ -139,52 +139,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:

View File

@ -159,52 +159,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:

View File

@ -133,43 +133,45 @@ 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-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.
Hostname v2:

View File

@ -153,43 +153,45 @@ 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-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.
Hostname v2:

View File

@ -138,52 +138,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:

View File

@ -158,52 +158,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:

View File

@ -136,52 +136,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:

View File

@ -156,52 +156,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: