All configuration options
Configuration property fixed at build time - All other configuration properties are overridable at runtime
Type |
Default |
|||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
The exception classes expected to be thrown by the handler. Any exception thrown by the handler that is an instance of a class in this list will not be logged, but will otherwise be handled normally by the lambda runtime. This is useful for avoiding unnecessary stack traces while preserving the ability to log unexpected exceptions. Environment variable: |
list of class name |
|||||||||||||||||||||||||||||||||
The handler name. Handler names are specified on handler classes using the Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
Port to access mock event server in dev mode Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
Port to access mock event server in dev mode Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
Enable security mechanisms to process lambda and AWS based security (i.e. Cognito, IAM) from the http event sent from API Gateway Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
If true, runtime will search Cognito JWT claims for "cognito:groups" and add them as Quarkus security roles. True by default Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Cognito claim that contains roles you want to map. Defaults to "cognito:groups" Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Regular expression to locate role values within a Cognito claim string. By default it looks for space delimited strings enclosed in brackets "[^\[\] \t]+" Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
If we create a JDBC datasource for this datasource. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The datasource driver class name Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Whether we want to use regular JDBC transactions, XA, or disable all transactional capabilities.
When enabling XA you will need a driver implementing Environment variable: |
|
|
||||||||||||||||||||||||||||||||
Enable datasource metrics collection. If unspecified, collecting metrics will be enabled by default if a metrics extension is active. Environment variable: |
boolean |
|||||||||||||||||||||||||||||||||
Enable JDBC tracing. Disabled by default. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Enable OpenTelemetry JDBC instrumentation. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The datasource URL Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The initial size of the pool. Usually you will want to set the initial size to match at least the minimal size, but this is not enforced so to allow for architectures which prefer a lazy initialization of the connections on boot, while being able to sustain a minimal pool size after boot. Environment variable: |
int |
|||||||||||||||||||||||||||||||||
The datasource pool minimum size Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
The datasource pool maximum size Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
The interval at which we validate idle connections in the background.
Set to Environment variable: |
|
|||||||||||||||||||||||||||||||||
Perform foreground validation on connections that have been idle for longer than the specified interval. Environment variable: |
||||||||||||||||||||||||||||||||||
The timeout before cancelling the acquisition of a new connection Environment variable: |
|
|||||||||||||||||||||||||||||||||
The interval at which we check for connection leaks. Environment variable: |
||||||||||||||||||||||||||||||||||
The interval at which we try to remove idle connections. Environment variable: |
|
|||||||||||||||||||||||||||||||||
The max lifetime of a connection. Environment variable: |
||||||||||||||||||||||||||||||||||
The transaction isolation level. Environment variable: |
|
|||||||||||||||||||||||||||||||||
Collect and display extra troubleshooting info on leaked connections. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Allows connections to be flushed upon return to the pool. It’s not enabled by default. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
When enabled Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there’s high confidence that no leaks are happening. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Query executed when first using a connection. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Query executed to validate a connection. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Disable pooling to prevent reuse of Connections. Use this with when an external pool manages the life-cycle of Connections. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Require an active transaction when acquiring a connection. Recommended for production. WARNING: Some extensions acquire connections without holding a transaction for things like schema updates and schema validation. Setting this setting to STRICT may lead to failures in those cases. Environment variable: |
|
|||||||||||||||||||||||||||||||||
Enable JDBC tracing. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Trace calls with active Spans only Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Ignore specific queries from being traced Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Enable OpenTelemetry JDBC instrumentation. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Other unspecified properties to be passed to the JDBC driver when creating new connections. Environment variable: |
|
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
If we create a JDBC datasource for this datasource. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The datasource driver class name Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Whether we want to use regular JDBC transactions, XA, or disable all transactional capabilities.
When enabling XA you will need a driver implementing Environment variable: |
|
|
||||||||||||||||||||||||||||||||
Enable datasource metrics collection. If unspecified, collecting metrics will be enabled by default if a metrics extension is active. Environment variable: |
boolean |
|||||||||||||||||||||||||||||||||
Enable JDBC tracing. Disabled by default. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Enable OpenTelemetry JDBC instrumentation. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The datasource URL Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The initial size of the pool. Usually you will want to set the initial size to match at least the minimal size, but this is not enforced so to allow for architectures which prefer a lazy initialization of the connections on boot, while being able to sustain a minimal pool size after boot. Environment variable: |
int |
|||||||||||||||||||||||||||||||||
The datasource pool minimum size Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
The datasource pool maximum size Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
The interval at which we validate idle connections in the background.
Set to Environment variable: |
|
|||||||||||||||||||||||||||||||||
Perform foreground validation on connections that have been idle for longer than the specified interval. Environment variable: |
||||||||||||||||||||||||||||||||||
The timeout before cancelling the acquisition of a new connection Environment variable: |
|
|||||||||||||||||||||||||||||||||
The interval at which we check for connection leaks. Environment variable: |
||||||||||||||||||||||||||||||||||
The interval at which we try to remove idle connections. Environment variable: |
|
|||||||||||||||||||||||||||||||||
The max lifetime of a connection. Environment variable: |
||||||||||||||||||||||||||||||||||
The transaction isolation level. Environment variable: |
|
|||||||||||||||||||||||||||||||||
Collect and display extra troubleshooting info on leaked connections. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Allows connections to be flushed upon return to the pool. It’s not enabled by default. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
When enabled Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there’s high confidence that no leaks are happening. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Query executed when first using a connection. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Query executed to validate a connection. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Disable pooling to prevent reuse of Connections. Use this with when an external pool manages the life-cycle of Connections. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Require an active transaction when acquiring a connection. Recommended for production. WARNING: Some extensions acquire connections without holding a transaction for things like schema updates and schema validation. Setting this setting to STRICT may lead to failures in those cases. Environment variable: |
|
|||||||||||||||||||||||||||||||||
Other unspecified properties to be passed to the JDBC driver when creating new connections. Environment variable: |
|
|||||||||||||||||||||||||||||||||
Enable JDBC tracing. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Trace calls with active Spans only Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Ignore specific queries from being traced Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Enable OpenTelemetry JDBC instrumentation. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
Whether a health check is published in case the smallrye-health extension is present.
If you enable the health check, you must specify the Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Whether to enable Snappy in native mode. Note that Snappy requires GraalVM 21+ and embeds a native library in the native executable. This library is unpacked and loaded when the application starts. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
If Dev Services for Kafka has been explicitly enabled or disabled. Dev Services are generally enabled by default, unless there is an existing configuration present. For Kafka, Dev Services starts a broker unless Environment variable: |
boolean |
|||||||||||||||||||||||||||||||||
Optional fixed port the dev service will listen to. If not defined, the port will be chosen randomly. Environment variable: |
int |
|||||||||||||||||||||||||||||||||
Kafka dev service container type. Redpanda, Strimzi and kafka-native container providers are supported. Default is redpanda. For Redpanda: See https://vectorized.io/docs/quick-start-docker/ and https://hub.docker.com/r/vectorized/redpanda For Strimzi: See https://github.com/strimzi/test-container and https://quay.io/repository/strimzi-test-container/test-container For Kafka Native: See https://github.com/ozangunalp/kafka-native and https://quay.io/repository/ogunalp/kafka-native Note that Strimzi and Kafka Native images are launched in Kraft mode. Environment variable: |
|
|
||||||||||||||||||||||||||||||||
The Kafka container image to use. Dependent on the provider. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Indicates if the Kafka broker managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for Kafka starts a new container.
The discovery uses the Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The value of the Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Timeout for admin client calls used in topic creation. Defaults to 2 seconds. Environment variable: |
|
|||||||||||||||||||||||||||||||||
Enables transaction support. Also enables the producer idempotence. Find more info about Red Panda transaction support on https://vectorized.io/blog/fast-transactions/. Notice that KIP-447 (producer scalability for exactly once semantic) and KIP-360 (Improve reliability of idempotent/transactional producer) are not supported. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The topic-partition pairs to create in the Dev Services Kafka broker. After the broker is started, given topics with partitions are created, skipping already existing topics. For example, Environment variable: |
|
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
Whether a health check is published in case the smallrye-health extension is present (defaults to true). Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
A unique identifier for this Kafka Streams application. If not set, defaults to quarkus.application.name. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
A comma-separated list of host:port pairs identifying the Kafka bootstrap server(s). If not set, fallback to Environment variable: |
list of host:port |
|
||||||||||||||||||||||||||||||||
A unique identifier of this application instance, typically in the form host:port. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
A comma-separated list of topic names. The pipeline will only be started once all these topics are present in the Kafka cluster and Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
Timeout to wait for topic names to be returned from admin client. If set to 0 (or negative), Environment variable: |
|
|||||||||||||||||||||||||||||||||
The schema registry key. Different schema registry libraries expect a registry URL in different configuration properties. For Apicurio Registry, use Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The schema registry URL. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The security protocol to use See https://docs.confluent.io/current/streams/developer-guide/security.html#security-example Environment variable: |
string |
|||||||||||||||||||||||||||||||||
SASL mechanism used for client connections Environment variable: |
string |
|||||||||||||||||||||||||||||||||
JAAS login context parameters for SASL connections in the format used by JAAS configuration files Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The fully qualified name of a SASL client callback handler class Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The fully qualified name of a SASL login callback handler class Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The fully qualified name of a class that implements the Login interface Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The Kerberos principal name that Kafka runs as Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Kerberos kinit command path Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Login thread will sleep until the specified window factor of time from last refresh Environment variable: |
double |
|||||||||||||||||||||||||||||||||
Percentage of random jitter added to the renewal time Environment variable: |
double |
|||||||||||||||||||||||||||||||||
Percentage of random jitter added to the renewal time Environment variable: |
long |
|||||||||||||||||||||||||||||||||
Login refresh thread will sleep until the specified window factor relative to the credential’s lifetime has been reached- Environment variable: |
double |
|||||||||||||||||||||||||||||||||
The maximum amount of random jitter relative to the credential’s lifetime Environment variable: |
double |
|||||||||||||||||||||||||||||||||
The desired minimum duration for the login refresh thread to wait before refreshing a credential Environment variable: |
||||||||||||||||||||||||||||||||||
The amount of buffer duration before credential expiration to maintain when refreshing a credential Environment variable: |
||||||||||||||||||||||||||||||||||
The SSL protocol used to generate the SSLContext Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The name of the security provider used for SSL connections Environment variable: |
string |
|||||||||||||||||||||||||||||||||
A list of cipher suites Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The list of protocols enabled for SSL connections Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Trust store type Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Trust store location Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Trust store password Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Trust store certificates Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Key store type Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Key store location Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Key store password Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Key store private key Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Key store certificate chain Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Password of the private key in the key store Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The algorithm used by key manager factory for SSL connections Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The algorithm used by trust manager factory for SSL connections Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The endpoint identification algorithm to validate server hostname using server certificate Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The SecureRandom PRNG implementation to use for SSL cryptography operations Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
If set to true Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
If set to true, the bytecode of unproxyable beans will be transformed. This ensures that a proxy/subclass can be created properly. If the value is set to false, then an exception is thrown at build time indicating that a subclass/proxy could not be created. Quarkus performs the following transformations when this setting is enabled: - Remove 'final' modifier from classes and methods when a proxy is required. - Create a no-args constructor if needed. - Makes private no-args constructors package-private if necessary. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
If set to true, the bytecode of private fields that are injection points will be transformed to package private. This ensures that field injection can be performed completely reflection-free. If the value is set to false, then a reflection fallback is used to perform the injection. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
If set to true (the default), the build fails if a private method that is neither an observer nor a producer, is annotated with an interceptor binding. An example of this is the use of Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The list of selected alternatives for an application.
An element value can be:
- a fully qualified class name, i.e. Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
If set to true then Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The list of types that should be excluded from discovery.
An element value can be:
- a fully qualified class name, i.e. Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
List of types that should be considered unremovable regardless of whether they are directly used or not. This is a configuration option equivalent to using Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
If set to true then the container attempts to detect "unused removed beans" false positives during programmatic lookup at runtime. You can disable this feature to conserve some memory when running your application in production. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
If set to true then the container attempts to detect wrong usages of annotations and eventually fails the build to prevent unexpected behavior of a Quarkus application.
A typical example is Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
If set to Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
If set to true then the container monitors business method invocations and fired events during the development mode. NOTE: This config property should not be changed in the development mode as it requires a full rebuild of the application Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
If set to true then disable Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The list of packages that will not be checked for split package issues.
A package string representation can be:
- a full name of the package, i.e. Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
If set to true and SmallRye Context Propagation extension is present then enable the context propagation for CDI contexts. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
The maven groupId of the artifact. Environment variable: |
string |
required |
||||||||||||||||||||||||||||||||
The maven artifactId of the artifact. Environment variable: |
string |
required |
||||||||||||||||||||||||||||||||
The maven classifier of the artifact. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
Cache type. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Whether or not the cache extension is enabled. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Default configuration applied to all Caffeine caches (lowest precedence) |
Type |
Default |
||||||||||||||||||||||||||||||||
Minimum total size for the internal data structures. Providing a large enough estimate at construction time avoids the need for expensive resizing operations later, but setting this value unnecessarily high wastes memory. Environment variable: |
int |
|||||||||||||||||||||||||||||||||
Maximum number of entries the cache may contain. Note that the cache may evict an entry before this limit is exceeded or temporarily exceed the threshold while evicting. As the cache size grows close to the maximum, the cache evicts entries that are less likely to be used again. For example, the cache may evict an entry because it hasn’t been used recently or very often. Environment variable: |
long |
|||||||||||||||||||||||||||||||||
Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry’s creation, or the most recent replacement of its value. Environment variable: |
||||||||||||||||||||||||||||||||||
Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry’s creation, the most recent replacement of its value, or its last read. Environment variable: |
||||||||||||||||||||||||||||||||||
Whether or not metrics are recorded if the application depends on the Micrometer extension. Setting this value to Environment variable: |
boolean |
|||||||||||||||||||||||||||||||||
Additional configuration applied to a specific Caffeine cache (highest precedence) |
Type |
Default |
||||||||||||||||||||||||||||||||
Minimum total size for the internal data structures. Providing a large enough estimate at construction time avoids the need for expensive resizing operations later, but setting this value unnecessarily high wastes memory. Environment variable: |
int |
|||||||||||||||||||||||||||||||||
Maximum number of entries the cache may contain. Note that the cache may evict an entry before this limit is exceeded or temporarily exceed the threshold while evicting. As the cache size grows close to the maximum, the cache evicts entries that are less likely to be used again. For example, the cache may evict an entry because it hasn’t been used recently or very often. Environment variable: |
long |
|||||||||||||||||||||||||||||||||
Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry’s creation, or the most recent replacement of its value. Environment variable: |
||||||||||||||||||||||||||||||||||
Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry’s creation, the most recent replacement of its value, or its last read. Environment variable: |
||||||||||||||||||||||||||||||||||
Whether or not metrics are recorded if the application depends on the Micrometer extension. Setting this value to Environment variable: |
boolean |
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
The group the container image will be part of Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The name of the container image. If not set defaults to the application name Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The tag of the container image. If not set defaults to the application version Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Additional tags of the container image. Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
The container registry to use Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Represents the entire image string. If set, then Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The username to use to authenticate with the registry where the built image will be pushed Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The password to use to authenticate with the registry where the built image will be pushed Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Whether or not insecure registries are allowed Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Whether or not a image build will be performed. Environment variable: |
boolean |
|||||||||||||||||||||||||||||||||
Whether or not an image push will be performed. Environment variable: |
boolean |
|||||||||||||||||||||||||||||||||
The name of the container image extension to use (e.g. docker, jib, s2i). The option will be used in case multiple extensions are present. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Custom labels to add to the generated image. Environment variable: |
|
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
The buildpacks builder image to use when building the project in jvm mode. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The buildpacks builder image to use when building the project in jvm mode. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The buildpacks run image to use when building the project When not supplied, the run image is determined by the builder image. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Max pull timeout for builder/run images, in seconds Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
DOCKER_HOST value to use. If not set, the env var DOCKER_HOST is used, if that is not set the value `unix:///var/run/docker.sock' (or 'npipe:///./pipe/docker_engine' for windows) is used. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Log level to use.. Defaults to 'info' Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The username to use to authenticate with the registry used to pull the base JVM image Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The password to use to authenticate with the registry used to pull the base JVM image Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Environment key/values to pass to buildpacks. Environment variable: |
|
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
Path to the JVM Dockerfile. If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root. If not set src/main/docker/Dockerfile.jvm will be used. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Path to the native Dockerfile. If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root. If not set src/main/docker/Dockerfile.native will be used. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Images to consider as cache sources. Values are passed to Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Name of binary used to execute the docker commands. This setting can override the global container runtime detection. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Build args passed to docker via Environment variable: |
|
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
Which platform(s) to target during the build. See https://docs.docker.com/engine/reference/commandline/buildx_build/#platform Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
Sets the export action for the build result. See https://docs.docker.com/engine/reference/commandline/buildx_build/#output. Note that any filesystem paths need to be absolute paths, not relative from where the command is executed from. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Set type of progress output ( Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
The base image to be used when a container image is being produced for the jar build. When the application is built against Java 17 or higher, Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The base image to be used when a container image is being produced for the native binary build. The default is "quay.io/quarkus/quarkus-micro-image". You can also use "registry.access.redhat.com/ubi8/ubi-minimal" which is a bigger base image, but provide more built-in utilities such as the microdnf package manager. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The JVM arguments to pass to the JVM when starting the application Environment variable: |
list of string |
|
||||||||||||||||||||||||||||||||
Additional JVM arguments to pass to the JVM when starting the application Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
Additional arguments to pass when starting the native application Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
If this is set, then it will be used as the entry point of the container image. There are a few things to be aware of when creating an entry point
- Entrypoint "INHERIT" means to inherit entrypoint from base image, Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
If this is set, then it will be used as the entry point of the container image. There are a few things to be aware of when creating an entry point
- Entrypoint "INHERIT" means to inherit entrypoint from base image, Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
The username to use to authenticate with the registry used to pull the base JVM image Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The password to use to authenticate with the registry used to pull the base JVM image Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The ports to expose Environment variable: |
list of int |
|
||||||||||||||||||||||||||||||||
The user to use in generated image Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The working directory to use in the generated image. The default value is chosen to work in accordance with the default base image. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Controls the optimization which skips downloading base image layers that exist in a target registry. If the user does not set this property, then read as false. If Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
List of target platforms. Each platform is defined using the pattern: Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
The path of a file in which the digest of the generated image will be written. If the path is relative, the base path is the output directory of the build tool. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The path of a file in which the id of the generated image will be written. If the path is relative, the base path is the output directory of the build tool. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Whether or not to operate offline. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Name of binary used to execute the docker commands. This is only used by Jib when the container image is being built locally. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Whether to set the creation time to the actual build time. Otherwise, the creation time will be set to the Unix epoch (00:00:00, January 1st, 1970 in UTC). See Jib FAQ for more information Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Whether to set the modification time (last modified time) of the files put by Jib in the image to the actual build time. Otherwise, the modification time will be set to the Unix epoch (00:00:00, January 1st, 1970 in UTC). If the modification time is constant (flag is set to false so Unix epoch is used) across two consecutive builds, the docker layer sha256 digest will be different only if the actual files added by Jib to the docker layer were changed. More exactly, having 2 consecutive builds will generate different docker layers only if the actual content of the files within the docker layer was changed. If the current timestamp is used the sha256 digest of the docker layer will always be different even if the content of the files didn’t change. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Environment variables to add to the container image Environment variable: |
|
|||||||||||||||||||||||||||||||||
Sets environment variables used by the Docker executable. This is only used by Jib when the container image is being built locally. Environment variable: |
|
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
The build config strategy to use. Environment variable: |
|
|
||||||||||||||||||||||||||||||||
The base image to be used when a container image is being produced for the jar build. When the application is built against Java 17 or higher, Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The base image to be used when a container image is being produced for the native binary build Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The default Dockerfile to use for jvm builds Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The default Dockerfile to use for native builds Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The JVM arguments to pass to the JVM when starting the application Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
Additional arguments to pass when starting the native application Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
The directory where the jar is added during the assemble phase. This is dependent on the S2I image and should be supplied if a non default image is used. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The resulting filename of the jar in the S2I image. This option may be used if the selected S2I image uses a fixed name for the jar. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The directory where the native binary is added during the assemble phase. This is dependent on the S2I image and should be supplied if a non-default image is used. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The resulting filename of the native binary in the S2I image. This option may be used if the selected S2I image uses a fixed name for the native binary. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The build timeout. Environment variable: |
|
|||||||||||||||||||||||||||||||||
The log level of OpenShift build log. Environment variable: |
|
|
||||||||||||||||||||||||||||||||
The build config strategy to use. Environment variable: |
|
|
||||||||||||||||||||||||||||||||
The base image to be used when a container image is being produced for the jar build. When the application is built against Java 17 or higher, Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The base image to be used when a container image is being produced for the native binary build Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The JVM arguments to pass to the JVM when starting the application Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
Additional arguments to pass when starting the native application Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
The directory where the jar is added during the assemble phase. This is dependent on the S2I image and should be supplied if a non default image is used. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The resulting filename of the jar in the S2I image. This option may be used if the selected S2I image uses a fixed name for the jar. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The directory where the native binary is added during the assemble phase. This is dependent on the S2I image and should be supplied if a non-default image is used. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The resulting filename of the native binary in the S2I image. This option may be used if the selected S2I image uses a fixed name for the native binary. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The build timeout. Environment variable: |
|
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
The base image to be used when a container image is being produced for the jar build Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The base image to be used when a container image is being produced for the native binary build Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The JVM arguments to pass to the JVM when starting the application Environment variable: |
list of string |
|
||||||||||||||||||||||||||||||||
Additional JVM arguments to pass to the JVM when starting the application Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
Additional arguments to pass when starting the native application Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
The directory where the jar is added during the assemble phase. This is dependent on the S2I image and should be supplied if a non default image is used. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The resulting filename of the jar in the S2I image. This option may be used if the selected S2I image uses a fixed name for the jar. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The directory where the native binary is added during the assemble phase. This is dependent on the S2I image and should be supplied if a non-default image is used. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The resulting filename of the native binary in the S2I image. This option may be used if the selected S2I image uses a fixed name for the native binary. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The build timeout. Environment variable: |
|
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
If filter is enabled. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Form field name which keeps a CSRF token. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
CSRF cookie name. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
CSRF cookie max age. Environment variable: |
|
|||||||||||||||||||||||||||||||||
CSRF cookie path. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
CSRF cookie domain. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
If enabled the CSRF cookie will have its 'secure' parameter set to 'true' when HTTP is used. It may be necessary when running behind an SSL terminating reverse proxy. The cookie will always be secure if HTTPS is used even if this property is set to false. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Create CSRF token only if the HTTP GET relative request path matches one of the paths configured with this property. Use a comma to separate multiple path values. Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
Random CSRF token size in bytes. Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
CSRF token HMAC signature key, if this key is set then it must be at least 32 characters long. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Verify CSRF token in the CSRF filter. If this property is enabled then the input stream will be read and cached by the CSRF filter to verify the token. If you prefer then you can disable this property and compare CSRF form and cookie parameters in the application code using JAX-RS jakarta.ws.rs.FormParam which refers to the Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Require that only 'application/x-www-form-urlencoded' or 'multipart/form-data' body is accepted for the token verification to proceed. Disable this property for the CSRF filter to avoid verifying the token for POST requests with other content types. This property is only effective if Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
The kind of database we will connect to (e.g. h2, postgresql…). Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The version of the database we will connect to (e.g. '10.0').
As a rule, the version set here should be as high as possible, but must be lower than or equal to the version of any database your application will connect to. A high version will allow better performance and using more features (e.g. Hibernate ORM may generate more efficient SQL, avoid workarounds and take advantage of more database features), but if it is higher than the version of the database you want to connect to, it may lead to runtime exceptions (e.g. Hibernate ORM may generate invalid SQL that your database will reject). Some extensions (like the Hibernate ORM extension) will try to check this version against the actual database version on startup, leading to a startup failure when the actual version is lower or simply a warning in case the database cannot be reached. The default for this property is specific to each extension; the Hibernate ORM extension will default to the oldest version it supports. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present. When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode. Environment variable: |
boolean |
|||||||||||||||||||||||||||||||||
The container image name to use, for container based DevServices providers. If the provider is not container based (e.g. a H2 Database) then this has no effect. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Optional fixed port the dev service will listen to. If not defined, the port will be chosen randomly. Environment variable: |
int |
|||||||||||||||||||||||||||||||||
The container start command to use, for container based DevServices providers. If the provider is not container based (e.g. a H2 Database) then this has no effect. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The name of the database to use if this Dev Service supports overriding it. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The username to use if this Dev Service supports overriding it. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The password to use if this Dev Service supports overriding it. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Path to a SQL script that will be loaded from the classpath and applied to the Dev Service database If the provider is not container based (e.g. an H2 or Derby Database) then this has no effect. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Whether this particular data source should be excluded from the health check if the general health check for data sources is enabled. By default, the health check includes all configured data sources (if it is enabled). Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Whether or not an health check is published in case the smallrye-health extension is present. This is a global setting and is not specific to a datasource. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Whether or not datasource metrics are published in case a metrics extension is present. This is a global setting and is not specific to a datasource. NOTE: This is different from the "jdbc.enable-metrics" property that needs to be set on the JDBC datasource level to enable collection of metrics for that datasource. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The datasource username Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The datasource password Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The credentials provider name Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The credentials provider bean name.
It is the Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Generic properties that are passed for additional container configuration. Properties defined here are database specific and are interpreted specifically in each database dev service implementation. Environment variable: |
|
|||||||||||||||||||||||||||||||||
Generic properties that are added to the database connection URL. Environment variable: |
|
|||||||||||||||||||||||||||||||||
The volumes to be mapped to the container. The map key corresponds to the host location and the map value is the container location. If the host location starts with "classpath:", then the mapping will load the resource from the classpath with read-only permission. When using a file system location, the volume will be created with read-write permission, so the data in your file system might be wiped out or altered. If the provider is not container based (e.g. an H2 or Derby Database) then this has no effect. Environment variable: |
|
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
The kind of database we will connect to (e.g. h2, postgresql…). Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The version of the database we will connect to (e.g. '10.0').
As a rule, the version set here should be as high as possible, but must be lower than or equal to the version of any database your application will connect to. A high version will allow better performance and using more features (e.g. Hibernate ORM may generate more efficient SQL, avoid workarounds and take advantage of more database features), but if it is higher than the version of the database you want to connect to, it may lead to runtime exceptions (e.g. Hibernate ORM may generate invalid SQL that your database will reject). Some extensions (like the Hibernate ORM extension) will try to check this version against the actual database version on startup, leading to a startup failure when the actual version is lower or simply a warning in case the database cannot be reached. The default for this property is specific to each extension; the Hibernate ORM extension will default to the oldest version it supports. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present. When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode. Environment variable: |
boolean |
|||||||||||||||||||||||||||||||||
The container image name to use, for container based DevServices providers. If the provider is not container based (e.g. a H2 Database) then this has no effect. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Generic properties that are passed for additional container configuration. Properties defined here are database specific and are interpreted specifically in each database dev service implementation. Environment variable: |
|
|||||||||||||||||||||||||||||||||
Generic properties that are added to the database connection URL. Environment variable: |
|
|||||||||||||||||||||||||||||||||
Optional fixed port the dev service will listen to. If not defined, the port will be chosen randomly. Environment variable: |
int |
|||||||||||||||||||||||||||||||||
The container start command to use, for container based DevServices providers. If the provider is not container based (e.g. a H2 Database) then this has no effect. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The name of the database to use if this Dev Service supports overriding it. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The username to use if this Dev Service supports overriding it. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The password to use if this Dev Service supports overriding it. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Path to a SQL script that will be loaded from the classpath and applied to the Dev Service database If the provider is not container based (e.g. an H2 or Derby Database) then this has no effect. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The volumes to be mapped to the container. The map key corresponds to the host location and the map value is the container location. If the host location starts with "classpath:", then the mapping will load the resource from the classpath with read-only permission. When using a file system location, the volume will be created with read-write permission, so the data in your file system might be wiped out or altered. If the provider is not container based (e.g. an H2 or Derby Database) then this has no effect. Environment variable: |
|
|||||||||||||||||||||||||||||||||
Whether this particular data source should be excluded from the health check if the general health check for data sources is enabled. By default, the health check includes all configured data sources (if it is enabled). Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The datasource username Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The datasource password Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The credentials provider name Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The credentials provider bean name.
It is the Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
Enables or disables the Vert.x cache. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Enables or disabled the Vert.x classpath resource resolver. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The number of event loops. By default, it matches the number of CPUs detected on the system. Environment variable: |
int |
|||||||||||||||||||||||||||||||||
The maximum amount of time the event loop can be blocked. Environment variable: |
|
|||||||||||||||||||||||||||||||||
The amount of time before a warning is displayed if the event loop is blocked. Environment variable: |
|
|||||||||||||||||||||||||||||||||
The size of the worker thread pool. Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
The maximum amount of time the worker thread can be blocked. Environment variable: |
|
|||||||||||||||||||||||||||||||||
The size of the internal thread pool (used for the file system). Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
The queue size. For most applications this should be unbounded Environment variable: |
int |
|||||||||||||||||||||||||||||||||
The executor growth resistance. A resistance factor applied after the core pool is full; values applied here will cause that fraction of submissions to create new threads when no idle thread is available. A value of Environment variable: |
float |
|
||||||||||||||||||||||||||||||||
The amount of time a thread will stay alive with no work. Environment variable: |
|
|||||||||||||||||||||||||||||||||
Prefill thread pool when creating a new Executor. When Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Enables the async DNS resolver. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
PEM Key/cert config is disabled by default. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Comma-separated list of the path to the key files (Pem format). Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
Comma-separated list of the path to the certificate files (Pem format). Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
JKS config is disabled by default. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Path of the key file (JKS format). Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Password of the key file. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
PFX config is disabled by default. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Path to the key file (PFX format). Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Password of the key. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
PEM Trust config is disabled by default. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Comma-separated list of the trust certificate files (Pem format). Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
JKS config is disabled by default. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Path of the key file (JKS format). Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Password of the key file. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
PFX config is disabled by default. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Path to the key file (PFX format). Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Password of the key. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The accept backlog. Environment variable: |
int |
|||||||||||||||||||||||||||||||||
The client authentication. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The connect timeout. Environment variable: |
|
|||||||||||||||||||||||||||||||||
The idle timeout in milliseconds. Environment variable: |
||||||||||||||||||||||||||||||||||
The receive buffer size. Environment variable: |
int |
|||||||||||||||||||||||||||||||||
The number of reconnection attempts. Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
The reconnection interval in milliseconds. Environment variable: |
|
|||||||||||||||||||||||||||||||||
Whether to reuse the address. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Whether to reuse the port. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The send buffer size. Environment variable: |
int |
|||||||||||||||||||||||||||||||||
The so linger. Environment variable: |
int |
|||||||||||||||||||||||||||||||||
Enables or Disabled SSL. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Whether to keep the TCP connection opened (keep-alive). Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Configure the TCP no delay. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Configure the traffic class. Environment variable: |
int |
|||||||||||||||||||||||||||||||||
Enables or disables the trust all parameter. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The host name. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The port. Environment variable: |
int |
|||||||||||||||||||||||||||||||||
The public host name. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The public port. Environment variable: |
int |
|||||||||||||||||||||||||||||||||
Enables or disables the clustering. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The ping interval. Environment variable: |
|
|||||||||||||||||||||||||||||||||
The ping reply interval. Environment variable: |
|
|||||||||||||||||||||||||||||||||
The maximum amount of time in seconds that a successfully resolved address will be cached. If not set explicitly, resolved addresses may be cached forever. Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
The minimum amount of time in seconds that a successfully resolved address will be cached. Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
The amount of time in seconds that an unsuccessful attempt to resolve an address will be cached. Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
The maximum number of queries to be sent during a resolution. Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
The duration after which a DNS query is considered to be failed. Environment variable: |
|
|||||||||||||||||||||||||||||||||
Enable or disable native transport Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
The number of history log entries to remember. Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
Enable CORS filter. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The HTTP root path. All web content will be served relative to this root path. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
If basic auth should be enabled. If both basic and form auth is enabled then basic auth will be enabled in silent mode. If no authentication mechanisms are configured basic auth is the default. Environment variable: |
boolean |
|||||||||||||||||||||||||||||||||
If form authentication is enabled. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The login page. Redirect to login page can be disabled by setting Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The post location. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The username field name. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The password field name. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The error page. Redirect to error page can be disabled by setting Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The landing page to redirect to if there is no saved page to redirect back to. Redirect to landing page can be disabled by setting Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Option to control the name of the cookie used to redirect the user back to where he wants to get access to. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The inactivity (idle) timeout When inactivity timeout is reached, cookie is not renewed and a new login is enforced. Environment variable: |
|
|||||||||||||||||||||||||||||||||
How old a cookie can get before it will be replaced with a new cookie with an updated timeout, also referred to as "renewal-timeout". Note that smaller values will result in slightly more server load (as new encrypted cookies will be generated more often), however larger values affect the inactivity timeout as the timeout is set when a cookie is generated. For example if this is set to 10 minutes, and the inactivity timeout is 30m, if a users last request is when the cookie is 9m old then the actual timeout will happen 21m after the last request, as the timeout is only refreshed when a new cookie is generated. In other words no timeout is tracked on the server side; the timestamp is encoded and encrypted in the cookie itself, and it is decrypted and parsed with each request. Environment variable: |
|
|||||||||||||||||||||||||||||||||
The cookie that is used to store the persistent session Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The cookie path for the session and location cookies. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Set the HttpOnly attribute to prevent access to the cookie via JavaScript. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
SameSite attribute for the session and location cookies. Environment variable: |
|
|
||||||||||||||||||||||||||||||||
The authentication realm Environment variable: |
string |
|||||||||||||||||||||||||||||||||
If this is true and credentials are present then a user will always be authenticated before the request progresses. If this is false then an attempt will only be made to authenticate the user if a permission check is performed or the current user is required for some other reason. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Configures the engine to require/request client authentication. NONE, REQUEST, REQUIRED Environment variable: |
|
|
||||||||||||||||||||||||||||||||
If this is true then only a virtual channel will be set up for vertx web. We have this switch for testing purposes. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
A common root path for non-application endpoints. Various extension-provided endpoints such as metrics, health, and openapi are deployed under this path by default.
If the management interface is enabled, the root path for the endpoints exposed on the management interface
is configured using the Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The REST Assured client timeout for testing. Environment variable: |
|
|||||||||||||||||||||||||||||||||
If enabled then the response body is compressed if the Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
When enabled, vert.x will decompress the request’s body if it’s compressed. Note that the compression format (e.g., gzip) must be specified in the Content-Encoding header in the request. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
List of media types for which the compression should be enabled automatically, unless declared explicitly via Environment variable: |
list of string |
|
||||||||||||||||||||||||||||||||
The compression level used when compression support is enabled. Environment variable: |
int |
|||||||||||||||||||||||||||||||||
Enable the CORS filter. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The HTTP port Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
The HTTP port used to run tests Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
The HTTP host In dev/test mode this defaults to localhost, in prod mode this defaults to 0.0.0.0 Defaulting to 0.0.0.0 makes it easier to deploy Quarkus to container, however it is not suitable for dev/test mode as other people on the network can connect to your development machine. Environment variable: |
string |
required |
||||||||||||||||||||||||||||||||
Enable listening to host:port Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The HTTPS port Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
The HTTPS port used to run tests Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
If insecure (i.e. http rather than https) requests are allowed. If this is Environment variable: |
|
|
||||||||||||||||||||||||||||||||
If this is true (the default) then HTTP/2 will be enabled. Note that for browsers to be able to use it HTTPS must be enabled, and you must be running on JDK11 or above, as JDK8 does not support ALPN. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Origins allowed for CORS Comma separated list of valid URLs, e.g.: http://www.quarkus.io,http://localhost:3000 In case an entry of the list is surrounded by forward slashes, it is interpreted as a regular expression. Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
HTTP methods allowed for CORS Comma separated list of valid methods. ex: GET,PUT,POST The filter allows any method if this is not set. default: returns any requested method as valid Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
HTTP headers allowed for CORS Comma separated list of valid headers. ex: X-Custom,Content-Disposition The filter allows any header if this is not set. default: returns any requested header as valid Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
HTTP headers exposed in CORS Comma separated list of valid headers. ex: X-Custom,Content-Disposition default: empty Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
The Environment variable: |
||||||||||||||||||||||||||||||||||
The Environment variable: |
boolean |
|||||||||||||||||||||||||||||||||
The Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The credentials provider bean name.
It is the Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The list of path to server certificates using the PEM format. Specifying multiple files require SNI to be enabled. Environment variable: |
list of path |
|||||||||||||||||||||||||||||||||
The list of path to server certificates private key file using the PEM format. Specifying multiple files require SNI to be enabled. The order of the key files must match the order of the certificates. Environment variable: |
list of path |
|||||||||||||||||||||||||||||||||
An optional key store which holds the certificate information instead of specifying separate files. Environment variable: |
path |
|||||||||||||||||||||||||||||||||
An optional parameter to specify type of the key store file. If not given, the type is automatically detected based on the file name. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
An optional parameter to specify a provider of the key store file. If not given, the provider is automatically detected based on the key store file type. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
A parameter to specify the password of the key store file. If not given, and if it can not be retrieved from Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
A parameter to specify a Environment variable: |
string |
|||||||||||||||||||||||||||||||||
An optional parameter to select a specific key in the key store. When SNI is disabled, if the key store contains multiple keys and no alias is specified, the behavior is undefined. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
An optional parameter to define the password for the key, in case it’s different from Environment variable: |
string |
|||||||||||||||||||||||||||||||||
A parameter to specify a Environment variable: |
string |
|||||||||||||||||||||||||||||||||
An optional trust store which holds the certificate information of the certificates to trust. Environment variable: |
path |
|||||||||||||||||||||||||||||||||
An optional parameter to specify type of the trust store file. If not given, the type is automatically detected based on the file name. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
An optional parameter to specify a provider of the trust store file. If not given, the provider is automatically detected based on the trust store file type. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
A parameter to specify the password of the trust store file. If not given then it may be retrieved from Environment variable: |
string |
|||||||||||||||||||||||||||||||||
A parameter to specify a Environment variable: |
string |
|||||||||||||||||||||||||||||||||
An optional parameter to trust only one specific certificate in the trust store (instead of trusting all certificates in the store). Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The cipher suites to use. If none is given, a reasonable default is selected. Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
The list of protocols to explicitly enable. Environment variable: |
list of string |
|
||||||||||||||||||||||||||||||||
Enables Server Name Indication (SNI), an TLS extension allowing the server to use multiple certificates. The client indicate the server name during the TLS handshake, allowing the server to select the right certificate. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Set the index page when serving static resources. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Set whether hidden files should be served. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Set whether range requests (resumable downloads; media streaming) should be enabled. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Set whether cache handling is enabled. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Set the cache entry timeout. The default is Environment variable: |
|
|||||||||||||||||||||||||||||||||
Set value for max age in caching headers. The default is Environment variable: |
|
|||||||||||||||||||||||||||||||||
Set the max cache size. Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
When set to Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The number if IO threads used to perform IO. This will be automatically set to a reasonable value based on the number of CPU cores if it is not provided. If this is set to a higher value than the number of Vert.x event loops then it will be capped at the number of event loops. In general this should be controlled by setting quarkus.vertx.event-loops-pool-size, this setting should only be used if you want to limit the number of HTTP io threads to a smaller number than the total number of IO threads. Environment variable: |
int |
|||||||||||||||||||||||||||||||||
The maximum length of all headers. Environment variable: |
|
|||||||||||||||||||||||||||||||||
The maximum size of a request body. Environment variable: |
|
|||||||||||||||||||||||||||||||||
The max HTTP chunk size Environment variable: |
|
|||||||||||||||||||||||||||||||||
The maximum length of the initial line (e.g. Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
The maximum length of a form attribute. Environment variable: |
|
|||||||||||||||||||||||||||||||||
The maximum number of connections that are allowed at any one time. If this is set it is recommended to set a short idle timeout. Environment variable: |
int |
|||||||||||||||||||||||||||||||||
Http connection idle timeout Environment variable: |
|
|||||||||||||||||||||||||||||||||
Http connection read timeout for blocking IO. This is the maximum amount of time a thread will wait for data, before an IOException will be thrown and the connection closed. Environment variable: |
|
|||||||||||||||||||||||||||||||||
Whether the files sent using Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The directory where the files sent using Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Whether the form attributes should be added to the request parameters.
If Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Whether the uploaded files should be removed after serving the request.
If Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Whether the body buffer should pre-allocated based on the Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
A comma-separated list of Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
The encryption key that is used to store persistent logins (e.g. for form auth). Logins are stored in a persistent cookie that is encrypted with AES-256 using a key derived from a SHA-256 hash of the key that is provided here. If no key is provided then an in-memory one will be generated, this will change on every restart though so it is not suitable for production environments. This must be more than 16 characters long for security reasons Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Enable socket reuse port (linux/macOs native transport only) Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Enable tcp quick ack (linux native transport only) Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Enable tcp cork (linux native transport only) Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Enable tcp fast open (linux native transport only) Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The accept backlog, this is how many connections can be waiting to be accepted before connections start being rejected Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
Path to a unix domain socket Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Enable listening to host:port Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
If this is true then the request start time will be recorded to enable logging of total request time. This has a small performance penalty, so is disabled by default. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
If access logging is enabled. By default this will log via the standard logging facility Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
A regular expression that can be used to exclude some paths from logging. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The access log pattern. If this is the string
Otherwise, consult the Quarkus documentation for the full list of variables that can be used. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
If logging should be done to a separate file. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The access log file base name, defaults to 'quarkus' which will give a log file name of 'quarkus.log'. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The log directory to use when logging access to a file If this is not set then the current working directory is used. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The log file suffix Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The log category to use if logging is being done via the standard log mechanism (i.e. if base-file-name is empty). Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
If the log should be rotated daily Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Provides a hint (optional) for the default content type of responses generated for the errors not handled by the application. If the client requested a supported content-type in request headers (e.g. "Accept: application/json", "Accept: text/html"), Quarkus will use that content type. Otherwise, it will default to the content type configured here. Environment variable: |
|
|||||||||||||||||||||||||||||||||
If this is true then the address, scheme etc. will be set from headers forwarded by the proxy server, such as Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
If this is true and proxy address forwarding is enabled then the standard Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
If either this or Environment variable: |
boolean |
|||||||||||||||||||||||||||||||||
Enable override the received request’s host through a forwarded host header. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Configure the forwarded host header to be used if override enabled. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Enable prefix the received request’s path with a forwarded prefix header. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Configure the forwarded prefix header to be used if prefixing enabled. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Configure the list of trusted proxy addresses. Received Environment variable: |
list of TrustedProxyCheckPart |
|
||||||||||||||||||||||||||||||||
Determines whether the entire permission set is enabled, or not. By default, if the permission set is defined, it is enabled. Environment variable: |
boolean |
|||||||||||||||||||||||||||||||||
The HTTP policy that this permission set is linked to. There are 3 built in policies: permit, deny and authenticated. Role based policies can be defined, and extensions can add their own policies. Environment variable: |
string |
required |
||||||||||||||||||||||||||||||||
The methods that this permission set applies to. If this is not set then they apply to all methods. Note that if a request matches any path from any permission set, but does not match the constraint due to the method not being listed then the request will be denied. Method specific permissions take precedence over matches that do not have any methods set. This means that for example if Quarkus is configured to allow GET and POST requests to /admin to and no other permissions are configured PUT requests to /admin will be denied. Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
The paths that this permission check applies to. If the path ends in /* then this is treated as a path prefix, otherwise it is treated as an exact match. Matches are done on a length basis, so the most specific path match takes precedence. If multiple permission sets match the same path then explicit methods matches take precedence over matches without methods set, otherwise the most restrictive permissions are applied. Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
Path specific authentication mechanism which must be used to authenticate a user. It needs to match Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The roles that are allowed to access resources protected by this policy. By default, access is allowed to any authenticated user. Environment variable: |
list of string |
|
||||||||||||||||||||||||||||||||
Permissions granted to the Environment variable: |
|
|||||||||||||||||||||||||||||||||
Permissions granted by this policy will be created with a Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
If the cookie pattern is case-sensitive Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The value to set in the samesite attribute Environment variable: |
|
required |
||||||||||||||||||||||||||||||||
Some User Agents break when sent SameSite=None, this will detect them and avoid sending the value Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
If this is true then the 'secure' attribute will automatically be sent on cookies with a SameSite attribute of None. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The path this header should be applied Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The value for this header configuration Environment variable: |
string |
required |
||||||||||||||||||||||||||||||||
The HTTP methods for this header configuration Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
A regular expression for the paths matching this configuration Environment variable: |
string |
required |
||||||||||||||||||||||||||||||||
Additional HTTP Headers always sent in the response Environment variable: |
|
|||||||||||||||||||||||||||||||||
The HTTP methods for this path configuration Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
Environment variable: |
int |
|||||||||||||||||||||||||||||||||
Enables / Disables the usage of a separate interface/port to expose the management endpoints. If sets to Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
If basic auth should be enabled. Environment variable: |
boolean |
|||||||||||||||||||||||||||||||||
If this is true and credentials are present then a user will always be authenticated before the request progresses. If this is false then an attempt will only be made to authenticate the user if a permission check is performed or the current user is required for some other reason. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Configures the engine to require/request client authentication. NONE, REQUEST, REQUIRED Environment variable: |
|
|
||||||||||||||||||||||||||||||||
A common root path for management endpoints. Various extension-provided management endpoints such as metrics and health are deployed under this path by default. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
If responses should be compressed. Note that this will attempt to compress all responses, to avoid compressing already compressed content (such as images) you need to set the following header: Content-Encoding: identity Which will tell vert.x not to compress the response. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
When enabled, vert.x will decompress the request’s body if it’s compressed. Note that the compression format (e.g., gzip) must be specified in the Content-Encoding header in the request. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The compression level used when compression support is enabled. Environment variable: |
int |
|||||||||||||||||||||||||||||||||
The HTTP port Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
The HTTP port Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
The HTTP host Defaults to 0.0.0.0 Defaulting to 0.0.0.0 makes it easier to deploy Quarkus to container, however it is not suitable for dev/test mode as other people on the network can connect to your development machine. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Enable listening to host:port Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The credentials provider bean name.
It is the Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The list of path to server certificates using the PEM format. Specifying multiple files require SNI to be enabled. Environment variable: |
list of path |
|||||||||||||||||||||||||||||||||
The list of path to server certificates private key file using the PEM format. Specifying multiple files require SNI to be enabled. The order of the key files must match the order of the certificates. Environment variable: |
list of path |
|||||||||||||||||||||||||||||||||
An optional key store which holds the certificate information instead of specifying separate files. Environment variable: |
path |
|||||||||||||||||||||||||||||||||
An optional parameter to specify type of the key store file. If not given, the type is automatically detected based on the file name. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
An optional parameter to specify a provider of the key store file. If not given, the provider is automatically detected based on the key store file type. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
A parameter to specify the password of the key store file. If not given, and if it can not be retrieved from Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
A parameter to specify a Environment variable: |
string |
|||||||||||||||||||||||||||||||||
An optional parameter to select a specific key in the key store. When SNI is disabled, if the key store contains multiple keys and no alias is specified, the behavior is undefined. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
An optional parameter to define the password for the key, in case it’s different from Environment variable: |
string |
|||||||||||||||||||||||||||||||||
A parameter to specify a Environment variable: |
string |
|||||||||||||||||||||||||||||||||
An optional trust store which holds the certificate information of the certificates to trust. Environment variable: |
path |
|||||||||||||||||||||||||||||||||
An optional parameter to specify type of the trust store file. If not given, the type is automatically detected based on the file name. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
An optional parameter to specify a provider of the trust store file. If not given, the provider is automatically detected based on the trust store file type. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
A parameter to specify the password of the trust store file. If not given then it may be retrieved from Environment variable: |
string |
|||||||||||||||||||||||||||||||||
A parameter to specify a Environment variable: |
string |
|||||||||||||||||||||||||||||||||
An optional parameter to trust only one specific certificate in the trust store (instead of trusting all certificates in the store). Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The cipher suites to use. If none is given, a reasonable default is selected. Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
The list of protocols to explicitly enable. Environment variable: |
list of string |
|
||||||||||||||||||||||||||||||||
Enables Server Name Indication (SNI), an TLS extension allowing the server to use multiple certificates. The client indicate the server name during the TLS handshake, allowing the server to select the right certificate. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
When set to Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The maximum length of all headers. Environment variable: |
|
|||||||||||||||||||||||||||||||||
The maximum size of a request body. Environment variable: |
|
|||||||||||||||||||||||||||||||||
The max HTTP chunk size Environment variable: |
|
|||||||||||||||||||||||||||||||||
The maximum length of the initial line (e.g. Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
The maximum length of a form attribute. Environment variable: |
|
|||||||||||||||||||||||||||||||||
The maximum number of connections that are allowed at any one time. If this is set it is recommended to set a short idle timeout. Environment variable: |
int |
|||||||||||||||||||||||||||||||||
Http connection idle timeout Environment variable: |
|
|||||||||||||||||||||||||||||||||
Whether the files sent using Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The directory where the files sent using Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Whether the form attributes should be added to the request parameters.
If Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Whether the uploaded files should be removed after serving the request.
If Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Whether the body buffer should pre-allocated based on the Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
A comma-separated list of Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
The accept backlog, this is how many connections can be waiting to be accepted before connections start being rejected Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
Path to a unix domain socket Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Enable listening to host:port Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
If this is true then the address, scheme etc. will be set from headers forwarded by the proxy server, such as Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
If this is true and proxy address forwarding is enabled then the standard Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
If either this or Environment variable: |
boolean |
|||||||||||||||||||||||||||||||||
Enable override the received request’s host through a forwarded host header. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Configure the forwarded host header to be used if override enabled. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Enable prefix the received request’s path with a forwarded prefix header. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Configure the forwarded prefix header to be used if prefixing enabled. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Configure the list of trusted proxy addresses. Received Environment variable: |
list of TrustedProxyCheckPart |
|
||||||||||||||||||||||||||||||||
Determines whether the entire permission set is enabled, or not. By default, if the permission set is defined, it is enabled. Environment variable: |
boolean |
|||||||||||||||||||||||||||||||||
The HTTP policy that this permission set is linked to. There are 3 built in policies: permit, deny and authenticated. Role based policies can be defined, and extensions can add their own policies. Environment variable: |
string |
required |
||||||||||||||||||||||||||||||||
The methods that this permission set applies to. If this is not set then they apply to all methods. Note that if a request matches any path from any permission set, but does not match the constraint due to the method not being listed then the request will be denied. Method specific permissions take precedence over matches that do not have any methods set. This means that for example if Quarkus is configured to allow GET and POST requests to /admin to and no other permissions are configured PUT requests to /admin will be denied. Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
The paths that this permission check applies to. If the path ends in /* then this is treated as a path prefix, otherwise it is treated as an exact match. Matches are done on a length basis, so the most specific path match takes precedence. If multiple permission sets match the same path then explicit methods matches take precedence over matches without methods set, otherwise the most restrictive permissions are applied. Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
Path specific authentication mechanism which must be used to authenticate a user. It needs to match Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The roles that are allowed to access resources protected by this policy. By default, access is allowed to any authenticated user. Environment variable: |
list of string |
|
||||||||||||||||||||||||||||||||
Permissions granted to the Environment variable: |
|
|||||||||||||||||||||||||||||||||
Permissions granted by this policy will be created with a Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The path this header should be applied Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The value for this header configuration Environment variable: |
string |
required |
||||||||||||||||||||||||||||||||
The HTTP methods for this header configuration Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
A regular expression for the paths matching this configuration Environment variable: |
string |
required |
||||||||||||||||||||||||||||||||
Additional HTTP Headers always sent in the response Environment variable: |
|
|||||||||||||||||||||||||||||||||
The HTTP methods for this path configuration Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
Environment variable: |
int |
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
If GraphQL UI should be included every time. By default, this is only included when the application is running in dev mode. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The path where GraphQL UI is available.
The value Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
If Dev Services for Elasticsearch has been explicitly enabled or disabled. Dev Services are generally enabled by default, unless there is an existing configuration present. For Elasticsearch, Dev Services starts a server unless Environment variable: |
boolean |
|||||||||||||||||||||||||||||||||
Optional fixed port the dev service will listen to. If not defined, the port will be chosen randomly. Environment variable: |
int |
|||||||||||||||||||||||||||||||||
The Elasticsearch container image to use. Defaults to the elasticsearch image provided by Elastic. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The value for the ES_JAVA_OPTS env variable. Defaults to setting the heap to 512MB min - 1GB max. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Indicates if the Elasticsearch server managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for Elasticsearch starts a new container.
The discovery uses the Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The value of the Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
Whether a health check is published in case the smallrye-health extension is present. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The list of hosts of the Elasticsearch servers. Environment variable: |
list of host:port |
|
||||||||||||||||||||||||||||||||
The protocol to use when contacting Elasticsearch servers. Set to "https" to enable SSL/TLS. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The username for basic HTTP authentication. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The password for basic HTTP authentication. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The connection timeout. Environment variable: |
|
|||||||||||||||||||||||||||||||||
The socket timeout. Environment variable: |
|
|||||||||||||||||||||||||||||||||
The maximum number of connections to all the Elasticsearch servers. Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
The maximum number of connections per Elasticsearch server. Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
The number of IO thread. By default, this is the number of locally detected processors. Thread counts higher than the number of processors should not be necessary because the I/O threads rely on non-blocking operations, but you may want to use a thread count lower than the number of processors. Environment variable: |
int |
|||||||||||||||||||||||||||||||||
Defines if automatic discovery is enabled. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Refresh interval of the node list. Environment variable: |
|
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
The realm name Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
If the properties store is enabled. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The sql query to find the password Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The data source to use Environment variable: |
string |
|||||||||||||||||||||||||||||||||
If the clear-password-mapper is enabled. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The index (1 based numbering) of the column containing the clear password Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
If the bcrypt-password-mapper is enabled. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The index (1 based numbering) of the column containing the password hash Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
A string referencing the password hash encoding ("BASE64" or "HEX") Environment variable: |
|
|
||||||||||||||||||||||||||||||||
The index (1 based numbering) of the column containing the Bcrypt salt Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
A string referencing the salt encoding ("BASE64" or "HEX") Environment variable: |
|
|
||||||||||||||||||||||||||||||||
The index (1 based numbering) of the column containing the Bcrypt iteration count Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
The index (1 based numbering) of column to map Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
The target attribute name Environment variable: |
string |
required |
||||||||||||||||||||||||||||||||
The sql query to find the password Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The data source to use Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The index (1 based numbering) of column to map Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
The target attribute name Environment variable: |
string |
required |
||||||||||||||||||||||||||||||||
If the clear-password-mapper is enabled. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The index (1 based numbering) of the column containing the clear password Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
If the bcrypt-password-mapper is enabled. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The index (1 based numbering) of the column containing the password hash Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
A string referencing the password hash encoding ("BASE64" or "HEX") Environment variable: |
|
|
||||||||||||||||||||||||||||||||
The index (1 based numbering) of the column containing the Bcrypt salt Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
A string referencing the salt encoding ("BASE64" or "HEX") Environment variable: |
|
|
||||||||||||||||||||||||||||||||
The index (1 based numbering) of the column containing the Bcrypt iteration count Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
The option to enable the ldap elytron module Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The elytron realm name Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Provided credentials are verified against ldap? Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The url of the ldap server Environment variable: |
string |
required |
||||||||||||||||||||||||||||||||
The principal: user which is used to connect to ldap server (also named "bindDn") Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The password which belongs to the principal (also named "bindCredential") Environment variable: |
string |
|||||||||||||||||||||||||||||||||
how ldap redirects are handled Environment variable: |
|
|
||||||||||||||||||||||||||||||||
The connect timeout Environment variable: |
|
|||||||||||||||||||||||||||||||||
The read timeout Environment variable: |
|
|||||||||||||||||||||||||||||||||
The identifier which correlates to the provided user (also named "baseFilter") Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The dn where we look for users Environment variable: |
string |
required |
||||||||||||||||||||||||||||||||
If the child nodes are also searched for identities Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The roleAttributeId from which is mapped (e.g. "cn") Environment variable: |
string |
required |
||||||||||||||||||||||||||||||||
The identifier whom the attribute is mapped to (in Quarkus: "groups", in WildFly this is "Roles") Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The filter (also named "roleFilter") Environment variable: |
string |
required |
||||||||||||||||||||||||||||||||
The filter base dn (also named "rolesContextDn") Environment variable: |
string |
required |
||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
Determine if the OAuth2 extension is enabled. Enabled by default if you include the Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The claim that is used in the introspection endpoint response to load the roles. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The OAuth2 client id used to validate the token. Mandatory if the extension is enabled. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The OAuth2 client secret used to validate the token. Mandatory if the extension is enabled. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The OAuth2 introspection endpoint URL used to validate the token and gather the authentication claims. Mandatory if the extension is enabled. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The OAuth2 server certificate file. Warning: this is not supported in native mode where the certificate must be included in the truststore used during the native image generation, see Using SSL With Native Executables. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
If the properties are stored in plain text. If this is false (the default) then it is expected that the passwords are of the form HEX( MD5( username ":" realm ":" password ) ) Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Determine which algorithm to use.
This property is ignored if Environment variable: |
|
|
||||||||||||||||||||||||||||||||
The realm users user1=password\nuser2=password2… mapping. See Embedded Users. Environment variable: |
|
|||||||||||||||||||||||||||||||||
The realm roles user1=role1,role2,…\nuser2=role1,role2,… mapping See Embedded Roles. Environment variable: |
|
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
The realm name. This is used when generating a hashed password Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Determine whether security via the file realm is enabled. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
If the properties are stored in plain text. If this is false (the default) then it is expected that the passwords are of the form HEX( MD5( username ":" realm ":" password ) ) Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Classpath resource name of properties file containing user to password mappings. See Users.properties. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Classpath resource name of properties file containing user to role mappings. See Roles.properties. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
The realm name. This is used when generating a hashed password Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Determine whether security via the embedded realm is enabled. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
Comma-separated list of locations to scan recursively for migrations. The location type is determined by its prefix. Unprefixed locations or locations starting with classpath: point to a package on the classpath and may contain both SQL and Java-based migrations. Locations starting with filesystem: point to a directory on the filesystem, may only contain SQL migrations and are only scanned recursively down non-hidden directories. Environment variable: |
list of string |
|
||||||||||||||||||||||||||||||||
Comma-separated list of fully qualified class names of Callback implementations to use to hook into the Flyway lifecycle. The Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
Flag to enable / disable Flyway. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The maximum number of retries when attempting to connect to the database. After each failed attempt, Flyway will wait 1 second before attempting to connect again, up to the maximum number of times specified by connectRetries. Environment variable: |
int |
|||||||||||||||||||||||||||||||||
Sets the default schema managed by Flyway. This schema name is case-sensitive. If not specified, but schemas is, Flyway uses the first schema in that list. If that is also not specified, Flyway uses the default schema for the database connection. Consequences: - This schema will be the one containing the schema history table. - This schema will be the default for the database connection (provided the database supports this concept). Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The JDBC URL that Flyway uses to connect to the database. Falls back to the datasource URL if not specified. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The username that Flyway uses to connect to the database. If no specific JDBC URL is configured, falls back to the datasource username if not specified. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The password that Flyway uses to connect to the database. If no specific JDBC URL is configured, falls back to the datasource password if not specified. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Comma-separated case-sensitive list of schemas managed by Flyway. The first schema in the list will be automatically set as the default one during the migration. It will also be the one containing the schema history table. Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
The name of Flyway’s schema history table. By default (single-schema mode), the schema history table is placed in the default schema for the connection provided by the datasource. When the flyway.schemas property is set (multi-schema mode), the schema history table is placed in the first schema of the list. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The file name prefix for versioned SQL migrations. Versioned SQL migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix , which using the defaults translates to V1.1__My_description.sql Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The file name prefix for repeatable SQL migrations. Repeatable SQL migrations have the following file name structure: prefixSeparatorDESCRIPTIONsuffix , which using the defaults translates to R__My_description.sql Environment variable: |
string |
|||||||||||||||||||||||||||||||||
true to execute Flyway clean command automatically when the application starts, false otherwise. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
true to prevent Flyway clean operations, false otherwise. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
true to automatically call clean when a validation error occurs, false otherwise. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
true to execute Flyway automatically when the application starts, false otherwise. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
true to execute a Flyway repair command when the application starts, false otherwise. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
true to execute a Flyway validate command when the application starts, false otherwise. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Enable the creation of the history table if it does not exist already. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The initial baseline version. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The description to tag an existing schema with when executing baseline. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Whether to automatically call validate when performing a migration. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Allows migrations to be run "out of order". Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Ignore missing migrations when reading the history table. When set to true migrations from older versions present in the history table but absent in the configured locations will be ignored (and logged as a warning), when false (the default) the validation step will fail. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Ignore future migrations when reading the history table. When set to true migrations from newer versions present in the history table but absent in the configured locations will be ignored (and logged as a warning), when false (the default) the validation step will fail. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Whether Flyway should attempt to create the schemas specified in the schemas property Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Prefix of every placeholder (default: ${ ) Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Suffix of every placeholder (default: } ) Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The SQL statements to run to initialize a new database connection immediately after opening it. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Whether to validate migrations and callbacks whose scripts do not obey the correct naming convention. A failure can be useful to check that errors such as case sensitivity in migration prefixes have been corrected. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Ignore migrations during validate and repair according to a given list of patterns (see https://flywaydb.org/documentation/configuration/parameters/ignoreMigrationPatterns for more information). When this configuration is set, the ignoreFutureMigrations and ignoreMissingMigrations settings are ignored. Patterns are comma separated. Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
Comma-separated list of locations to scan recursively for migrations. The location type is determined by its prefix. Unprefixed locations or locations starting with classpath: point to a package on the classpath and may contain both SQL and Java-based migrations. Locations starting with filesystem: point to a directory on the filesystem, may only contain SQL migrations and are only scanned recursively down non-hidden directories. Environment variable: |
list of string |
|
||||||||||||||||||||||||||||||||
Comma-separated list of fully qualified class names of Callback implementations to use to hook into the Flyway lifecycle. The Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
Sets the placeholders to replace in SQL migration scripts. Environment variable: |
|
|||||||||||||||||||||||||||||||||
The maximum number of retries when attempting to connect to the database. After each failed attempt, Flyway will wait 1 second before attempting to connect again, up to the maximum number of times specified by connectRetries. Environment variable: |
int |
|||||||||||||||||||||||||||||||||
Sets the default schema managed by Flyway. This schema name is case-sensitive. If not specified, but schemas is, Flyway uses the first schema in that list. If that is also not specified, Flyway uses the default schema for the database connection. Consequences: - This schema will be the one containing the schema history table. - This schema will be the default for the database connection (provided the database supports this concept). Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The JDBC URL that Flyway uses to connect to the database. Falls back to the datasource URL if not specified. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The username that Flyway uses to connect to the database. If no specific JDBC URL is configured, falls back to the datasource username if not specified. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The password that Flyway uses to connect to the database. If no specific JDBC URL is configured, falls back to the datasource password if not specified. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Comma-separated case-sensitive list of schemas managed by Flyway. The first schema in the list will be automatically set as the default one during the migration. It will also be the one containing the schema history table. Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
The name of Flyway’s schema history table. By default (single-schema mode), the schema history table is placed in the default schema for the connection provided by the datasource. When the flyway.schemas property is set (multi-schema mode), the schema history table is placed in the first schema of the list. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The file name prefix for versioned SQL migrations. Versioned SQL migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix , which using the defaults translates to V1.1__My_description.sql Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The file name prefix for repeatable SQL migrations. Repeatable SQL migrations have the following file name structure: prefixSeparatorDESCRIPTIONsuffix , which using the defaults translates to R__My_description.sql Environment variable: |
string |
|||||||||||||||||||||||||||||||||
true to execute Flyway clean command automatically when the application starts, false otherwise. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
true to prevent Flyway clean operations, false otherwise. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
true to automatically call clean when a validation error occurs, false otherwise. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
true to execute Flyway automatically when the application starts, false otherwise. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
true to execute a Flyway repair command when the application starts, false otherwise. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
true to execute a Flyway validate command when the application starts, false otherwise. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Enable the creation of the history table if it does not exist already. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The initial baseline version. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The description to tag an existing schema with when executing baseline. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Whether to automatically call validate when performing a migration. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Allows migrations to be run "out of order". Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Ignore missing migrations when reading the history table. When set to true migrations from older versions present in the history table but absent in the configured locations will be ignored (and logged as a warning), when false (the default) the validation step will fail. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Ignore future migrations when reading the history table. When set to true migrations from newer versions present in the history table but absent in the configured locations will be ignored (and logged as a warning), when false (the default) the validation step will fail. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Sets the placeholders to replace in SQL migration scripts. Environment variable: |
|
|||||||||||||||||||||||||||||||||
Whether Flyway should attempt to create the schemas specified in the schemas property Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Prefix of every placeholder (default: ${ ) Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Suffix of every placeholder (default: } ) Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The SQL statements to run to initialize a new database connection immediately after opening it. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Whether to validate migrations and callbacks whose scripts do not obey the correct naming convention. A failure can be useful to check that errors such as case sensitivity in migration prefixes have been corrected. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Ignore migrations during validate and repair according to a given list of patterns (see https://flywaydb.org/documentation/configuration/parameters/ignoreMigrationPatterns for more information). When this configuration is set, the ignoreFutureMigrations and ignoreMissingMigrations settings are ignored. Patterns are comma separated. Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
Cloud Event type (ce-type) that triggers this function. Default value is function name. This config item is only required when there is more than one function defined within the deployment. The ce-type is not looked at if there is only one function in the deployment. The message will just be dispatched to that function. This allows you to change the knative trigger binding without having to change the configuration of the quarkus deployment. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
If function has response output, then what is the Cloud Event type (ce-type)? This will default to {function}.output Environment variable: |
string |
|||||||||||||||||||||||||||||||||
If function has response output, then what is the Cloud Event source (ce-source)? This will default to the function name Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
The function to export. If there is more than one function defined for this deployment, then you must set this variable. If there is only a single function, you do not have to set this config item. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
The function name. Function names are specified on function classes using the Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
Whether Hibernate Envers is enabled <strong>during the build</strong>. If Hibernate Envers is disabled during the build, all processing related to Hibernate Envers will be skipped,
and the audit entities will not be added to the Hibernate ORM metamodel
nor to the database schema that Hibernate ORM generates,
but it will not be possible to use Hibernate Envers at runtime:
Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Whether Hibernate Envers should be active for this persistence unit at runtime. If Hibernate Envers is not active, the audit entities will still be added to the Hibernate ORM metamodel
and to the database schema that Hibernate ORM generates:
you would need to disable Hibernate Envers at build time (i.e. set Note that if Hibernate Envers is disabled (i.e. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Enable store_data_at_delete feature. Maps to Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Defines a suffix for historical data table. Defaults to Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Defines a prefix for historical data table. Default is the empty string. Maps to Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Revision field name. Defaults to Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Revision type field name. Defaults to Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Enable the revision_on_collection_change feature. Maps to Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Enable the do_not_audit_optimistic_locking_field feature. Maps to Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Defines the default schema of where audit tables are to be created. Maps to Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Defines the default catalog of where audit tables are to be created. Maps to Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Enables the track_entities_changed_in_revision feature. Maps to Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Enables the use_revision_entity_with_native_id feature. Maps to Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Enables the global_with_modified_flag feature. Maps to Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Defines the suffix to be used for modified flag columns. Defaults to Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Defines the fully qualified class name of a user defined revision listener. Maps to Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Defines the fully qualified class name of the audit strategy to be used. Maps to Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Defines the property name for the audit entity’s composite primary key. Defaults to Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Defines the column name that holds the end revision number in audit entities. Defaults to Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Enables the audit_strategy_validity_store_revend_timestamp feature. Maps to Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Defines the column name of the revision end timestamp in the audit tables. Defaults to Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Defines the name of the column used for storing collection ordinal values for embeddable elements. Defaults to Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Enables the allow_identifier_reuse feature. Maps to Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Defines the naming strategy to be used for modified columns. Defaults to Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
Whether Hibernate Envers should be active for this persistence unit at runtime. If Hibernate Envers is not active, the audit entities will still be added to the Hibernate ORM metamodel
and to the database schema that Hibernate ORM generates:
you would need to disable Hibernate Envers at build time (i.e. set Note that if Hibernate Envers is disabled (i.e. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Enable store_data_at_delete feature. Maps to Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Defines a suffix for historical data table. Defaults to Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Defines a prefix for historical data table. Default is the empty string. Maps to Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Revision field name. Defaults to Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Revision type field name. Defaults to Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Enable the revision_on_collection_change feature. Maps to Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Enable the do_not_audit_optimistic_locking_field feature. Maps to Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Defines the default schema of where audit tables are to be created. Maps to Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Defines the default catalog of where audit tables are to be created. Maps to Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Enables the track_entities_changed_in_revision feature. Maps to Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Enables the use_revision_entity_with_native_id feature. Maps to Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Enables the global_with_modified_flag feature. Maps to Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Defines the suffix to be used for modified flag columns. Defaults to Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Defines the fully qualified class name of a user defined revision listener. Maps to Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Defines the fully qualified class name of the audit strategy to be used. Maps to Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Defines the property name for the audit entity’s composite primary key. Defaults to Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Defines the column name that holds the end revision number in audit entities. Defaults to Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Enables the audit_strategy_validity_store_revend_timestamp feature. Maps to Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Defines the column name of the revision end timestamp in the audit tables. Defaults to Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Defines the name of the column used for storing collection ordinal values for embeddable elements. Defaults to Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Enables the allow_identifier_reuse feature. Maps to Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Defines the naming strategy to be used for modified columns. Defaults to Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
Whether Hibernate ORM is enabled during the build. If Hibernate ORM is disabled during the build, all processing related to Hibernate ORM will be skipped,
but it will not be possible to activate Hibernate ORM at runtime:
Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
Path to a file containing the SQL statements to execute when Hibernate ORM starts. The file is retrieved from the classpath resources,
so it must be located in the resources directory (e.g. The default value for this setting differs depending on the Quarkus launch mode:
If you need different SQL statements between dev mode, test ( application.properties
Environment variable: |
list of string |
|
||||||||||||||||||||||||||||||||
Pluggable strategy contract for applying physical naming rules for database object names. Class name of the Hibernate PhysicalNamingStrategy implementation Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Pluggable strategy for applying implicit naming rules when an explicit name is not given. Class name of the Hibernate ImplicitNamingStrategy implementation Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Class name of a custom
Environment variable: |
string |
|||||||||||||||||||||||||||||||||
XML files to configure the entity mapping, e.g. Environment variable: |
list of string |
|
||||||||||||||||||||||||||||||||
Identifiers can be quoted using one of the available strategies.
Set to Environment variable: |
tooltip:none[No optimizer, resulting in a database call each and every time an identifier value is needed from the generator. Not recommended in production environments:
may result in degraded performance and/or frequent gaps in identifier values.], |
|
||||||||||||||||||||||||||||||||
The default in Quarkus is for 2nd level caching to be enabled, and a good implementation is already integrated for you. Just cherry-pick which entities should be using the cache. Set this to false to disable all 2nd level caches. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Enables the Bean Validation integration. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Defines the method for multi-tenancy (DATABASE, NONE, SCHEMA). The complete list of allowed values is available in the Hibernate ORM JavaDoc. The type DISCRIMINATOR is currently not supported. The default value is NONE (no multi-tenancy). Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Defines the name of the datasource to use in case of SCHEMA approach. The datasource of the persistence unit will be used if not set. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
If hibernate is not auto generating the schema, and Quarkus is running in development mode then Quarkus will attempt to validate the database after startup and print a log message if there are any problems. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
If Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Whether statistics collection is enabled. If 'metrics.enabled' is true, then the default here is considered true, otherwise the default is false. Environment variable: |
boolean |
|||||||||||||||||||||||||||||||||
Whether session metrics should be appended into the server log for each Hibernate session. This only has effect if statistics are enabled ( Environment variable: |
boolean |
|||||||||||||||||||||||||||||||||
Whether metrics are published if a metrics extension is enabled. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Whether this persistence unit should be active at runtime. If the persistence unit is not active, it won’t start with the application, and accessing the corresponding EntityManagerFactory/EntityManager or SessionFactory/Session will not be possible. Note that if Hibernate ORM is disabled (i.e. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Properties that should be passed on directly to Hibernate ORM.
Use the full configuration property key here,
for instance
Consider using a supported configuration property before falling back to unsupported ones. If none exists, make sure to file a feature request so that a supported configuration property can be added to Quarkus, and more importantly so that the configuration property is tested regularly. Environment variable: |
|
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
When set, attempts to exchange data with the database as the given version of Hibernate ORM would have, on a best-effort basis. Please note:
Environment variable: |
|
|
||||||||||||||||||||||||||||||||
The charset of the database. Used for DDL generation and also for the SQL import scripts. Environment variable: |
|
|||||||||||||||||||||||||||||||||
Select whether the database schema is generated or not. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
If Hibernate ORM should create the schemas automatically (for databases supporting them). Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Whether we should stop on the first error when applying the schema. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The default catalog to use for the database objects. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The default schema to use for the database objects. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
Class name of the Hibernate ORM dialect. The complete list of bundled dialects is available in the Hibernate ORM JavaDoc. Setting the dialect directly is only recommended as a last resort:
most popular databases have a corresponding Quarkus extension,
allowing Quarkus to select the dialect automatically,
in which case you do not need to set the dialect at all,
though you may want to set
If your database does not have a corresponding Quarkus extension, you will need to set the dialect directly. In that case, keep in mind that the JDBC driver and Hibernate ORM dialect may not work properly in GraalVM native executables. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The storage engine to use when the dialect supports multiple storage engines. E.g. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
How to store timezones in the database by default
for properties of type This default may be overridden on a per-property basis using
Environment variable: |
|
|
||||||||||||||||||||||||||||||||
The optimizer to apply to identifier generators whose optimizer is not configured explicitly. Only relevant for table- and sequence-based identifier generators. Other generators, such as UUID-based generators, will ignore this setting. The optimizer is responsible for pooling new identifier values, in order to reduce the frequency of database calls to retrieve those values and thereby improve performance. Environment variable: |
|
|
||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
The maximum size of the query plan cache. see # Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
Default precedence of null values in Valid values are: Environment variable: |
|
|
||||||||||||||||||||||||||||||||
Enables IN clause parameter padding which improves statement caching. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
The time zone pushed to the JDBC driver. See Environment variable: |
string |
|||||||||||||||||||||||||||||||||
How many rows are fetched at a time by the JDBC driver. Environment variable: |
int |
|||||||||||||||||||||||||||||||||
The number of updates (inserts, updates and deletes) that are sent by the JDBC driver at one time for execution. Environment variable: |
int |
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
The size of the batches used when loading entities and collections.
Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
The maximum depth of outer join fetch tree for single-ended associations (one-to-one, many-to-one). A Environment variable: |
int |
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
The maximum time before an object of the cache is considered expired. Environment variable: |
||||||||||||||||||||||||||||||||||
The maximum number of objects kept in memory in the cache. Environment variable: |
long |
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
Existing applications rely (implicitly or explicitly) on Hibernate ignoring any DiscriminatorColumn declarations on joined inheritance hierarchies. This setting allows these applications to maintain the legacy behavior of DiscriminatorColumn annotations being ignored when paired with joined inheritance. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
Path to a file containing the SQL statements to execute when Hibernate ORM starts. The file is retrieved from the classpath resources,
so it must be located in the resources directory (e.g. The default value for this setting differs depending on the Quarkus launch mode:
If you need different SQL statements between dev mode, test ( application.properties
Environment variable: |
list of string |
|
||||||||||||||||||||||||||||||||
Pluggable strategy contract for applying physical naming rules for database object names. Class name of the Hibernate PhysicalNamingStrategy implementation Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Pluggable strategy for applying implicit naming rules when an explicit name is not given. Class name of the Hibernate ImplicitNamingStrategy implementation Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Class name of a custom
Environment variable: |
string |
|||||||||||||||||||||||||||||||||
XML files to configure the entity mapping, e.g. Environment variable: |
list of string |
|
||||||||||||||||||||||||||||||||
Identifiers can be quoted using one of the available strategies.
Set to Environment variable: |
tooltip:none[No optimizer, resulting in a database call each and every time an identifier value is needed from the generator. Not recommended in production environments:
may result in degraded performance and/or frequent gaps in identifier values.], |
|
||||||||||||||||||||||||||||||||
The default in Quarkus is for 2nd level caching to be enabled, and a good implementation is already integrated for you. Just cherry-pick which entities should be using the cache. Set this to false to disable all 2nd level caches. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Enables the Bean Validation integration. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Defines the method for multi-tenancy (DATABASE, NONE, SCHEMA). The complete list of allowed values is available in the Hibernate ORM JavaDoc. The type DISCRIMINATOR is currently not supported. The default value is NONE (no multi-tenancy). Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Defines the name of the datasource to use in case of SCHEMA approach. The datasource of the persistence unit will be used if not set. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
If hibernate is not auto generating the schema, and Quarkus is running in development mode then Quarkus will attempt to validate the database after startup and print a log message if there are any problems. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Whether this persistence unit should be active at runtime. If the persistence unit is not active, it won’t start with the application, and accessing the corresponding EntityManagerFactory/EntityManager or SessionFactory/Session will not be possible. Note that if Hibernate ORM is disabled (i.e. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Properties that should be passed on directly to Hibernate ORM.
Use the full configuration property key here,
for instance
Consider using a supported configuration property before falling back to unsupported ones. If none exists, make sure to file a feature request so that a supported configuration property can be added to Quarkus, and more importantly so that the configuration property is tested regularly. Environment variable: |
|
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
Class name of the Hibernate ORM dialect. The complete list of bundled dialects is available in the Hibernate ORM JavaDoc. Setting the dialect directly is only recommended as a last resort:
most popular databases have a corresponding Quarkus extension,
allowing Quarkus to select the dialect automatically,
in which case you do not need to set the dialect at all,
though you may want to set
If your database does not have a corresponding Quarkus extension, you will need to set the dialect directly. In that case, keep in mind that the JDBC driver and Hibernate ORM dialect may not work properly in GraalVM native executables. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
The storage engine to use when the dialect supports multiple storage engines. E.g. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
How to store timezones in the database by default
for properties of type This default may be overridden on a per-property basis using
Environment variable: |
|
|
||||||||||||||||||||||||||||||||
The optimizer to apply to identifier generators whose optimizer is not configured explicitly. Only relevant for table- and sequence-based identifier generators. Other generators, such as UUID-based generators, will ignore this setting. The optimizer is responsible for pooling new identifier values, in order to reduce the frequency of database calls to retrieve those values and thereby improve performance. Environment variable: |
|
|
||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
The maximum size of the query plan cache. see # Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
Default precedence of null values in Valid values are: Environment variable: |
|
|
||||||||||||||||||||||||||||||||
Enables IN clause parameter padding which improves statement caching. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
The charset of the database. Used for DDL generation and also for the SQL import scripts. Environment variable: |
|
|||||||||||||||||||||||||||||||||
Select whether the database schema is generated or not. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
If Hibernate ORM should create the schemas automatically (for databases supporting them). Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Whether we should stop on the first error when applying the schema. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The default catalog to use for the database objects. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The default schema to use for the database objects. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
The time zone pushed to the JDBC driver. See Environment variable: |
string |
|||||||||||||||||||||||||||||||||
How many rows are fetched at a time by the JDBC driver. Environment variable: |
int |
|||||||||||||||||||||||||||||||||
The number of updates (inserts, updates and deletes) that are sent by the JDBC driver at one time for execution. Environment variable: |
int |
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
The size of the batches used when loading entities and collections.
Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
The maximum depth of outer join fetch tree for single-ended associations (one-to-one, many-to-one). A Environment variable: |
int |
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
The maximum time before an object of the cache is considered expired. Environment variable: |
||||||||||||||||||||||||||||||||||
The maximum number of objects kept in memory in the cache. Environment variable: |
long |
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
Existing applications rely (implicitly or explicitly) on Hibernate ignoring any DiscriminatorColumn declarations on joined inheritance hierarchies. This setting allows these applications to maintain the legacy behavior of DiscriminatorColumn annotations being ignored when paired with joined inheritance. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
Select whether the database schema DDL files are generated or not. Accepted values: Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Filename or URL where the database create DDL file should be generated. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Filename or URL where the database drop DDL file should be generated. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
Show SQL logs and format them nicely. Setting it to true is obviously not recommended in production. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Format the SQL logs if SQL log is enabled Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Whether JDBC warnings should be collected and logged. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
If set, Hibernate will log queries that took more than specified number of milliseconds to execute. Environment variable: |
long |
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
Logs SQL bind parameters. Setting it to true is obviously not recommended in production. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Show SQL logs and format them nicely. Setting it to true is obviously not recommended in production. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Format the SQL logs if SQL log is enabled Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
Whether JDBC warnings should be collected and logged. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
If set, Hibernate will log queries that took more than specified number of milliseconds to execute. Environment variable: |
long |
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
Select whether the database schema DDL files are generated or not. Accepted values: Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Filename or URL where the database create DDL file should be generated. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Filename or URL where the database drop DDL file should be generated. Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
Whether Hibernate Search is enabled during the build. If Hibernate Search is disabled during the build, all processing related to Hibernate Search will be skipped,
but it will not be possible to activate Hibernate Search at runtime:
Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
A bean reference to a component that should be notified of any failure occurring in a background process (mainly index operations). The referenced bean must implement
Environment variable: |
string |
|||||||||||||||||||||||||||||||||
The strategy to use for coordinating between threads or even separate instances of the application, in particular in automatic indexing. See coordination for more information. Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Whether Hibernate Search should be active for this persistence unit at runtime. If Hibernate Search is not active, it won’t index Hibernate ORM entities, and accessing the SearchMapping/SearchSession of the relevant persistence unit for search or other operation will not be possible. Note that if Hibernate Search is disabled (i.e. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
The schema management strategy, controlling how indexes and their schema are created, updated, validated or dropped on startup and shutdown. Available values:
See this section of the reference documentation for more information. Environment variable: |
SchemaManagementStrategyName |
|
||||||||||||||||||||||||||||||||
The strategy to use when loading entities during the execution of a search query. Environment variable: |
|
|
||||||||||||||||||||||||||||||||
The fetch size to use when loading entities during the execution of a search query. Environment variable: |
int |
|
||||||||||||||||||||||||||||||||
The synchronization strategy to use when indexing automatically. Defines how complete indexing should be before resuming the application thread after a database transaction is committed.
Available values:
This property also accepts a bean reference
to a custom implementations of See this section of the reference documentation for more information.
Environment variable: |
string |
|
||||||||||||||||||||||||||||||||
Whether to check if dirty properties are relevant to indexing before actually reindexing an entity. When enabled, re-indexing of an entity is skipped if the only changes are on properties that are not used when indexing. Environment variable: |
boolean |
|
||||||||||||||||||||||||||||||||
An exhaustive list of all tenant identifiers that may be used by the application when multi-tenancy is enabled. Mainly useful when using the {@code outbox-polling} coordination strategy, since it involves setting up one background processor per tenant. Environment variable: |
list of string |
|||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||||
The version of Elasticsearch used in the cluster. As the schema is generated without a connection to the server, this item is mandatory. It doesn’t have to be the exact version (it can be There’s no rule of thumb here as it depends on the schema incompatibilities introduced by Elasticsearch versions. In any case, if there is a problem, you will have an error when Hibernate Search tries to connect to the cluster. Environment variable: |
ElasticsearchVersion |
|||||||||||||||||||||||||||||||||
A bean reference to the component used to configure layout (e.g. index names, index aliases). The referenced bean must implement Available built-in implementations:
See this section of the reference documentation for more information.
Environment variable: |
string |
|||||||||||||||||||||||||||||||||
Path to a file in the classpath holding custom index settings to be included in the index definition when creating an Elasticsearch index. The provided settings will be merged with those generated by Hibernate Search, including analyzer definitions. When analysis is configured both through an analysis configurer and these cus |