AWS Lambda |
类型 |
默认 |
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: QUARKUS_LAMBDA_EXPECTED_EXCEPTIONS
|
list of class name |
|
The handler name. Handler names are specified on handler classes using the @javax.inject.Named annotation. If this name is unspecified and there is exactly one unnamed implementation of com.amazonaws.services.lambda.runtime.RequestHandler then this unnamed handler will be used. If there is only a single named handler and the name is unspecified then the named handler will be used.
Environment variable: QUARKUS_LAMBDA_HANDLER
|
string |
|
AWS Lambda Common |
类型 |
默认 |
Port to access mock event server in dev mode
Environment variable: QUARKUS_LAMBDA_MOCK_EVENT_SERVER_DEV_PORT
|
int |
8080
|
Port to access mock event server in dev mode
Environment variable: QUARKUS_LAMBDA_MOCK_EVENT_SERVER_TEST_PORT
|
int |
8081
|
AWS Lambda Gateway REST API |
类型 |
默认 |
Enable security mechanisms to process lambda and AWS based security (i.e. Cognito, IAM) from the http event sent from API Gateway
Environment variable: QUARKUS_LAMBDA_HTTP_ENABLE_SECURITY
|
boolean |
false
|
Agroal - Database connection pool |
类型 |
默认 |
If we create a JDBC datasource for this datasource.
Environment variable: QUARKUS_DATASOURCE_JDBC
|
boolean |
true
|
The datasource driver class name
Environment variable: QUARKUS_DATASOURCE_JDBC_DRIVER
|
string |
|
Whether we want to use regular JDBC transactions, XA, or disable all transactional capabilities.
When enabling XA you will need a driver implementing javax.sql.XADataSource .
Environment variable: QUARKUS_DATASOURCE_JDBC_TRANSACTIONS
|
|
enabled
|
Enable datasource metrics collection. If unspecified, collecting metrics will be enabled by default if a metrics extension is active.
Environment variable: QUARKUS_DATASOURCE_JDBC_ENABLE_METRICS
|
boolean |
|
Enable JDBC tracing. Disabled by default.
Environment variable: QUARKUS_DATASOURCE_JDBC_TRACING
|
boolean |
false
|
Environment variable: QUARKUS_DATASOURCE_JDBC_URL
|
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: QUARKUS_DATASOURCE_JDBC_INITIAL_SIZE
|
int |
|
The datasource pool minimum size
Environment variable: QUARKUS_DATASOURCE_JDBC_MIN_SIZE
|
int |
0
|
The datasource pool maximum size
Environment variable: QUARKUS_DATASOURCE_JDBC_MAX_SIZE
|
int |
20
|
The interval at which we validate idle connections in the background.
Set to 0 to disable background validation.
Environment variable: QUARKUS_DATASOURCE_JDBC_BACKGROUND_VALIDATION_INTERVAL
|
Duration
|
2M
|
Perform foreground validation on connections that have been idle for longer than the specified interval.
Environment variable: QUARKUS_DATASOURCE_JDBC_FOREGROUND_VALIDATION_INTERVAL
|
Duration
|
|
The timeout before cancelling the acquisition of a new connection
Environment variable: QUARKUS_DATASOURCE_JDBC_ACQUISITION_TIMEOUT
|
Duration
|
5
|
The interval at which we check for connection leaks.
Environment variable: QUARKUS_DATASOURCE_JDBC_LEAK_DETECTION_INTERVAL
|
Duration
|
|
The interval at which we try to remove idle connections.
Environment variable: QUARKUS_DATASOURCE_JDBC_IDLE_REMOVAL_INTERVAL
|
Duration
|
5M
|
The max lifetime of a connection.
Environment variable: QUARKUS_DATASOURCE_JDBC_MAX_LIFETIME
|
Duration
|
|
The transaction isolation level.
Environment variable: QUARKUS_DATASOURCE_JDBC_TRANSACTION_ISOLATION_LEVEL
|
undefined , none , read-uncommitted , read-committed , repeatable-read , serializable
|
|
Collect and display extra troubleshooting info on leaked connections.
Environment variable: QUARKUS_DATASOURCE_JDBC_EXTENDED_LEAK_REPORT
|
boolean |
false
|
Allows connections to be flushed upon return to the pool. It’s not enabled by default.
Environment variable: QUARKUS_DATASOURCE_JDBC_FLUSH_ON_CLOSE
|
boolean |
false
|
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: QUARKUS_DATASOURCE_JDBC_DETECT_STATEMENT_LEAKS
|
boolean |
true
|
Query executed when first using a connection.
Environment variable: QUARKUS_DATASOURCE_JDBC_NEW_CONNECTION_SQL
|
string |
|
Query executed to validate a connection.
Environment variable: QUARKUS_DATASOURCE_JDBC_VALIDATION_QUERY_SQL
|
string |
|
Disable pooling to prevent reuse of Connections. Use this with when an external pool manages the life-cycle of Connections.
Environment variable: QUARKUS_DATASOURCE_JDBC_POOLING_ENABLED
|
boolean |
true
|
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: QUARKUS_DATASOURCE_JDBC_TRANSACTION_REQUIREMENT
|
|
|
Environment variable: QUARKUS_DATASOURCE_JDBC_TRACING_ENABLED
|
boolean |
false if quarkus.datasource.jdbc.tracing=false and true if quarkus.datasource.jdbc.tracing=true
|
Trace calls with active Spans only
Environment variable: QUARKUS_DATASOURCE_JDBC_TRACING_TRACE_WITH_ACTIVE_SPAN_ONLY
|
boolean |
false
|
Ignore specific queries from being traced
Environment variable: QUARKUS_DATASOURCE_JDBC_TRACING_IGNORE_FOR_TRACING
|
string |
Ignore specific queries from being traced, multiple queries can be specified separated by semicolon, double quotes should be escaped with \
|
Other unspecified properties to be passed to the JDBC driver when creating new connections.
Environment variable: QUARKUS_DATASOURCE_JDBC_ADDITIONAL_JDBC_PROPERTIES
|
Map<String,String>
|
|
Additional named datasources |
类型 |
默认 |
If we create a JDBC datasource for this datasource.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC
|
boolean |
true
|
The datasource driver class name
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_DRIVER
|
string |
|
Whether we want to use regular JDBC transactions, XA, or disable all transactional capabilities.
When enabling XA you will need a driver implementing javax.sql.XADataSource .
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_TRANSACTIONS
|
|
enabled
|
Enable datasource metrics collection. If unspecified, collecting metrics will be enabled by default if a metrics extension is active.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_ENABLE_METRICS
|
boolean |
|
Enable JDBC tracing. Disabled by default.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_TRACING
|
boolean |
false
|
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_URL
|
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: QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_INITIAL_SIZE
|
int |
|
The datasource pool minimum size
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_MIN_SIZE
|
int |
0
|
The datasource pool maximum size
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_MAX_SIZE
|
int |
20
|
The interval at which we validate idle connections in the background.
Set to 0 to disable background validation.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_BACKGROUND_VALIDATION_INTERVAL
|
Duration
|
2M
|
Perform foreground validation on connections that have been idle for longer than the specified interval.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_FOREGROUND_VALIDATION_INTERVAL
|
Duration
|
|
The timeout before cancelling the acquisition of a new connection
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_ACQUISITION_TIMEOUT
|
Duration
|
5
|
The interval at which we check for connection leaks.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_LEAK_DETECTION_INTERVAL
|
Duration
|
|
The interval at which we try to remove idle connections.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_IDLE_REMOVAL_INTERVAL
|
Duration
|
5M
|
The max lifetime of a connection.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_MAX_LIFETIME
|
Duration
|
|
The transaction isolation level.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_TRANSACTION_ISOLATION_LEVEL
|
undefined , none , read-uncommitted , read-committed , repeatable-read , serializable
|
|
Collect and display extra troubleshooting info on leaked connections.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_EXTENDED_LEAK_REPORT
|
boolean |
false
|
Allows connections to be flushed upon return to the pool. It’s not enabled by default.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_FLUSH_ON_CLOSE
|
boolean |
false
|
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: QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_DETECT_STATEMENT_LEAKS
|
boolean |
true
|
Query executed when first using a connection.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_NEW_CONNECTION_SQL
|
string |
|
Query executed to validate a connection.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_VALIDATION_QUERY_SQL
|
string |
|
Disable pooling to prevent reuse of Connections. Use this with when an external pool manages the life-cycle of Connections.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_POOLING_ENABLED
|
boolean |
true
|
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: QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_TRANSACTION_REQUIREMENT
|
|
|
Other unspecified properties to be passed to the JDBC driver when creating new connections.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_ADDITIONAL_JDBC_PROPERTIES
|
Map<String,String>
|
|
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_TRACING_ENABLED
|
boolean |
false if quarkus.datasource.jdbc.tracing=false and true if quarkus.datasource.jdbc.tracing=true
|
Trace calls with active Spans only
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_TRACING_TRACE_WITH_ACTIVE_SPAN_ONLY
|
boolean |
false
|
Ignore specific queries from being traced
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_TRACING_IGNORE_FOR_TRACING
|
string |
Ignore specific queries from being traced, multiple queries can be specified separated by semicolon, double quotes should be escaped with \
|
Apache Kafka Client |
类型 |
默认 |
Whether a health check is published in case the smallrye-health extension is present.
If you enable the health check, you must specify the kafka.bootstrap.servers property.
Environment variable: QUARKUS_KAFKA_HEALTH_ENABLED
|
boolean |
false
|
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: QUARKUS_KAFKA_SNAPPY_ENABLED
|
boolean |
false
|
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 kafka.bootstrap.servers is set or if all the Reactive Messaging Kafka channel are configured with a bootstrap.servers .
Environment variable: QUARKUS_KAFKA_DEVSERVICES_ENABLED
|
boolean |
|
Optional fixed port the dev service will listen to.
If not defined, the port will be chosen randomly.
Environment variable: QUARKUS_KAFKA_DEVSERVICES_PORT
|
int |
|
Environment variable: QUARKUS_KAFKA_DEVSERVICES_IMAGE_NAME
|
string |
docker.io/vectorized/redpanda:v21.11.3
|
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 quarkus-dev-service-kafka label. The value is configured using the service-name property.
Container sharing is only used in dev mode.
Environment variable: QUARKUS_KAFKA_DEVSERVICES_SHARED
|
boolean |
true
|
The value of the quarkus-dev-service-kafka label attached to the started container. This property is used when shared is set to true . In this case, before starting a container, Dev Services for Kafka looks for a container with the quarkus-dev-service-kafka label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the quarkus-dev-service-kafka label set to the specified value.
This property is used when you need multiple shared Kafka brokers.
Environment variable: QUARKUS_KAFKA_DEVSERVICES_SERVICE_NAME
|
string |
kafka
|
Timeout for admin client calls used in topic creation.
Defaults to 2 seconds.
Environment variable: QUARKUS_KAFKA_DEVSERVICES_TOPIC_PARTITIONS_TIMEOUT
|
Duration
|
2S
|
Environment variable: QUARKUS_KAFKA_DEVSERVICES_REDPANDA_TRANSACTION_ENABLED
|
boolean |
false
|
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, quarkus.kafka.devservices.topic-partitions.test=2 will create a topic named test with 2 partitions.
The topic creation will not try to re-partition existing topics with different number of partitions.
Environment variable: QUARKUS_KAFKA_DEVSERVICES_TOPIC_PARTITIONS
|
Map<String,Integer>
|
|
Apache Kafka Streams |
类型 |
默认 |
Whether a health check is published in case the smallrye-health extension is present (defaults to true).
Environment variable: QUARKUS_KAFKA_STREAMS_HEALTH_ENABLED
|
boolean |
true
|
A unique identifier for this Kafka Streams application. If not set, defaults to quarkus.application.name.
Environment variable: QUARKUS_KAFKA_STREAMS_APPLICATION_ID
|
string |
${quarkus.application.name}
|
A comma-separated list of host:port pairs identifying the Kafka bootstrap server(s). If not set, fallback to kafka.bootstrap.servers , and if not set either use localhost:9012 .
Environment variable: QUARKUS_KAFKA_STREAMS_BOOTSTRAP_SERVERS
|
list of host:port |
localhost:9012
|
A unique identifier of this application instance, typically in the form host:port.
Environment variable: QUARKUS_KAFKA_STREAMS_APPLICATION_SERVER
|
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 ignore.topics is set to false.
Environment variable: QUARKUS_KAFKA_STREAMS_TOPICS
|
list of string |
|
Timeout to wait for topic names to be returned from admin client. If set to 0 (or negative), topics check is ignored.
Environment variable: QUARKUS_KAFKA_STREAMS_TOPICS_TIMEOUT
|
Duration
|
10S
|
The schema registry key. Different schema registry libraries expect a registry URL in different configuration properties. For Apicurio Registry, use apicurio.registry.url . For Confluent schema registry, use schema.registry.url .
Environment variable: QUARKUS_KAFKA_STREAMS_SCHEMA_REGISTRY_KEY
|
string |
schema.registry.url
|
Environment variable: QUARKUS_KAFKA_STREAMS_SCHEMA_REGISTRY_URL
|
string |
|
Environment variable: QUARKUS_KAFKA_STREAMS_SECURITY_PROTOCOL
|
string |
|
SASL mechanism used for client connections
Environment variable: QUARKUS_KAFKA_STREAMS_SASL_MECHANISM
|
string |
|
JAAS login context parameters for SASL connections in the format used by JAAS configuration files
Environment variable: QUARKUS_KAFKA_STREAMS_SASL_JAAS_CONFIG
|
string |
|
The fully qualified name of a SASL client callback handler class
Environment variable: QUARKUS_KAFKA_STREAMS_SASL_CLIENT_CALLBACK_HANDLER_CLASS
|
string |
|
The fully qualified name of a SASL login callback handler class
Environment variable: QUARKUS_KAFKA_STREAMS_SASL_LOGIN_CALLBACK_HANDLER_CLASS
|
string |
|
The fully qualified name of a class that implements the Login interface
Environment variable: QUARKUS_KAFKA_STREAMS_SASL_LOGIN_CLASS
|
string |
|
The Kerberos principal name that Kafka runs as
Environment variable: QUARKUS_KAFKA_STREAMS_SASL_KERBEROS_SERVICE_NAME
|
string |
|
Kerberos kinit command path
Environment variable: QUARKUS_KAFKA_STREAMS_SASL_KERBEROS_KINIT_CMD
|
string |
|
Login thread will sleep until the specified window factor of time from last refresh
Environment variable: QUARKUS_KAFKA_STREAMS_SASL_KERBEROS_TICKET_RENEW_WINDOW_FACTOR
|
double |
|
Percentage of random jitter added to the renewal time
Environment variable: QUARKUS_KAFKA_STREAMS_SASL_KERBEROS_TICKET_RENEW_JITTER
|
double |
|
Percentage of random jitter added to the renewal time
Environment variable: QUARKUS_KAFKA_STREAMS_SASL_KERBEROS_MIN_TIME_BEFORE_RELOGIN
|
long |
|
Login refresh thread will sleep until the specified window factor relative to the credential’s lifetime has been reached-
Environment variable: QUARKUS_KAFKA_STREAMS_SASL_LOGIN_REFRESH_WINDOW_FACTOR
|
double |
|
The maximum amount of random jitter relative to the credential’s lifetime
Environment variable: QUARKUS_KAFKA_STREAMS_SASL_LOGIN_REFRESH_WINDOW_JITTER
|
double |
|
The desired minimum duration for the login refresh thread to wait before refreshing a credential
Environment variable: QUARKUS_KAFKA_STREAMS_SASL_LOGIN_REFRESH_MIN_PERIOD
|
Duration
|
|
The amount of buffer duration before credential expiration to maintain when refreshing a credential
Environment variable: QUARKUS_KAFKA_STREAMS_SASL_LOGIN_REFRESH_BUFFER
|
Duration
|
|
The SSL protocol used to generate the SSLContext
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_PROTOCOL
|
string |
|
The name of the security provider used for SSL connections
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_PROVIDER
|
string |
|
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_CIPHER_SUITES
|
string |
|
The list of protocols enabled for SSL connections
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_ENABLED_PROTOCOLS
|
string |
|
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_TRUSTSTORE_TYPE
|
string |
|
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_TRUSTSTORE_LOCATION
|
string |
|
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_TRUSTSTORE_PASSWORD
|
string |
|
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_TRUSTSTORE_CERTIFICATES
|
string |
|
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_KEYSTORE_TYPE
|
string |
|
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_KEYSTORE_LOCATION
|
string |
|
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_KEYSTORE_PASSWORD
|
string |
|
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_KEYSTORE_KEY
|
string |
|
Key store certificate chain
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_KEYSTORE_CERTIFICATE_CHAIN
|
string |
|
Password of the private key in the key store
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_KEY_PASSWORD
|
string |
|
The algorithm used by key manager factory for SSL connections
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_KEYMANAGER_ALGORITHM
|
string |
|
The algorithm used by trust manager factory for SSL connections
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_TRUSTMANAGER_ALGORITHM
|
string |
|
The endpoint identification algorithm to validate server hostname using server certificate
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_ENDPOINT_IDENTIFICATION_ALGORITHM
|
string |
https
|
The SecureRandom PRNG implementation to use for SSL cryptography operations
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_SECURE_RANDOM_IMPLEMENTATION
|
string |
|
ArC |
类型 |
默认 |
-
If set to all (or true ) the container will attempt to remove all unused beans.
-
If set to none (or false ) no beans will ever be removed even if they are unused (according to the criteria set out below)
-
If set to fwk , then all unused beans will be removed, except the unused beans whose classes are declared in the application code
An unused bean:
-
is not a built-in bean or interceptor,
-
is not eligible for injection to any injection point,
-
is not excluded by any extension,
-
does not have a name,
-
does not declare an observer,
-
does not declare any producer which is eligible for injection to any injection point,
-
is not directly eligible for injection into any javax.enterprise.inject.Instance injection point
Environment variable: QUARKUS_ARC_REMOVE_UNUSED_BEANS
|
string |
all
|
If set to true @Inject is automatically added to all non-static fields that are annotated with one of the annotations defined by AutoInjectAnnotationBuildItem .
Environment variable: QUARKUS_ARC_AUTO_INJECT_FIELDS
|
boolean |
true
|
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: QUARKUS_ARC_TRANSFORM_UNPROXYABLE_CLASSES
|
boolean |
true
|
If set to true, 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 Transactional on a private method of a bean. If set to false, Quarkus simply logs a warning that the annotation will be ignored.
Environment variable: QUARKUS_ARC_FAIL_ON_INTERCEPTED_PRIVATE_METHOD
|
boolean |
false
|
The default naming strategy for ConfigProperties.NamingStrategy . The allowed values are determined by that enum
Environment variable: QUARKUS_ARC_CONFIG_PROPERTIES_DEFAULT_NAMING_STRATEGY
|
from-config , verbatim , kebab-case
|
kebab-case
|
The list of selected alternatives for an application.
An element value can be:
- a fully qualified class name, i.e. org.acme.Foo
- a simple class name as defined by Class#getSimpleName() , i.e. Foo
- a package name with suffix .* , i.e. org.acme.* , matches a package
- a package name with suffix .** , i.e. org.acme.** , matches a package that starts with the value Each element value is used to match an alternative bean class, an alternative stereotype annotation type or a bean class that declares an alternative producer. If any value matches then the priority of Integer#MAX_VALUE is used for the relevant bean. The priority declared via javax.annotation.Priority or io.quarkus.arc.AlternativePriority is overridden.
Environment variable: QUARKUS_ARC_SELECTED_ALTERNATIVES
|
list of string |
|
If set to true then javax.enterprise.inject.Produces is automatically added to all non-void methods that are annotated with a scope annotation, a stereotype or a qualifier, and are not annotated with Inject or Produces , and no parameter is annotated with Disposes , Observes or ObservesAsync .
Environment variable: QUARKUS_ARC_AUTO_PRODUCER_METHODS
|
boolean |
true
|
The list of types that should be excluded from discovery.
An element value can be:
- a fully qualified class name, i.e. org.acme.Foo
- a simple class name as defined by Class#getSimpleName() , i.e. Foo
- a package name with suffix .* , i.e. org.acme.* , matches a package
- a package name with suffix .** , i.e. org.acme.** , matches a package that starts with the value If any element value matches a discovered type then the type is excluded from discovery, i.e. no beans and observer methods are created from this type.
Environment variable: QUARKUS_ARC_EXCLUDE_TYPES
|
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 io.quarkus.arc.Unremovable annotation.
An element value can be:
- a fully qualified class name, i.e. org.acme.Foo
- a simple class name as defined by Class#getSimpleName() , i.e. Foo
- a package name with suffix .* , i.e. org.acme.* , matches a package
- a package name with suffix .** , i.e. org.acme.** , matches a package that starts with the value If any element value matches a discovered bean, then such a bean is considered unremovable.
Environment variable: QUARKUS_ARC_UNREMOVABLE_TYPES
|
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: QUARKUS_ARC_DETECT_UNUSED_FALSE_POSITIVES
|
boolean |
true
|
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 @javax.ejb.Singleton which is often confused with @javax.inject.Singleton . As a result a component annotated with @javax.ejb.Singleton would be completely ignored. Another example is an inner class annotated with a scope annotation - this component would be again completely ignored.
Environment variable: QUARKUS_ARC_DETECT_WRONG_ANNOTATIONS
|
boolean |
true
|
If set to true then the container monitors business method invocations and fired events during the development mode.
Environment variable: QUARKUS_ARC_DEV_MODE_MONITORING_ENABLED
|
boolean |
true
|
If set to true then disable StartupEvent and ShutdownEvent observers declared on application bean classes during the tests.
Environment variable: QUARKUS_ARC_TEST_DISABLE_APPLICATION_LIFECYCLE_OBSERVERS
|
boolean |
false
|
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. org.acme.foo
- a package name with suffix .* , i.e. org.acme.* , which matches a package that starts with provided value
Environment variable: QUARKUS_ARC_IGNORED_SPLIT_PACKAGES
|
list of string |
|
Artifacts that should be excluded from discovery |
类型 |
默认 |
The maven groupId of the artifact.
Environment variable: QUARKUS_ARC_EXCLUDE_DEPENDENCY__DEPENDENCY_NAME__GROUP_ID
|
string |
required |
The maven artifactId of the artifact.
Environment variable: QUARKUS_ARC_EXCLUDE_DEPENDENCY__DEPENDENCY_NAME__ARTIFACT_ID
|
string |
required |
The maven classifier of the artifact.
Environment variable: QUARKUS_ARC_EXCLUDE_DEPENDENCY__DEPENDENCY_NAME__CLASSIFIER
|
string |
|
Cache |
类型 |
默认 |
Whether or not the cache extension is enabled.
Environment variable: QUARKUS_CACHE_ENABLED
|
boolean |
true
|
Environment variable: QUARKUS_CACHE_TYPE
|
string |
caffeine
|
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: QUARKUS_CACHE_CAFFEINE__CACHE_NAME__INITIAL_CAPACITY
|
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: QUARKUS_CACHE_CAFFEINE__CACHE_NAME__MAXIMUM_SIZE
|
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: QUARKUS_CACHE_CAFFEINE__CACHE_NAME__EXPIRE_AFTER_WRITE
|
Duration
|
|
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: QUARKUS_CACHE_CAFFEINE__CACHE_NAME__EXPIRE_AFTER_ACCESS
|
Duration
|
|
Environment variable: QUARKUS_CACHE_CAFFEINE__CACHE_NAME__METRICS_ENABLED
|
boolean |
false
|
Container Image |
类型 |
默认 |
The group the container image will be part of
Environment variable: QUARKUS_CONTAINER_IMAGE_GROUP
|
string |
${user.name}
|
The name of the container image. If not set defaults to the application name
Environment variable: QUARKUS_CONTAINER_IMAGE_NAME
|
string |
${quarkus.application.name:unset}
|
The tag of the container image. If not set defaults to the application version
Environment variable: QUARKUS_CONTAINER_IMAGE_TAG
|
string |
${quarkus.application.version:latest}
|
Additional tags of the container image.
Environment variable: QUARKUS_CONTAINER_IMAGE_ADDITIONAL_TAGS
|
list of string |
|
The container registry to use
Environment variable: QUARKUS_CONTAINER_IMAGE_REGISTRY
|
string |
|
Represents the entire image string. If set, then group , name , registry , tags , additionalTags are ignored
Environment variable: QUARKUS_CONTAINER_IMAGE_IMAGE
|
string |
|
The username to use to authenticate with the registry where the built image will be pushed
Environment variable: QUARKUS_CONTAINER_IMAGE_USERNAME
|
string |
|
The password to use to authenticate with the registry where the built image will be pushed
Environment variable: QUARKUS_CONTAINER_IMAGE_PASSWORD
|
string |
|
Whether or not insecure registries are allowed
Environment variable: QUARKUS_CONTAINER_IMAGE_INSECURE
|
boolean |
false
|
Whether or not a image build will be performed.
Environment variable: QUARKUS_CONTAINER_IMAGE_BUILD
|
boolean |
|
Whether or not an image push will be performed.
Environment variable: QUARKUS_CONTAINER_IMAGE_PUSH
|
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: QUARKUS_CONTAINER_IMAGE_BUILDER
|
string |
|
Custom labels to add to the generated image.
Environment variable: QUARKUS_CONTAINER_IMAGE_LABELS
|
Map<String,String>
|
|
Container Image Buildpack |
类型 |
默认 |
The buildpacks builder image to use when building the project in jvm mode.
Environment variable: QUARKUS_BUILDPACK_JVM_BUILDER_IMAGE
|
string |
|
The buildpacks builder image to use when building the project in jvm mode.
Environment variable: QUARKUS_BUILDPACK_NATIVE_BUILDER_IMAGE
|
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: QUARKUS_BUILDPACK_RUN_IMAGE
|
string |
|
Max pull timeout for builder/run images, in seconds
Environment variable: QUARKUS_BUILDPACK_PULL_TIMEOUT_SECONDS
|
int |
300
|
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: QUARKUS_BUILDPACK_DOCKER_HOST
|
string |
|
Log level to use.. Defaults to 'info'
Environment variable: QUARKUS_BUILDPACK_LOG_LEVEL
|
string |
info
|
The username to use to authenticate with the registry used to pull the base JVM image
Environment variable: QUARKUS_BUILDPACK_BASE_REGISTRY_USERNAME
|
string |
|
The password to use to authenticate with the registry used to pull the base JVM image
Environment variable: QUARKUS_BUILDPACK_BASE_REGISTRY_PASSWORD
|
string |
|
Environment key/values to pass to buildpacks.
Environment variable: QUARKUS_BUILDPACK_BUILDER_ENV
|
Map<String,String>
|
|
Container Image Docker |
类型 |
默认 |
Path to the JVM Dockerfile. If not set ${project.root}/src/main/docker/Dockerfile.jvm will be used If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root
Environment variable: QUARKUS_DOCKER_DOCKERFILE_JVM_PATH
|
string |
|
Path to the JVM Dockerfile. If not set ${project.root}/src/main/docker/Dockerfile.native will be used If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root
Environment variable: QUARKUS_DOCKER_DOCKERFILE_NATIVE_PATH
|
string |
|
Images to consider as cache sources. Values are passed to docker build via the cache-from option
Environment variable: QUARKUS_DOCKER_CACHE_FROM
|
list of string |
|
Environment variable: QUARKUS_DOCKER_NETWORK
|
string |
|
Name of binary used to execute the docker commands.
Environment variable: QUARKUS_DOCKER_EXECUTABLE_NAME
|
string |
docker
|
Build args passed to docker via --build-arg
Environment variable: QUARKUS_DOCKER_BUILD_ARGS
|
Map<String,String>
|
|
Configuration for Docker Buildx options |
类型 |
默认 |
Environment variable: QUARKUS_DOCKER_BUILDX_PLATFORM
|
list of string |
|
Environment variable: QUARKUS_DOCKER_BUILDX_OUTPUT
|
string |
|
Environment variable: QUARKUS_DOCKER_BUILDX_PROGRESS
|
string |
|
Container Image Jib |
类型 |
默认 |
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, registry.access.redhat.com/ubi8/openjdk-17-runtime:1.11 is used as the default. Otherwise registry.access.redhat.com/ubi8/openjdk-11-runtime:1.11 is used as the default.
Environment variable: QUARKUS_JIB_BASE_JVM_IMAGE
|
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: QUARKUS_JIB_BASE_NATIVE_IMAGE
|
string |
quay.io/quarkus/quarkus-micro-image:1.0
|
The JVM arguments to pass to the JVM when starting the application
Environment variable: QUARKUS_JIB_JVM_ARGUMENTS
|
list of string |
-Djava.util.logging.manager=org.jboss.logmanager.LogManager
|
Additional JVM arguments to pass to the JVM when starting the application
Environment variable: QUARKUS_JIB_JVM_ADDITIONAL_ARGUMENTS
|
list of string |
|
Additional arguments to pass when starting the native application
Environment variable: QUARKUS_JIB_NATIVE_ARGUMENTS
|
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
- A valid entrypoint is jar package specific (see quarkus.package.type )
- A valid entrypoint depends on the location of both the launching scripts and the application jar file. To that end it’s helpful to remember that when fast-jar packaging is used (the default), all necessary application jars are added to the /work directory and that the same directory is also used as the working directory. When legacy-jar or uber-jar are used, the application jars are unpacked under the /app directory and that directory is used as the working directory.
- Even if the jvmArguments field is set, it is ignored completely When this is not set, a proper default entrypoint will be constructed. As a final note, a very useful tool for inspecting container image layers that can greatly aid when debugging problems with endpoints is dive
Environment variable: QUARKUS_JIB_JVM_ENTRYPOINT
|
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
- A valid entrypoint depends on the location of both the launching scripts and the native binary file. To that end it’s helpful to remember that the native application is added to the /work directory and that and the same directory is also used as the working directory
- Even if the nativeArguments field is set, it is ignored completely When this is not set, a proper default entrypoint will be constructed. As a final note, a very useful tool for inspecting container image layers that can greatly aid when debugging problems with endpoints is dive
Environment variable: QUARKUS_JIB_NATIVE_ENTRYPOINT
|
list of string |
|
The username to use to authenticate with the registry used to pull the base JVM image
Environment variable: QUARKUS_JIB_BASE_REGISTRY_USERNAME
|
string |
|
The password to use to authenticate with the registry used to pull the base JVM image
Environment variable: QUARKUS_JIB_BASE_REGISTRY_PASSWORD
|
string |
|
Environment variable: QUARKUS_JIB_PORTS
|
list of int |
${quarkus.http.port:8080}
|
The user to use in generated image
Environment variable: QUARKUS_JIB_USER
|
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: QUARKUS_JIB_WORKING_DIRECTORY
|
string |
/home/jboss
|
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 true , base image layers are always pulled and cached. If false , base image layers will not be pulled/cached if they already exist on the target registry.
Environment variable: QUARKUS_JIB_ALWAYS_CACHE_BASE_IMAGE
|
boolean |
false
|
List of target platforms. Each platform is defined using the pattern: <os>|<arch>[/variant]|<os>/<arch>[/variant] for example: linux/amd64,linux/arm64/v8 If not specified, OS default is linux and architecture default is amd64 If more than one platform is configured, it is important to note that the base image has to be a Docker manifest or an OCI image index containing a version of each chosen platform It doesn’t work with native images, as cross-compilation is not supported Target Platform is a incubating feature of Jib. See Jib FAQ for more information
Environment variable: QUARKUS_JIB_PLATFORMS
|
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: QUARKUS_JIB_IMAGE_DIGEST_FILE
|
string |
jib-image.digest
|
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: QUARKUS_JIB_IMAGE_ID_FILE
|
string |
jib-image.id
|
Whether or not to operate offline.
Environment variable: QUARKUS_JIB_OFFLINE_MODE
|
boolean |
false
|
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: QUARKUS_JIB_DOCKER_EXECUTABLE_NAME
|
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: QUARKUS_JIB_USE_CURRENT_TIMESTAMP
|
boolean |
true
|
Environment variables to add to the container image
Environment variable: QUARKUS_JIB_ENVIRONMENT_VARIABLES
|
Map<String,String>
|
|
Sets environment variables used by the Docker executable. This is only used by Jib when the container image is being built locally.
Environment variable: QUARKUS_JIB_DOCKER_ENVIRONMENT
|
Map<String,String>
|
|
Container Image OpenShift |
类型 |
默认 |
The build config strategy to use.
Environment variable: QUARKUS_OPENSHIFT_BUILD_STRATEGY
|
|
binary
|
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, registry.access.redhat.com/ubi8/openjdk-17:1.11 is used as the default. Otherwise registry.access.redhat.com/ubi8/openjdk-11:1.11 is used as the default.
Environment variable: QUARKUS_OPENSHIFT_BASE_JVM_IMAGE
|
string |
|
The base image to be used when a container image is being produced for the native binary build
Environment variable: QUARKUS_OPENSHIFT_BASE_NATIVE_IMAGE
|
string |
quay.io/quarkus/ubi-quarkus-native-binary-s2i:1.0
|
The default Dockerfile to use for jvm builds
Environment variable: QUARKUS_OPENSHIFT_JVM_DOCKERFILE
|
string |
src/main/docker/Dockerfile.jvm
|
The default Dockerfile to use for native builds
Environment variable: QUARKUS_OPENSHIFT_NATIVE_DOCKERFILE
|
string |
src/main/docker/Dockerfile.native
|
The JVM arguments to pass to the JVM when starting the application
Environment variable: QUARKUS_OPENSHIFT_JVM_ARGUMENTS
|
list of string |
|
Additional arguments to pass when starting the native application
Environment variable: QUARKUS_OPENSHIFT_NATIVE_ARGUMENTS
|
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: QUARKUS_OPENSHIFT_JAR_DIRECTORY
|
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: QUARKUS_OPENSHIFT_JAR_FILE_NAME
|
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: QUARKUS_OPENSHIFT_NATIVE_BINARY_DIRECTORY
|
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: QUARKUS_OPENSHIFT_NATIVE_BINARY_FILE_NAME
|
string |
|
Environment variable: QUARKUS_OPENSHIFT_BUILD_TIMEOUT
|
Duration
|
PT5M
|
The build config strategy to use.
Environment variable: QUARKUS_S2I_BUILD_STRATEGY
|
|
binary
|
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, registry.access.redhat.com/ubi8/openjdk-17:1.11 is used as the default. Otherwise registry.access.redhat.com/ubi8/openjdk-11:1.11 is used as the default.
Environment variable: QUARKUS_S2I_BASE_JVM_IMAGE
|
string |
|
The base image to be used when a container image is being produced for the native binary build
Environment variable: QUARKUS_S2I_BASE_NATIVE_IMAGE
|
string |
quay.io/quarkus/ubi-quarkus-native-binary-s2i:1.0
|
The JVM arguments to pass to the JVM when starting the application
Environment variable: QUARKUS_S2I_JVM_ARGUMENTS
|
list of string |
|
Additional arguments to pass when starting the native application
Environment variable: QUARKUS_S2I_NATIVE_ARGUMENTS
|
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: QUARKUS_S2I_JAR_DIRECTORY
|
string |
/deployments/target/
|
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: QUARKUS_S2I_JAR_FILE_NAME
|
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: QUARKUS_S2I_NATIVE_BINARY_DIRECTORY
|
string |
/home/quarkus/
|
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: QUARKUS_S2I_NATIVE_BINARY_FILE_NAME
|
string |
|
Environment variable: QUARKUS_S2I_BUILD_TIMEOUT
|
Duration
|
PT5M
|
Container Image S2I |
类型 |
默认 |
The base image to be used when a container image is being produced for the jar build
Environment variable: QUARKUS_S2I_BASE_JVM_IMAGE
|
string |
|
The base image to be used when a container image is being produced for the native binary build
Environment variable: QUARKUS_S2I_BASE_NATIVE_IMAGE
|
string |
quay.io/quarkus/ubi-quarkus-native-binary-s2i:1.0
|
The JVM arguments to pass to the JVM when starting the application
Environment variable: QUARKUS_S2I_JVM_ARGUMENTS
|
list of string |
-Djava.util.logging.manager=org.jboss.logmanager.LogManager
|
Additional JVM arguments to pass to the JVM when starting the application
Environment variable: QUARKUS_S2I_JVM_ADDITIONAL_ARGUMENTS
|
list of string |
|
Additional arguments to pass when starting the native application
Environment variable: QUARKUS_S2I_NATIVE_ARGUMENTS
|
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: QUARKUS_S2I_JAR_DIRECTORY
|
string |
/deployments/
|
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: QUARKUS_S2I_JAR_FILE_NAME
|
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: QUARKUS_S2I_NATIVE_BINARY_DIRECTORY
|
string |
/home/quarkus/
|
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: QUARKUS_S2I_NATIVE_BINARY_FILE_NAME
|
string |
|
Environment variable: QUARKUS_S2I_BUILD_TIMEOUT
|
Duration
|
PT5M
|
Datasources |
类型 |
默认 |
The kind of database we will connect to (e.g. h2, postgresql…).
Environment variable: QUARKUS_DATASOURCE_DB_KIND
|
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: QUARKUS_DATASOURCE_DEVSERVICES_ENABLED
|
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: QUARKUS_DATASOURCE_DEVSERVICES_IMAGE_NAME
|
string |
|
Optional fixed port the dev service will listen to.
If not defined, the port will be chosen randomly.
Environment variable: QUARKUS_DATASOURCE_DEVSERVICES_PORT
|
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: QUARKUS_DATASOURCE_DEVSERVICES_COMMAND
|
string |
|
The name of the database to use if this Dev Service supports overriding it.
Environment variable: QUARKUS_DATASOURCE_DEVSERVICES_DB_NAME
|
string |
|
The username to use if this Dev Service supports overriding it.
Environment variable: QUARKUS_DATASOURCE_DEVSERVICES_USERNAME
|
string |
|
The password to use if this Dev Service supports overriding it.
Environment variable: QUARKUS_DATASOURCE_DEVSERVICES_PASSWORD
|
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: QUARKUS_DATASOURCE_HEALTH_EXCLUDE
|
boolean |
false
|
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: QUARKUS_DATASOURCE_HEALTH_ENABLED
|
boolean |
true
|
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: QUARKUS_DATASOURCE_METRICS_ENABLED
|
boolean |
false
|
Environment variable: QUARKUS_DATASOURCE_USERNAME
|
string |
|
Environment variable: QUARKUS_DATASOURCE_PASSWORD
|
string |
|
The credentials provider name
Environment variable: QUARKUS_DATASOURCE_CREDENTIALS_PROVIDER
|
string |
|
The credentials provider bean name.
It is the @Named value of the credentials provider bean. It is used to discriminate if multiple CredentialsProvider beans are available.
For Vault it is: vault-credentials-provider. Not necessary if there is only one credentials provider available.
Environment variable: QUARKUS_DATASOURCE_CREDENTIALS_PROVIDER_NAME
|
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: QUARKUS_DATASOURCE_DEVSERVICES_CONTAINER_PROPERTIES
|
Map<String,String>
|
|
Generic properties that are added to the database connection URL.
Environment variable: QUARKUS_DATASOURCE_DEVSERVICES_PROPERTIES
|
Map<String,String>
|
|
Additional named datasources |
类型 |
默认 |
The kind of database we will connect to (e.g. h2, postgresql…).
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__DB_KIND
|
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: QUARKUS_DATASOURCE__DATASOURCE_NAME__DEVSERVICES_ENABLED
|
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: QUARKUS_DATASOURCE__DATASOURCE_NAME__DEVSERVICES_IMAGE_NAME
|
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: QUARKUS_DATASOURCE__DATASOURCE_NAME__DEVSERVICES_CONTAINER_PROPERTIES
|
Map<String,String>
|
|
Generic properties that are added to the database connection URL.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__DEVSERVICES_PROPERTIES
|
Map<String,String>
|
|
Optional fixed port the dev service will listen to.
If not defined, the port will be chosen randomly.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__DEVSERVICES_PORT
|
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: QUARKUS_DATASOURCE__DATASOURCE_NAME__DEVSERVICES_COMMAND
|
string |
|
The name of the database to use if this Dev Service supports overriding it.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__DEVSERVICES_DB_NAME
|
string |
|
The username to use if this Dev Service supports overriding it.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__DEVSERVICES_USERNAME
|
string |
|
The password to use if this Dev Service supports overriding it.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__DEVSERVICES_PASSWORD
|
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: QUARKUS_DATASOURCE__DATASOURCE_NAME__HEALTH_EXCLUDE
|
boolean |
false
|
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__USERNAME
|
string |
|
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__PASSWORD
|
string |
|
The credentials provider name
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__CREDENTIALS_PROVIDER
|
string |
|
The credentials provider bean name.
It is the @Named value of the credentials provider bean. It is used to discriminate if multiple CredentialsProvider beans are available.
For Vault it is: vault-credentials-provider. Not necessary if there is only one credentials provider available.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__CREDENTIALS_PROVIDER_NAME
|
string |
|
Eclipse Vert.x |
类型 |
默认 |
Enables or disables the Vert.x cache.
Environment variable: QUARKUS_VERTX_CACHING
|
boolean |
true
|
Enables or disabled the Vert.x classpath resource resolver.
Environment variable: QUARKUS_VERTX_CLASSPATH_RESOLVING
|
boolean |
true
|
The number of event loops. 2 x the number of core by default.
Environment variable: QUARKUS_VERTX_EVENT_LOOPS_POOL_SIZE
|
int |
|
The maximum amount of time the event loop can be blocked.
Environment variable: QUARKUS_VERTX_MAX_EVENT_LOOP_EXECUTE_TIME
|
Duration
|
2S
|
The amount of time before a warning is displayed if the event loop is blocked.
Environment variable: QUARKUS_VERTX_WARNING_EXCEPTION_TIME
|
Duration
|
2S
|
The size of the worker thread pool.
Environment variable: QUARKUS_VERTX_WORKER_POOL_SIZE
|
int |
20
|
The maximum amount of time the worker thread can be blocked.
Environment variable: QUARKUS_VERTX_MAX_WORKER_EXECUTE_TIME
|
Duration
|
60S
|
The size of the internal thread pool (used for the file system).
Environment variable: QUARKUS_VERTX_INTERNAL_BLOCKING_POOL_SIZE
|
int |
20
|
The queue size. For most applications this should be unbounded
Environment variable: QUARKUS_VERTX_QUEUE_SIZE
|
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 0.0f implies that threads beyond the core size should be created as aggressively as threads within it; a value of 1.0f implies that threads beyond the core size should never be created.
Environment variable: QUARKUS_VERTX_GROWTH_RESISTANCE
|
float |
0f
|
The amount of time a thread will stay alive with no work.
Environment variable: QUARKUS_VERTX_KEEP_ALIVE_TIME
|
Duration
|
30S
|
Prefill thread pool when creating a new Executor. When io.vertx.core.spi.ExecutorServiceFactory.createExecutor is called, initialise with the number of defined threads at startup
Environment variable: QUARKUS_VERTX_PREFILL
|
boolean |
false
|
Enables the async DNS resolver.
Environment variable: QUARKUS_VERTX_USE_ASYNC_DNS
|
boolean |
false
|
PEM Key/cert config is disabled by default.
Environment variable: QUARKUS_VERTX_EVENTBUS_KEY_CERTIFICATE_PEM
|
boolean |
false
|
Comma-separated list of the path to the key files (Pem format).
Environment variable: QUARKUS_VERTX_EVENTBUS_KEY_CERTIFICATE_PEM_KEYS
|
list of string |
|
Comma-separated list of the path to the certificate files (Pem format).
Environment variable: QUARKUS_VERTX_EVENTBUS_KEY_CERTIFICATE_PEM_CERTS
|
list of string |
|
JKS config is disabled by default.
Environment variable: QUARKUS_VERTX_EVENTBUS_KEY_CERTIFICATE_JKS
|
boolean |
false
|
Path of the key file (JKS format).
Environment variable: QUARKUS_VERTX_EVENTBUS_KEY_CERTIFICATE_JKS_PATH
|
string |
|
Password of the key file.
Environment variable: QUARKUS_VERTX_EVENTBUS_KEY_CERTIFICATE_JKS_PASSWORD
|
string |
|
PFX config is disabled by default.
Environment variable: QUARKUS_VERTX_EVENTBUS_KEY_CERTIFICATE_PFX
|
boolean |
false
|
Path to the key file (PFX format).
Environment variable: QUARKUS_VERTX_EVENTBUS_KEY_CERTIFICATE_PFX_PATH
|
string |
|
Environment variable: QUARKUS_VERTX_EVENTBUS_KEY_CERTIFICATE_PFX_PASSWORD
|
string |
|
PEM Trust config is disabled by default.
Environment variable: QUARKUS_VERTX_EVENTBUS_TRUST_CERTIFICATE_PEM
|
boolean |
false
|
Comma-separated list of the trust certificate files (Pem format).
Environment variable: QUARKUS_VERTX_EVENTBUS_TRUST_CERTIFICATE_PEM_CERTS
|
list of string |
|
JKS config is disabled by default.
Environment variable: QUARKUS_VERTX_EVENTBUS_TRUST_CERTIFICATE_JKS
|
boolean |
false
|
Path of the key file (JKS format).
Environment variable: QUARKUS_VERTX_EVENTBUS_TRUST_CERTIFICATE_JKS_PATH
|
string |
|
Password of the key file.
Environment variable: QUARKUS_VERTX_EVENTBUS_TRUST_CERTIFICATE_JKS_PASSWORD
|
string |
|
PFX config is disabled by default.
Environment variable: QUARKUS_VERTX_EVENTBUS_TRUST_CERTIFICATE_PFX
|
boolean |
false
|
Path to the key file (PFX format).
Environment variable: QUARKUS_VERTX_EVENTBUS_TRUST_CERTIFICATE_PFX_PATH
|
string |
|
Environment variable: QUARKUS_VERTX_EVENTBUS_TRUST_CERTIFICATE_PFX_PASSWORD
|
string |
|
Environment variable: QUARKUS_VERTX_EVENTBUS_ACCEPT_BACKLOG
|
int |
|
The client authentication.
Environment variable: QUARKUS_VERTX_EVENTBUS_CLIENT_AUTH
|
string |
NONE
|
Environment variable: QUARKUS_VERTX_EVENTBUS_CONNECT_TIMEOUT
|
Duration
|
60S
|
The idle timeout in milliseconds.
Environment variable: QUARKUS_VERTX_EVENTBUS_IDLE_TIMEOUT
|
Duration
|
|
Environment variable: QUARKUS_VERTX_EVENTBUS_RECEIVE_BUFFER_SIZE
|
int |
|
The number of reconnection attempts.
Environment variable: QUARKUS_VERTX_EVENTBUS_RECONNECT_ATTEMPTS
|
int |
0
|
The reconnection interval in milliseconds.
Environment variable: QUARKUS_VERTX_EVENTBUS_RECONNECT_INTERVAL
|
Duration
|
1S
|
Whether to reuse the address.
Environment variable: QUARKUS_VERTX_EVENTBUS_REUSE_ADDRESS
|
boolean |
true
|
Whether to reuse the port.
Environment variable: QUARKUS_VERTX_EVENTBUS_REUSE_PORT
|
boolean |
false
|
Environment variable: QUARKUS_VERTX_EVENTBUS_SEND_BUFFER_SIZE
|
int |
|
Environment variable: QUARKUS_VERTX_EVENTBUS_SOLINGER
|
int |
|
Environment variable: QUARKUS_VERTX_EVENTBUS_SSL
|
boolean |
false
|
Whether to keep the TCP connection opened (keep-alive).
Environment variable: QUARKUS_VERTX_EVENTBUS_TCP_KEEP_ALIVE
|
boolean |
false
|
Configure the TCP no delay.
Environment variable: QUARKUS_VERTX_EVENTBUS_TCP_NO_DELAY
|
boolean |
true
|
Configure the traffic class.
Environment variable: QUARKUS_VERTX_EVENTBUS_TRAFFIC_CLASS
|
int |
|
Enables or disables the trust all parameter.
Environment variable: QUARKUS_VERTX_EVENTBUS_TRUST_ALL
|
boolean |
false
|
Environment variable: QUARKUS_VERTX_CLUSTER_HOST
|
string |
localhost
|
Environment variable: QUARKUS_VERTX_CLUSTER_PORT
|
int |
|
Environment variable: QUARKUS_VERTX_CLUSTER_PUBLIC_HOST
|
string |
|
Environment variable: QUARKUS_VERTX_CLUSTER_PUBLIC_PORT
|
int |
|
Enables or disables the clustering.
Environment variable: QUARKUS_VERTX_CLUSTER_CLUSTERED
|
boolean |
false
|
Environment variable: QUARKUS_VERTX_CLUSTER_PING_INTERVAL
|
Duration
|
20S
|
Environment variable: QUARKUS_VERTX_CLUSTER_PING_REPLY_INTERVAL
|
Duration
|
20S
|
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: QUARKUS_VERTX_RESOLVER_CACHE_MAX_TIME_TO_LIVE
|
int |
2147483647
|
The minimum amount of time in seconds that a successfully resolved address will be cached.
Environment variable: QUARKUS_VERTX_RESOLVER_CACHE_MIN_TIME_TO_LIVE
|
int |
0
|
The amount of time in seconds that an unsuccessful attempt to resolve an address will be cached.
Environment variable: QUARKUS_VERTX_RESOLVER_CACHE_NEGATIVE_TIME_TO_LIVE
|
int |
0
|
The maximum number of queries to be sent during a resolution.
Environment variable: QUARKUS_VERTX_RESOLVER_MAX_QUERIES
|
int |
4
|
The duration after which a DNS query is considered to be failed.
Environment variable: QUARKUS_VERTX_RESOLVER_QUERY_TIMEOUT
|
Duration
|
5S
|
Enable or disable native transport
Environment variable: QUARKUS_VERTX_PREFER_NATIVE_TRANSPORT
|
boolean |
false
|
Eclipse Vert.x - HTTP |
类型 |
默认 |
The number of history log entries to remember.
Environment variable: QUARKUS_DEV_UI_HISTORY_SIZE
|
int |
50
|
The HTTP root path. All web content will be served relative to this root path.
Environment variable: QUARKUS_HTTP_ROOT_PATH
|
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: QUARKUS_HTTP_AUTH_BASIC
|
boolean |
|
If form authentication is enabled
Environment variable: QUARKUS_HTTP_AUTH_FORM_ENABLED
|
boolean |
false
|
Environment variable: QUARKUS_HTTP_AUTH_FORM_LOGIN_PAGE
|
string |
/login.html
|
Environment variable: QUARKUS_HTTP_AUTH_FORM_POST_LOCATION
|
string |
/j_security_check
|
Environment variable: QUARKUS_HTTP_AUTH_FORM_USERNAME_PARAMETER
|
string |
j_username
|
Environment variable: QUARKUS_HTTP_AUTH_FORM_PASSWORD_PARAMETER
|
string |
j_password
|
Environment variable: QUARKUS_HTTP_AUTH_FORM_ERROR_PAGE
|
string |
/error.html
|
The landing page to redirect to if there is no saved page to redirect back to
Environment variable: QUARKUS_HTTP_AUTH_FORM_LANDING_PAGE
|
string |
/index.html
|
Option to disable redirect to landingPage if there is no saved page to redirect back to. Form Auth POST is followed by redirect to landingPage by default.
Environment variable: QUARKUS_HTTP_AUTH_FORM_REDIRECT_AFTER_LOGIN
|
boolean |
true
|
Option to control the name of the cookie used to redirect the user back to where he wants to get access to.
Environment variable: QUARKUS_HTTP_AUTH_FORM_LOCATION_COOKIE
|
string |
quarkus-redirect-location
|
The inactivity (idle) timeout When inactivity timeout is reached, cookie is not renewed and a new login is enforced.
Environment variable: QUARKUS_HTTP_AUTH_FORM_TIMEOUT
|
Duration
|
PT30M
|
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: QUARKUS_HTTP_AUTH_FORM_NEW_COOKIE_INTERVAL
|
Duration
|
PT1M
|
The cookie that is used to store the persistent session
Environment variable: QUARKUS_HTTP_AUTH_FORM_COOKIE_NAME
|
string |
quarkus-credential
|
Environment variable: QUARKUS_HTTP_AUTH_REALM
|
string |
Quarkus
|
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: QUARKUS_HTTP_AUTH_PROACTIVE
|
boolean |
true
|
Configures the engine to require/request client authentication. NONE, REQUEST, REQUIRED
Environment variable: QUARKUS_HTTP_SSL_CLIENT_AUTH
|
|
none
|
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: QUARKUS_HTTP_VIRTUAL
|
boolean |
false
|
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.
-
Relative path (Default, q ) →
Non-application endpoints will be served from
${quarkus.http.root-path}/${quarkus.http.non-application-root-path} .
-
Absolute path (/q ) →
Non-application endpoints will be served from the specified path.
-
${quarkus.http.root-path} → Setting this path to the same value as HTTP root path disables
this root path. All extension-provided endpoints will be served from ${quarkus.http.root-path} .
Environment variable: QUARKUS_HTTP_NON_APPLICATION_ROOT_PATH
|
string |
q
|
The REST Assured client timeout for testing.
Environment variable: QUARKUS_HTTP_TEST_TIMEOUT
|
Duration
|
30S
|
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: QUARKUS_HTTP_ENABLE_COMPRESSION
|
boolean |
false
|
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: QUARKUS_HTTP_ENABLE_DECOMPRESSION
|
boolean |
false
|
List of media types for which the compression should be enabled automatically, unless declared explicitly via Compressed or Uncompressed .
Environment variable: QUARKUS_HTTP_COMPRESS_MEDIA_TYPES
|
list of string |
text/html,text/plain,text/xml,text/css,text/javascript,application/javascript
|
The compression level used when compression support is enabled.
Environment variable: QUARKUS_HTTP_COMPRESSION_LEVEL
|
int |
|
Environment variable: QUARKUS_HTTP_CORS
|
boolean |
false
|
Environment variable: QUARKUS_HTTP_PORT
|
int |
8080
|
The HTTP port used to run tests
Environment variable: QUARKUS_HTTP_TEST_PORT
|
int |
8081
|
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: QUARKUS_HTTP_HOST
|
string |
required |
Enable listening to host:port
Environment variable: QUARKUS_HTTP_HOST_ENABLED
|
boolean |
true
|
Environment variable: QUARKUS_HTTP_SSL_PORT
|
int |
8443
|
The HTTPS port used to run tests
Environment variable: QUARKUS_HTTP_TEST_SSL_PORT
|
int |
8444
|
If insecure (i.e. http rather than https) requests are allowed. If this is enabled then http works as normal. redirect will still open the http port, but all requests will be redirected to the HTTPS port. disabled will prevent the HTTP port from opening at all.
Environment variable: QUARKUS_HTTP_INSECURE_REQUESTS
|
enabled , redirect , disabled
|
enabled
|
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: QUARKUS_HTTP_HTTP2
|
boolean |
true
|
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. The filter allows any origin if this is not set. default: returns any requested origin as valid
Environment variable: QUARKUS_HTTP_CORS_ORIGINS
|
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: QUARKUS_HTTP_CORS_METHODS
|
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: QUARKUS_HTTP_CORS_HEADERS
|
list of string |
|
HTTP headers exposed in CORS Comma separated list of valid headers. ex: X-Custom,Content-Disposition default: empty
Environment variable: QUARKUS_HTTP_CORS_EXPOSED_HEADERS
|
list of string |
|
The Access-Control-Max-Age response header value indicating how long the results of a pre-flight request can be cached.
Environment variable: QUARKUS_HTTP_CORS_ACCESS_CONTROL_MAX_AGE
|
Duration
|
|
The Access-Control-Allow-Credentials header is used to tell the browsers to expose the response to front-end JavaScript code when the request’s credentials mode Request.credentials is “include”. The value of this header will default to true if quarkus.http.cors.origins property is set and there is a match with the precise Origin header and that header is not '*'.
Environment variable: QUARKUS_HTTP_CORS_ACCESS_CONTROL_ALLOW_CREDENTIALS
|
boolean |
|
The CredentialsProvider }. If this property is configured then a matching 'CredentialsProvider' will be used to get the keystore, keystore key and truststore passwords unless these passwords have already been configured. Please note that using MicroProfile ConfigSource which is directly supported by Quarkus Configuration should be preferred unless using CredentialsProvider provides for some additional security and dynamism.
Environment variable: QUARKUS_HTTP_SSL_CERTIFICATE_CREDENTIALS_PROVIDER
|
string |
|
The credentials provider bean name.
It is the @Named value of the credentials provider bean. It is used to discriminate if multiple CredentialsProvider beans are available. It is recommended to set this property even if there is only one credentials provider currently available to ensure the same provider is always found in deployments where more than one provider may be available.
Environment variable: QUARKUS_HTTP_SSL_CERTIFICATE_CREDENTIALS_PROVIDER_NAME
|
string |
|
The list of path to server certificates using the PEM format. Specifying multiple files require SNI to be enabled.
Environment variable: QUARKUS_HTTP_SSL_CERTIFICATE_FILES
|
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: QUARKUS_HTTP_SSL_CERTIFICATE_KEY_FILES
|
list of path |
|
An optional key store which holds the certificate information instead of specifying separate files.
Environment variable: QUARKUS_HTTP_SSL_CERTIFICATE_KEY_STORE_FILE
|
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: QUARKUS_HTTP_SSL_CERTIFICATE_KEY_STORE_FILE_TYPE
|
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: QUARKUS_HTTP_SSL_CERTIFICATE_KEY_STORE_PROVIDER
|
string |
|
A parameter to specify the password of the key store file. If not given, and if it can not be retrieved from CredentialsProvider , then the default ("password") is used.
Environment variable: QUARKUS_HTTP_SSL_CERTIFICATE_KEY_STORE_PASSWORD
|
string |
password
|
A parameter to specify a CredentialsProvider property key which can be used to get the password of the key store file from CredentialsProvider .
Environment variable: QUARKUS_HTTP_SSL_CERTIFICATE_KEY_STORE_PASSWORD_KEY
|
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: QUARKUS_HTTP_SSL_CERTIFICATE_KEY_STORE_KEY_ALIAS
|
string |
|
An optional parameter to define the password for the key, in case it’s different from key-store-password If not given then it may be retrieved from CredentialsProvider .
Environment variable: QUARKUS_HTTP_SSL_CERTIFICATE_KEY_STORE_KEY_PASSWORD
|
string |
|
A parameter to specify a CredentialsProvider property key which can be used to get the password for the key from CredentialsProvider .
Environment variable: QUARKUS_HTTP_SSL_CERTIFICATE_KEY_STORE_KEY_PASSWORD_KEY
|
string |
|
An optional trust store which holds the certificate information of the certificates to trust.
Environment variable: QUARKUS_HTTP_SSL_CERTIFICATE_TRUST_STORE_FILE
|
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: QUARKUS_HTTP_SSL_CERTIFICATE_TRUST_STORE_FILE_TYPE
|
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: QUARKUS_HTTP_SSL_CERTIFICATE_TRUST_STORE_PROVIDER
|
string |
|
A parameter to specify the password of the trust store file. If not given then it may be retrieved from CredentialsProvider .
Environment variable: QUARKUS_HTTP_SSL_CERTIFICATE_TRUST_STORE_PASSWORD
|
string |
|
A parameter to specify a CredentialsProvider property key which can be used to get the password of the trust store file from CredentialsProvider .
Environment variable: QUARKUS_HTTP_SSL_CERTIFICATE_TRUST_STORE_PASSWORD_KEY
|
string |
|
An optional parameter to trust only one specific certificate in the trust store (instead of trusting all certificates in the store).
Environment variable: QUARKUS_HTTP_SSL_CERTIFICATE_TRUST_STORE_CERT_ALIAS
|
string |
|
The cipher suites to use. If none is given, a reasonable default is selected.
Environment variable: QUARKUS_HTTP_SSL_CIPHER_SUITES
|
list of string |
|
The list of protocols to explicitly enable.
Environment variable: QUARKUS_HTTP_SSL_PROTOCOLS
|
list of string |
TLSv1.3,TLSv1.2
|
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: QUARKUS_HTTP_SSL_SNI
|
boolean |
false
|
When set to true , the HTTP server automatically sends 100 CONTINUE response when the request expects it (with the Expect: 100-Continue header).
Environment variable: QUARKUS_HTTP_HANDLE_100_CONTINUE_AUTOMATICALLY
|
boolean |
false
|
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: QUARKUS_HTTP_IO_THREADS
|
int |
|
The maximum length of all headers.
Environment variable: QUARKUS_HTTP_LIMITS_MAX_HEADER_SIZE
|
MemorySize |
20K
|
The maximum size of a request body.
Environment variable: QUARKUS_HTTP_LIMITS_MAX_BODY_SIZE
|
MemorySize |
10240K
|
Environment variable: QUARKUS_HTTP_LIMITS_MAX_CHUNK_SIZE
|
MemorySize |
8192
|
The maximum length of the initial line (e.g. "GET / HTTP/1.0" ).
Environment variable: QUARKUS_HTTP_LIMITS_MAX_INITIAL_LINE_LENGTH
|
int |
4096
|
The maximum length of a form attribute.
Environment variable: QUARKUS_HTTP_LIMITS_MAX_FORM_ATTRIBUTE_SIZE
|
MemorySize |
2048
|
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: QUARKUS_HTTP_LIMITS_MAX_CONNECTIONS
|
int |
|
Http connection idle timeout
Environment variable: QUARKUS_HTTP_IDLE_TIMEOUT
|
Duration
|
30M
|
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: QUARKUS_HTTP_READ_TIMEOUT
|
Duration
|
60S
|
Whether the files sent using multipart/form-data will be stored locally.
If true , they will be stored in quarkus.http.body-handler.uploads-directory and will be made available via io.vertx.ext.web.RoutingContext.fileUploads() . Otherwise, the files sent using multipart/form-data will not be stored locally, and io.vertx.ext.web.RoutingContext.fileUploads() will always return an empty collection. Note that even with this option being set to false , the multipart/form-data requests will be accepted.
Environment variable: QUARKUS_HTTP_BODY_HANDLE_FILE_UPLOADS
|
boolean |
true
|
The directory where the files sent using multipart/form-data should be stored.
Either an absolute path or a path relative to the current directory of the application process.
Environment variable: QUARKUS_HTTP_BODY_UPLOADS_DIRECTORY
|
string |
${java.io.tmpdir}/uploads
|
Whether the form attributes should be added to the request parameters.
If true , the form attributes will be added to the request parameters; otherwise the form parameters will not be added to the request parameters
Environment variable: QUARKUS_HTTP_BODY_MERGE_FORM_ATTRIBUTES
|
boolean |
true
|
Whether the uploaded files should be removed after serving the request.
If true the uploaded files stored in quarkus.http.body-handler.uploads-directory will be removed after handling the request. Otherwise, the files will be left there forever.
Environment variable: QUARKUS_HTTP_BODY_DELETE_UPLOADED_FILES_ON_END
|
boolean |
true
|
Whether the body buffer should pre-allocated based on the Content-Length header value.
If true the body buffer is pre-allocated according to the size read from the Content-Length header. Otherwise, the body buffer is pre-allocated to 1KB, and is resized dynamically
Environment variable: QUARKUS_HTTP_BODY_PREALLOCATE_BODY_BUFFER
|
boolean |
false
|
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: QUARKUS_HTTP_AUTH_SESSION_ENCRYPTION_KEY
|
string |
|
Enable socket reuse port (linux/macOs native transport only)
Environment variable: QUARKUS_HTTP_SO_REUSE_PORT
|
boolean |
false
|
Enable tcp quick ack (linux native transport only)
Environment variable: QUARKUS_HTTP_TCP_QUICK_ACK
|
boolean |
false
|
Enable tcp cork (linux native transport only)
Environment variable: QUARKUS_HTTP_TCP_CORK
|
boolean |
false
|
Enable tcp fast open (linux native transport only)
Environment variable: QUARKUS_HTTP_TCP_FAST_OPEN
|
boolean |
false
|
The accept backlog, this is how many connections can be waiting to be accepted before connections start being rejected
Environment variable: QUARKUS_HTTP_ACCEPT_BACKLOG
|
int |
-1
|
Path to a unix domain socket
Environment variable: QUARKUS_HTTP_DOMAIN_SOCKET
|
string |
/var/run/io.quarkus.app.socket
|
Enable listening to host:port
Environment variable: QUARKUS_HTTP_DOMAIN_SOCKET_ENABLED
|
boolean |
false
|
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: QUARKUS_HTTP_RECORD_REQUEST_START_TIME
|
boolean |
false
|
If access logging is enabled. By default this will log via the standard logging facility
Environment variable: QUARKUS_HTTP_ACCESS_LOG_ENABLED
|
boolean |
false
|
A regular expression that can be used to exclude some paths from logging.
Environment variable: QUARKUS_HTTP_ACCESS_LOG_EXCLUDE_PATTERN
|
string |
|
If this is the string common , combined or long then this will use one of the specified named formats:
-
common: %h %l %u %t "%r" %s %b
-
combined: %h %l %u %t "%r" %s %b "%{i,Referer}" "%{i,User-Agent}"
-
long: %r\n%{ALL_REQUEST_HEADERS}
Otherwise, consult the Quarkus documentation for the full list of variables that can be used.
Environment variable: QUARKUS_HTTP_ACCESS_LOG_PATTERN
|
string |
common
|
If logging should be done to a separate file.
Environment variable: QUARKUS_HTTP_ACCESS_LOG_LOG_TO_FILE
|
boolean |
false
|
The access log file base name, defaults to 'quarkus' which will give a log file name of 'quarkus.log'.
Environment variable: QUARKUS_HTTP_ACCESS_LOG_BASE_FILE_NAME
|
string |
quarkus
|
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: QUARKUS_HTTP_ACCESS_LOG_LOG_DIRECTORY
|
string |
|
Environment variable: QUARKUS_HTTP_ACCESS_LOG_LOG_SUFFIX
|
string |
.log
|
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: QUARKUS_HTTP_ACCESS_LOG_CATEGORY
|
string |
io.quarkus.http.access-log
|
If the log should be rotated daily
Environment variable: QUARKUS_HTTP_ACCESS_LOG_ROTATE
|
boolean |
true
|
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: QUARKUS_HTTP_UNHANDLED_ERROR_CONTENT_TYPE_DEFAULT
|
|
|
If this is true then the address, scheme etc. will be set from headers forwarded by the proxy server, such as X-Forwarded-For . This should only be set if you are behind a proxy that sets these headers.
Environment variable: QUARKUS_HTTP_PROXY_PROXY_ADDRESS_FORWARDING
|
boolean |
false
|
If this is true and proxy address forwarding is enabled then the standard Forwarded header will be used. In case the not standard X-Forwarded-For header is enabled and detected on HTTP requests, the standard header has the precedence. Activating this together with quarkus.http.proxy.allow-x-forwarded has security implications as clients can forge requests with a forwarded header that is not overwritten by the proxy. Therefore, proxies should strip unexpected X-Forwarded or X-Forwarded-* headers from the client.
Environment variable: QUARKUS_HTTP_PROXY_ALLOW_FORWARDED
|
boolean |
false
|
If either this or allow-forwarded are true and proxy address forwarding is enabled then the not standard Forwarded header will be used. In case the standard Forwarded header is enabled and detected on HTTP requests, the standard header has the precedence. Activating this together with quarkus.http.proxy.allow-x-forwarded has security implications as clients can forge requests with a forwarded header that is not overwritten by the proxy. Therefore, proxies should strip unexpected X-Forwarded or X-Forwarded-* headers from the client.
Environment variable: QUARKUS_HTTP_PROXY_ALLOW_X_FORWARDED
|
boolean |
|
Enable override the received request’s host through a forwarded host header.
Environment variable: QUARKUS_HTTP_PROXY_ENABLE_FORWARDED_HOST
|
boolean |
false
|
Configure the forwarded host header to be used if override enabled.
Environment variable: QUARKUS_HTTP_PROXY_FORWARDED_HOST_HEADER
|
string |
X-Forwarded-Host
|
Enable prefix the received request’s path with a forwarded prefix header.
Environment variable: QUARKUS_HTTP_PROXY_ENABLE_FORWARDED_PREFIX
|
boolean |
false
|
Configure the forwarded prefix header to be used if prefixing enabled.
Environment variable: QUARKUS_HTTP_PROXY_FORWARDED_PREFIX_HEADER
|
string |
X-Forwarded-Prefix
|
Determines whether the entire permission set is enabled, or not. By default, if the permission set is defined, it is enabled.
Environment variable: QUARKUS_HTTP_AUTH_PERMISSION__PERMISSIONS__ENABLED
|
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: QUARKUS_HTTP_AUTH_PERMISSION__PERMISSIONS__POLICY
|
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: QUARKUS_HTTP_AUTH_PERMISSION__PERMISSIONS__METHODS
|
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: QUARKUS_HTTP_AUTH_PERMISSION__PERMISSIONS__PATHS
|
list of string |
|
Path specific authentication mechanism which must be used to authenticate a user. It needs to match HttpCredentialTransport authentication scheme such as 'basic', 'bearer', 'form', etc.
Environment variable: QUARKUS_HTTP_AUTH_PERMISSION__PERMISSIONS__AUTH_MECHANISM
|
string |
|
The roles that are allowed to access resources protected by this policy
Environment variable: QUARKUS_HTTP_AUTH_POLICY__ROLE_POLICY__ROLES_ALLOWED
|
list of string |
required |
If the cookie pattern is case-sensitive
Environment variable: QUARKUS_HTTP_SAME_SITE_COOKIE__SAME_SITE_COOKIE__CASE_SENSITIVE
|
boolean |
false
|
The value to set in the samesite attribute
Environment variable: QUARKUS_HTTP_SAME_SITE_COOKIE__SAME_SITE_COOKIE__VALUE
|
|
required |
Some User Agents break when sent SameSite=None, this will detect them and avoid sending the value
Environment variable: QUARKUS_HTTP_SAME_SITE_COOKIE__SAME_SITE_COOKIE__ENABLE_CLIENT_CHECKER
|
boolean |
true
|
If this is true then the 'secure' attribute will automatically be sent on cookies with a SameSite attribute of None.
Environment variable: QUARKUS_HTTP_SAME_SITE_COOKIE__SAME_SITE_COOKIE__ADD_SECURE_FOR_NONE
|
boolean |
true
|
The path this header should be applied
Environment variable: QUARKUS_HTTP_HEADER__HEADER__PATH
|
string |
/*
|
The value for this header configuration
Environment variable: QUARKUS_HTTP_HEADER__HEADER__VALUE
|
string |
required |
The HTTP methods for this header configuration
Environment variable: QUARKUS_HTTP_HEADER__HEADER__METHODS
|
list of string |
|
A regular expression for the paths matching this configuration
Environment variable: QUARKUS_HTTP_FILTER__FILTER__MATCHES
|
string |
required |
Additional HTTP Headers always sent in the response
Environment variable: QUARKUS_HTTP_FILTER__FILTER__HEADER
|
Map<String,String>
|
|
The HTTP methods for this path configuration
Environment variable: QUARKUS_HTTP_FILTER__FILTER__METHODS
|
list of string |
|
Environment variable: QUARKUS_HTTP_FILTER__FILTER__ORDER
|
int |
|
Eclipse Vert.x GraphQL |
类型 |
默认 |
If GraphQL UI should be included every time. By default, this is only included when the application is running in dev mode.
Environment variable: QUARKUS_VERTX_GRAPHQL_UI_ALWAYS_INCLUDE
|
boolean |
false
|
The path where GraphQL UI is available.
The value / is not allowed as it blocks the application from serving anything else.
Environment variable: QUARKUS_VERTX_GRAPHQL_UI_PATH
|
string |
graphql-ui
|
Elasticsearch REST Client Common |
类型 |
默认 |
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 quarkus.elasticsearch.hosts is set.
Environment variable: QUARKUS_ELASTICSEARCH_DEVSERVICES_ENABLED
|
boolean |
|
Optional fixed port the dev service will listen to.
If not defined, the port will be chosen randomly.
Environment variable: QUARKUS_ELASTICSEARCH_DEVSERVICES_PORT
|
int |
|
The Elasticsearch container image to use. Defaults to the elasticsearch image provided by Elastic.
Environment variable: QUARKUS_ELASTICSEARCH_DEVSERVICES_IMAGE_NAME
|
string |
docker.elastic.co/elasticsearch/elasticsearch:7.17.0
|
The value for the ES_JAVA_OPTS env variable. Defaults to setting the heap to 1GB.
Environment variable: QUARKUS_ELASTICSEARCH_DEVSERVICES_JAVA_OPTS
|
string |
-Xmx1g
|
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 quarkus-dev-service-elasticsearch label. The value is configured using the service-name property.
Container sharing is only used in dev mode.
Environment variable: QUARKUS_ELASTICSEARCH_DEVSERVICES_SHARED
|
boolean |
true
|
The value of the quarkus-dev-service-elasticsearch label attached to the started container. This property is used when shared is set to true . In this case, before starting a container, Dev Services for Elasticsearch looks for a container with the quarkus-dev-service-elasticsearch label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise it starts a new container with the quarkus-dev-service-elasticsearch label set to the specified value.
This property is used when you need multiple shared Elasticsearch servers.
Environment variable: QUARKUS_ELASTICSEARCH_DEVSERVICES_SERVICE_NAME
|
string |
elasticsearch
|
Elasticsearch REST client |
类型 |
默认 |
Whether a health check is published in case the smallrye-health extension is present.
Environment variable: QUARKUS_ELASTICSEARCH_HEALTH_ENABLED
|
boolean |
true
|
The list of hosts of the Elasticsearch servers.
Environment variable: QUARKUS_ELASTICSEARCH_HOSTS
|
list of host:port |
localhost:9200
|
The protocol to use when contacting Elasticsearch servers. Set to "https" to enable SSL/TLS.
Environment variable: QUARKUS_ELASTICSEARCH_PROTOCOL
|
string |
http
|
The username for basic HTTP authentication.
Environment variable: QUARKUS_ELASTICSEARCH_USERNAME
|
string |
|
The password for basic HTTP authentication.
Environment variable: QUARKUS_ELASTICSEARCH_PASSWORD
|
string |
|
Environment variable: QUARKUS_ELASTICSEARCH_CONNECTION_TIMEOUT
|
Duration
|
1S
|
Environment variable: QUARKUS_ELASTICSEARCH_SOCKET_TIMEOUT
|
Duration
|
30S
|
The maximum number of connections to all the Elasticsearch servers.
Environment variable: QUARKUS_ELASTICSEARCH_MAX_CONNECTIONS
|
int |
20
|
The maximum number of connections per Elasticsearch server.
Environment variable: QUARKUS_ELASTICSEARCH_MAX_CONNECTIONS_PER_ROUTE
|
int |
10
|
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: QUARKUS_ELASTICSEARCH_IO_THREAD_COUNTS
|
int |
|
Defines if automatic discovery is enabled.
Environment variable: QUARKUS_ELASTICSEARCH_DISCOVERY_ENABLED
|
boolean |
false
|
Refresh interval of the node list.
Environment variable: QUARKUS_ELASTICSEARCH_DISCOVERY_REFRESH_INTERVAL
|
Duration
|
5M
|
Elytron Security JDBC |
类型 |
默认 |
Environment variable: QUARKUS_SECURITY_JDBC_REALM_NAME
|
string |
Quarkus
|
If the properties store is enabled.
Environment variable: QUARKUS_SECURITY_JDBC_ENABLED
|
boolean |
false
|
The sql query to find the password
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY_SQL
|
string |
|
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY_DATASOURCE
|
string |
|
If the clear-password-mapper is enabled.
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY_CLEAR_PASSWORD_MAPPER_ENABLED
|
boolean |
false
|
The index (1 based numbering) of the column containing the clear password
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY_CLEAR_PASSWORD_MAPPER_PASSWORD_INDEX
|
int |
1
|
If the bcrypt-password-mapper is enabled.
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY_BCRYPT_PASSWORD_MAPPER_ENABLED
|
boolean |
false
|
The index (1 based numbering) of the column containing the password hash
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY_BCRYPT_PASSWORD_MAPPER_PASSWORD_INDEX
|
int |
0
|
A string referencing the password hash encoding ("BASE64" or "HEX")
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY_BCRYPT_PASSWORD_MAPPER_HASH_ENCODING
|
|
base64
|
The index (1 based numbering) of the column containing the Bcrypt salt
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY_BCRYPT_PASSWORD_MAPPER_SALT_INDEX
|
int |
0
|
A string referencing the salt encoding ("BASE64" or "HEX")
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY_BCRYPT_PASSWORD_MAPPER_SALT_ENCODING
|
|
base64
|
The index (1 based numbering) of the column containing the Bcrypt iteration count
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY_BCRYPT_PASSWORD_MAPPER_ITERATION_COUNT_INDEX
|
int |
0
|
The index (1 based numbering) of column to map
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY_ATTRIBUTE_MAPPINGS__ATTRIBUTE_MAPPINGS__INDEX
|
int |
0
|
The target attribute name
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY_ATTRIBUTE_MAPPINGS__ATTRIBUTE_MAPPINGS__TO
|
string |
required |
The sql query to find the password
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY__NAMED_PRINCIPAL_QUERIES__SQL
|
string |
|
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY__NAMED_PRINCIPAL_QUERIES__DATASOURCE
|
string |
|
The index (1 based numbering) of column to map
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY__NAMED_PRINCIPAL_QUERIES__ATTRIBUTE_MAPPINGS__ATTRIBUTE_MAPPINGS__INDEX
|
int |
0
|
The target attribute name
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY__NAMED_PRINCIPAL_QUERIES__ATTRIBUTE_MAPPINGS__ATTRIBUTE_MAPPINGS__TO
|
string |
required |
If the clear-password-mapper is enabled.
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY__NAMED_PRINCIPAL_QUERIES__CLEAR_PASSWORD_MAPPER_ENABLED
|
boolean |
false
|
The index (1 based numbering) of the column containing the clear password
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY__NAMED_PRINCIPAL_QUERIES__CLEAR_PASSWORD_MAPPER_PASSWORD_INDEX
|
int |
1
|
If the bcrypt-password-mapper is enabled.
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY__NAMED_PRINCIPAL_QUERIES__BCRYPT_PASSWORD_MAPPER_ENABLED
|
boolean |
false
|
The index (1 based numbering) of the column containing the password hash
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY__NAMED_PRINCIPAL_QUERIES__BCRYPT_PASSWORD_MAPPER_PASSWORD_INDEX
|
int |
0
|
A string referencing the password hash encoding ("BASE64" or "HEX")
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY__NAMED_PRINCIPAL_QUERIES__BCRYPT_PASSWORD_MAPPER_HASH_ENCODING
|
|
base64
|
The index (1 based numbering) of the column containing the Bcrypt salt
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY__NAMED_PRINCIPAL_QUERIES__BCRYPT_PASSWORD_MAPPER_SALT_INDEX
|
int |
0
|
A string referencing the salt encoding ("BASE64" or "HEX")
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY__NAMED_PRINCIPAL_QUERIES__BCRYPT_PASSWORD_MAPPER_SALT_ENCODING
|
|
base64
|
The index (1 based numbering) of the column containing the Bcrypt iteration count
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY__NAMED_PRINCIPAL_QUERIES__BCRYPT_PASSWORD_MAPPER_ITERATION_COUNT_INDEX
|
int |
0
|
Elytron Security LDAP Realm |
类型 |
默认 |
The option to enable the ldap elytron module
Environment variable: QUARKUS_SECURITY_LDAP_ENABLED
|
boolean |
false
|
Environment variable: QUARKUS_SECURITY_LDAP_REALM_NAME
|
string |
Quarkus
|
Provided credentials are verified against ldap?
Environment variable: QUARKUS_SECURITY_LDAP_DIRECT_VERIFICATION
|
boolean |
true
|
The url of the ldap server
Environment variable: QUARKUS_SECURITY_LDAP_DIR_CONTEXT_URL
|
string |
required |
The principal: user which is used to connect to ldap server (also named "bindDn")
Environment variable: QUARKUS_SECURITY_LDAP_DIR_CONTEXT_PRINCIPAL
|
string |
|
The password which belongs to the principal (also named "bindCredential")
Environment variable: QUARKUS_SECURITY_LDAP_DIR_CONTEXT_PASSWORD
|
string |
|
how ldap redirects are handled
Environment variable: QUARKUS_SECURITY_LDAP_DIR_CONTEXT_REFERRAL_MODE
|
|
ignore
|
Environment variable: QUARKUS_SECURITY_LDAP_DIR_CONTEXT_CONNECT_TIMEOUT
|
Duration
|
5S
|
Environment variable: QUARKUS_SECURITY_LDAP_DIR_CONTEXT_READ_TIMEOUT
|
Duration
|
60S
|
The identifier which correlates to the provided user (also named "baseFilter")
Environment variable: QUARKUS_SECURITY_LDAP_IDENTITY_MAPPING_RDN_IDENTIFIER
|
string |
uid
|
The dn where we look for users
Environment variable: QUARKUS_SECURITY_LDAP_IDENTITY_MAPPING_SEARCH_BASE_DN
|
string |
required |
If the child nodes are also searched for identities
Environment variable: QUARKUS_SECURITY_LDAP_IDENTITY_MAPPING_SEARCH_RECURSIVE
|
boolean |
false
|
The roleAttributeId from which is mapped (e.g. "cn")
Environment variable: QUARKUS_SECURITY_LDAP_IDENTITY_MAPPING_ATTRIBUTE_MAPPINGS__ATTRIBUTE_MAPPINGS__FROM
|
string |
required |
The identifier whom the attribute is mapped to (in Quarkus: "groups", in WildFly this is "Roles")
Environment variable: QUARKUS_SECURITY_LDAP_IDENTITY_MAPPING_ATTRIBUTE_MAPPINGS__ATTRIBUTE_MAPPINGS__TO
|
string |
groups
|
The filter (also named "roleFilter")
Environment variable: QUARKUS_SECURITY_LDAP_IDENTITY_MAPPING_ATTRIBUTE_MAPPINGS__ATTRIBUTE_MAPPINGS__FILTER
|
string |
required |
The filter base dn (also named "rolesContextDn")
Environment variable: QUARKUS_SECURITY_LDAP_IDENTITY_MAPPING_ATTRIBUTE_MAPPINGS__ATTRIBUTE_MAPPINGS__FILTER_BASE_DN
|
string |
required |
Elytron Security OAuth 2.0 |
类型 |
默认 |
Determine if the OAuth2 extension is enabled. Enabled by default if you include the elytron-security-oauth2 dependency, so this would be used to disable it.
Environment variable: QUARKUS_OAUTH2_ENABLED
|
boolean |
true
|
The claim that is used in the introspection endpoint response to load the roles.
Environment variable: QUARKUS_OAUTH2_ROLE_CLAIM
|
string |
scope
|
The OAuth2 client id used to validate the token. Mandatory if the extension is enabled.
Environment variable: QUARKUS_OAUTH2_CLIENT_ID
|
string |
|
The OAuth2 client secret used to validate the token. Mandatory if the extension is enabled.
Environment variable: QUARKUS_OAUTH2_CLIENT_SECRET
|
string |
|
The OAuth2 introspection endpoint URL used to validate the token and gather the authentication claims. Mandatory if the extension is enabled.
Environment variable: QUARKUS_OAUTH2_INTROSPECTION_URL
|
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: QUARKUS_OAUTH2_CA_CERT_FILE
|
string |
|
Elytron Security Properties File |
类型 |
默认 |
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: QUARKUS_SECURITY_USERS_EMBEDDED_PLAIN_TEXT
|
boolean |
false
|
Determine which algorithm to use.
This property is ignored if plainText is true.
Environment variable: QUARKUS_SECURITY_USERS_EMBEDDED_ALGORITHM
|
digest-md5 , digest-sha , digest-sha-256 , digest-sha-384 , digest-sha-512 , digest-sha-512-256
|
digest-md5
|
The realm users user1=password\nuser2=password2… mapping. See Embedded Users.
Environment variable: QUARKUS_SECURITY_USERS_EMBEDDED_USERS
|
Map<String,String>
|
none
|
The realm roles user1=role1,role2,…\nuser2=role1,role2,… mapping See Embedded Roles.
Environment variable: QUARKUS_SECURITY_USERS_EMBEDDED_ROLES
|
Map<String,String>
|
none
|
Property Files Realm Configuration |
类型 |
默认 |
The realm name. This is used when generating a hashed password
Environment variable: QUARKUS_SECURITY_USERS_FILE_REALM_NAME
|
string |
Quarkus
|
Determine whether security via the file realm is enabled.
Environment variable: QUARKUS_SECURITY_USERS_FILE_ENABLED
|
boolean |
false
|
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: QUARKUS_SECURITY_USERS_FILE_PLAIN_TEXT
|
boolean |
false
|
Classpath resource name of properties file containing user to password mappings. See Users.properties.
Environment variable: QUARKUS_SECURITY_USERS_FILE_USERS
|
string |
users.properties
|
Classpath resource name of properties file containing user to role mappings. See Roles.properties.
Environment variable: QUARKUS_SECURITY_USERS_FILE_ROLES
|
string |
roles.properties
|
Embedded Realm Configuration |
类型 |
默认 |
The realm name. This is used when generating a hashed password
Environment variable: QUARKUS_SECURITY_USERS_EMBEDDED_REALM_NAME
|
string |
Quarkus
|
Determine whether security via the embedded realm is enabled.
Environment variable: QUARKUS_SECURITY_USERS_EMBEDDED_ENABLED
|
boolean |
false
|
Flyway |
类型 |
默认 |
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: QUARKUS_FLYWAY_LOCATIONS
|
list of string |
db/migration
|
Comma-separated list of fully qualified class names of Callback implementations to use to hook into the Flyway lifecycle. The org.flywaydb.core.api.callback.Callback subclass must have a no-args constructor and must not be abstract. These classes must also not have any fields that hold state (unless that state is initialized in the constructor).
Environment variable: QUARKUS_FLYWAY_CALLBACKS
|
list of string |
|
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: QUARKUS_FLYWAY_CONNECT_RETRIES
|
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: QUARKUS_FLYWAY_DEFAULT_SCHEMA
|
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: QUARKUS_FLYWAY_SCHEMAS
|
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: QUARKUS_FLYWAY_TABLE
|
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: QUARKUS_FLYWAY_SQL_MIGRATION_PREFIX
|
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: QUARKUS_FLYWAY_REPEATABLE_SQL_MIGRATION_PREFIX
|
string |
|
true to execute Flyway clean command automatically when the application starts, false otherwise.
Environment variable: QUARKUS_FLYWAY_CLEAN_AT_START
|
boolean |
false
|
true to prevent Flyway clean operations, false otherwise.
Environment variable: QUARKUS_FLYWAY_CLEAN_DISABLED
|
boolean |
false
|
true to automatically call clean when a validation error occurs, false otherwise.
Environment variable: QUARKUS_FLYWAY_CLEAN_ON_VALIDATION_ERROR
|
boolean |
false
|
true to execute Flyway automatically when the application starts, false otherwise.
Environment variable: QUARKUS_FLYWAY_MIGRATE_AT_START
|
boolean |
false
|
Enable the creation of the history table if it does not exist already.
Environment variable: QUARKUS_FLYWAY_BASELINE_ON_MIGRATE
|
boolean |
false
|
The initial baseline version.
Environment variable: QUARKUS_FLYWAY_BASELINE_VERSION
|
string |
|
The description to tag an existing schema with when executing baseline.
Environment variable: QUARKUS_FLYWAY_BASELINE_DESCRIPTION
|
string |
|
Whether to automatically call validate when performing a migration.
Environment variable: QUARKUS_FLYWAY_VALIDATE_ON_MIGRATE
|
boolean |
false
|
Allows migrations to be run "out of order".
Environment variable: QUARKUS_FLYWAY_OUT_OF_ORDER
|
boolean |
false
|
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: QUARKUS_FLYWAY_IGNORE_MISSING_MIGRATIONS
|
boolean |
false
|
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: QUARKUS_FLYWAY_IGNORE_FUTURE_MIGRATIONS
|
boolean |
false
|
Whether Flyway should attempt to create the schemas specified in the schemas property
Environment variable: QUARKUS_FLYWAY_CREATE_SCHEMAS
|
boolean |
true
|
Prefix of every placeholder (default: ${ )
Environment variable: QUARKUS_FLYWAY_PLACEHOLDER_PREFIX
|
string |
|
Suffix of every placeholder (default: } )
Environment variable: QUARKUS_FLYWAY_PLACEHOLDER_SUFFIX
|
string |
|
The SQL statements to run to initialize a new database connection immediately after opening it.
Environment variable: QUARKUS_FLYWAY_INIT_SQL
|
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: QUARKUS_FLYWAY__NAMED_DATA_SOURCES__LOCATIONS
|
list of string |
db/migration
|
Comma-separated list of fully qualified class names of Callback implementations to use to hook into the Flyway lifecycle. The org.flywaydb.core.api.callback.Callback subclass must have a no-args constructor and must not be abstract. These classes must also not have any fields that hold state (unless that state is initialized in the constructor).
Environment variable: QUARKUS_FLYWAY__NAMED_DATA_SOURCES__CALLBACKS
|
list of string |
|
Sets the placeholders to replace in SQL migration scripts.
Environment variable: QUARKUS_FLYWAY_PLACEHOLDERS
|
Map<String,String>
|
|
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: QUARKUS_FLYWAY__NAMED_DATA_SOURCES__CONNECT_RETRIES
|
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: QUARKUS_FLYWAY__NAMED_DATA_SOURCES__DEFAULT_SCHEMA
|
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: QUARKUS_FLYWAY__NAMED_DATA_SOURCES__SCHEMAS
|
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: QUARKUS_FLYWAY__NAMED_DATA_SOURCES__TABLE
|
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: QUARKUS_FLYWAY__NAMED_DATA_SOURCES__SQL_MIGRATION_PREFIX
|
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: QUARKUS_FLYWAY__NAMED_DATA_SOURCES__REPEATABLE_SQL_MIGRATION_PREFIX
|
string |
|
true to execute Flyway clean command automatically when the application starts, false otherwise.
Environment variable: QUARKUS_FLYWAY__NAMED_DATA_SOURCES__CLEAN_AT_START
|
boolean |
false
|
true to prevent Flyway clean operations, false otherwise.
Environment variable: QUARKUS_FLYWAY__NAMED_DATA_SOURCES__CLEAN_DISABLED
|
boolean |
false
|
true to automatically call clean when a validation error occurs, false otherwise.
Environment variable: QUARKUS_FLYWAY__NAMED_DATA_SOURCES__CLEAN_ON_VALIDATION_ERROR
|
boolean |
false
|
true to execute Flyway automatically when the application starts, false otherwise.
Environment variable: QUARKUS_FLYWAY__NAMED_DATA_SOURCES__MIGRATE_AT_START
|
boolean |
false
|
Enable the creation of the history table if it does not exist already.
Environment variable: QUARKUS_FLYWAY__NAMED_DATA_SOURCES__BASELINE_ON_MIGRATE
|
boolean |
false
|
The initial baseline version.
Environment variable: QUARKUS_FLYWAY__NAMED_DATA_SOURCES__BASELINE_VERSION
|
string |
|
The description to tag an existing schema with when executing baseline.
Environment variable: QUARKUS_FLYWAY__NAMED_DATA_SOURCES__BASELINE_DESCRIPTION
|
string |
|
Whether to automatically call validate when performing a migration.
Environment variable: QUARKUS_FLYWAY__NAMED_DATA_SOURCES__VALIDATE_ON_MIGRATE
|
boolean |
false
|
Allows migrations to be run "out of order".
Environment variable: QUARKUS_FLYWAY__NAMED_DATA_SOURCES__OUT_OF_ORDER
|
boolean |
false
|
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: QUARKUS_FLYWAY__NAMED_DATA_SOURCES__IGNORE_MISSING_MIGRATIONS
|
boolean |
false
|
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: QUARKUS_FLYWAY__NAMED_DATA_SOURCES__IGNORE_FUTURE_MIGRATIONS
|
boolean |
false
|
Sets the placeholders to replace in SQL migration scripts.
Environment variable: QUARKUS_FLYWAY__NAMED_DATA_SOURCES__PLACEHOLDERS
|
Map<String,String>
|
|
Whether Flyway should attempt to create the schemas specified in the schemas property
Environment variable: QUARKUS_FLYWAY__NAMED_DATA_SOURCES__CREATE_SCHEMAS
|
boolean |
true
|
Prefix of every placeholder (default: ${ )
Environment variable: QUARKUS_FLYWAY__NAMED_DATA_SOURCES__PLACEHOLDER_PREFIX
|
string |
|
Suffix of every placeholder (default: } )
Environment variable: QUARKUS_FLYWAY__NAMED_DATA_SOURCES__PLACEHOLDER_SUFFIX
|
string |
|
The SQL statements to run to initialize a new database connection immediately after opening it.
Environment variable: QUARKUS_FLYWAY__NAMED_DATA_SOURCES__INIT_SQL
|
string |
|
Funqy Knative Events Binding |
类型 |
默认 |
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: QUARKUS_FUNQY_KNATIVE_EVENTS_MAPPING__MAPPING__TRIGGER
|
string |
|
If function has response output, then what is the Cloud Event type (ce-type)? This will default to {function}.output
Environment variable: QUARKUS_FUNQY_KNATIVE_EVENTS_MAPPING__MAPPING__RESPONSE_TYPE
|
string |
|
If function has response output, then what is the Cloud Event source (ce-source)? This will default to the function name
Environment variable: QUARKUS_FUNQY_KNATIVE_EVENTS_MAPPING__MAPPING__RESPONSE_SOURCE
|
string |
|
Funqy Server Common |
类型 |
默认 |
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: QUARKUS_FUNQY_EXPORT
|
string |
|
Google Cloud Functions |
类型 |
默认 |
The function name. Function names are specified on function classes using the @javax.inject.Named annotation. If this name is unspecified and there is exactly one unnamed function then this unnamed function will be used. If there is only a single named function and the name is unspecified then the named function will be used. These rules apply for each function implementation (HttpFunction, BackgroundFunction, RawBackgroundFunction).
Environment variable: QUARKUS_GOOGLE_CLOUD_FUNCTIONS_FUNCTION
|
string |
|
Hibernate Envers |
类型 |
默认 |
Enable store_data_at_delete feature. Maps to org.hibernate.envers.configuration.EnversSettings#STORE_DATA_AT_DELETE .
Environment variable: QUARKUS_HIBERNATE_ENVERS_STORE_DATA_AT_DELETE
|
boolean |
false
|
Defines a suffix for historical data table. Defaults to _AUD . Maps to org.hibernate.envers.configuration.EnversSettings#AUDIT_TABLE_SUFFIX .
Environment variable: QUARKUS_HIBERNATE_ENVERS_AUDIT_TABLE_SUFFIX
|
string |
_AUD
|
Defines a prefix for historical data table. Default is the empty string. Maps to org.hibernate.envers.configuration.EnversSettings#AUDIT_TABLE_PREFIX .
Environment variable: QUARKUS_HIBERNATE_ENVERS_AUDIT_TABLE_PREFIX
|
string |
|
Revision field name. Defaults to REV . Maps to org.hibernate.envers.configuration.EnversSettings#REVISION_FIELD_NAME .
Environment variable: QUARKUS_HIBERNATE_ENVERS_REVISION_FIELD_NAME
|
string |
REV
|
Revision type field name. Defaults to REVTYPE . Maps to org.hibernate.envers.configuration.EnversSettings#REVISION_TYPE_FIELD_NAME .
Environment variable: QUARKUS_HIBERNATE_ENVERS_REVISION_TYPE_FIELD_NAME
|
string |
REVTYPE
|
Enable the revision_on_collection_change feature. Maps to org.hibernate.envers.configuration.EnversSettings#REVISION_ON_COLLECTION_CHANGE .
Environment variable: QUARKUS_HIBERNATE_ENVERS_REVISION_ON_COLLECTION_CHANGE
|
boolean |
true
|
Enable the do_not_audit_optimistic_locking_field feature. Maps to org.hibernate.envers.configuration.EnversSettings#DO_NOT_AUDIT_OPTIMISTIC_LOCKING_FIELD .
Environment variable: QUARKUS_HIBERNATE_ENVERS_DO_NOT_AUDIT_OPTIMISTIC_LOCKING_FIELD
|
boolean |
true
|
Defines the default schema of where audit tables are to be created. Maps to org.hibernate.envers.configuration.EnversSettings#DEFAULT_SCHEMA .
Environment variable: QUARKUS_HIBERNATE_ENVERS_DEFAULT_SCHEMA
|
string |
|
Defines the default catalog of where audit tables are to be created. Maps to org.hibernate.envers.configuration.EnversSettings#DEFAULT_CATALOG .
Environment variable: QUARKUS_HIBERNATE_ENVERS_DEFAULT_CATALOG
|
string |
|
Enables the track_entities_changed_in_revision feature. Maps to org.hibernate.envers.configuration.EnversSettings#TRACK_ENTITIES_CHANGED_IN_REVISION .
Environment variable: QUARKUS_HIBERNATE_ENVERS_TRACK_ENTITIES_CHANGED_IN_REVISION
|
boolean |
false
|
Enables the use_revision_entity_with_native_id feature. Maps to org.hibernate.envers.configuration.EnversSettings#USE_REVISION_ENTITY_WITH_NATIVE_ID .
Environment variable: QUARKUS_HIBERNATE_ENVERS_USE_REVISION_ENTITY_WITH_NATIVE_ID
|
boolean |
true
|
Enables the global_with_modified_flag feature. Maps to org.hibernate.envers.configuration.EnversSettings#GLOBAL_WITH_MODIFIED_FLAG .
Environment variable: QUARKUS_HIBERNATE_ENVERS_GLOBAL_WITH_MODIFIED_FLAG
|
boolean |
false
|
Defines the suffix to be used for modified flag columns. Defaults to _MOD . Maps to org.hibernate.envers.configuration.EnversSettings#MODIFIED_FLAG_SUFFIX
Environment variable: QUARKUS_HIBERNATE_ENVERS_MODIFIED_FLAG_SUFFIX
|
string |
_MOD
|
Defines the fully qualified class name of a user defined revision listener. Maps to org.hibernate.envers.configuration.EnversSettings#REVISION_LISTENER .
Environment variable: QUARKUS_HIBERNATE_ENVERS_REVISION_LISTENER
|
string |
|
Defines the fully qualified class name of the audit strategy to be used. Maps to org.hibernate.envers.configuration.EnversSettings#AUDIT_STRATEGY .
Environment variable: QUARKUS_HIBERNATE_ENVERS_AUDIT_STRATEGY
|
string |
org.hibernate.envers.strategy.DefaultAuditStrategy
|
Defines the property name for the audit entity’s composite primary key. Defaults to originalId . Maps to org.hibernate.envers.configuration.EnversSettings#ORIGINAL_ID_PROP_NAME .
Environment variable: QUARKUS_HIBERNATE_ENVERS_ORIGINAL_ID_PROP_NAME
|
string |
originalId
|
Defines the column name that holds the end revision number in audit entities. Defaults to REVEND . Maps to org.hibernate.envers.configuration.EnversSettings#AUDIT_STRATEGY_VALIDITY_END_REV_FIELD_NAME .
Environment variable: QUARKUS_HIBERNATE_ENVERS_AUDIT_STRATEGY_VALIDITY_END_REV_FIELD_NAME
|
string |
REVEND
|
Enables the audit_strategy_validity_store_revend_timestamp feature. Maps to org.hibernate.envers.configuration.EnversSettings#AUDIT_STRATEGY_VALIDITY_STORE_REVEND_TIMESTAMP .
Environment variable: QUARKUS_HIBERNATE_ENVERS_AUDIT_STRATEGY_VALIDITY_STORE_REVEND_TIMESTAMP
|
boolean |
false
|
Defines the column name of the revision end timestamp in the audit tables. Defaults to REVEND_TSTMP . Maps to org.hibernate.envers.configuration.EnversSettings#AUDIT_STRATEGY_VALIDITY_REVEND_TIMESTAMP_FIELD_NAME .
Environment variable: QUARKUS_HIBERNATE_ENVERS_AUDIT_STRATEGY_VALIDITY_REVEND_TIMESTAMP_FIELD_NAME
|
string |
REVEND_TSTMP
|
Defines the name of the column used for storing collection ordinal values for embeddable elements. Defaults to SETORDINAL . Maps to org.hibernate.envers.configuration.EnversSettings#EMBEDDABLE_SET_ORDINAL_FIELD_NAME .
Environment variable: QUARKUS_HIBERNATE_ENVERS_EMBEDDABLE_SET_ORDINAL_FIELD_NAME
|
string |
SETORDINAL
|
Enables the allow_identifier_reuse feature. Maps to org.hibernate.envers.configuration.EnversSettings#ALLOW_IDENTIFIER_REUSE .
Environment variable: QUARKUS_HIBERNATE_ENVERS_ALLOW_IDENTIFIER_REUSE
|
boolean |
false
|
Defines the naming strategy to be used for modified columns. Defaults to org.hibernate.envers.boot.internal.LegacyModifiedColumnNamingStrategy . Maps to org.hibernate.envers.configuration.EnversSettings#MODIFIED_COLUMN_NAMING_STRATEGY .
Environment variable: QUARKUS_HIBERNATE_ENVERS_MODIFIED_COLUMN_NAMING_STRATEGY
|
string |
org.hibernate.envers.boot.internal.LegacyModifiedColumnNamingStrategy
|
Hibernate ORM |
类型 |
默认 |
Environment variable: QUARKUS_HIBERNATE_ORM_DATASOURCE
|
string |
|
Environment variable: QUARKUS_HIBERNATE_ORM_PACKAGES
|
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. src/main/resources ).
The default value for this setting differs depending on the Quarkus launch mode:
-
In dev and test modes, it defaults to import.sql .
Simply add an import.sql file in the root of your resources directory
and it will be picked up without having to set this property.
Pass no-file to force Hibernate ORM to ignore the SQL import file.
-
In production mode, it defaults to no-file .
It means Hibernate ORM won’t try to execute any SQL import file by default.
Pass an explicit value to force Hibernate ORM to execute the SQL import file.
application.properties
%dev.quarkus.hibernate-orm.sql-load-script = import-dev.sql
%test.quarkus.hibernate-orm.sql-load-script = import-test.sql
%prod.quarkus.hibernate-orm.sql-load-script = no-file
|
Quarkus supports .sql file with SQL statements or comments spread over multiple lines.
Each SQL statement must be terminated by a semicolon.
|
Environment variable: QUARKUS_HIBERNATE_ORM_SQL_LOAD_SCRIPT
|
list of string |
import.sql in DEV, TEST ; no-file otherwise
|
Pluggable strategy contract for applying physical naming rules for database object names. Class name of the Hibernate PhysicalNamingStrategy implementation
Environment variable: QUARKUS_HIBERNATE_ORM_PHYSICAL_NAMING_STRATEGY
|
string |
|
Pluggable strategy for applying implicit naming rules when an explicit name is not given. Class name of the Hibernate ImplicitNamingStrategy implementation
Environment variable: QUARKUS_HIBERNATE_ORM_IMPLICIT_NAMING_STRATEGY
|
string |
|
|
This setting is exposed mainly to allow registration of types, converters and SQL functions.
|
Environment variable: QUARKUS_HIBERNATE_ORM_METADATA_BUILDER_CONTRIBUTOR
|
string |
|
XML files to configure the entity mapping, e.g. META-INF/my-orm.xml .
Defaults to META-INF/orm.xml if it exists. Pass no-file to force Hibernate ORM to ignore META-INF/orm.xml .
Environment variable: QUARKUS_HIBERNATE_ORM_MAPPING_FILES
|
list of string |
META-INF/orm.xml if it exists; no-file otherwise
|
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: QUARKUS_HIBERNATE_ORM_SECOND_LEVEL_CACHING_ENABLED
|
boolean |
true
|
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: QUARKUS_HIBERNATE_ORM_MULTITENANT
|
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: QUARKUS_HIBERNATE_ORM_MULTITENANT_SCHEMA_DATASOURCE
|
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: QUARKUS_HIBERNATE_ORM_VALIDATE_IN_DEV_MODE
|
boolean |
true
|
Whether statistics collection is enabled. If 'metrics.enabled' is true, then the default here is considered true, otherwise the default is false.
Environment variable: QUARKUS_HIBERNATE_ORM_STATISTICS
|
boolean |
|
Whether session metrics should be appended into the server log for each Hibernate session. This only has effect if statistics are enabled (quarkus.hibernate-orm.statistics ). The default is false (which means both statistics and log-session-metrics need to be enabled for the session metrics to appear in the log).
Environment variable: QUARKUS_HIBERNATE_ORM_LOG_SESSION_METRICS
|
boolean |
|
Whether metrics are published if a metrics extension is enabled.
Environment variable: QUARKUS_HIBERNATE_ORM_METRICS_ENABLED
|
boolean |
false
|
Properties that should be passed on directly to Hibernate ORM.
Use the full configuration property key here,
for instance quarkus.hibernate-orm.unsupported-properties."hibernate.order_inserts" = true .
|
Properties set here are completely unsupported:
as Quarkus doesn’t generally know about these properties and their purpose,
there is absolutely no guarantee that they will work correctly,
and even if they do, that may change when upgrading to a newer version of Quarkus
(even just a micro/patch version).
|
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: QUARKUS_HIBERNATE_ORM_UNSUPPORTED_PROPERTIES
|
Map<String,String>
|
|
Dialect related configuration |
类型 |
默认 |
Class name of the Hibernate ORM dialect. The complete list of bundled dialects is available in the
Hibernate ORM
JavaDoc.
|
Not all the dialects are supported in GraalVM native executables: we currently provide driver extensions for
PostgreSQL,
MariaDB, Microsoft SQL Server and H2.
|
Environment variable: QUARKUS_HIBERNATE_ORM_DIALECT
|
string |
|
The storage engine to use when the dialect supports multiple storage engines.
E.g. MyISAM or InnoDB for MySQL.
Environment variable: QUARKUS_HIBERNATE_ORM_DIALECT_STORAGE_ENGINE
|
string |
|
Query related configuration |
类型 |
默认 |
The maximum size of the query plan cache. see #QueryPlanCache#DEFAULT_QUERY_PLAN_MAX_COUNT
Environment variable: QUARKUS_HIBERNATE_ORM_QUERY_QUERY_PLAN_CACHE_MAX_SIZE
|
int |
2048
|
Default precedence of null values in ORDER BY clauses.
Valid values are: none , first , last .
Environment variable: QUARKUS_HIBERNATE_ORM_QUERY_DEFAULT_NULL_ORDERING
|
|
none
|
Database related configuration |
类型 |
默认 |
The charset of the database.
Used for DDL generation and also for the SQL import scripts.
Environment variable: QUARKUS_HIBERNATE_ORM_DATABASE_CHARSET
|
Charset |
UTF-8
|
Whether Hibernate should quote all identifiers.
Environment variable: QUARKUS_HIBERNATE_ORM_DATABASE_GLOBALLY_QUOTED_IDENTIFIERS
|
boolean |
false
|
Select whether the database schema is generated or not. drop-and-create is awesome in development mode. This defaults to 'none', however if Dev Services is in use and no other extensions that manage the schema are present this will default to 'drop-and-create'. Accepted values: none , create , drop-and-create , drop , update , validate .
Environment variable: QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION
|
string |
none
|
If Hibernate ORM should create the schemas automatically (for databases supporting them).
Environment variable: QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_CREATE_SCHEMAS
|
boolean |
false
|
Whether we should stop on the first error when applying the schema.
Environment variable: QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_HALT_ON_ERROR
|
boolean |
false
|
The default catalog to use for the database objects.
Environment variable: QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_CATALOG
|
string |
|
The default schema to use for the database objects.
Environment variable: QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_SCHEMA
|
string |
|
JDBC related configuration |
类型 |
默认 |
The time zone pushed to the JDBC driver.
Environment variable: QUARKUS_HIBERNATE_ORM_JDBC_TIMEZONE
|
string |
|
How many rows are fetched at a time by the JDBC driver.
Environment variable: QUARKUS_HIBERNATE_ORM_JDBC_STATEMENT_FETCH_SIZE
|
int |
|
The number of updates (inserts, updates and deletes) that are sent by the JDBC driver at one time for execution.
Environment variable: QUARKUS_HIBERNATE_ORM_JDBC_STATEMENT_BATCH_SIZE
|
int |
|
Fetching logic configuration |
类型 |
默认 |
The size of the batches used when loading entities and collections.
-1 means batch loading is disabled.
Environment variable: QUARKUS_HIBERNATE_ORM_FETCH_BATCH_SIZE
|
int |
16
|
The maximum depth of outer join fetch tree for single-ended associations (one-to-one, many-to-one).
A 0 disables default outer join fetching.
Environment variable: QUARKUS_HIBERNATE_ORM_FETCH_MAX_DEPTH
|
int |
|
Caching configuration |
类型 |
默认 |
The maximum time before an object of the cache is considered expired.
Environment variable: QUARKUS_HIBERNATE_ORM_CACHE__CACHE__EXPIRATION_MAX_IDLE
|
Duration
|
|
The maximum number of objects kept in memory in the cache.
Environment variable: QUARKUS_HIBERNATE_ORM_CACHE__CACHE__MEMORY_OBJECT_COUNT
|
long |
|
Discriminator related configuration |
类型 |
默认 |
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: QUARKUS_HIBERNATE_ORM_DISCRIMINATOR_IGNORE_EXPLICIT_FOR_JOINED
|
boolean |
false
|
Additional named persistence units |
类型 |
默认 |
Environment variable: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATASOURCE
|
string |
|
Environment variable: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__PACKAGES
|
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. src/main/resources ).
The default value for this setting differs depending on the Quarkus launch mode:
-
In dev and test modes, it defaults to import.sql .
Simply add an import.sql file in the root of your resources directory
and it will be picked up without having to set this property.
Pass no-file to force Hibernate ORM to ignore the SQL import file.
-
In production mode, it defaults to no-file .
It means Hibernate ORM won’t try to execute any SQL import file by default.
Pass an explicit value to force Hibernate ORM to execute the SQL import file.
application.properties
%dev.quarkus.hibernate-orm.sql-load-script = import-dev.sql
%test.quarkus.hibernate-orm.sql-load-script = import-test.sql
%prod.quarkus.hibernate-orm.sql-load-script = no-file
|
Quarkus supports .sql file with SQL statements or comments spread over multiple lines.
Each SQL statement must be terminated by a semicolon.
|
Environment variable: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SQL_LOAD_SCRIPT
|
list of string |
import.sql in DEV, TEST ; no-file otherwise
|
Pluggable strategy contract for applying physical naming rules for database object names. Class name of the Hibernate PhysicalNamingStrategy implementation
Environment variable: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__PHYSICAL_NAMING_STRATEGY
|
string |
|
Pluggable strategy for applying implicit naming rules when an explicit name is not given. Class name of the Hibernate ImplicitNamingStrategy implementation
Environment variable: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__IMPLICIT_NAMING_STRATEGY
|
string |
|
|
This setting is exposed mainly to allow registration of types, converters and SQL functions.
|
Environment variable: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__METADATA_BUILDER_CONTRIBUTOR
|
string |
|
XML files to configure the entity mapping, e.g. META-INF/my-orm.xml .
Defaults to META-INF/orm.xml if it exists. Pass no-file to force Hibernate ORM to ignore META-INF/orm.xml .
Environment variable: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__MAPPING_FILES
|
list of string |
META-INF/orm.xml if it exists; no-file otherwise
|
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: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SECOND_LEVEL_CACHING_ENABLED
|
boolean |
true
|
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: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__MULTITENANT
|
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: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__MULTITENANT_SCHEMA_DATASOURCE
|
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: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__VALIDATE_IN_DEV_MODE
|
boolean |
true
|
Properties that should be passed on directly to Hibernate ORM.
Use the full configuration property key here,
for instance quarkus.hibernate-orm.unsupported-properties."hibernate.order_inserts" = true .
|
Properties set here are completely unsupported:
as Quarkus doesn’t generally know about these properties and their purpose,
there is absolutely no guarantee that they will work correctly,
and even if they do, that may change when upgrading to a newer version of Quarkus
(even just a micro/patch version).
|
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: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__UNSUPPORTED_PROPERTIES
|
Map<String,String>
|
|
Dialect related configuration |
类型 |
默认 |
Class name of the Hibernate ORM dialect. The complete list of bundled dialects is available in the
Hibernate ORM
JavaDoc.
|
Not all the dialects are supported in GraalVM native executables: we currently provide driver extensions for
PostgreSQL,
MariaDB, Microsoft SQL Server and H2.
|
Environment variable: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DIALECT
|
string |
|
The storage engine to use when the dialect supports multiple storage engines.
E.g. MyISAM or InnoDB for MySQL.
Environment variable: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DIALECT_STORAGE_ENGINE
|
string |
|
Query related configuration |
类型 |
默认 |
The maximum size of the query plan cache. see #QueryPlanCache#DEFAULT_QUERY_PLAN_MAX_COUNT
Environment variable: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUERY_QUERY_PLAN_CACHE_MAX_SIZE
|
int |
2048
|
Default precedence of null values in ORDER BY clauses.
Valid values are: none , first , last .
Environment variable: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUERY_DEFAULT_NULL_ORDERING
|
|
none
|
Database related configuration |
类型 |
默认 |
The charset of the database.
Used for DDL generation and also for the SQL import scripts.
Environment variable: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_CHARSET
|
Charset |
UTF-8
|
Whether Hibernate should quote all identifiers.
Environment variable: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GLOBALLY_QUOTED_IDENTIFIERS
|
boolean |
false
|
Select whether the database schema is generated or not. drop-and-create is awesome in development mode. This defaults to 'none', however if Dev Services is in use and no other extensions that manage the schema are present this will default to 'drop-and-create'. Accepted values: none , create , drop-and-create , drop , update , validate .
Environment variable: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION
|
string |
none
|
If Hibernate ORM should create the schemas automatically (for databases supporting them).
Environment variable: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION_CREATE_SCHEMAS
|
boolean |
false
|
Whether we should stop on the first error when applying the schema.
Environment variable: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION_HALT_ON_ERROR
|
boolean |
false
|
The default catalog to use for the database objects.
Environment variable: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_DEFAULT_CATALOG
|
string |
|
The default schema to use for the database objects.
Environment variable: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_DEFAULT_SCHEMA
|
string |
|
JDBC related configuration |
类型 |
默认 |
The time zone pushed to the JDBC driver.
Environment variable: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__JDBC_TIMEZONE
|
string |
|
How many rows are fetched at a time by the JDBC driver.
Environment variable: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__JDBC_STATEMENT_FETCH_SIZE
|
int |
|
The number of updates (inserts, updates and deletes) that are sent by the JDBC driver at one time for execution.
Environment variable: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__JDBC_STATEMENT_BATCH_SIZE
|
int |
|
Fetching logic configuration |
类型 |
默认 |
The size of the batches used when loading entities and collections.
-1 means batch loading is disabled.
Environment variable: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__FETCH_BATCH_SIZE
|
int |
16
|
The maximum depth of outer join fetch tree for single-ended associations (one-to-one, many-to-one).
A 0 disables default outer join fetching.
Environment variable: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__FETCH_MAX_DEPTH
|
int |
|
Caching configuration |
类型 |
默认 |
The maximum time before an object of the cache is considered expired.
Environment variable: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__CACHE__CACHE__EXPIRATION_MAX_IDLE
|
Duration
|
|
The maximum number of objects kept in memory in the cache.
Environment variable: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__CACHE__CACHE__MEMORY_OBJECT_COUNT
|
long |
|
Discriminator related configuration |
类型 |
默认 |
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: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DISCRIMINATOR_IGNORE_EXPLICIT_FOR_JOINED
|
boolean |
false
|
Database scripts related configuration |
类型 |
默认 |
Select whether the database schema DDL files are generated or not. Accepted values: none , create , drop-and-create , drop , update , validate .
Environment variable: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION
|
string |
none
|
Filename or URL where the database create DDL file should be generated.
Environment variable: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION_CREATE_TARGET
|
string |
|
Filename or URL where the database drop DDL file should be generated.
Environment variable: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION_DROP_TARGET
|
string |
|
Logging configuration |
类型 |
默认 |
Show SQL logs and format them nicely.
Setting it to true is obviously not recommended in production.
Environment variable: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_SQL
|
boolean |
false
|
Format the SQL logs if SQL log is enabled
Environment variable: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_FORMAT_SQL
|
boolean |
true
|
Whether JDBC warnings should be collected and logged.
Environment variable: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_JDBC_WARNINGS
|
boolean |
depends on dialect
|
If set, Hibernate will log queries that took more than specified number of milliseconds to execute.
Environment variable: QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_QUERIES_SLOWER_THAN_MS
|
long |
|
Logging configuration |
类型 |
默认 |
Logs SQL bind parameters.
Setting it to true is obviously not recommended in production.
Environment variable: QUARKUS_HIBERNATE_ORM_LOG_BIND_PARAMETERS
|
boolean |
false
|
Show SQL logs and format them nicely.
Setting it to true is obviously not recommended in production.
Environment variable: QUARKUS_HIBERNATE_ORM_LOG_SQL
|
boolean |
false
|
Format the SQL logs if SQL log is enabled
Environment variable: QUARKUS_HIBERNATE_ORM_LOG_FORMAT_SQL
|
boolean |
true
|
Whether JDBC warnings should be collected and logged.
Environment variable: QUARKUS_HIBERNATE_ORM_LOG_JDBC_WARNINGS
|
boolean |
depends on dialect
|
If set, Hibernate will log queries that took more than specified number of milliseconds to execute.
Environment variable: QUARKUS_HIBERNATE_ORM_LOG_QUERIES_SLOWER_THAN_MS
|
long |
|
Database scripts related configuration |
类型 |
默认 |
Select whether the database schema DDL files are generated or not. Accepted values: none , create , drop-and-create , drop , update , validate .
Environment variable: QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION
|
string |
none
|
Filename or URL where the database create DDL file should be generated.
Environment variable: QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION_CREATE_TARGET
|
string |
|
Filename or URL where the database drop DDL file should be generated.
Environment variable: QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION_DROP_TARGET
|
string |
|
Hibernate Search + Elasticsearch |
类型 |
默认 |
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 FailureHandler .
|
Instead of setting this configuration property,
you can simply annotate your custom FailureHandler implementation with @SearchExtension
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
If this configuration property is set, it takes precedence over any @SearchExtension annotation.
|
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_BACKGROUND_FAILURE_HANDLER
|
string |
|
The strategy to use for coordinating between threads or even separate instances of the application,
in particular in automatic indexing.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_STRATEGY
|
string |
none
|
Whether Hibernate Search is enabled.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ENABLED
|
boolean |
true
|
The schema management strategy, controlling how indexes and their schema
are created, updated, validated or dropped on startup and shutdown.
Strategy |
Definition |
none |
Do nothing: assume that indexes already exist and that their schema matches Hibernate Search’s expectations. |
validate |
Validate that indexes exist and that their schema matches Hibernate Search’s expectations.
If it does not, throw an exception, but make no attempt to fix the problem. |
create |
For indexes that do not exist, create them along with their schema.
For indexes that already exist, do nothing: assume that their schema matches Hibernate Search’s expectations. |
create-or-validate (default unless using Dev Services) |
For indexes that do not exist, create them along with their schema.
For indexes that already exist, validate that their schema matches Hibernate Search’s expectations.
If it does not, throw an exception, but make no attempt to fix the problem. |
create-or-update |
For indexes that do not exist, create them along with their schema.
For indexes that already exist, validate that their schema matches Hibernate Search’s expectations;
if it does not match expectations, try to update it.
This strategy is unfit for production environments,
due to several important limitations,
but can be useful when developing. |
drop-and-create |
For indexes that do not exist, create them along with their schema.
For indexes that already exist, drop them, then create them along with their schema. |
drop-and-create-and-drop (default when using Dev Services) |
For indexes that do not exist, create them along with their schema.
For indexes that already exist, drop them, then create them along with their schema.
Also, drop indexes and their schema on shutdown. |
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_SCHEMA_MANAGEMENT_STRATEGY
|
none , validate , create , create-or-validate , create-or-update , drop-and-create , drop-and-create-and-drop
|
create-or-validate
|
The strategy to use when loading entities during the execution of a search query.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_QUERY_LOADING_CACHE_LOOKUP_STRATEGY
|
skip , persistence-context , persistence-context-then-second-level-cache
|
skip
|
The fetch size to use when loading entities during the execution of a search query.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_QUERY_LOADING_FETCH_SIZE
|
int |
100
|
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.
|
Indexing synchronization is only relevant when coordination is disabled (which is the default).
With the outbox-polling coordination strategy,
indexing happens in background threads and is always asynchronous;
the behavior is equivalent to the write-sync synchronization strategy.
|
Strategy |
Throughput |
Guarantees when the application thread resumes |
Changes applied |
Changes safe from crash/power loss |
Changes visible on search |
async |
Best |
|
|
|
write-sync (default) |
Medium |
|
|
|
read-sync |
Medium to worst |
|
|
|
sync |
Worst |
|
|
|
This property also accepts a bean reference
to a custom implementations of AutomaticIndexingSynchronizationStrategy .
|
Instead of setting this configuration property,
you can simply annotate your custom AutomaticIndexingSynchronizationStrategy implementation with @SearchExtension
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
If this configuration property is set, it takes precedence over any @SearchExtension annotation.
|
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_AUTOMATIC_INDEXING_SYNCHRONIZATION_STRATEGY
|
string |
write-sync
|
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: QUARKUS_HIBERNATE_SEARCH_ORM_AUTOMATIC_INDEXING_ENABLE_DIRTY_CHECK
|
boolean |
true
|
An exhaustive list of all tenant identifiers that may be used by the application when multi-tenancy is enabled.
Mainly useful when using the outbox-polling coordination strategy, since it involves setting up one background processor per tenant.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_MULTI_TENANCY_TENANT_IDS
|
list of string |
|
Default backend |
类型 |
默认 |
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 7 or 7.1 for instance) but it has to be sufficiently precise to choose a model dialect (the one used to generate the schema) compatible with the protocol dialect (the one used to communicate with Elasticsearch).
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: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_VERSION
|
ElasticsearchVersion |
|
A bean reference to the component
used to configure layout (e.g. index names, index aliases).
The referenced bean must implement IndexLayoutStrategy .
Available built-in implementations:
simple
-
The default, future-proof strategy: if the index name in Hibernate Search is myIndex ,
this strategy will create an index named myindex-000001 , an alias for write operations named myindex-write ,
and an alias for read operations named myindex-read .
no-alias
-
A strategy without index aliases, mostly useful on legacy clusters:
if the index name in Hibernate Search is myIndex ,
this strategy will create an index named myindex , and will not use any alias.
|
Instead of setting this configuration property,
you can simply annotate your custom IndexLayoutStrategy implementation with @SearchExtension
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
If this configuration property is set, it takes precedence over any @SearchExtension annotation.
|
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_LAYOUT_STRATEGY
|
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 custom settings, the behavior is undefined;
it should not be relied upon.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_SCHEMA_MANAGEMENT_SETTINGS_FILE
|
string |
|
Path to a file in the classpath holding a custom index mapping to be included in the index definition
when creating an Elasticsearch index.
The file does not need to (and generally shouldn’t) contain the full mapping:
Hibernate Search will automatically inject missing properties (index fields) in the given mapping.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_SCHEMA_MANAGEMENT_MAPPING_FILE
|
string |
|
A bean reference to the component
used to configure full text analysis (e.g. analyzers, normalizers).
The referenced bean must implement ElasticsearchAnalysisConfigurer .
|
Instead of setting this configuration property,
you can simply annotate your custom ElasticsearchAnalysisConfigurer implementation with @SearchExtension
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
If this configuration property is set, it takes precedence over any @SearchExtension annotation.
|
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_ANALYSIS_CONFIGURER
|
string |
|
The list of hosts of the Elasticsearch servers.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_HOSTS
|
list of string |
localhost:9200
|
The protocol to use when contacting Elasticsearch servers. Set to "https" to enable SSL/TLS.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_PROTOCOL
|
|
http
|
The username used for authentication.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_USERNAME
|
string |
|
The password used for authentication.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_PASSWORD
|
string |
|
The timeout when establishing a connection to an Elasticsearch server.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_CONNECTION_TIMEOUT
|
Duration
|
1S
|
The timeout when reading responses from an Elasticsearch server.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_READ_TIMEOUT
|
Duration
|
30S
|
The timeout when executing a request to an Elasticsearch server.
This includes the time needed to wait for a connection to be available, send the request and read the response.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_REQUEST_TIMEOUT
|
Duration
|
|
The maximum number of connections to all the Elasticsearch servers.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_MAX_CONNECTIONS
|
int |
20
|
The maximum number of connections per Elasticsearch server.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_MAX_CONNECTIONS_PER_ROUTE
|
int |
10
|
Defines if automatic discovery is enabled.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_DISCOVERY_ENABLED
|
boolean |
false
|
Refresh interval of the node list.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_DISCOVERY_REFRESH_INTERVAL
|
Duration
|
10S
|
The size of the thread pool assigned to the backend.
Note that number is per backend, not per index. Adding more indexes will not add more threads.
As all operations happening in this thread-pool are non-blocking, raising its size above the number of processor cores available to the JVM will not bring noticeable performance benefit. The only reason to alter this setting would be to reduce the number of threads; for example, in an application with a single index with a single indexing queue, running on a machine with 64 processor cores, you might want to bring down the number of threads.
Defaults to the number of processor cores available to the JVM on startup.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_THREAD_POOL_SIZE
|
int |
|
Whether Hibernate Search should check the version of the Elasticsearch cluster on startup.
Set to false if the Elasticsearch cluster may not be available on startup.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_VERSION_CHECK_ENABLED
|
boolean |
true
|
The minimal cluster status required.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_SCHEMA_MANAGEMENT_REQUIRED_STATUS
|
|
yellow
|
How long we should wait for the status before failing the bootstrap.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT
|
Duration
|
10S
|
The number of indexing queues assigned to each index.
Higher values will lead to more connections being used in parallel, which may lead to higher indexing throughput, but incurs a risk of overloading Elasticsearch, i.e. of overflowing its HTTP request buffers and tripping circuit breakers, leading to Elasticsearch giving up on some request and resulting in indexing failures.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXING_QUEUE_COUNT
|
int |
10
|
The size of indexing queues.
Lower values may lead to lower memory usage, especially if there are many queues, but values that are too low will reduce the likeliness of reaching the max bulk size and increase the likeliness of application threads blocking because the queue is full, which may lead to lower indexing throughput.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXING_QUEUE_SIZE
|
int |
1000
|
The maximum size of bulk requests created when processing indexing queues.
Higher values will lead to more documents being sent in each HTTP request sent to Elasticsearch, which may lead to higher indexing throughput, but incurs a risk of overloading Elasticsearch, i.e. of overflowing its HTTP request buffers and tripping circuit breakers, leading to Elasticsearch giving up on some request and resulting in indexing failures.
Note that raising this number above the queue size has no effect, as bulks cannot include more requests than are contained in the queue.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXING_MAX_BULK_SIZE
|
int |
100
|
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 custom settings, the behavior is undefined;
it should not be relied upon.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_SETTINGS_FILE
|
string |
|
Path to a file in the classpath holding a custom index mapping to be included in the index definition
when creating an Elasticsearch index.
The file does not need to (and generally shouldn’t) contain the full mapping:
Hibernate Search will automatically inject missing properties (index fields) in the given mapping.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_MAPPING_FILE
|
string |
|
A bean reference to the component
used to configure full text analysis (e.g. analyzers, normalizers).
The referenced bean must implement ElasticsearchAnalysisConfigurer .
|
Instead of setting this configuration property,
you can simply annotate your custom ElasticsearchAnalysisConfigurer implementation with @SearchExtension
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
If this configuration property is set, it takes precedence over any @SearchExtension annotation.
|
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__ANALYSIS_CONFIGURER
|
string |
|
The minimal cluster status required.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS
|
|
yellow
|
How long we should wait for the status before failing the bootstrap.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT
|
Duration
|
10S
|
The number of indexing queues assigned to each index.
Higher values will lead to more connections being used in parallel, which may lead to higher indexing throughput, but incurs a risk of overloading Elasticsearch, i.e. of overflowing its HTTP request buffers and tripping circuit breakers, leading to Elasticsearch giving up on some request and resulting in indexing failures.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__INDEXING_QUEUE_COUNT
|
int |
10
|
The size of indexing queues.
Lower values may lead to lower memory usage, especially if there are many queues, but values that are too low will reduce the likeliness of reaching the max bulk size and increase the likeliness of application threads blocking because the queue is full, which may lead to lower indexing throughput.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__INDEXING_QUEUE_SIZE
|
int |
1000
|
The maximum size of bulk requests created when processing indexing queues.
Higher values will lead to more documents being sent in each HTTP request sent to Elasticsearch, which may lead to higher indexing throughput, but incurs a risk of overloading Elasticsearch, i.e. of overflowing its HTTP request buffers and tripping circuit breakers, leading to Elasticsearch giving up on some request and resulting in indexing failures.
Note that raising this number above the queue size has no effect, as bulks cannot include more requests than are contained in the queue.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__INDEXING_MAX_BULK_SIZE
|
int |
100
|
Named backends |
类型 |
默认 |
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 7 or 7.1 for instance) but it has to be sufficiently precise to choose a model dialect (the one used to generate the schema) compatible with the protocol dialect (the one used to communicate with Elasticsearch).
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: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_BACKENDS__BACKEND_NAME__VERSION
|
ElasticsearchVersion |
|
A bean reference to the component
used to configure layout (e.g. index names, index aliases).
The referenced bean must implement IndexLayoutStrategy .
Available built-in implementations:
simple
-
The default, future-proof strategy: if the index name in Hibernate Search is myIndex ,
this strategy will create an index named myindex-000001 , an alias for write operations named myindex-write ,
and an alias for read operations named myindex-read .
no-alias
-
A strategy without index aliases, mostly useful on legacy clusters:
if the index name in Hibernate Search is myIndex ,
this strategy will create an index named myindex , and will not use any alias.
|
Instead of setting this configuration property,
you can simply annotate your custom IndexLayoutStrategy implementation with @SearchExtension
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
If this configuration property is set, it takes precedence over any @SearchExtension annotation.
|
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_BACKENDS__BACKEND_NAME__LAYOUT_STRATEGY
|
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 custom settings, the behavior is undefined;
it should not be relied upon.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_BACKENDS__BACKEND_NAME__SCHEMA_MANAGEMENT_SETTINGS_FILE
|
string |
|
Path to a file in the classpath holding a custom index mapping to be included in the index definition
when creating an Elasticsearch index.
The file does not need to (and generally shouldn’t) contain the full mapping:
Hibernate Search will automatically inject missing properties (index fields) in the given mapping.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_BACKENDS__BACKEND_NAME__SCHEMA_MANAGEMENT_MAPPING_FILE
|
string |
|
A bean reference to the component
used to configure full text analysis (e.g. analyzers, normalizers).
The referenced bean must implement ElasticsearchAnalysisConfigurer .
|
Instead of setting this configuration property,
you can simply annotate your custom ElasticsearchAnalysisConfigurer implementation with @SearchExtension
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
If this configuration property is set, it takes precedence over any @SearchExtension annotation.
|
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_BACKENDS__BACKEND_NAME__ANALYSIS_CONFIGURER
|
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 custom settings, the behavior is undefined;
it should not be relied upon.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_BACKENDS__BACKEND_NAME__INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_SETTINGS_FILE
|
string |
|
Path to a file in the classpath holding a custom index mapping to be included in the index definition
when creating an Elasticsearch index.
The file does not need to (and generally shouldn’t) contain the full mapping:
Hibernate Search will automatically inject missing properties (index fields) in the given mapping.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_BACKENDS__BACKEND_NAME__INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_MAPPING_FILE
|
string |
|
A bean reference to the component
used to configure full text analysis (e.g. analyzers, normalizers).
The referenced bean must implement ElasticsearchAnalysisConfigurer .
|
Instead of setting this configuration property,
you can simply annotate your custom ElasticsearchAnalysisConfigurer implementation with @SearchExtension
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
If this configuration property is set, it takes precedence over any @SearchExtension annotation.
|
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_BACKENDS__BACKEND_NAME__INDEXES__INDEX_NAME__ANALYSIS_CONFIGURER
|
string |
|
The list of hosts of the Elasticsearch servers.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_BACKENDS__BACKEND_NAME__HOSTS
|
list of string |
localhost:9200
|
The protocol to use when contacting Elasticsearch servers. Set to "https" to enable SSL/TLS.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_BACKENDS__BACKEND_NAME__PROTOCOL
|
|
http
|
The username used for authentication.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_BACKENDS__BACKEND_NAME__USERNAME
|
string |
|
The password used for authentication.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_BACKENDS__BACKEND_NAME__PASSWORD
|
string |
|
The timeout when establishing a connection to an Elasticsearch server.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_BACKENDS__BACKEND_NAME__CONNECTION_TIMEOUT
|
Duration
|
1S
|
The timeout when reading responses from an Elasticsearch server.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_BACKENDS__BACKEND_NAME__READ_TIMEOUT
|
Duration
|
30S
|
The timeout when executing a request to an Elasticsearch server.
This includes the time needed to wait for a connection to be available, send the request and read the response.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_BACKENDS__BACKEND_NAME__REQUEST_TIMEOUT
|
Duration
|
|
The maximum number of connections to all the Elasticsearch servers.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_BACKENDS__BACKEND_NAME__MAX_CONNECTIONS
|
int |
20
|
The maximum number of connections per Elasticsearch server.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_BACKENDS__BACKEND_NAME__MAX_CONNECTIONS_PER_ROUTE
|
int |
10
|
Defines if automatic discovery is enabled.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_BACKENDS__BACKEND_NAME__DISCOVERY_ENABLED
|
boolean |
false
|
Refresh interval of the node list.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_BACKENDS__BACKEND_NAME__DISCOVERY_REFRESH_INTERVAL
|
Duration
|
10S
|
The size of the thread pool assigned to the backend.
Note that number is per backend, not per index. Adding more indexes will not add more threads.
As all operations happening in this thread-pool are non-blocking, raising its size above the number of processor cores available to the JVM will not bring noticeable performance benefit. The only reason to alter this setting would be to reduce the number of threads; for example, in an application with a single index with a single indexing queue, running on a machine with 64 processor cores, you might want to bring down the number of threads.
Defaults to the number of processor cores available to the JVM on startup.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_BACKENDS__BACKEND_NAME__THREAD_POOL_SIZE
|
int |
|
Whether Hibernate Search should check the version of the Elasticsearch cluster on startup.
Set to false if the Elasticsearch cluster may not be available on startup.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_BACKENDS__BACKEND_NAME__VERSION_CHECK_ENABLED
|
boolean |
true
|
The minimal cluster status required.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_BACKENDS__BACKEND_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS
|
|
yellow
|
How long we should wait for the status before failing the bootstrap.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_BACKENDS__BACKEND_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT
|
Duration
|
10S
|
The number of indexing queues assigned to each index.
Higher values will lead to more connections being used in parallel, which may lead to higher indexing throughput, but incurs a risk of overloading Elasticsearch, i.e. of overflowing its HTTP request buffers and tripping circuit breakers, leading to Elasticsearch giving up on some request and resulting in indexing failures.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_BACKENDS__BACKEND_NAME__INDEXING_QUEUE_COUNT
|
int |
10
|
The size of indexing queues.
Lower values may lead to lower memory usage, especially if there are many queues, but values that are too low will reduce the likeliness of reaching the max bulk size and increase the likeliness of application threads blocking because the queue is full, which may lead to lower indexing throughput.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_BACKENDS__BACKEND_NAME__INDEXING_QUEUE_SIZE
|
int |
1000
|
The maximum size of bulk requests created when processing indexing queues.
Higher values will lead to more documents being sent in each HTTP request sent to Elasticsearch, which may lead to higher indexing throughput, but incurs a risk of overloading Elasticsearch, i.e. of overflowing its HTTP request buffers and tripping circuit breakers, leading to Elasticsearch giving up on some request and resulting in indexing failures.
Note that raising this number above the queue size has no effect, as bulks cannot include more requests than are contained in the queue.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_BACKENDS__BACKEND_NAME__INDEXING_MAX_BULK_SIZE
|
int |
100
|
The minimal cluster status required.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_BACKENDS__BACKEND_NAME__INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS
|
|
yellow
|
How long we should wait for the status before failing the bootstrap.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_BACKENDS__BACKEND_NAME__INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT
|
Duration
|
10S
|
The number of indexing queues assigned to each index.
Higher values will lead to more connections being used in parallel, which may lead to higher indexing throughput, but incurs a risk of overloading Elasticsearch, i.e. of overflowing its HTTP request buffers and tripping circuit breakers, leading to Elasticsearch giving up on some request and resulting in indexing failures.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_BACKENDS__BACKEND_NAME__INDEXES__INDEX_NAME__INDEXING_QUEUE_COUNT
|
int |
10
|
The size of indexing queues.
Lower values may lead to lower memory usage, especially if there are many queues, but values that are too low will reduce the likeliness of reaching the max bulk size and increase the likeliness of application threads blocking because the queue is full, which may lead to lower indexing throughput.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_BACKENDS__BACKEND_NAME__INDEXES__INDEX_NAME__INDEXING_QUEUE_SIZE
|
int |
1000
|
The maximum size of bulk requests created when processing indexing queues.
Higher values will lead to more documents being sent in each HTTP request sent to Elasticsearch, which may lead to higher indexing throughput, but incurs a risk of overloading Elasticsearch, i.e. of overflowing its HTTP request buffers and tripping circuit breakers, leading to Elasticsearch giving up on some request and resulting in indexing failures.
Note that raising this number above the queue size has no effect, as bulks cannot include more requests than are contained in the queue.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_BACKENDS__BACKEND_NAME__INDEXES__INDEX_NAME__INDEXING_MAX_BULK_SIZE
|
int |
100
|
Configuration for additional named persistence units |
类型 |
默认 |
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 FailureHandler .
|
Instead of setting this configuration property,
you can simply annotate your custom FailureHandler implementation with @SearchExtension
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
If this configuration property is set, it takes precedence over any @SearchExtension annotation.
|
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__BACKGROUND_FAILURE_HANDLER
|
string |
|
The strategy to use for coordinating between threads or even separate instances of the application,
in particular in automatic indexing.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__COORDINATION_STRATEGY
|
string |
none
|
Whether Hibernate Search is enabled.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ENABLED
|
boolean |
true
|
The schema management strategy, controlling how indexes and their schema
are created, updated, validated or dropped on startup and shutdown.
Strategy |
Definition |
none |
Do nothing: assume that indexes already exist and that their schema matches Hibernate Search’s expectations. |
validate |
Validate that indexes exist and that their schema matches Hibernate Search’s expectations.
If it does not, throw an exception, but make no attempt to fix the problem. |
create |
For indexes that do not exist, create them along with their schema.
For indexes that already exist, do nothing: assume that their schema matches Hibernate Search’s expectations. |
create-or-validate (default unless using Dev Services) |
For indexes that do not exist, create them along with their schema.
For indexes that already exist, validate that their schema matches Hibernate Search’s expectations.
If it does not, throw an exception, but make no attempt to fix the problem. |
create-or-update |
For indexes that do not exist, create them along with their schema.
For indexes that already exist, validate that their schema matches Hibernate Search’s expectations;
if it does not match expectations, try to update it.
This strategy is unfit for production environments,
due to several important limitations,
but can be useful when developing. |
drop-and-create |
For indexes that do not exist, create them along with their schema.
For indexes that already exist, drop them, then create them along with their schema. |
drop-and-create-and-drop (default when using Dev Services) |
For indexes that do not exist, create them along with their schema.
For indexes that already exist, drop them, then create them along with their schema.
Also, drop indexes and their schema on shutdown. |
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__SCHEMA_MANAGEMENT_STRATEGY
|
none , validate , create , create-or-validate , create-or-update , drop-and-create , drop-and-create-and-drop
|
create-or-validate
|
The strategy to use when loading entities during the execution of a search query.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__QUERY_LOADING_CACHE_LOOKUP_STRATEGY
|
skip , persistence-context , persistence-context-then-second-level-cache
|
skip
|
The fetch size to use when loading entities during the execution of a search query.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__QUERY_LOADING_FETCH_SIZE
|
int |
100
|
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.
|
Indexing synchronization is only relevant when coordination is disabled (which is the default).
With the outbox-polling coordination strategy,
indexing happens in background threads and is always asynchronous;
the behavior is equivalent to the write-sync synchronization strategy.
|
Strategy |
Throughput |
Guarantees when the application thread resumes |
Changes applied |
Changes safe from crash/power loss |
Changes visible on search |
async |
Best |
|
|
|
write-sync (default) |
Medium |
|
|
|
read-sync |
Medium to worst |
|
|
|
sync |
Worst |
|
|
|
This property also accepts a bean reference
to a custom implementations of AutomaticIndexingSynchronizationStrategy .
|
Instead of setting this configuration property,
you can simply annotate your custom AutomaticIndexingSynchronizationStrategy implementation with @SearchExtension
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
If this configuration property is set, it takes precedence over any @SearchExtension annotation.
|
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__AUTOMATIC_INDEXING_SYNCHRONIZATION_STRATEGY
|
string |
write-sync
|
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: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__AUTOMATIC_INDEXING_ENABLE_DIRTY_CHECK
|
boolean |
true
|
An exhaustive list of all tenant identifiers that may be used by the application when multi-tenancy is enabled.
Mainly useful when using the outbox-polling coordination strategy, since it involves setting up one background processor per tenant.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__MULTI_TENANCY_TENANT_IDS
|
list of string |
|
Default backend |
类型 |
默认 |
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 7 or 7.1 for instance) but it has to be sufficiently precise to choose a model dialect (the one used to generate the schema) compatible with the protocol dialect (the one used to communicate with Elasticsearch).
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: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_VERSION
|
ElasticsearchVersion |
|
A bean reference to the component
used to configure layout (e.g. index names, index aliases).
The referenced bean must implement IndexLayoutStrategy .
Available built-in implementations:
simple
-
The default, future-proof strategy: if the index name in Hibernate Search is myIndex ,
this strategy will create an index named myindex-000001 , an alias for write operations named myindex-write ,
and an alias for read operations named myindex-read .
no-alias
-
A strategy without index aliases, mostly useful on legacy clusters:
if the index name in Hibernate Search is myIndex ,
this strategy will create an index named myindex , and will not use any alias.
|
Instead of setting this configuration property,
you can simply annotate your custom IndexLayoutStrategy implementation with @SearchExtension
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
If this configuration property is set, it takes precedence over any @SearchExtension annotation.
|
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_LAYOUT_STRATEGY
|
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 custom settings, the behavior is undefined;
it should not be relied upon.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_SCHEMA_MANAGEMENT_SETTINGS_FILE
|
string |
|
Path to a file in the classpath holding a custom index mapping to be included in the index definition
when creating an Elasticsearch index.
The file does not need to (and generally shouldn’t) contain the full mapping:
Hibernate Search will automatically inject missing properties (index fields) in the given mapping.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_SCHEMA_MANAGEMENT_MAPPING_FILE
|
string |
|
A bean reference to the component
used to configure full text analysis (e.g. analyzers, normalizers).
The referenced bean must implement ElasticsearchAnalysisConfigurer .
|
Instead of setting this configuration property,
you can simply annotate your custom ElasticsearchAnalysisConfigurer implementation with @SearchExtension
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
If this configuration property is set, it takes precedence over any @SearchExtension annotation.
|
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_ANALYSIS_CONFIGURER
|
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 custom settings, the behavior is undefined;
it should not be relied upon.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_SETTINGS_FILE
|
string |
|
Path to a file in the classpath holding a custom index mapping to be included in the index definition
when creating an Elasticsearch index.
The file does not need to (and generally shouldn’t) contain the full mapping:
Hibernate Search will automatically inject missing properties (index fields) in the given mapping.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_MAPPING_FILE
|
string |
|
A bean reference to the component
used to configure full text analysis (e.g. analyzers, normalizers).
The referenced bean must implement ElasticsearchAnalysisConfigurer .
|
Instead of setting this configuration property,
you can simply annotate your custom ElasticsearchAnalysisConfigurer implementation with @SearchExtension
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
If this configuration property is set, it takes precedence over any @SearchExtension annotation.
|
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_INDEXES__INDEX_NAME__ANALYSIS_CONFIGURER
|
string |
|
The list of hosts of the Elasticsearch servers.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_HOSTS
|
list of string |
localhost:9200
|
The protocol to use when contacting Elasticsearch servers. Set to "https" to enable SSL/TLS.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_PROTOCOL
|
|
http
|
The username used for authentication.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_USERNAME
|
string |
|
The password used for authentication.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_PASSWORD
|
string |
|
The timeout when establishing a connection to an Elasticsearch server.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_CONNECTION_TIMEOUT
|
Duration
|
1S
|
The timeout when reading responses from an Elasticsearch server.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_READ_TIMEOUT
|
Duration
|
30S
|
The timeout when executing a request to an Elasticsearch server.
This includes the time needed to wait for a connection to be available, send the request and read the response.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_REQUEST_TIMEOUT
|
Duration
|
|
The maximum number of connections to all the Elasticsearch servers.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_MAX_CONNECTIONS
|
int |
20
|
The maximum number of connections per Elasticsearch server.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_MAX_CONNECTIONS_PER_ROUTE
|
int |
10
|
Defines if automatic discovery is enabled.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_DISCOVERY_ENABLED
|
boolean |
false
|
Refresh interval of the node list.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_DISCOVERY_REFRESH_INTERVAL
|
Duration
|
10S
|
The size of the thread pool assigned to the backend.
Note that number is per backend, not per index. Adding more indexes will not add more threads.
As all operations happening in this thread-pool are non-blocking, raising its size above the number of processor cores available to the JVM will not bring noticeable performance benefit. The only reason to alter this setting would be to reduce the number of threads; for example, in an application with a single index with a single indexing queue, running on a machine with 64 processor cores, you might want to bring down the number of threads.
Defaults to the number of processor cores available to the JVM on startup.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_THREAD_POOL_SIZE
|
int |
|
Whether Hibernate Search should check the version of the Elasticsearch cluster on startup.
Set to false if the Elasticsearch cluster may not be available on startup.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_VERSION_CHECK_ENABLED
|
boolean |
true
|
The minimal cluster status required.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_SCHEMA_MANAGEMENT_REQUIRED_STATUS
|
|
yellow
|
How long we should wait for the status before failing the bootstrap.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT
|
Duration
|
10S
|
The number of indexing queues assigned to each index.
Higher values will lead to more connections being used in parallel, which may lead to higher indexing throughput, but incurs a risk of overloading Elasticsearch, i.e. of overflowing its HTTP request buffers and tripping circuit breakers, leading to Elasticsearch giving up on some request and resulting in indexing failures.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_INDEXING_QUEUE_COUNT
|
int |
10
|
The size of indexing queues.
Lower values may lead to lower memory usage, especially if there are many queues, but values that are too low will reduce the likeliness of reaching the max bulk size and increase the likeliness of application threads blocking because the queue is full, which may lead to lower indexing throughput.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_INDEXING_QUEUE_SIZE
|
int |
1000
|
The maximum size of bulk requests created when processing indexing queues.
Higher values will lead to more documents being sent in each HTTP request sent to Elasticsearch, which may lead to higher indexing throughput, but incurs a risk of overloading Elasticsearch, i.e. of overflowing its HTTP request buffers and tripping circuit breakers, leading to Elasticsearch giving up on some request and resulting in indexing failures.
Note that raising this number above the queue size has no effect, as bulks cannot include more requests than are contained in the queue.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_INDEXING_MAX_BULK_SIZE
|
int |
100
|
The minimal cluster status required.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS
|
|
yellow
|
How long we should wait for the status before failing the bootstrap.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT
|
Duration
|
10S
|
The number of indexing queues assigned to each index.
Higher values will lead to more connections being used in parallel, which may lead to higher indexing throughput, but incurs a risk of overloading Elasticsearch, i.e. of overflowing its HTTP request buffers and tripping circuit breakers, leading to Elasticsearch giving up on some request and resulting in indexing failures.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_INDEXES__INDEX_NAME__INDEXING_QUEUE_COUNT
|
int |
10
|
The size of indexing queues.
Lower values may lead to lower memory usage, especially if there are many queues, but values that are too low will reduce the likeliness of reaching the max bulk size and increase the likeliness of application threads blocking because the queue is full, which may lead to lower indexing throughput.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_INDEXES__INDEX_NAME__INDEXING_QUEUE_SIZE
|
int |
1000
|
The maximum size of bulk requests created when processing indexing queues.
Higher values will lead to more documents being sent in each HTTP request sent to Elasticsearch, which may lead to higher indexing throughput, but incurs a risk of overloading Elasticsearch, i.e. of overflowing its HTTP request buffers and tripping circuit breakers, leading to Elasticsearch giving up on some request and resulting in indexing failures.
Note that raising this number above the queue size has no effect, as bulks cannot include more requests than are contained in the queue.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_INDEXES__INDEX_NAME__INDEXING_MAX_BULK_SIZE
|
int |
100
|
Named backends |
类型 |
默认 |
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 7 or 7.1 for instance) but it has to be sufficiently precise to choose a model dialect (the one used to generate the schema) compatible with the protocol dialect (the one used to communicate with Elasticsearch).
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: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_BACKENDS__BACKEND_NAME__VERSION
|
ElasticsearchVersion |
|
A bean reference to the component
used to configure layout (e.g. index names, index aliases).
The referenced bean must implement IndexLayoutStrategy .
Available built-in implementations:
simple
-
The default, future-proof strategy: if the index name in Hibernate Search is myIndex ,
this strategy will create an index named myindex-000001 , an alias for write operations named myindex-write ,
and an alias for read operations named myindex-read .
no-alias
-
A strategy without index aliases, mostly useful on legacy clusters:
if the index name in Hibernate Search is myIndex ,
this strategy will create an index named myindex , and will not use any alias.
|
Instead of setting this configuration property,
you can simply annotate your custom IndexLayoutStrategy implementation with @SearchExtension
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
If this configuration property is set, it takes precedence over any @SearchExtension annotation.
|
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_BACKENDS__BACKEND_NAME__LAYOUT_STRATEGY
|
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 custom settings, the behavior is undefined;
it should not be relied upon.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_BACKENDS__BACKEND_NAME__SCHEMA_MANAGEMENT_SETTINGS_FILE
|
string |
|
Path to a file in the classpath holding a custom index mapping to be included in the index definition
when creating an Elasticsearch index.
The file does not need to (and generally shouldn’t) contain the full mapping:
Hibernate Search will automatically inject missing properties (index fields) in the given mapping.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_BACKENDS__BACKEND_NAME__SCHEMA_MANAGEMENT_MAPPING_FILE
|
string |
|
A bean reference to the component
used to configure full text analysis (e.g. analyzers, normalizers).
The referenced bean must implement ElasticsearchAnalysisConfigurer .
|
Instead of setting this configuration property,
you can simply annotate your custom ElasticsearchAnalysisConfigurer implementation with @SearchExtension
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
If this configuration property is set, it takes precedence over any @SearchExtension annotation.
|
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_BACKENDS__BACKEND_NAME__ANALYSIS_CONFIGURER
|
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 custom settings, the behavior is undefined;
it should not be relied upon.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_BACKENDS__BACKEND_NAME__INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_SETTINGS_FILE
|
string |
|
Path to a file in the classpath holding a custom index mapping to be included in the index definition
when creating an Elasticsearch index.
The file does not need to (and generally shouldn’t) contain the full mapping:
Hibernate Search will automatically inject missing properties (index fields) in the given mapping.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_BACKENDS__BACKEND_NAME__INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_MAPPING_FILE
|
string |
|
A bean reference to the component
used to configure full text analysis (e.g. analyzers, normalizers).
The referenced bean must implement ElasticsearchAnalysisConfigurer .
|
Instead of setting this configuration property,
you can simply annotate your custom ElasticsearchAnalysisConfigurer implementation with @SearchExtension
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
If this configuration property is set, it takes precedence over any @SearchExtension annotation.
|
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_BACKENDS__BACKEND_NAME__INDEXES__INDEX_NAME__ANALYSIS_CONFIGURER
|
string |
|
The list of hosts of the Elasticsearch servers.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_BACKENDS__BACKEND_NAME__HOSTS
|
list of string |
localhost:9200
|
The protocol to use when contacting Elasticsearch servers. Set to "https" to enable SSL/TLS.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_BACKENDS__BACKEND_NAME__PROTOCOL
|
|
http
|
The username used for authentication.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_BACKENDS__BACKEND_NAME__USERNAME
|
string |
|
The password used for authentication.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_BACKENDS__BACKEND_NAME__PASSWORD
|
string |
|
The timeout when establishing a connection to an Elasticsearch server.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_BACKENDS__BACKEND_NAME__CONNECTION_TIMEOUT
|
Duration
|
1S
|
The timeout when reading responses from an Elasticsearch server.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_BACKENDS__BACKEND_NAME__READ_TIMEOUT
|
Duration
|
30S
|
The timeout when executing a request to an Elasticsearch server.
This includes the time needed to wait for a connection to be available, send the request and read the response.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_BACKENDS__BACKEND_NAME__REQUEST_TIMEOUT
|
Duration
|
|
The maximum number of connections to all the Elasticsearch servers.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_BACKENDS__BACKEND_NAME__MAX_CONNECTIONS
|
int |
20
|
The maximum number of connections per Elasticsearch server.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_BACKENDS__BACKEND_NAME__MAX_CONNECTIONS_PER_ROUTE
|
int |
10
|
Defines if automatic discovery is enabled.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_BACKENDS__BACKEND_NAME__DISCOVERY_ENABLED
|
boolean |
false
|
Refresh interval of the node list.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_BACKENDS__BACKEND_NAME__DISCOVERY_REFRESH_INTERVAL
|
Duration
|
10S
|
The size of the thread pool assigned to the backend.
Note that number is per backend, not per index. Adding more indexes will not add more threads.
As all operations happening in this thread-pool are non-blocking, raising its size above the number of processor cores available to the JVM will not bring noticeable performance benefit. The only reason to alter this setting would be to reduce the number of threads; for example, in an application with a single index with a single indexing queue, running on a machine with 64 processor cores, you might want to bring down the number of threads.
Defaults to the number of processor cores available to the JVM on startup.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_BACKENDS__BACKEND_NAME__THREAD_POOL_SIZE
|
int |
|
Whether Hibernate Search should check the version of the Elasticsearch cluster on startup.
Set to false if the Elasticsearch cluster may not be available on startup.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_BACKENDS__BACKEND_NAME__VERSION_CHECK_ENABLED
|
boolean |
true
|
The minimal cluster status required.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_BACKENDS__BACKEND_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS
|
|
yellow
|
How long we should wait for the status before failing the bootstrap.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_BACKENDS__BACKEND_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT
|
Duration
|
10S
|
The number of indexing queues assigned to each index.
Higher values will lead to more connections being used in parallel, which may lead to higher indexing throughput, but incurs a risk of overloading Elasticsearch, i.e. of overflowing its HTTP request buffers and tripping circuit breakers, leading to Elasticsearch giving up on some request and resulting in indexing failures.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_BACKENDS__BACKEND_NAME__INDEXING_QUEUE_COUNT
|
int |
10
|
The size of indexing queues.
Lower values may lead to lower memory usage, especially if there are many queues, but values that are too low will reduce the likeliness of reaching the max bulk size and increase the likeliness of application threads blocking because the queue is full, which may lead to lower indexing throughput.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_BACKENDS__BACKEND_NAME__INDEXING_QUEUE_SIZE
|
int |
1000
|
The maximum size of bulk requests created when processing indexing queues.
Higher values will lead to more documents being sent in each HTTP request sent to Elasticsearch, which may lead to higher indexing throughput, but incurs a risk of overloading Elasticsearch, i.e. of overflowing its HTTP request buffers and tripping circuit breakers, leading to Elasticsearch giving up on some request and resulting in indexing failures.
Note that raising this number above the queue size has no effect, as bulks cannot include more requests than are contained in the queue.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_BACKENDS__BACKEND_NAME__INDEXING_MAX_BULK_SIZE
|
int |
100
|
The minimal cluster status required.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_BACKENDS__BACKEND_NAME__INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS
|
|
yellow
|
How long we should wait for the status before failing the bootstrap.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_BACKENDS__BACKEND_NAME__INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT
|
Duration
|
10S
|
The number of indexing queues assigned to each index.
Higher values will lead to more connections being used in parallel, which may lead to higher indexing throughput, but incurs a risk of overloading Elasticsearch, i.e. of overflowing its HTTP request buffers and tripping circuit breakers, leading to Elasticsearch giving up on some request and resulting in indexing failures.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_BACKENDS__BACKEND_NAME__INDEXES__INDEX_NAME__INDEXING_QUEUE_COUNT
|
int |
10
|
The size of indexing queues.
Lower values may lead to lower memory usage, especially if there are many queues, but values that are too low will reduce the likeliness of reaching the max bulk size and increase the likeliness of application threads blocking because the queue is full, which may lead to lower indexing throughput.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_BACKENDS__BACKEND_NAME__INDEXES__INDEX_NAME__INDEXING_QUEUE_SIZE
|
int |
1000
|
The maximum size of bulk requests created when processing indexing queues.
Higher values will lead to more documents being sent in each HTTP request sent to Elasticsearch, which may lead to higher indexing throughput, but incurs a risk of overloading Elasticsearch, i.e. of overflowing its HTTP request buffers and tripping circuit breakers, leading to Elasticsearch giving up on some request and resulting in indexing failures.
Note that raising this number above the queue size has no effect, as bulks cannot include more requests than are contained in the queue.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__ELASTICSEARCH_BACKENDS__BACKEND_NAME__INDEXES__INDEX_NAME__INDEXING_MAX_BULK_SIZE
|
int |
100
|
Hibernate Search Coordination with Outbox Polling |
类型 |
默认 |
Default config |
类型 |
默认 |
Whether the event processor is enabled,
i.e. whether events will be processed to perform automatic reindexing on this instance of the application.
This can be set to false to disable event processing on some application nodes,
for example to dedicate some nodes to HTTP request processing and other nodes to event processing.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_ENABLED
|
boolean |
true
|
The total number of shards that will form a partition of the entity change events to process.
By default, sharding is dynamic and setting this property is not necessary.
If you want to control explicitly the number and assignment of shards,
you must configure static sharding and then setting this property as well as the assigned shards (see shards.assigned )
is necessary.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_SHARDS_TOTAL_COUNT
|
int |
|
Among shards that will form a partition of the entity change events,
the shards that will be processed by this application instance.
By default, sharding is dynamic and setting this property is not necessary.
If you want to control explicitly the number and assignment of shards,
you must configure static sharding and then setting this property as well as the total shard count
is necessary.
Shards are referred to by an index in the range [0, total_count - 1] (see shards.total-count ).
A given application node must be assigned at least one shard but may be assigned multiple shards
by setting shards.assigned to a comma-separated list, e.g. 0,3 .
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_SHARDS_ASSIGNED
|
list of int |
|
How long to wait for another query to the outbox events table after a query didn’t return any event.
Lower values will reduce the time it takes for a change to be reflected in the index,
but will increase the stress on the database when there are no new events.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_POLLING_INTERVAL
|
Duration
|
0.100S
|
How long the event processor can poll for events before it must perform a "pulse",
updating and checking registrations in the agents table.
The pulse interval must be set to a value between the polling interval
and one third (1/3) of the expiration interval.
Low values (closer to the polling interval) mean less time wasted not processing events
when a node joins or leaves the cluster,
and reduced risk of wasting time not processing events
because an event processor is incorrectly considered disconnected,
but more stress on the database because of more frequent checks of the list of agents.
High values (closer to the expiration interval) mean more time wasted not processing events
when a node joins or leaves the cluster,
and increased risk of wasting time not processing events
because an event processor is incorrectly considered disconnected,
but less stress on the database because of less frequent checks of the list of agents.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_PULSE_INTERVAL
|
Duration
|
2S
|
How long an event processor "pulse" remains valid before considering the processor disconnected
and forcibly removing it from the cluster.
The expiration interval must be set to a value at least 3 times larger than the pulse interval.
Low values (closer to the pulse interval) mean less time wasted not processing events
when a node abruptly leaves the cluster due to a crash or network failure,
but increased risk of wasting time not processing events
because an event processor is incorrectly considered disconnected.
High values (much larger than the pulse interval) mean more time wasted not processing events
when a node abruptly leaves the cluster due to a crash or network failure,
but reduced risk of wasting time not processing events
because an event processor is incorrectly considered disconnected.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_PULSE_EXPIRATION
|
Duration
|
30S
|
How many outbox events, at most, are processed in a single transaction.
Higher values will reduce the number of transactions opened by the background process
and may increase performance thanks to the first-level cache (persistence context),
but will increase memory usage and in extreme cases may lead to OutOfMemoryErrors .
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_BATCH_SIZE
|
int |
50
|
The timeout for transactions processing outbox events.
When this property is not set,
Hibernate Search will use whatever default transaction timeout is configured in the JTA transaction manager,
which may be too low for batch processing and lead to transaction timeouts when processing batches of events.
If this happens, set a higher transaction timeout for event processing using this property.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_TRANSACTION_TIMEOUT
|
Duration
|
|
How long the event processor must wait before re-processing an event after its previous processing failed.
Use the value 0S to reprocess failed events as soon as possible, with no delay.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_RETRY_DELAY
|
Duration
|
30S
|
How long to wait for another query to the agent table
when actively waiting for event processors to suspend themselves.
Low values will reduce the time it takes for the mass indexer agent to detect
that event processors finally suspended themselves,
but will increase the stress on the database while the mass indexer agent is actively waiting.
High values will increase the time it takes for the mass indexer agent to detect
that event processors finally suspended themselves,
but will reduce the stress on the database while the mass indexer agent is actively waiting.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_MASS_INDEXER_POLLING_INTERVAL
|
Duration
|
0.100S
|
How long the mass indexer can wait before it must perform a "pulse",
updating and checking registrations in the agent table.
The pulse interval must be set to a value between the polling interval
and one third (1/3) of the expiration interval.
Low values (closer to the polling interval) mean reduced risk of
event processors starting to process events again during mass indexing
because a mass indexer agent is incorrectly considered disconnected,
but more stress on the database because of more frequent updates of the mass indexer agent’s entry in the agent table.
High values (closer to the expiration interval) mean increased risk of
event processors starting to process events again during mass indexing
because a mass indexer agent is incorrectly considered disconnected,
but less stress on the database because of less frequent updates of the mass indexer agent’s entry in the agent table.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_MASS_INDEXER_PULSE_INTERVAL
|
Duration
|
2S
|
How long an event processor "pulse" remains valid before considering the processor disconnected
and forcibly removing it from the cluster.
The expiration interval must be set to a value at least 3 times larger than the pulse interval.
Low values (closer to the pulse interval) mean less time wasted with event processors not processing events
when a mass indexer agent terminates due to a crash,
but increased risk of event processors starting to process events again during mass indexing
because a mass indexer agent is incorrectly considered disconnected.
High values (much larger than the pulse interval) mean more time wasted with event processors not processing events
when a mass indexer agent terminates due to a crash,
but reduced risk of event processors starting to process events again during mass indexing
because a mass indexer agent is incorrectly considered disconnected.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_MASS_INDEXER_PULSE_EXPIRATION
|
Duration
|
30S
|
Per-tenant config |
类型 |
默认 |
Whether the event processor is enabled,
i.e. whether events will be processed to perform automatic reindexing on this instance of the application.
This can be set to false to disable event processing on some application nodes,
for example to dedicate some nodes to HTTP request processing and other nodes to event processing.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_ENABLED
|
boolean |
true
|
The total number of shards that will form a partition of the entity change events to process.
By default, sharding is dynamic and setting this property is not necessary.
If you want to control explicitly the number and assignment of shards,
you must configure static sharding and then setting this property as well as the assigned shards (see shards.assigned )
is necessary.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_SHARDS_TOTAL_COUNT
|
int |
|
Among shards that will form a partition of the entity change events,
the shards that will be processed by this application instance.
By default, sharding is dynamic and setting this property is not necessary.
If you want to control explicitly the number and assignment of shards,
you must configure static sharding and then setting this property as well as the total shard count
is necessary.
Shards are referred to by an index in the range [0, total_count - 1] (see shards.total-count ).
A given application node must be assigned at least one shard but may be assigned multiple shards
by setting shards.assigned to a comma-separated list, e.g. 0,3 .
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_SHARDS_ASSIGNED
|
list of int |
|
How long to wait for another query to the outbox events table after a query didn’t return any event.
Lower values will reduce the time it takes for a change to be reflected in the index,
but will increase the stress on the database when there are no new events.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_POLLING_INTERVAL
|
Duration
|
0.100S
|
How long the event processor can poll for events before it must perform a "pulse",
updating and checking registrations in the agents table.
The pulse interval must be set to a value between the polling interval
and one third (1/3) of the expiration interval.
Low values (closer to the polling interval) mean less time wasted not processing events
when a node joins or leaves the cluster,
and reduced risk of wasting time not processing events
because an event processor is incorrectly considered disconnected,
but more stress on the database because of more frequent checks of the list of agents.
High values (closer to the expiration interval) mean more time wasted not processing events
when a node joins or leaves the cluster,
and increased risk of wasting time not processing events
because an event processor is incorrectly considered disconnected,
but less stress on the database because of less frequent checks of the list of agents.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_PULSE_INTERVAL
|
Duration
|
2S
|
How long an event processor "pulse" remains valid before considering the processor disconnected
and forcibly removing it from the cluster.
The expiration interval must be set to a value at least 3 times larger than the pulse interval.
Low values (closer to the pulse interval) mean less time wasted not processing events
when a node abruptly leaves the cluster due to a crash or network failure,
but increased risk of wasting time not processing events
because an event processor is incorrectly considered disconnected.
High values (much larger than the pulse interval) mean more time wasted not processing events
when a node abruptly leaves the cluster due to a crash or network failure,
but reduced risk of wasting time not processing events
because an event processor is incorrectly considered disconnected.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_PULSE_EXPIRATION
|
Duration
|
30S
|
How many outbox events, at most, are processed in a single transaction.
Higher values will reduce the number of transactions opened by the background process
and may increase performance thanks to the first-level cache (persistence context),
but will increase memory usage and in extreme cases may lead to OutOfMemoryErrors .
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_BATCH_SIZE
|
int |
50
|
The timeout for transactions processing outbox events.
When this property is not set,
Hibernate Search will use whatever default transaction timeout is configured in the JTA transaction manager,
which may be too low for batch processing and lead to transaction timeouts when processing batches of events.
If this happens, set a higher transaction timeout for event processing using this property.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_TRANSACTION_TIMEOUT
|
Duration
|
|
How long the event processor must wait before re-processing an event after its previous processing failed.
Use the value 0S to reprocess failed events as soon as possible, with no delay.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_RETRY_DELAY
|
Duration
|
30S
|
How long to wait for another query to the agent table
when actively waiting for event processors to suspend themselves.
Low values will reduce the time it takes for the mass indexer agent to detect
that event processors finally suspended themselves,
but will increase the stress on the database while the mass indexer agent is actively waiting.
High values will increase the time it takes for the mass indexer agent to detect
that event processors finally suspended themselves,
but will reduce the stress on the database while the mass indexer agent is actively waiting.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__MASS_INDEXER_POLLING_INTERVAL
|
Duration
|
0.100S
|
How long the mass indexer can wait before it must perform a "pulse",
updating and checking registrations in the agent table.
The pulse interval must be set to a value between the polling interval
and one third (1/3) of the expiration interval.
Low values (closer to the polling interval) mean reduced risk of
event processors starting to process events again during mass indexing
because a mass indexer agent is incorrectly considered disconnected,
but more stress on the database because of more frequent updates of the mass indexer agent’s entry in the agent table.
High values (closer to the expiration interval) mean increased risk of
event processors starting to process events again during mass indexing
because a mass indexer agent is incorrectly considered disconnected,
but less stress on the database because of less frequent updates of the mass indexer agent’s entry in the agent table.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__MASS_INDEXER_PULSE_INTERVAL
|
Duration
|
2S
|
How long an event processor "pulse" remains valid before considering the processor disconnected
and forcibly removing it from the cluster.
The expiration interval must be set to a value at least 3 times larger than the pulse interval.
Low values (closer to the pulse interval) mean less time wasted with event processors not processing events
when a mass indexer agent terminates due to a crash,
but increased risk of event processors starting to process events again during mass indexing
because a mass indexer agent is incorrectly considered disconnected.
High values (much larger than the pulse interval) mean more time wasted with event processors not processing events
when a mass indexer agent terminates due to a crash,
but reduced risk of event processors starting to process events again during mass indexing
because a mass indexer agent is incorrectly considered disconnected.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__MASS_INDEXER_PULSE_EXPIRATION
|
Duration
|
30S
|
Configuration for additional named persistence units |
类型 |
默认 |
Default config |
类型 |
默认 |
Whether the event processor is enabled,
i.e. whether events will be processed to perform automatic reindexing on this instance of the application.
This can be set to false to disable event processing on some application nodes,
for example to dedicate some nodes to HTTP request processing and other nodes to event processing.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__COORDINATION_EVENT_PROCESSOR_ENABLED
|
boolean |
true
|
The total number of shards that will form a partition of the entity change events to process.
By default, sharding is dynamic and setting this property is not necessary.
If you want to control explicitly the number and assignment of shards,
you must configure static sharding and then setting this property as well as the assigned shards (see shards.assigned )
is necessary.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__COORDINATION_EVENT_PROCESSOR_SHARDS_TOTAL_COUNT
|
int |
|
Among shards that will form a partition of the entity change events,
the shards that will be processed by this application instance.
By default, sharding is dynamic and setting this property is not necessary.
If you want to control explicitly the number and assignment of shards,
you must configure static sharding and then setting this property as well as the total shard count
is necessary.
Shards are referred to by an index in the range [0, total_count - 1] (see shards.total-count ).
A given application node must be assigned at least one shard but may be assigned multiple shards
by setting shards.assigned to a comma-separated list, e.g. 0,3 .
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__COORDINATION_EVENT_PROCESSOR_SHARDS_ASSIGNED
|
list of int |
|
How long to wait for another query to the outbox events table after a query didn’t return any event.
Lower values will reduce the time it takes for a change to be reflected in the index,
but will increase the stress on the database when there are no new events.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__COORDINATION_EVENT_PROCESSOR_POLLING_INTERVAL
|
Duration
|
0.100S
|
How long the event processor can poll for events before it must perform a "pulse",
updating and checking registrations in the agents table.
The pulse interval must be set to a value between the polling interval
and one third (1/3) of the expiration interval.
Low values (closer to the polling interval) mean less time wasted not processing events
when a node joins or leaves the cluster,
and reduced risk of wasting time not processing events
because an event processor is incorrectly considered disconnected,
but more stress on the database because of more frequent checks of the list of agents.
High values (closer to the expiration interval) mean more time wasted not processing events
when a node joins or leaves the cluster,
and increased risk of wasting time not processing events
because an event processor is incorrectly considered disconnected,
but less stress on the database because of less frequent checks of the list of agents.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__COORDINATION_EVENT_PROCESSOR_PULSE_INTERVAL
|
Duration
|
2S
|
How long an event processor "pulse" remains valid before considering the processor disconnected
and forcibly removing it from the cluster.
The expiration interval must be set to a value at least 3 times larger than the pulse interval.
Low values (closer to the pulse interval) mean less time wasted not processing events
when a node abruptly leaves the cluster due to a crash or network failure,
but increased risk of wasting time not processing events
because an event processor is incorrectly considered disconnected.
High values (much larger than the pulse interval) mean more time wasted not processing events
when a node abruptly leaves the cluster due to a crash or network failure,
but reduced risk of wasting time not processing events
because an event processor is incorrectly considered disconnected.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__COORDINATION_EVENT_PROCESSOR_PULSE_EXPIRATION
|
Duration
|
30S
|
How many outbox events, at most, are processed in a single transaction.
Higher values will reduce the number of transactions opened by the background process
and may increase performance thanks to the first-level cache (persistence context),
but will increase memory usage and in extreme cases may lead to OutOfMemoryErrors .
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__COORDINATION_EVENT_PROCESSOR_BATCH_SIZE
|
int |
50
|
The timeout for transactions processing outbox events.
When this property is not set,
Hibernate Search will use whatever default transaction timeout is configured in the JTA transaction manager,
which may be too low for batch processing and lead to transaction timeouts when processing batches of events.
If this happens, set a higher transaction timeout for event processing using this property.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__COORDINATION_EVENT_PROCESSOR_TRANSACTION_TIMEOUT
|
Duration
|
|
How long the event processor must wait before re-processing an event after its previous processing failed.
Use the value 0S to reprocess failed events as soon as possible, with no delay.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__COORDINATION_EVENT_PROCESSOR_RETRY_DELAY
|
Duration
|
30S
|
How long to wait for another query to the agent table
when actively waiting for event processors to suspend themselves.
Low values will reduce the time it takes for the mass indexer agent to detect
that event processors finally suspended themselves,
but will increase the stress on the database while the mass indexer agent is actively waiting.
High values will increase the time it takes for the mass indexer agent to detect
that event processors finally suspended themselves,
but will reduce the stress on the database while the mass indexer agent is actively waiting.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__COORDINATION_MASS_INDEXER_POLLING_INTERVAL
|
Duration
|
0.100S
|
How long the mass indexer can wait before it must perform a "pulse",
updating and checking registrations in the agent table.
The pulse interval must be set to a value between the polling interval
and one third (1/3) of the expiration interval.
Low values (closer to the polling interval) mean reduced risk of
event processors starting to process events again during mass indexing
because a mass indexer agent is incorrectly considered disconnected,
but more stress on the database because of more frequent updates of the mass indexer agent’s entry in the agent table.
High values (closer to the expiration interval) mean increased risk of
event processors starting to process events again during mass indexing
because a mass indexer agent is incorrectly considered disconnected,
but less stress on the database because of less frequent updates of the mass indexer agent’s entry in the agent table.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__COORDINATION_MASS_INDEXER_PULSE_INTERVAL
|
Duration
|
2S
|
How long an event processor "pulse" remains valid before considering the processor disconnected
and forcibly removing it from the cluster.
The expiration interval must be set to a value at least 3 times larger than the pulse interval.
Low values (closer to the pulse interval) mean less time wasted with event processors not processing events
when a mass indexer agent terminates due to a crash,
but increased risk of event processors starting to process events again during mass indexing
because a mass indexer agent is incorrectly considered disconnected.
High values (much larger than the pulse interval) mean more time wasted with event processors not processing events
when a mass indexer agent terminates due to a crash,
but reduced risk of event processors starting to process events again during mass indexing
because a mass indexer agent is incorrectly considered disconnected.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__COORDINATION_MASS_INDEXER_PULSE_EXPIRATION
|
Duration
|
30S
|
Per-tenant config |
类型 |
默认 |
Whether the event processor is enabled,
i.e. whether events will be processed to perform automatic reindexing on this instance of the application.
This can be set to false to disable event processing on some application nodes,
for example to dedicate some nodes to HTTP request processing and other nodes to event processing.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_ENABLED
|
boolean |
true
|
The total number of shards that will form a partition of the entity change events to process.
By default, sharding is dynamic and setting this property is not necessary.
If you want to control explicitly the number and assignment of shards,
you must configure static sharding and then setting this property as well as the assigned shards (see shards.assigned )
is necessary.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_SHARDS_TOTAL_COUNT
|
int |
|
Among shards that will form a partition of the entity change events,
the shards that will be processed by this application instance.
By default, sharding is dynamic and setting this property is not necessary.
If you want to control explicitly the number and assignment of shards,
you must configure static sharding and then setting this property as well as the total shard count
is necessary.
Shards are referred to by an index in the range [0, total_count - 1] (see shards.total-count ).
A given application node must be assigned at least one shard but may be assigned multiple shards
by setting shards.assigned to a comma-separated list, e.g. 0,3 .
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_SHARDS_ASSIGNED
|
list of int |
|
How long to wait for another query to the outbox events table after a query didn’t return any event.
Lower values will reduce the time it takes for a change to be reflected in the index,
but will increase the stress on the database when there are no new events.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_POLLING_INTERVAL
|
Duration
|
0.100S
|
How long the event processor can poll for events before it must perform a "pulse",
updating and checking registrations in the agents table.
The pulse interval must be set to a value between the polling interval
and one third (1/3) of the expiration interval.
Low values (closer to the polling interval) mean less time wasted not processing events
when a node joins or leaves the cluster,
and reduced risk of wasting time not processing events
because an event processor is incorrectly considered disconnected,
but more stress on the database because of more frequent checks of the list of agents.
High values (closer to the expiration interval) mean more time wasted not processing events
when a node joins or leaves the cluster,
and increased risk of wasting time not processing events
because an event processor is incorrectly considered disconnected,
but less stress on the database because of less frequent checks of the list of agents.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_PULSE_INTERVAL
|
Duration
|
2S
|
How long an event processor "pulse" remains valid before considering the processor disconnected
and forcibly removing it from the cluster.
The expiration interval must be set to a value at least 3 times larger than the pulse interval.
Low values (closer to the pulse interval) mean less time wasted not processing events
when a node abruptly leaves the cluster due to a crash or network failure,
but increased risk of wasting time not processing events
because an event processor is incorrectly considered disconnected.
High values (much larger than the pulse interval) mean more time wasted not processing events
when a node abruptly leaves the cluster due to a crash or network failure,
but reduced risk of wasting time not processing events
because an event processor is incorrectly considered disconnected.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_PULSE_EXPIRATION
|
Duration
|
30S
|
How many outbox events, at most, are processed in a single transaction.
Higher values will reduce the number of transactions opened by the background process
and may increase performance thanks to the first-level cache (persistence context),
but will increase memory usage and in extreme cases may lead to OutOfMemoryErrors .
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_BATCH_SIZE
|
int |
50
|
The timeout for transactions processing outbox events.
When this property is not set,
Hibernate Search will use whatever default transaction timeout is configured in the JTA transaction manager,
which may be too low for batch processing and lead to transaction timeouts when processing batches of events.
If this happens, set a higher transaction timeout for event processing using this property.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_TRANSACTION_TIMEOUT
|
Duration
|
|
How long the event processor must wait before re-processing an event after its previous processing failed.
Use the value 0S to reprocess failed events as soon as possible, with no delay.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_RETRY_DELAY
|
Duration
|
30S
|
How long to wait for another query to the agent table
when actively waiting for event processors to suspend themselves.
Low values will reduce the time it takes for the mass indexer agent to detect
that event processors finally suspended themselves,
but will increase the stress on the database while the mass indexer agent is actively waiting.
High values will increase the time it takes for the mass indexer agent to detect
that event processors finally suspended themselves,
but will reduce the stress on the database while the mass indexer agent is actively waiting.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__COORDINATION_TENANTS__TENANT_ID__MASS_INDEXER_POLLING_INTERVAL
|
Duration
|
0.100S
|
How long the mass indexer can wait before it must perform a "pulse",
updating and checking registrations in the agent table.
The pulse interval must be set to a value between the polling interval
and one third (1/3) of the expiration interval.
Low values (closer to the polling interval) mean reduced risk of
event processors starting to process events again during mass indexing
because a mass indexer agent is incorrectly considered disconnected,
but more stress on the database because of more frequent updates of the mass indexer agent’s entry in the agent table.
High values (closer to the expiration interval) mean increased risk of
event processors starting to process events again during mass indexing
because a mass indexer agent is incorrectly considered disconnected,
but less stress on the database because of less frequent updates of the mass indexer agent’s entry in the agent table.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__COORDINATION_TENANTS__TENANT_ID__MASS_INDEXER_PULSE_INTERVAL
|
Duration
|
2S
|
How long an event processor "pulse" remains valid before considering the processor disconnected
and forcibly removing it from the cluster.
The expiration interval must be set to a value at least 3 times larger than the pulse interval.
Low values (closer to the pulse interval) mean less time wasted with event processors not processing events
when a mass indexer agent terminates due to a crash,
but increased risk of event processors starting to process events again during mass indexing
because a mass indexer agent is incorrectly considered disconnected.
High values (much larger than the pulse interval) mean more time wasted with event processors not processing events
when a mass indexer agent terminates due to a crash,
but reduced risk of event processors starting to process events again during mass indexing
because a mass indexer agent is incorrectly considered disconnected.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM__PERSISTENCE_UNIT_NAME__COORDINATION_TENANTS__TENANT_ID__MASS_INDEXER_PULSE_EXPIRATION
|
Duration
|
30S
|
Hibernate Validator |
类型 |
默认 |
Enable the fail fast mode. When fail fast is enabled the validation will stop on the first constraint violation detected.
Environment variable: QUARKUS_HIBERNATE_VALIDATOR_FAIL_FAST
|
boolean |
false
|
Method validation |
类型 |
默认 |
Define whether overriding methods that override constraints should throw a ConstraintDefinitionException . The default value is false , i.e. do not allow.
See Section 4.5.5 of the JSR 380 specification, specifically "In sub types (be it sub classes/interfaces or interface implementations), no parameter constraints may be declared on overridden or implemented methods, nor may parameters be marked for cascaded validation. This would pose a strengthening of preconditions to be fulfilled by the caller."
Environment variable: QUARKUS_HIBERNATE_VALIDATOR_METHOD_VALIDATION_ALLOW_OVERRIDING_PARAMETER_CONSTRAINTS
|
boolean |
false
|
Define whether parallel methods that define constraints should throw a ConstraintDefinitionException . The default value is false , i.e. do not allow.
See Section 4.5.5 of the JSR 380 specification, specifically "If a sub type overrides/implements a method originally defined in several parallel types of the hierarchy (e.g. two interfaces not extending each other, or a class and an interface not implemented by said class), no parameter constraints may be declared for that method at all nor parameters be marked for cascaded validation. This again is to avoid an unexpected strengthening of preconditions to be fulfilled by the caller."
Environment variable: QUARKUS_HIBERNATE_VALIDATOR_METHOD_VALIDATION_ALLOW_PARAMETER_CONSTRAINTS_ON_PARALLEL_METHODS
|
boolean |
false
|
Define whether more than one constraint on a return value may be marked for cascading validation are allowed. The default value is false , i.e. do not allow.
See Section 4.5.5 of the JSR 380 specification, specifically "One must not mark a method return value for cascaded validation more than once in a line of a class hierarchy. In other words, overriding methods on sub types (be it sub classes/interfaces or interface implementations) cannot mark the return value for cascaded validation if the return value has already been marked on the overridden method of the super type or interface."
Environment variable: QUARKUS_HIBERNATE_VALIDATOR_METHOD_VALIDATION_ALLOW_MULTIPLE_CASCADED_VALIDATION_ON_RETURN_VALUES
|
boolean |
false
|
Expression Language |
类型 |
默认 |
Configure the Expression Language feature level for constraints, allowing the selection of Expression Language features available for message interpolation.
This property only affects the EL feature level of "static" constraint violation messages set through the message attribute of constraint annotations.
In particular, it doesn’t affect the default EL feature level for custom violations created programmatically in validator implementations. The feature level for those can only be configured directly in the validator implementation.
Environment variable: QUARKUS_HIBERNATE_VALIDATOR_EXPRESSION_LANGUAGE_CONSTRAINT_EXPRESSION_FEATURE_LEVEL
|
default , none , variables , bean-properties , bean-methods
|
bean-properties
|
Infinispan Client |
类型 |
默认 |
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 and when Docker is running.
Environment variable: QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_ENABLED
|
boolean |
true
|
Optional fixed port the dev service will listen to.
If not defined, the port will be chosen randomly.
Environment variable: QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_PORT
|
int |
|
Indicates if the Infinispan 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 Infinispan starts a new container.
The discovery uses the quarkus-dev-service-infinispan label. The value is configured using the service-name property.
Container sharing is only used in dev mode.
Environment variable: QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_SHARED
|
boolean |
true
|
The value of the quarkus-dev-service-infinispan label attached to the started container. This property is used when shared is set to true . In this case, before starting a container, Dev Services for Infinispan looks for a container with the quarkus-dev-service-infinispan label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the quarkus-dev-service-infinispan label set to the specified value.
This property is used when you need multiple shared Infinispan servers.
Environment variable: QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_SERVICE_NAME
|
string |
infinispan
|
List of the artifacts to automatically download and add to the Infinispan server libraries.
For example a Maven coordinate (org.postgresql:postgresql:42.3.1) or a dependency location url.
If an invalid value is passed, the Infinispan server will throw an error when trying to start.
Environment variable: QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_ARTIFACTS
|
list of string |
|
Whether a health check is published in case the smallrye-health extension is present.
Environment variable: QUARKUS_INFINISPAN_CLIENT_HEALTH_ENABLED
|
boolean |
true
|
Sets the bounded entry count for near cache. If this value is 0 or less near cache is disabled.
Environment variable: QUARKUS_INFINISPAN_CLIENT_NEAR_CACHE_MAX_ENTRIES
|
int |
0
|
Sets the host name/port to connect to. Each one is separated by a semicolon (eg. host1:11222;host2:11222).
Environment variable: QUARKUS_INFINISPAN_CLIENT_SERVER_LIST
|
string |
|
Enables or disables Protobuf generated schemas upload to the server. Set it to 'false' when you need to handle the lifecycle of the Protobuf Schemas on Server side yourself. Default is 'true'.
Environment variable: QUARKUS_INFINISPAN_CLIENT_USE_SCHEMA_REGISTRATION
|
boolean |
true
|
Sets client intelligence used by authentication Available values: * BASIC - Means that the client doesn’t handle server topology changes and therefore will only use the list of servers supplied at configuration time. * TOPOLOGY_AWARE - Use this provider if you don’t want the client to present any certificates to the remote TLS host. * HASH_DISTRIBUTION_AWARE - Like TOPOLOGY_AWARE but with the additional advantage that each request involving keys will be routed to the server who is the primary owner which improves performance greatly. This is the default.
Environment variable: QUARKUS_INFINISPAN_CLIENT_CLIENT_INTELLIGENCE
|
string |
HASH_DISTRIBUTION_AWARE
|
Enables or disables authentication. Set it to false when connecting to an Infinispan Server without authentication. deployments. Default is 'true'.
Environment variable: QUARKUS_INFINISPAN_CLIENT_USE_AUTH
|
boolean |
true
|
Sets username used by authentication.
Environment variable: QUARKUS_INFINISPAN_CLIENT_AUTH_USERNAME
|
string |
|
Sets password used by authentication
Environment variable: QUARKUS_INFINISPAN_CLIENT_AUTH_PASSWORD
|
string |
|
Sets realm used by authentication
Environment variable: QUARKUS_INFINISPAN_CLIENT_AUTH_REALM
|
string |
default
|
Sets server name used by authentication
Environment variable: QUARKUS_INFINISPAN_CLIENT_AUTH_SERVER_NAME
|
string |
infinispan
|
Sets client subject, necessary for those SASL mechanisms which require it to access client credentials.
Environment variable: QUARKUS_INFINISPAN_CLIENT_AUTH_CLIENT_SUBJECT
|
string |
|
Specifies a CallbackHandler to be used during the authentication handshake. The `Callback`s that need to be handled are specific to the chosen SASL mechanism.
Environment variable: QUARKUS_INFINISPAN_CLIENT_AUTH_CALLBACK_HANDLER
|
string |
|
Sets SASL mechanism used by authentication. Available values: * DIGEST-MD5 - Uses the MD5 hashing algorithm in addition to nonces to encrypt credentials. This is the default. * EXTERNAL - Uses client certificates to provide valid identities to Infinispan Server and enable encryption. * PLAIN - Sends credentials in plain text (unencrypted) over the wire in a way that is similar to HTTP BASIC authentication. You should use PLAIN authentication only in combination with TLS encryption.
Environment variable: QUARKUS_INFINISPAN_CLIENT_SASL_MECHANISM
|
string |
DIGEST-MD5
|
Specifies the filename of a truststore to use to create the SSLContext . You also need to specify a trustStorePassword. Setting this property implicitly enables SSL/TLS.
Environment variable: QUARKUS_INFINISPAN_CLIENT_TRUST_STORE
|
string |
|
Specifies the password needed to open the truststore You also need to specify a trustStore. Setting this property implicitly enables SSL/TLS.
Environment variable: QUARKUS_INFINISPAN_CLIENT_TRUST_STORE_PASSWORD
|
string |
|
Specifies the type of the truststore, such as JKS or JCEKS. Defaults to JKS if trustStore is enabled.
Environment variable: QUARKUS_INFINISPAN_CLIENT_TRUST_STORE_TYPE
|
string |
|
Jackson |
类型 |
默认 |
If enabled, Jackson will fail when encountering unknown properties.
You can still override it locally with @JsonIgnoreProperties(ignoreUnknown = false) .
Environment variable: QUARKUS_JACKSON_FAIL_ON_UNKNOWN_PROPERTIES
|
boolean |
false
|
If enabled, Jackson will fail when no accessors are found for a type. This is enabled by default to match the default Jackson behavior.
Environment variable: QUARKUS_JACKSON_FAIL_ON_EMPTY_BEANS
|
boolean |
true
|
If enabled, Jackson will serialize dates as numeric value(s).
Environment variable: QUARKUS_JACKSON_WRITE_DATES_AS_TIMESTAMPS
|
boolean |
false
|
If enabled, Jackson will ignore case during Enum deserialization.
Environment variable: QUARKUS_JACKSON_ACCEPT_CASE_INSENSITIVE_ENUMS
|
boolean |
false
|
If set, Jackson will default to using the specified timezone when formatting dates. Some examples values are "Asia/Jakarta" and "GMT+3". If not set, Jackson will use its own default.
Environment variable: QUARKUS_JACKSON_TIMEZONE
|
ZoneId |
UTC
|
Define which properties of Java Beans are to be included in serialization.
Environment variable: QUARKUS_JACKSON_SERIALIZATION_INCLUSION
|
always , non-null , non-absent , non-empty , non-default , custom , use-defaults
|
|
Jacoco - Code Coverage |
类型 |
默认 |
Environment variable: QUARKUS_JACOCO_DATA_FILE
|
string |
jacoco-quarkus.exec
|
Whether to reuse (true ) or delete (false ) the jacoco data file on each run.
Environment variable: QUARKUS_JACOCO_REUSE_DATA_FILE
|
boolean |
false
|
If Quarkus should generate the Jacoco report
Environment variable: QUARKUS_JACOCO_REPORT
|
boolean |
true
|
Encoding of the generated reports.
Environment variable: QUARKUS_JACOCO_OUTPUT_ENCODING
|
string |
UTF-8
|
Name of the root node HTML report pages.
Environment variable: QUARKUS_JACOCO_TITLE
|
string |
|
Footer text used in HTML report pages.
Environment variable: QUARKUS_JACOCO_FOOTER
|
string |
|
Encoding of the source files.
Environment variable: QUARKUS_JACOCO_SOURCE_ENCODING
|
string |
UTF-8
|
A list of class files to include in the report. May use wildcard characters (* and ?). When not specified everything will be included.
For instance:
- **/fo/**/* targets all classes under fo and sub packages
- **/bar/* targets all classes directly under bar
- **/*BAR*.class targets classes that contain BAR in their name regardless of path
Environment variable: QUARKUS_JACOCO_INCLUDES
|
list of string |
**
|
A list of class files to exclude from the report. May use wildcard characters (* and ?). When not specified nothing will be excluded.
For instance:
- **/fo/**/* targets all classes under fo and sub packages
- **/bar/* targets all classes directly under bar
- **/*BAR*.class targets classes that contain BAR in their name regardless of path
Environment variable: QUARKUS_JACOCO_EXCLUDES
|
list of string |
|
The location of the report files.
Environment variable: QUARKUS_JACOCO_REPORT_LOCATION
|
string |
jacoco-report
|
Jaeger |
类型 |
默认 |
Defines if the Jaeger extension is enabled.
Environment variable: QUARKUS_JAEGER_ENABLED
|
boolean |
true
|
Whether metrics are published in case a metrics extension is present.
Environment variable: QUARKUS_JAEGER_METRICS_ENABLED
|
boolean |
false
|
Environment variable: QUARKUS_JAEGER_ENDPOINT
|
URI |
|
Authentication Token to send as "Bearer" to the endpoint
Environment variable: QUARKUS_JAEGER_AUTH_TOKEN
|
string |
|
Username to send as part of "Basic" authentication to the endpoint
Environment variable: QUARKUS_JAEGER_USER
|
string |
|
Password to send as part of "Basic" authentication to the endpoint
Environment variable: QUARKUS_JAEGER_PASSWORD
|
string |
|
The hostname and port for communicating with agent via UDP
Environment variable: QUARKUS_JAEGER_AGENT_HOST_PORT
|
host:port |
|
Whether the reporter should also log the spans
Environment variable: QUARKUS_JAEGER_REPORTER_LOG_SPANS
|
boolean |
|
The reporter’s maximum queue size
Environment variable: QUARKUS_JAEGER_REPORTER_MAX_QUEUE_SIZE
|
int |
|
The reporter’s flush interval
Environment variable: QUARKUS_JAEGER_REPORTER_FLUSH_INTERVAL
|
Duration
|
|
The sampler type (const, probabilistic, ratelimiting or remote)
Environment variable: QUARKUS_JAEGER_SAMPLER_TYPE
|
string |
|
The sampler parameter (number)
Environment variable: QUARKUS_JAEGER_SAMPLER_PARAM
|
BigDecimal |
|
The host name and port when using the remote controlled sampler
Environment variable: QUARKUS_JAEGER_SAMPLER_MANAGER_HOST_PORT
|
host:port |
|
Environment variable: QUARKUS_JAEGER_SERVICE_NAME
|
string |
|
A comma separated list of name = value tracer level tags, which get added to all reported spans. The value can also refer to an environment variable using the format ${envVarName:default}, where the :default is optional, and identifies a value to be used if the environment variable cannot be found
Environment variable: QUARKUS_JAEGER_TAGS
|
string |
|
Comma separated list of formats to use for propagating the trace context. Defaults to the standard Jaeger format. Valid values are jaeger and b3
Environment variable: QUARKUS_JAEGER_PROPAGATION
|
string |
|
The sender factory class name
Environment variable: QUARKUS_JAEGER_SENDER_FACTORY
|
string |
|
Whether the trace context should be logged.
Environment variable: QUARKUS_JAEGER_LOG_TRACE_CONTEXT
|
boolean |
true
|
Whether the registration of tracer as the global tracer should be disabled. This setting should only be turned on in tests that need to install a mock tracer.
Environment variable: QUARKUS_JAEGER_DISABLE_TRACER_REGISTRATION
|
boolean |
false
|
Whether jaeger should run in zipkin compatibility mode
Environment variable: QUARKUS_JAEGER_ZIPKIN_COMPATIBILITY_MODE
|
boolean |
false
|
Keycloak Authorization |
类型 |
默认 |
Enables policy enforcement.
Environment variable: QUARKUS_KEYCLOAK_POLICY_ENFORCER_ENABLE
|
boolean |
false
|
Adapters will make separate HTTP invocations to the Keycloak server to turn an access code into an access token. This config option defines how many connections to the Keycloak server should be pooled
Environment variable: QUARKUS_KEYCLOAK_CONNECTION_POOL_SIZE
|
int |
20
|
Specifies how policies are enforced.
Environment variable: QUARKUS_KEYCLOAK_POLICY_ENFORCER_ENFORCEMENT_MODE
|
permissive , enforcing , disabled
|
enforcing
|
Defines the limit of entries that should be kept in the cache
Environment variable: QUARKUS_KEYCLOAK_POLICY_ENFORCER_PATH_CACHE_MAX_ENTRIES
|
int |
1000
|
Defines the time in milliseconds when the entry should be expired
Environment variable: QUARKUS_KEYCLOAK_POLICY_ENFORCER_PATH_CACHE_LIFESPAN
|
long |
30000
|
Specifies how the adapter should fetch the server for resources associated with paths in your application. If true, the policy enforcer is going to fetch resources on-demand accordingly with the path being requested
Environment variable: QUARKUS_KEYCLOAK_POLICY_ENFORCER_LAZY_LOAD_PATHS
|
boolean |
true
|
Specifies how scopes should be mapped to HTTP methods. If set to true, the policy enforcer will use the HTTP method from the current request to check whether access should be granted
Environment variable: QUARKUS_KEYCLOAK_POLICY_ENFORCER_HTTP_METHOD_AS_SCOPE
|
boolean |
false
|
The name of a resource on the server that is to be associated with a given path
Environment variable: QUARKUS_KEYCLOAK_POLICY_ENFORCER_PATHS__PATHS__NAME
|
string |
|
A URI relative to the application’s context path that should be protected by the policy enforcer
Environment variable: QUARKUS_KEYCLOAK_POLICY_ENFORCER_PATHS__PATHS__PATH
|
string |
|
The name of the HTTP method
Environment variable: QUARKUS_KEYCLOAK_POLICY_ENFORCER_PATHS__PATHS__METHODS__METHODS__METHOD
|
string |
required |
An array of strings with the scopes associated with the method
Environment variable: QUARKUS_KEYCLOAK_POLICY_ENFORCER_PATHS__PATHS__METHODS__METHODS__SCOPES
|
list of string |
required |
A string referencing the enforcement mode for the scopes associated with a method
Environment variable: QUARKUS_KEYCLOAK_POLICY_ENFORCER_PATHS__PATHS__METHODS__METHODS__SCOPES_ENFORCEMENT_MODE
|
|
all
|
Specifies how policies are enforced
Environment variable: QUARKUS_KEYCLOAK_POLICY_ENFORCER_PATHS__PATHS__ENFORCEMENT_MODE
|
permissive , enforcing , disable
|