mirror/keycloak
1
0
Fork 0
mirror of https://github.com/keycloak/keycloak.git synced 2026-01-06 23:09:51 -06:00
Code Issues Packages Projects Releases Wiki Activity

[Docs] Additional datasources support (#42655)

Browse Source 
* [Docs] Additional datasources support

Closes #40388

Closes #42263

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

* Rename namedKey to wildcardKey in the code

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

* Clarify the defaults for DB kind

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

* Be more clear about the Named key reference in guide

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

* Vasek's review

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-09-27 10:45:12 +02:00
committed by GitHub
parent 6e851ce80e
commit f53e5ebdac
32 changed files with 848 additions and 660 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/documentation/release_notes/topics/26_4_0.adoc
View File

@@ -175,3 +175,12 @@ When this option is set, Infinispan will automatically replicate the cache data
With this release, we added support for the following new database vendors:
* EnterpriseDB (EDB) Advanced 17.6
= Additional datasources configuration is supported
Some {project_name} use cases (like User Federation) might require connecting to additional databases.
This was possible only through specifying unsupported raw Quarkus properties in previous {project_name} versions. In this release, we've refined dedicated server options for additional datasources and promoted them to supported. This allows users to leverage additional databases in their extensions in a supported and user-friendly way.
Read more about it in the link:https://www.keycloak.org/server/db#configure-multiple-datasources[Configure multiple datasources] guide.
For the information about the necessary migration from the old configuration to the new one, see the link:{upgradingguide_link}[{upgradingguide_name}].

1
docs/documentation/server_development/topics.adoc
View File

@@ -12,6 +12,7 @@ include::topics/events.adoc[]
include::topics/saml-role-mappings-spi.adoc[]
endif::[]
include::topics/user-storage.adoc[]
include::topics/user-storage/entity-manager.adoc[]
include::topics/user-storage/provider-interfaces.adoc[]
include::topics/user-storage/provider-capability-interfaces.adoc[]
include::topics/user-storage/model-interfaces.adoc[]

16
docs/documentation/server_development/topics/user-storage.adoc
View File

@@ -27,18 +27,4 @@ There are two sample projects in link:{quickstartRepo_link}[{quickstartRepo_name
|===
In order to connect to the external database, you should use the {project_name} properties for the additional datasources described in the link:https://www.keycloak.org/server/db#configure-multiple-datasources[Configure multiple datasources] guide.

13
docs/documentation/server_development/topics/user-storage/entity-manager.adoc Normal file
View File

@@ -0,0 +1,13 @@
=== Accessing the new entity manager
In order to simply access your data in your {project_name} extension, you can obtain the link:https://jakarta.ee/specifications/persistence/3.2/apidocs/jakarta.persistence/jakarta/persistence/entitymanager[EntityManager] for the additional datasources used in these quickstarts.
It helps you to interact with entities specified for your datasource, as it provides some kind of bridge between your JPA entities and the database.
You can use the new entity manager (for the `user-store` datasource) as follows:
[source,java]
----
EntityManager em = session.getProvider(JpaConnectionProvider.class, "user-store").getEntityManager();
var user = em.find(org.your.extension.UserEntity.class, 123L);
----

4
docs/documentation/tests/src/test/resources/ignored-links
View File

@@ -40,5 +40,7 @@ https://www.npmjs.com/package/*
# Failing because of broken certificate, can likely be restored later.
https://docs.kantarainitiative.org*
https://saml.xml.org*
# To be removed once KC 26.4 has been released
# BEGIN - To be removed once KC 26.4 has been released
https://www.keycloak.org/securing-apps/specifications
https://www.keycloak.org/server/db#configure-multiple-datasources
# END

51
docs/documentation/upgrading/topics/changes/changes-26_4_0.adoc
View File

@@ -25,6 +25,57 @@ This affects indexes on the `CLIENT_ATTRIBUTES` and `GROUP_ATTRIBUTE` tables. If
on the console during migration to be applied manually after {project_name}'s startup.
See the link:{upgradingguide_link}[{upgradingguide_name}] for details on how to configure a different limit.
=== Configuration changes for additional datasources
In previous releases, the only possible way to configure additional datasources was using raw Quarkus properties that are generally considered unsupported. At the same time, adding additional datasources was supported which led to unclear situation.
To provide supported and user friendly way to configure additional datasources, we introduced new dedicated server options for that. Configuring additional datasources using the original approach via the Quarkus properties is considered **unsupported** starting with this release.
Check the following examples on how to migrate your configuration:
==== 1. Use new {project_name} options (preferred)
The supported way to configure additional datasources is by using the new configuration options.
You can migrate from this configuration in `conf/quarkus.properties`:
[source,properties]
----
quarkus.datasource.user-store.db-kind=postgresql
quarkus.datasource.user-store.username=my-username
quarkus.datasource.user-store.jdbc.url=jdbc:postgresql://my-remote-postgres:5432/user-store
quarkus.datasource.user-store.jdbc.transactions=xa
----
to this configuration in `conf/keycloak.conf`:
[source,properties]
----
db-kind-user-store=postgres
db-username-user-store=my-username
db-url-full-user-store=jdbc:postgresql://my-remote-postgres:5432/user-store
# transactions XA is enabled by default for datasources
----
For more information about the datasource options, check the link:https://www.keycloak.org/server/db#configure-multiple-datasources[Configure multiple datasources] guide.
==== 2. Remove quoting in `quarkus.properties` (unsupported)
If you are not able to migrate to the {project_name} datasource options right now, remove the additional datasource name quoting to avoid a clash of the datasource options mapping to prevent any issue.
It means that you should migrate your configuration in `conf/quarkus.properties`:
[source,properties]
----
quarkus.datasource."user-store".db-kind=postgresql
quarkus.datasource."user-store".username=my-username
----
to a version without the quotation:
[source,properties]
----
quarkus.datasource.user-store.db-kind=postgresql
quarkus.datasource.user-store.username=my-username
----
// ------------------------ Notable changes ------------------------ //
== Notable changes

4
docs/guides/server/configuration.adoc
View File

@@ -171,14 +171,14 @@ Non-alphanumeric characters in your configuration key must be converted to `_` i
Environment variables are converted back to normal option keys by lower-casing the name and replacing `\_` with `-`. Logging wildcards are the exception as `_` in the category is replaced with `.` instead. Logging categories are commonly class / package names, which are more likely to use `.` rather than `-`.
WARNING: Automatic mapping of the environment variable key to option key may not preserve the intended key
WARNING: Automatic mapping of the environment variable key to option key may not preserve the intended key
For example `kc.log-level-package.class_name` will become the environment variable key `KC_LOG_LEVEL_PACKAGE_CLASS_NAME`. That will automatically be mapped to `kc.log-level-package.class.name` because `_` in the logging category will be replaced by `.`. Unfortunately this does not match the intent of `kc.log-level-package.class_name`.
You have a couple of options in this case:
- create an entry in your `keycloak.conf` file that references an environment variable of your choosing. e.g. `kc.log-level-package.class_name=${r"${CLASS_NAME_LEVEL}"}`. See more on referencing environment variables in <<Format for referencing environment variables>>.
- or in situations where modifying the `keycloak.conf` may not be easy, you can use a pair of environment variables `KC_UNIQUEIFIER=value` and `KCKEY_UNIQUEIFIER=key`, e.g. `KC_MYKEY=debug` and `KCKEY_MYKEY=log-level-package.class_name`, or `KC_LOG_LEVEL_PACKAGE_CLASS_NAME=debug` and `KCKEY_LOG_LEVEL_PACKAGE_CLASS_NAME=log-level-package.class_name`
- or in situations where modifying the `keycloak.conf` may not be easy, you can use a pair of environment variables `KC_UNIQUEIFIER=value` and `KCKEY_UNIQUEIFIER=key`, e.g. `KC_MYKEY=debug` and `KCKEY_MYKEY=log-level-package.class_name`, or `KC_LOG_LEVEL_PACKAGE_CLASS_NAME=debug` and `KCKEY_LOG_LEVEL_PACKAGE_CLASS_NAME=log-level-package.class_name`
== Starting {project_name}
You can start {project_name} in `development mode` or `production mode`. Each mode offers different defaults for the intended environment.

124
docs/guides/server/db.adoc
View File

@@ -6,8 +6,7 @@
<@tmpl.guide
title="Configuring the database"
summary="Configure a relational database for {project_name} to store user, client, and realm data."
includedOptions="db db-* transaction-xa-enabled">
summary="Configure a relational database for {project_name} to store user, client, and realm data.">
This {section} explains how to configure the {project_name} server to store data in a relational database.
@@ -349,8 +348,6 @@ In the same way the migrationExport to point to a specific file and location:
For more information, check the link:{upgrading_guide_link}#_migrate_db[Migrating the database] documentation.
</@tmpl.guide>
== Configuring the connection pool
=== MySQL and MariaDB
@@ -364,3 +361,122 @@ If you are explicitly configuring the `wait_timeout` in your database, it is nec
`db-pool-max-lifetime` value that is less than the `wait_timeout`. The recommended best practice, is to define this value
to be your `wait_timeout` minus a few minutes. Failure to correctly configure the `db-pool-max-lifetime` will result in
{project_name} logging a warning on startup.
== Configure multiple datasources
{project_name} allows you to specify additional datasources in case you need to access another database from your extensions. This is useful when using the main {project_name} datasource is not a viable option for storing custom data, like users.
You can find more details on how to connect to your own users database in the link:{server_developer_guide}#_user-storage-spi[User Storage SPI] documentation.
Defining multiple datasources works like defining a single datasource, with one important change - you have to specify a name for each datasource as part of the config option name.
=== Required configuration
In order to enable an additional datasource, you need to set up 2 things - the JPA `persistence.xml` file and {project_name} configuration.
The `persistence.xml` file serves to specify persistence units as part of the Jakarta Persistence API standard, and is required for proper configuration propagation to the Hibernate ORM framework.
When you complete the part with the `persistence.xml` file, you need to set up {project_name} configuration accordingly.
The additional datasource properties might be specified via the standard config sources like CLI, `keycloak.conf`, or environment variables.
The additional datasources can be configured in a similar way as the main datasource.
This is achieved by using analogous names for config options, which additionally include the name of the additional datasource.
For example, when the main datasource uses the `db-username`, the additional one would be `db-username-<datasource>`.
See the Relevant options chapter for the complete list of them.
==== 1. JPA `persistence.xml` file
The `persistence.xml` provides configuration for Jakarta Persistence API (JPA) such as what entities it should manage, the datasource name, JDBC settings, JPA/Hibernate custom settings, and more.
The file needs to be placed in the `META-INF/persistence.xml` folder of your custom {project_name} extension.
NOTE: Be aware that Quarkus provides the ability to set up the JPA persistence unit via Hibernate ORM properties instead of using the `persistence.xml` file.
However, the supported way for {project_name} is using the `persistence.xml` file, and if the file is present, the Quarkus properties are ignored.
In {project_name}, most of the configuration is automatic, and you just need to provide fundamental configuration details - the datasource name and transaction type.
{project_name} requires setting the transaction type for the additional datasource to `JTA`.
You can set the transaction type and datasource name as follows for this minimal `persistence.xml` file:
[source,xml]
----
<persistence xmlns="https://jakarta.ee/xml/ns/persistence"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://jakarta.ee/xml/ns/persistence https://jakarta.ee/xml/ns/persistence/persistence_3_0.xsd"
version="3.0">
<persistence-unit name="user-store-pu" transaction-type="JTA">
<class>org.your.extension.UserEntity</class>
<properties>
<property name="jakarta.persistence.jtaDataSource" value="user-store" />
</properties>
</persistence-unit>
</persistence>
----
NOTE: To properly set the datasource name, you should set the `jakarta.persistence.jtaDataSource` property.
If it is not set, the persistence unit name will be used as the datasource name instead (so `user-store-pu` in this case).
In the example above, the resulting datasource name is `user-store`. The datasource name can be the same as the persistence unit name.
In order to use your own JPA entities, you need to provide the `<class>` properties that mark JPA entities that will be managed by this persistence unit, directed to a specific datasource.
In the example above, the `org.your.extension.UserEntity` JPA entity will be managed by the persistence unit `user-store-pu`, directed to the `user-store` datasource.
==== 2. Required properties
Once you have set up your `persistence.xml`, the minimal configuration on the {project_name} side is the setup of the DB kind/vendor for the specified datasource.
You need to specify the build time option `db-kind-<name>`, where the `<name>` is the name of your datasource and must be the **same** as specified in the `persistence.xml` file.
Therefore, you can enable the additional datasource `user-store` as follows (`postgres` as an example):
<@kc.start parameters="--db-kind-user-store=postgres"/>
After specifying the db-kind for the datasource, all database-kind–specific defaults (such as the driver and dialect) are automatically applied, just like for the main datasource.
=== Configuration via environment variables
If you do not want to configure the datasource via CLI or `keycloak.conf` properties, you can use the environment variables.
You can set the DB kind via environment variables (for the `user-store` datasource) as follows:
[source,bash]
----
export KC_DB_KIND_USER_STORE=postgres
export KC_DB_USERNAME_USER_STORE=my-username
----
It maps to the `db-kind-user-store` and `db-username-user-store` {project_name} properties due to the default mapping of the `\_` (underscore) to the `-` (dash) for environment variables.
However, sometimes, the name of the datasource might contain some special characters like `_`, `$` or `.`
In order to have it properly configured via the {project_name} environment variables, you need to explicitly say what the key for the datasource should look like.
You can use a pair of unique {project_name} environment variables with a special case of the `KCKEY_`.
For instance, for a datasource with the name __user_store$marketing__, you can set environment variables as follows:
[source,bash]
----
export KC_USER_STORE_DB_KIND=mariadb
export KCKEY_USER_STORE_DB_KIND=db-kind-user_store$marketing
----
You can find more information in the guide <@links.server id="configuration"/>, in subsection _Formats for environment variable keys with special characters_.
=== Backward compatibility for the `quarkus.properties`
In the past, we instructed users to use raw Quarkus properties to configure additional datasources in some places.
However, as using Quarkus properties in the `conf/quarkus.properties` file is considered **unsupported**, it is strongly recommended to use the dedicated additional datasources options as described above.
Before you are able to migrate to the dedicated options, you can still specify the datasource settings via the Quarkus properties as follows:
[source,properties]
----
quarkus.datasource.user-store.db-kind=h2
quarkus.datasource.user-store.username=sa
quarkus.datasource.user-store.jdbc.url=jdbc:h2:mem:user-store;DB_CLOSE_DELAY=-1
quarkus.datasource.user-store.jdbc.transactions=xa
----
WARNING: Use Quarkus properties **without quotation** for the datasource name, as properties with the quoted datasource name clash with the new datasource options mapping.
Therefore, use `quarkus.datasource.user-store.db-kind=h2`, instead of `quarkus.datasource."user-store".db-kind=h2` to prevent any issues.
<@opts.printRelevantOptions includedOptions="db db-* transaction-xa-enabled" excludedOptions="db-*-<datasource>">
=== Additional datasources options
<@opts.includeOptions includedOptions="*-<datasource>"/>
</@opts.printRelevantOptions>
</@tmpl.guide>

2
docs/guides/templates/options.adoc
View File

@@ -31,6 +31,8 @@
--
<#if option.descriptionExtended?has_content>[.options-description-extended]#${option.descriptionExtended!}#</#if>
<#if option.wildcardKey?has_content>*Named key:* [.options-wildcard-key]#`+${option.wildcardKey}+`# <#if buildIcon><#if option.build>[.none]#icon:tools[role=options-build]#</#if></#if></#if>
*CLI:* `+${option.keyCli}+` +
*Env:* `+${option.keyEnv}+`
--

18
docs/maven-plugin/src/main/java/org/keycloak/guides/maven/Options.java
View File

@@ -38,7 +38,9 @@ public class Options {
public Options() {
this.options = new EnumMap<>(OptionCategory.class);
PropertyMappers.getMappers().stream()
var mappers = PropertyMappers.getMappers();
mappers.addAll(PropertyMappers.getWildcardMappers());
mappers.stream()
.filter(m -> !m.isHidden())
.filter(propertyMapper -> Objects.nonNull(propertyMapper.getDescription()))
.map(m -> new Option(m.getFrom(),
@@ -50,7 +52,8 @@ public class Options {
m.getExpectedValues(),
m.isStrictExpectedValues(),
m.getEnabledWhen().orElse(""),
m.getDeprecatedMetadata().orElse(null)))
m.getDeprecatedMetadata().orElse(null),
m.getOption().getWildcardKey().orElse(null)))
.forEach(o -> options.computeIfAbsent(o.category, k -> new TreeSet<>(Comparator.comparing(Option::getKey))).add(o));
ProviderManager providerManager = Providers.getProviderManager(Thread.currentThread().getContextClassLoader());
@@ -83,6 +86,7 @@ public class Options {
m.getOptions() == null ? Collections.emptyList() : m.getOptions(),
true,
"",
null,
null))
.sorted(Comparator.comparing(Option::getKey)).collect(Collectors.toList());
@@ -187,6 +191,8 @@ public class Options {
private final String enabledWhen;
private final DeprecatedMetadata deprecated;
private final String wildcardKey;
public Option(String key,
OptionCategory category,
boolean build,
@@ -196,7 +202,8 @@ public class Options {
Iterable<String> expectedValues,
boolean strictExpectedValues,
String enabledWhen,
DeprecatedMetadata deprecatedMetadata) {
DeprecatedMetadata deprecatedMetadata,
String wildcardKey) {
this.key = key;
this.category = category;
this.build = build;
@@ -207,6 +214,7 @@ public class Options {
this.strictExpectedValues = strictExpectedValues;
this.enabledWhen = enabledWhen;
this.deprecated = deprecatedMetadata;
this.wildcardKey = wildcardKey;
}
public boolean isBuild() {
@@ -270,6 +278,10 @@ public class Options {
public DeprecatedMetadata getDeprecated() {
return deprecated;
}
public String getWildcardKey() {
return wildcardKey;
}
}
}

1
quarkus/config-api/src/main/java/org/keycloak/config/DatabaseOptions.java
View File

@@ -206,6 +206,7 @@ public class DatabaseOptions {
}
option = builder.build();
parentOption.setWildcardKey(option.getKey());
cachedDatasourceOptions.put(key.get(), option);
}
return Optional.of((Option<T>) option);

21
quarkus/config-api/src/main/java/org/keycloak/config/Option.java
View File

@@ -20,10 +20,11 @@ public class Option<T> {
private final boolean caseInsensitiveExpectedValues;
private final DeprecatedMetadata deprecatedMetadata;
private final Set<String> connectedOptions;
private String wildcardKey;
public Option(Class<T> type, String key, OptionCategory category, boolean hidden, boolean buildTime, String description,
Optional<T> defaultValue, List<String> expectedValues, boolean strictExpectedValues, boolean caseInsensitiveExpectedValues,
DeprecatedMetadata deprecatedMetadata, Set<String> connectedOptions) {
DeprecatedMetadata deprecatedMetadata, Set<String> connectedOptions, String wildcardKey) {
this.type = type;
this.key = key;
this.category = category;
@@ -36,6 +37,7 @@ public class Option<T> {
this.caseInsensitiveExpectedValues = caseInsensitiveExpectedValues;
this.deprecatedMetadata = deprecatedMetadata;
this.connectedOptions = connectedOptions;
this.wildcardKey = wildcardKey;
}
public Class<T> getType() {
@@ -100,6 +102,20 @@ public class Option<T> {
return connectedOptions;
}
/**
* Get sibling option name that is able to use a named key - like using wildcards
* Useful mainly for references in docs
* f.e. {@code db-username} has wildcard option {@code db-username-<datasource>}
*/
public Optional<String> getWildcardKey() {
return Optional.ofNullable(wildcardKey);
}
// used for setting the named key implicitly
void setWildcardKey(String wildcardKey) {
this.wildcardKey = wildcardKey;
}
public OptionBuilder<T> toBuilder() {
var builder = new OptionBuilder<>(key, type)
.category(category)
@@ -109,7 +125,8 @@ public class Option<T> {
.expectedValues(expectedValues)
.strictExpectedValues(strictExpectedValues)
.caseInsensitiveExpectedValues(caseInsensitiveExpectedValues)
.deprecatedMetadata(deprecatedMetadata);
.deprecatedMetadata(deprecatedMetadata)
.wildcardKey(wildcardKey);
if (hidden) {
builder.hidden();

11
quarkus/config-api/src/main/java/org/keycloak/config/OptionBuilder.java
View File

@@ -33,6 +33,7 @@ public class OptionBuilder<T> {
private boolean strictExpectedValues;
private boolean caseInsensitiveExpectedValues;
private DeprecatedMetadata deprecatedMetadata;
private String wildcardKey;
public static <A> OptionBuilder<List<A>> listOptionBuilder(String key, Class<A> type) {
return new OptionBuilder(key, List.class, type);
@@ -147,6 +148,14 @@ public class OptionBuilder<T> {
return this;
}
/**
* For more details, see the {@link Option#getWildcardKey()}
*/
public OptionBuilder<T> wildcardKey(String wildcardKey) {
this.wildcardKey = wildcardKey;
return this;
}
public Option<T> build() {
if (deprecatedMetadata == null && category.getSupportLevel() == ConfigSupportLevel.DEPRECATED) {
deprecated();
@@ -182,7 +191,7 @@ public class OptionBuilder<T> {
}
}
return new Option<T>(type, key, category, hidden, build, description, defaultValue, expectedValues, strictExpectedValues, caseInsensitiveExpectedValues, deprecatedMetadata, connectedOptions);
return new Option<T>(type, key, category, hidden, build, description, defaultValue, expectedValues, strictExpectedValues, caseInsensitiveExpectedValues, deprecatedMetadata, connectedOptions, wildcardKey);
}
}

2
quarkus/config-api/src/main/java/org/keycloak/config/OptionCategory.java
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.PREVIEW),
DATABASE_DATASOURCES("Database - additional datasources", 21, ConfigSupportLevel.SUPPORTED),
TRANSACTION("Transaction",30, ConfigSupportLevel.SUPPORTED),
FEATURE("Feature", 40, ConfigSupportLevel.SUPPORTED),
HOSTNAME_V2("Hostname v2", 50, ConfigSupportLevel.SUPPORTED),

15
quarkus/config-api/src/main/java/org/keycloak/config/TransactionOptions.java
View File

@@ -2,13 +2,6 @@ package org.keycloak.config;
public class TransactionOptions {
public static final Option<Boolean> TRANSACTION_XA_ENABLED = new OptionBuilder<>("transaction-xa-enabled", Boolean.class)
.category(OptionCategory.TRANSACTION)
.description("If set to true, XA datasources will be used.")
.buildTime(true)
.defaultValue(Boolean.FALSE)
.build();
public static final Option<Boolean> TRANSACTION_XA_ENABLED_DATASOURCE = new OptionBuilder<>("transaction-xa-enabled-<datasource>", Boolean.class)
.category(OptionCategory.TRANSACTION)
.description("If set to true, XA for <datasource> datasource will be used.")
@@ -16,6 +9,14 @@ public class TransactionOptions {
.defaultValue(Boolean.TRUE)
.build();
public static final Option<Boolean> TRANSACTION_XA_ENABLED = new OptionBuilder<>("transaction-xa-enabled", Boolean.class)
.category(OptionCategory.TRANSACTION)
.description("If set to true, XA datasources will be used.")
.buildTime(true)
.defaultValue(Boolean.FALSE)
.wildcardKey(TRANSACTION_XA_ENABLED_DATASOURCE.getKey())
.build();
public static String getNamedTxXADatasource(String namedProperty) {
if ("<default>".equals(namedProperty)) {
return TRANSACTION_XA_ENABLED.getKey();

76
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testBootstrapAdminService.approved.txt vendored
View File

@@ -75,62 +75,60 @@ Database:
--db-username <username>
The username of the database user.
Database - additional datasources (Preview):
Database - additional datasources:
--db-debug-jpql-<datasource> <true|false>
Preview: Used for named <datasource>. Add JPQL information as comments to SQL
Used for named <datasource>. Add JPQL information as comments to SQL
statements to debug JPA SQL statement generation. Default: false.
--db-driver-<datasource> <driver>
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
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-enabled-<datasource> <true|false>
Preview: If the named datasource <datasource> should be enabled at runtime.
Default: true.
If the named datasource <datasource> should be enabled at runtime. Default:
true.
--db-kind-<datasource> <vendor>
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, tidb.
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, tidb.
--db-log-slow-queries-threshold-<datasource> <milliseconds>
Preview: Used for named <datasource>. Log SQL statements slower than the
configured threshold with logger org.hibernate.SQL_SLOW and log-level info.
Default: 10000.
Used for named <datasource>. Log SQL statements slower than the configured
threshold with logger org.hibernate.SQL_SLOW and log-level info. Default:
10000.
--db-password-<datasource> <password>
Preview: Used for named <datasource>. The password of the database user.
Used for named <datasource>. The password of the database user.
--db-pool-initial-size-<datasource> <size>
Preview: Used for named <datasource>. The initial size of the connection pool.
Used for named <datasource>. The initial size of the connection pool.
--db-pool-max-size-<datasource> <size>
Preview: Used for named <datasource>. The maximum size of the connection pool.
Default: 100.
Used for named <datasource>. The maximum size of the connection pool. Default:
100.
--db-pool-min-size-<datasource> <size>
Preview: Used for named <datasource>. The minimal size of the connection pool.
Used for named <datasource>. The minimal size of the connection pool.
--db-schema-<datasource> <schema>
Preview: Used for named <datasource>. The database schema to be used.
Used for named <datasource>. The database schema to be used.
--db-url-database-<datasource> <dbname>
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>
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>
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>
Preview: Used for named <datasource>. Sets the port of the default JDBC URL of
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'.
--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.
--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.
--db-url-properties-<datasource> <properties>
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.
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>
Preview: Used for named <datasource>. The username of the database user.
Used for named <datasource>. The username of the database user.
Transaction:

76
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testBootstrapAdminUser.approved.txt vendored
View File

@@ -77,62 +77,60 @@ Database:
--db-username <username>
The username of the database user.
Database - additional datasources (Preview):
Database - additional datasources:
--db-debug-jpql-<datasource> <true|false>
Preview: Used for named <datasource>. Add JPQL information as comments to SQL
Used for named <datasource>. Add JPQL information as comments to SQL
statements to debug JPA SQL statement generation. Default: false.
--db-driver-<datasource> <driver>
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
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-enabled-<datasource> <true|false>
Preview: If the named datasource <datasource> should be enabled at runtime.
Default: true.
If the named datasource <datasource> should be enabled at runtime. Default:
true.
--db-kind-<datasource> <vendor>
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, tidb.
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, tidb.
--db-log-slow-queries-threshold-<datasource> <milliseconds>
Preview: Used for named <datasource>. Log SQL statements slower than the
configured threshold with logger org.hibernate.SQL_SLOW and log-level info.
Default: 10000.
Used for named <datasource>. Log SQL statements slower than the configured
threshold with logger org.hibernate.SQL_SLOW and log-level info. Default:
10000.
--db-password-<datasource> <password>
Preview: Used for named <datasource>. The password of the database user.
Used for named <datasource>. The password of the database user.
--db-pool-initial-size-<datasource> <size>
Preview: Used for named <datasource>. The initial size of the connection pool.
Used for named <datasource>. The initial size of the connection pool.
--db-pool-max-size-<datasource> <size>
Preview: Used for named <datasource>. The maximum size of the connection pool.
Default: 100.
Used for named <datasource>. The maximum size of the connection pool. Default:
100.
--db-pool-min-size-<datasource> <size>
Preview: Used for named <datasource>. The minimal size of the connection pool.
Used for named <datasource>. The minimal size of the connection pool.
--db-schema-<datasource> <schema>
Preview: Used for named <datasource>. The database schema to be used.
Used for named <datasource>. The database schema to be used.
--db-url-database-<datasource> <dbname>
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>
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>
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>
Preview: Used for named <datasource>. Sets the port of the default JDBC URL of
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'.
--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.
--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.
--db-url-properties-<datasource> <properties>
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.
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>
Preview: Used for named <datasource>. The username of the database user.
Used for named <datasource>. The username of the database user.
Transaction:

14
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testBuildHelp.approved.txt vendored
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 (Preview):
Database - additional datasources:
--db-driver-<datasource> <driver>
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
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>
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, tidb.
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, tidb.
Transaction:

76
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testExportHelp.approved.txt vendored
View File

@@ -70,62 +70,60 @@ Database:
--db-username <username>
The username of the database user.
Database - additional datasources (Preview):
Database - additional datasources:
--db-debug-jpql-<datasource> <true|false>
Preview: Used for named <datasource>. Add JPQL information as comments to SQL
Used for named <datasource>. Add JPQL information as comments to SQL
statements to debug JPA SQL statement generation. Default: false.
--db-driver-<datasource> <driver>
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
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-enabled-<datasource> <true|false>
Preview: If the named datasource <datasource> should be enabled at runtime.
Default: true.
If the named datasource <datasource> should be enabled at runtime. Default:
true.
--db-kind-<datasource> <vendor>
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, tidb.
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, tidb.
--db-log-slow-queries-threshold-<datasource> <milliseconds>
Preview: Used for named <datasource>. Log SQL statements slower than the
configured threshold with logger org.hibernate.SQL_SLOW and log-level info.
Default: 10000.
Used for named <datasource>. Log SQL statements slower than the configured
threshold with logger org.hibernate.SQL_SLOW and log-level info. Default:
10000.
--db-password-<datasource> <password>
Preview: Used for named <datasource>. The password of the database user.
Used for named <datasource>. The password of the database user.
--db-pool-initial-size-<datasource> <size>
Preview: Used for named <datasource>. The initial size of the connection pool.
Used for named <datasource>. The initial size of the connection pool.
--db-pool-max-size-<datasource> <size>
Preview: Used for named <datasource>. The maximum size of the connection pool.
Default: 100.
Used for named <datasource>. The maximum size of the connection pool. Default:
100.
--db-pool-min-size-<datasource> <size>
Preview: Used for named <datasource>. The minimal size of the connection pool.
Used for named <datasource>. The minimal size of the connection pool.
--db-schema-<datasource> <schema>
Preview: Used for named <datasource>. The database schema to be used.
Used for named <datasource>. The database schema to be used.
--db-url-database-<datasource> <dbname>
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>
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>
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>
Preview: Used for named <datasource>. Sets the port of the default JDBC URL of
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'.
--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.
--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.
--db-url-properties-<datasource> <properties>
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.
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>
Preview: Used for named <datasource>. The username of the database user.
Used for named <datasource>. The username of the database user.
Transaction:

76
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testExportHelpAll.approved.txt vendored
View File

@@ -70,62 +70,60 @@ Database:
--db-username <username>
The username of the database user.
Database - additional datasources (Preview):
Database - additional datasources:
--db-debug-jpql-<datasource> <true|false>
Preview: Used for named <datasource>. Add JPQL information as comments to SQL
Used for named <datasource>. Add JPQL information as comments to SQL
statements to debug JPA SQL statement generation. Default: false.
--db-driver-<datasource> <driver>
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
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-enabled-<datasource> <true|false>
Preview: If the named datasource <datasource> should be enabled at runtime.
Default: true.
If the named datasource <datasource> should be enabled at runtime. Default:
true.
--db-kind-<datasource> <vendor>
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, tidb.
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, tidb.
--db-log-slow-queries-threshold-<datasource> <milliseconds>
Preview: Used for named <datasource>. Log SQL statements slower than the
configured threshold with logger org.hibernate.SQL_SLOW and log-level info.
Default: 10000.
Used for named <datasource>. Log SQL statements slower than the configured
threshold with logger org.hibernate.SQL_SLOW and log-level info. Default:
10000.
--db-password-<datasource> <password>
Preview: Used for named <datasource>. The password of the database user.
Used for named <datasource>. The password of the database user.
--db-pool-initial-size-<datasource> <size>
Preview: Used for named <datasource>. The initial size of the connection pool.
Used for named <datasource>. The initial size of the connection pool.
--db-pool-max-size-<datasource> <size>
Preview: Used for named <datasource>. The maximum size of the connection pool.
Default: 100.
Used for named <datasource>. The maximum size of the connection pool. Default:
100.
--db-pool-min-size-<datasource> <size>
Preview: Used for named <datasource>. The minimal size of the connection pool.
Used for named <datasource>. The minimal size of the connection pool.
--db-schema-<datasource> <schema>
Preview: Used for named <datasource>. The database schema to be used.
Used for named <datasource>. The database schema to be used.
--db-url-database-<datasource> <dbname>
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>
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>
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>
Preview: Used for named <datasource>. Sets the port of the default JDBC URL of
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'.
--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.
--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.
--db-url-properties-<datasource> <properties>
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.
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>
Preview: Used for named <datasource>. The username of the database user.
Used for named <datasource>. The username of the database user.
Transaction:

76
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testImportHelp.approved.txt vendored
View File

@@ -70,62 +70,60 @@ Database:
--db-username <username>
The username of the database user.
Database - additional datasources (Preview):
Database - additional datasources:
--db-debug-jpql-<datasource> <true|false>
Preview: Used for named <datasource>. Add JPQL information as comments to SQL
Used for named <datasource>. Add JPQL information as comments to SQL
statements to debug JPA SQL statement generation. Default: false.
--db-driver-<datasource> <driver>
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
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-enabled-<datasource> <true|false>
Preview: If the named datasource <datasource> should be enabled at runtime.
Default: true.
If the named datasource <datasource> should be enabled at runtime. Default:
true.
--db-kind-<datasource> <vendor>
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, tidb.
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, tidb.
--db-log-slow-queries-threshold-<datasource> <milliseconds>
Preview: Used for named <datasource>. Log SQL statements slower than the
configured threshold with logger org.hibernate.SQL_SLOW and log-level info.
Default: 10000.
Used for named <datasource>. Log SQL statements slower than the configured
threshold with logger org.hibernate.SQL_SLOW and log-level info. Default:
10000.
--db-password-<datasource> <password>
Preview: Used for named <datasource>. The password of the database user.
Used for named <datasource>. The password of the database user.
--db-pool-initial-size-<datasource> <size>
Preview: Used for named <datasource>. The initial size of the connection pool.
Used for named <datasource>. The initial size of the connection pool.
--db-pool-max-size-<datasource> <size>
Preview: Used for named <datasource>. The maximum size of the connection pool.
Default: 100.
Used for named <datasource>. The maximum size of the connection pool. Default:
100.
--db-pool-min-size-<datasource> <size>
Preview: Used for named <datasource>. The minimal size of the connection pool.
Used for named <datasource>. The minimal size of the connection pool.
--db-schema-<datasource> <schema>
Preview: Used for named <datasource>. The database schema to be used.
Used for named <datasource>. The database schema to be used.
--db-url-database-<datasource> <dbname>
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>
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>
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>
Preview: Used for named <datasource>. Sets the port of the default JDBC URL of
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'.
--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.
--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.
--db-url-properties-<datasource> <properties>
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.
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>
Preview: Used for named <datasource>. The username of the database user.
Used for named <datasource>. The username of the database user.
Transaction:

76
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testImportHelpAll.approved.txt vendored
View File

@@ -70,62 +70,60 @@ Database:
--db-username <username>
The username of the database user.
Database - additional datasources (Preview):
Database - additional datasources:
--db-debug-jpql-<datasource> <true|false>
Preview: Used for named <datasource>. Add JPQL information as comments to SQL
Used for named <datasource>. Add JPQL information as comments to SQL
statements to debug JPA SQL statement generation. Default: false.
--db-driver-<datasource> <driver>
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
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-enabled-<datasource> <true|false>
Preview: If the named datasource <datasource> should be enabled at runtime.
Default: true.
If the named datasource <datasource> should be enabled at runtime. Default:
true.
--db-kind-<datasource> <vendor>
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, tidb.
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, tidb.
--db-log-slow-queries-threshold-<datasource> <milliseconds>
Preview: Used for named <datasource>. Log SQL statements slower than the
configured threshold with logger org.hibernate.SQL_SLOW and log-level info.
Default: 10000.
Used for named <datasource>. Log SQL statements slower than the configured
threshold with logger org.hibernate.SQL_SLOW and log-level info. Default:
10000.
--db-password-<datasource> <password>
Preview: Used for named <datasource>. The password of the database user.
Used for named <datasource>. The password of the database user.
--db-pool-initial-size-<datasource> <size>
Preview: Used for named <datasource>. The initial size of the connection pool.
Used for named <datasource>. The initial size of the connection pool.
--db-pool-max-size-<datasource> <size>
Preview: Used for named <datasource>. The maximum size of the connection pool.
Default: 100.
Used for named <datasource>. The maximum size of the connection pool. Default:
100.
--db-pool-min-size-<datasource> <size>
Preview: Used for named <datasource>. The minimal size of the connection pool.
Used for named <datasource>. The minimal size of the connection pool.
--db-schema-<datasource> <schema>
Preview: Used for named <datasource>. The database schema to be used.
Used for named <datasource>. The database schema to be used.
--db-url-database-<datasource> <dbname>
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>
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>
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>
Preview: Used for named <datasource>. Sets the port of the default JDBC URL of
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'.
--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.
--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.
--db-url-properties-<datasource> <properties>
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.
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>
Preview: Used for named <datasource>. The username of the database user.
Used for named <datasource>. The username of the database user.
Transaction:

76
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartDevHelp.approved.txt vendored
View File

@@ -118,62 +118,60 @@ Database:
--db-username <username>
The username of the database user.
Database - additional datasources (Preview):
Database - additional datasources:
--db-debug-jpql-<datasource> <true|false>
Preview: Used for named <datasource>. Add JPQL information as comments to SQL
Used for named <datasource>. Add JPQL information as comments to SQL
statements to debug JPA SQL statement generation. Default: false.
--db-driver-<datasource> <driver>
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
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-enabled-<datasource> <true|false>
Preview: If the named datasource <datasource> should be enabled at runtime.
Default: true.
If the named datasource <datasource> should be enabled at runtime. Default:
true.
--db-kind-<datasource> <vendor>
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, tidb.
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, tidb.
--db-log-slow-queries-threshold-<datasource> <milliseconds>
Preview: Used for named <datasource>. Log SQL statements slower than the
configured threshold with logger org.hibernate.SQL_SLOW and log-level info.
Default: 10000.
Used for named <datasource>. Log SQL statements slower than the configured
threshold with logger org.hibernate.SQL_SLOW and log-level info. Default:
10000.
--db-password-<datasource> <password>
Preview: Used for named <datasource>. The password of the database user.
Used for named <datasource>. The password of the database user.
--db-pool-initial-size-<datasource> <size>
Preview: Used for named <datasource>. The initial size of the connection pool.
Used for named <datasource>. The initial size of the connection pool.
--db-pool-max-size-<datasource> <size>
Preview: Used for named <datasource>. The maximum size of the connection pool.
Default: 100.
Used for named <datasource>. The maximum size of the connection pool. Default:
100.
--db-pool-min-size-<datasource> <size>
Preview: Used for named <datasource>. The minimal size of the connection pool.
Used for named <datasource>. The minimal size of the connection pool.
--db-schema-<datasource> <schema>
Preview: Used for named <datasource>. The database schema to be used.
Used for named <datasource>. The database schema to be used.
--db-url-database-<datasource> <dbname>
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>
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>
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>
Preview: Used for named <datasource>. Sets the port of the default JDBC URL of
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'.
--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.
--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.
--db-url-properties-<datasource> <properties>
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.
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>
Preview: Used for named <datasource>. The username of the database user.
Used for named <datasource>. The username of the database user.
Transaction:

78
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartDevHelpAll.approved.txt vendored
View File

@@ -188,62 +188,60 @@ Database:
--db-username <username>
The username of the database user.
Database - additional datasources (Preview):
Database - additional datasources:
--db-debug-jpql-<datasource> <true|false>
Preview: Used for named <datasource>. Add JPQL information as comments to SQL
Used for named <datasource>. Add JPQL information as comments to SQL
statements to debug JPA SQL statement generation. Default: false.
--db-driver-<datasource> <driver>
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
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-enabled-<datasource> <true|false>
Preview: If the named datasource <datasource> should be enabled at runtime.
Default: true.
If the named datasource <datasource> should be enabled at runtime. Default:
true.
--db-kind-<datasource> <vendor>
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, tidb.
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, tidb.
--db-log-slow-queries-threshold-<datasource> <milliseconds>
Preview: Used for named <datasource>. Log SQL statements slower than the
configured threshold with logger org.hibernate.SQL_SLOW and log-level info.
Default: 10000.
Used for named <datasource>. Log SQL statements slower than the configured
threshold with logger org.hibernate.SQL_SLOW and log-level info. Default:
10000.
--db-password-<datasource> <password>
Preview: Used for named <datasource>. The password of the database user.
Used for named <datasource>. The password of the database user.
--db-pool-initial-size-<datasource> <size>
Preview: Used for named <datasource>. The initial size of the connection pool.
Used for named <datasource>. The initial size of the connection pool.
--db-pool-max-size-<datasource> <size>
Preview: Used for named <datasource>. The maximum size of the connection pool.
Default: 100.
Used for named <datasource>. The maximum size of the connection pool. Default:
100.
--db-pool-min-size-<datasource> <size>
Preview: Used for named <datasource>. The minimal size of the connection pool.
Used for named <datasource>. The minimal size of the connection pool.
--db-schema-<datasource> <schema>
Preview: Used for named <datasource>. The database schema to be used.
Used for named <datasource>. The database schema to be used.
--db-url-database-<datasource> <dbname>
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>
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>
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>
Preview: Used for named <datasource>. Sets the port of the default JDBC URL of
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'.
--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.
--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.
--db-url-properties-<datasource> <properties>
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.
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>
Preview: Used for named <datasource>. The username of the database user.
Used for named <datasource>. The username of the database user.
Transaction:
@@ -718,4 +716,4 @@ Bootstrap Admin:
Do NOT start the server using this command when deploying to production.
Use 'kc.sh start-dev --help-all' to list all available options, including build
options.
options.

76
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartHelp.approved.txt vendored
View File

@@ -166,62 +166,60 @@ Database:
--db-username <username>
The username of the database user.
Database - additional datasources (Preview):
Database - additional datasources:
--db-debug-jpql-<datasource> <true|false>
Preview: Used for named <datasource>. Add JPQL information as comments to SQL
Used for named <datasource>. Add JPQL information as comments to SQL
statements to debug JPA SQL statement generation. Default: false.
--db-driver-<datasource> <driver>
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
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-enabled-<datasource> <true|false>
Preview: If the named datasource <datasource> should be enabled at runtime.
Default: true.
If the named datasource <datasource> should be enabled at runtime. Default:
true.
--db-kind-<datasource> <vendor>
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, tidb.
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, tidb.
--db-log-slow-queries-threshold-<datasource> <milliseconds>
Preview: Used for named <datasource>. Log SQL statements slower than the
configured threshold with logger org.hibernate.SQL_SLOW and log-level info.
Default: 10000.
Used for named <datasource>. Log SQL statements slower than the configured
threshold with logger org.hibernate.SQL_SLOW and log-level info. Default:
10000.
--db-password-<datasource> <password>
Preview: Used for named <datasource>. The password of the database user.
Used for named <datasource>. The password of the database user.
--db-pool-initial-size-<datasource> <size>
Preview: Used for named <datasource>. The initial size of the connection pool.
Used for named <datasource>. The initial size of the connection pool.
--db-pool-max-size-<datasource> <size>
Preview: Used for named <datasource>. The maximum size of the connection pool.
Default: 100.
Used for named <datasource>. The maximum size of the connection pool. Default:
100.
--db-pool-min-size-<datasource> <size>
Preview: Used for named <datasource>. The minimal size of the connection pool.
Used for named <datasource>. The minimal size of the connection pool.
--db-schema-<datasource> <schema>
Preview: Used for named <datasource>. The database schema to be used.
Used for named <datasource>. The database schema to be used.
--db-url-database-<datasource> <dbname>
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>
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>
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>
Preview: Used for named <datasource>. Sets the port of the default JDBC URL of
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'.
--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.
--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.
--db-url-properties-<datasource> <properties>
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.
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>
Preview: Used for named <datasource>. The username of the database user.
Used for named <datasource>. The username of the database user.
Transaction:

78
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartHelpAll.approved.txt vendored
View File

@@ -189,62 +189,60 @@ Database:
--db-username <username>
The username of the database user.
Database - additional datasources (Preview):
Database - additional datasources:
--db-debug-jpql-<datasource> <true|false>
Preview: Used for named <datasource>. Add JPQL information as comments to SQL
Used for named <datasource>. Add JPQL information as comments to SQL
statements to debug JPA SQL statement generation. Default: false.
--db-driver-<datasource> <driver>
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
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-enabled-<datasource> <true|false>
Preview: If the named datasource <datasource> should be enabled at runtime.
Default: true.
If the named datasource <datasource> should be enabled at runtime. Default:
true.
--db-kind-<datasource> <vendor>
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, tidb.
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, tidb.
--db-log-slow-queries-threshold-<datasource> <milliseconds>
Preview: Used for named <datasource>. Log SQL statements slower than the
configured threshold with logger org.hibernate.SQL_SLOW and log-level info.
Default: 10000.
Used for named <datasource>. Log SQL statements slower than the configured
threshold with logger org.hibernate.SQL_SLOW and log-level info. Default:
10000.
--db-password-<datasource> <password>
Preview: Used for named <datasource>. The password of the database user.
Used for named <datasource>. The password of the database user.
--db-pool-initial-size-<datasource> <size>
Preview: Used for named <datasource>. The initial size of the connection pool.
Used for named <datasource>. The initial size of the connection pool.
--db-pool-max-size-<datasource> <size>
Preview: Used for named <datasource>. The maximum size of the connection pool.
Default: 100.
Used for named <datasource>. The maximum size of the connection pool. Default:
100.
--db-pool-min-size-<datasource> <size>
Preview: Used for named <datasource>. The minimal size of the connection pool.
Used for named <datasource>. The minimal size of the connection pool.
--db-schema-<datasource> <schema>
Preview: Used for named <datasource>. The database schema to be used.
Used for named <datasource>. The database schema to be used.
--db-url-database-<datasource> <dbname>
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>
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>
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>
Preview: Used for named <datasource>. Sets the port of the default JDBC URL of
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'.
--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.
--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.
--db-url-properties-<datasource> <properties>
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.
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>
Preview: Used for named <datasource>. The username of the database user.
Used for named <datasource>. The username of the database user.
Transaction:
@@ -723,4 +721,4 @@ By default, this command tries to update the server configuration by running a
$ kc.sh start '--optimized'
By doing that, the server should start faster based on any previous
configuration you have set when manually running the 'build' command.
configuration you have set when manually running the 'build' command.

64
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartOptimizedHelp.approved.txt vendored
View File

@@ -160,53 +160,51 @@ Database:
--db-username <username>
The username of the database user.
Database - additional datasources (Preview):
Database - additional datasources:
--db-debug-jpql-<datasource> <true|false>
Preview: Used for named <datasource>. Add JPQL information as comments to SQL
Used for named <datasource>. Add JPQL information as comments to SQL
statements to debug JPA SQL statement generation. Default: false.
--db-enabled-<datasource> <true|false>
Preview: If the named datasource <datasource> should be enabled at runtime.
Default: true.
If the named datasource <datasource> should be enabled at runtime. Default:
true.
--db-log-slow-queries-threshold-<datasource> <milliseconds>
Preview: Used for named <datasource>. Log SQL statements slower than the
configured threshold with logger org.hibernate.SQL_SLOW and log-level info.
Default: 10000.
Used for named <datasource>. Log SQL statements slower than the configured
threshold with logger org.hibernate.SQL_SLOW and log-level info. Default:
10000.
--db-password-<datasource> <password>
Preview: Used for named <datasource>. The password of the database user.
Used for named <datasource>. The password of the database user.
--db-pool-initial-size-<datasource> <size>
Preview: Used for named <datasource>. The initial size of the connection pool.
Used for named <datasource>. The initial size of the connection pool.
--db-pool-max-size-<datasource> <size>
Preview: Used for named <datasource>. The maximum size of the connection pool.
Default: 100.
Used for named <datasource>. The maximum size of the connection pool. Default:
100.
--db-pool-min-size-<datasource> <size>
Preview: Used for named <datasource>. The minimal size of the connection pool.
Used for named <datasource>. The minimal size of the connection pool.
--db-schema-<datasource> <schema>
Preview: Used for named <datasource>. The database schema to be used.
Used for named <datasource>. The database schema to be used.
--db-url-database-<datasource> <dbname>
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>
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>
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>
Preview: Used for named <datasource>. Sets the port of the default JDBC URL of
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'.
--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.
--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.
--db-url-properties-<datasource> <properties>
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.
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>
Preview: Used for named <datasource>. The username of the database user.
Used for named <datasource>. The username of the database user.
Hostname v2:

66
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartOptimizedHelpAll.approved.txt vendored
View File

@@ -183,53 +183,51 @@ Database:
--db-username <username>
The username of the database user.
Database - additional datasources (Preview):
Database - additional datasources:
--db-debug-jpql-<datasource> <true|false>
Preview: Used for named <datasource>. Add JPQL information as comments to SQL
Used for named <datasource>. Add JPQL information as comments to SQL
statements to debug JPA SQL statement generation. Default: false.
--db-enabled-<datasource> <true|false>
Preview: If the named datasource <datasource> should be enabled at runtime.
Default: true.
If the named datasource <datasource> should be enabled at runtime. Default:
true.
--db-log-slow-queries-threshold-<datasource> <milliseconds>
Preview: Used for named <datasource>. Log SQL statements slower than the
configured threshold with logger org.hibernate.SQL_SLOW and log-level info.
Default: 10000.
Used for named <datasource>. Log SQL statements slower than the configured
threshold with logger org.hibernate.SQL_SLOW and log-level info. Default:
10000.
--db-password-<datasource> <password>
Preview: Used for named <datasource>. The password of the database user.
Used for named <datasource>. The password of the database user.
--db-pool-initial-size-<datasource> <size>
Preview: Used for named <datasource>. The initial size of the connection pool.
Used for named <datasource>. The initial size of the connection pool.
--db-pool-max-size-<datasource> <size>
Preview: Used for named <datasource>. The maximum size of the connection pool.
Default: 100.
Used for named <datasource>. The maximum size of the connection pool. Default:
100.
--db-pool-min-size-<datasource> <size>
Preview: Used for named <datasource>. The minimal size of the connection pool.
Used for named <datasource>. The minimal size of the connection pool.
--db-schema-<datasource> <schema>
Preview: Used for named <datasource>. The database schema to be used.
Used for named <datasource>. The database schema to be used.
--db-url-database-<datasource> <dbname>
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>
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>
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>
Preview: Used for named <datasource>. Sets the port of the default JDBC URL of
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'.
--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.
--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.
--db-url-properties-<datasource> <properties>
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.
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>
Preview: Used for named <datasource>. The username of the database user.
Used for named <datasource>. The username of the database user.
Hostname v2:
@@ -630,4 +628,4 @@ By default, this command tries to update the server configuration by running a
$ kc.sh start '--optimized'
By doing that, the server should start faster based on any previous
configuration you have set when manually running the 'build' command.
configuration you have set when manually running the 'build' command.

76
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testUpdateCompatibilityCheckHelp.approved.txt vendored
View File

@@ -165,62 +165,60 @@ Database:
--db-username <username>
The username of the database user.
Database - additional datasources (Preview):
Database - additional datasources:
--db-debug-jpql-<datasource> <true|false>
Preview: Used for named <datasource>. Add JPQL information as comments to SQL
Used for named <datasource>. Add JPQL information as comments to SQL
statements to debug JPA SQL statement generation. Default: false.
--db-driver-<datasource> <driver>
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
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-enabled-<datasource> <true|false>
Preview: If the named datasource <datasource> should be enabled at runtime.
Default: true.
If the named datasource <datasource> should be enabled at runtime. Default:
true.
--db-kind-<datasource> <vendor>
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, tidb.
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, tidb.
--db-log-slow-queries-threshold-<datasource> <milliseconds>
Preview: Used for named <datasource>. Log SQL statements slower than the
configured threshold with logger org.hibernate.SQL_SLOW and log-level info.
Default: 10000.
Used for named <datasource>. Log SQL statements slower than the configured
threshold with logger org.hibernate.SQL_SLOW and log-level info. Default:
10000.
--db-password-<datasource> <password>
Preview: Used for named <datasource>. The password of the database user.
Used for named <datasource>. The password of the database user.
--db-pool-initial-size-<datasource> <size>
Preview: Used for named <datasource>. The initial size of the connection pool.
Used for named <datasource>. The initial size of the connection pool.
--db-pool-max-size-<datasource> <size>
Preview: Used for named <datasource>. The maximum size of the connection pool.
Default: 100.
Used for named <datasource>. The maximum size of the connection pool. Default:
100.
--db-pool-min-size-<datasource> <size>
Preview: Used for named <datasource>. The minimal size of the connection pool.
Used for named <datasource>. The minimal size of the connection pool.
--db-schema-<datasource> <schema>
Preview: Used for named <datasource>. The database schema to be used.
Used for named <datasource>. The database schema to be used.
--db-url-database-<datasource> <dbname>
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>
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>
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>
Preview: Used for named <datasource>. Sets the port of the default JDBC URL of
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'.
--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.
--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.
--db-url-properties-<datasource> <properties>
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.
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>
Preview: Used for named <datasource>. The username of the database user.
Used for named <datasource>. The username of the database user.
Transaction:

78
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testUpdateCompatibilityCheckHelpAll.approved.txt vendored
View File

@@ -188,62 +188,60 @@ Database:
--db-username <username>
The username of the database user.
Database - additional datasources (Preview):
Database - additional datasources:
--db-debug-jpql-<datasource> <true|false>
Preview: Used for named <datasource>. Add JPQL information as comments to SQL
Used for named <datasource>. Add JPQL information as comments to SQL
statements to debug JPA SQL statement generation. Default: false.
--db-driver-<datasource> <driver>
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
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-enabled-<datasource> <true|false>
Preview: If the named datasource <datasource> should be enabled at runtime.
Default: true.
If the named datasource <datasource> should be enabled at runtime. Default:
true.
--db-kind-<datasource> <vendor>
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, tidb.
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, tidb.
--db-log-slow-queries-threshold-<datasource> <milliseconds>
Preview: Used for named <datasource>. Log SQL statements slower than the
configured threshold with logger org.hibernate.SQL_SLOW and log-level info.
Default: 10000.
Used for named <datasource>. Log SQL statements slower than the configured
threshold with logger org.hibernate.SQL_SLOW and log-level info. Default:
10000.
--db-password-<datasource> <password>
Preview: Used for named <datasource>. The password of the database user.
Used for named <datasource>. The password of the database user.
--db-pool-initial-size-<datasource> <size>
Preview: Used for named <datasource>. The initial size of the connection pool.
Used for named <datasource>. The initial size of the connection pool.
--db-pool-max-size-<datasource> <size>
Preview: Used for named <datasource>. The maximum size of the connection pool.
Default: 100.
Used for named <datasource>. The maximum size of the connection pool. Default:
100.
--db-pool-min-size-<datasource> <size>
Preview: Used for named <datasource>. The minimal size of the connection pool.
Used for named <datasource>. The minimal size of the connection pool.
--db-schema-<datasource> <schema>
Preview: Used for named <datasource>. The database schema to be used.
Used for named <datasource>. The database schema to be used.
--db-url-database-<datasource> <dbname>
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>
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>
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>
Preview: Used for named <datasource>. Sets the port of the default JDBC URL of
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'.
--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.
--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.
--db-url-properties-<datasource> <properties>
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.
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>
Preview: Used for named <datasource>. The username of the database user.
Used for named <datasource>. The username of the database user.
Transaction:
@@ -713,4 +711,4 @@ Bootstrap Admin:
--bootstrap-admin-username <username>
Temporary bootstrap admin username. Used only when the master realm is
created. Available only when bootstrap admin password is set. Default:
temp-admin.
temp-admin.

76
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testUpdateCompatibilityMetadataHelp.approved.txt vendored
View File

@@ -163,62 +163,60 @@ Database:
--db-username <username>
The username of the database user.
Database - additional datasources (Preview):
Database - additional datasources:
--db-debug-jpql-<datasource> <true|false>
Preview: Used for named <datasource>. Add JPQL information as comments to SQL
Used for named <datasource>. Add JPQL information as comments to SQL
statements to debug JPA SQL statement generation. Default: false.
--db-driver-<datasource> <driver>
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
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-enabled-<datasource> <true|false>
Preview: If the named datasource <datasource> should be enabled at runtime.
Default: true.
If the named datasource <datasource> should be enabled at runtime. Default:
true.
--db-kind-<datasource> <vendor>
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, tidb.
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, tidb.
--db-log-slow-queries-threshold-<datasource> <milliseconds>
Preview: Used for named <datasource>. Log SQL statements slower than the
configured threshold with logger org.hibernate.SQL_SLOW and log-level info.
Default: 10000.
Used for named <datasource>. Log SQL statements slower than the configured
threshold with logger org.hibernate.SQL_SLOW and log-level info. Default:
10000.
--db-password-<datasource> <password>
Preview: Used for named <datasource>. The password of the database user.
Used for named <datasource>. The password of the database user.
--db-pool-initial-size-<datasource> <size>
Preview: Used for named <datasource>. The initial size of the connection pool.
Used for named <datasource>. The initial size of the connection pool.
--db-pool-max-size-<datasource> <size>
Preview: Used for named <datasource>. The maximum size of the connection pool.
Default: 100.
Used for named <datasource>. The maximum size of the connection pool. Default:
100.
--db-pool-min-size-<datasource> <size>
Preview: Used for named <datasource>. The minimal size of the connection pool.
Used for named <datasource>. The minimal size of the connection pool.
--db-schema-<datasource> <schema>
Preview: Used for named <datasource>. The database schema to be used.
Used for named <datasource>. The database schema to be used.
--db-url-database-<datasource> <dbname>
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>
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>
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>
Preview: Used for named <datasource>. Sets the port of the default JDBC URL of
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'.
--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.
--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.
--db-url-properties-<datasource> <properties>
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.
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>
Preview: Used for named <datasource>. The username of the database user.
Used for named <datasource>. The username of the database user.
Transaction:

78
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testUpdateCompatibilityMetadataHelpAll.approved.txt vendored
View File

@@ -186,62 +186,60 @@ Database:
--db-username <username>
The username of the database user.
Database - additional datasources (Preview):
Database - additional datasources:
--db-debug-jpql-<datasource> <true|false>
Preview: Used for named <datasource>. Add JPQL information as comments to SQL
Used for named <datasource>. Add JPQL information as comments to SQL
statements to debug JPA SQL statement generation. Default: false.
--db-driver-<datasource> <driver>
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
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-enabled-<datasource> <true|false>
Preview: If the named datasource <datasource> should be enabled at runtime.
Default: true.
If the named datasource <datasource> should be enabled at runtime. Default:
true.
--db-kind-<datasource> <vendor>
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, tidb.
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, tidb.
--db-log-slow-queries-threshold-<datasource> <milliseconds>
Preview: Used for named <datasource>. Log SQL statements slower than the
configured threshold with logger org.hibernate.SQL_SLOW and log-level info.
Default: 10000.
Used for named <datasource>. Log SQL statements slower than the configured
threshold with logger org.hibernate.SQL_SLOW and log-level info. Default:
10000.
--db-password-<datasource> <password>
Preview: Used for named <datasource>. The password of the database user.
Used for named <datasource>. The password of the database user.
--db-pool-initial-size-<datasource> <size>
Preview: Used for named <datasource>. The initial size of the connection pool.
Used for named <datasource>. The initial size of the connection pool.
--db-pool-max-size-<datasource> <size>
Preview: Used for named <datasource>. The maximum size of the connection pool.
Default: 100.
Used for named <datasource>. The maximum size of the connection pool. Default:
100.
--db-pool-min-size-<datasource> <size>
Preview: Used for named <datasource>. The minimal size of the connection pool.
Used for named <datasource>. The minimal size of the connection pool.
--db-schema-<datasource> <schema>
Preview: Used for named <datasource>. The database schema to be used.
Used for named <datasource>. The database schema to be used.
--db-url-database-<datasource> <dbname>
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>
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>
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>
Preview: Used for named <datasource>. Sets the port of the default JDBC URL of
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'.
--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.
--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.
--db-url-properties-<datasource> <properties>
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.
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>
Preview: Used for named <datasource>. The username of the database user.
Used for named <datasource>. The username of the database user.
Transaction:
@@ -711,4 +709,4 @@ Bootstrap Admin:
--bootstrap-admin-username <username>
Temporary bootstrap admin username. Used only when the master realm is
created. Available only when bootstrap admin password is set. Default:
temp-admin.
temp-admin.