From ef8a880bd3af46b910c9e6bb096ee697549ab24b Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Sat, 3 Aug 2024 01:54:06 +0000 Subject: [PATCH] Sync documentation of main branch --- ...oyment.processor.JacksonOptimizationConfig | 1 + ...oyment.processor.JacksonOptimizationConfig | 1 + .../main/config/quarkus-all-config.adoc | 22 + _generated-doc/main/config/quarkus-core.adoc | 72 +- ...ta-sources-reactive-build-time-config.adoc | 539 +-------------- ...-data-sources-reactive-runtime-config.adoc | 17 + ...asticsearch-backend-build-time-config.adoc | 161 ++++- ...ch-build-time-config-persistence-unit.adoc | 646 +++++++++++++++++- ...-elasticsearch-backend-runtime-config.adoc | 101 --- ...earch-runtime-config-persistence-unit.adoc | 286 -------- ...earch-elasticsearch-build-time-config.adoc | 646 +++++++++++++++++- ...e-search-elasticsearch-runtime-config.adoc | 286 -------- ...eactive-outer-named-build-time-config.adoc | 539 +-------------- ...e-reactive-outer-named-runtime-config.adoc | 17 + ...processor-jackson-optimization-config.adoc | 29 + .../quarkus-resteasy-reactive-jackson.adoc | 29 + _versions/main/guides/qute-reference.adoc | 1 + _versions/main/guides/rest.adoc | 6 + _versions/main/guides/scripting.adoc | 2 +- 19 files changed, 1612 insertions(+), 1789 deletions(-) create mode 100644 _generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.resteasy.reactive.jackson.deployment.processor.JacksonOptimizationConfig create mode 100644 _generated-doc/main/config/extensions-configuration-roots-list/quarkus-resteasy-reactive-jackson.adoc/io.quarkus.resteasy.reactive.jackson.deployment.processor.JacksonOptimizationConfig create mode 100644 _generated-doc/main/config/quarkus-rest-jackson-optimization-processor-jackson-optimization-config.adoc create mode 100644 _generated-doc/main/config/quarkus-resteasy-reactive-jackson.adoc diff --git a/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.resteasy.reactive.jackson.deployment.processor.JacksonOptimizationConfig b/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.resteasy.reactive.jackson.deployment.processor.JacksonOptimizationConfig new file mode 100644 index 0000000000..d1922df093 --- /dev/null +++ b/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.resteasy.reactive.jackson.deployment.processor.JacksonOptimizationConfig @@ -0,0 +1 @@ +[{"configDocKey":{"type":"boolean","key":"quarkus.rest.jackson.optimization.enable-reflection-free-serializers","additionalKeys":[],"configDoc":"Enable build time generation of reflection-free Jackson serializers.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enable-reflection-free-serializers","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.rest.jackson.optimization","since":null,"environmentVariable":"QUARKUS_REST_JACKSON_OPTIMIZATION_ENABLE_REFLECTION_FREE_SERIALIZERS","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/main/config/extensions-configuration-roots-list/quarkus-resteasy-reactive-jackson.adoc/io.quarkus.resteasy.reactive.jackson.deployment.processor.JacksonOptimizationConfig b/_generated-doc/main/config/extensions-configuration-roots-list/quarkus-resteasy-reactive-jackson.adoc/io.quarkus.resteasy.reactive.jackson.deployment.processor.JacksonOptimizationConfig new file mode 100644 index 0000000000..ee5faca6df --- /dev/null +++ b/_generated-doc/main/config/extensions-configuration-roots-list/quarkus-resteasy-reactive-jackson.adoc/io.quarkus.resteasy.reactive.jackson.deployment.processor.JacksonOptimizationConfig @@ -0,0 +1 @@ +io.quarkus.resteasy.reactive.jackson.deployment.processor.JacksonOptimizationConfig \ No newline at end of file diff --git a/_generated-doc/main/config/quarkus-all-config.adoc b/_generated-doc/main/config/quarkus-all-config.adoc index 323232319b..76389aa2ba 100644 --- a/_generated-doc/main/config/quarkus-all-config.adoc +++ b/_generated-doc/main/config/quarkus-all-config.adoc @@ -63348,6 +63348,28 @@ endif::add-copy-button-to-env-var[] | +h|[[quarkus-rest-jackson_quarkus-rest-jackson-rest-jackson]]link:#quarkus-rest-jackson_quarkus-rest-jackson-rest-jackson[REST Jackson] + +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-rest-jackson_quarkus-rest-jackson-optimization-enable-reflection-free-serializers]]`link:#quarkus-rest-jackson_quarkus-rest-jackson-optimization-enable-reflection-free-serializers[quarkus.rest.jackson.optimization.enable-reflection-free-serializers]` + + +[.description] +-- +Enable build time generation of reflection-free Jackson serializers. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REST_JACKSON_OPTIMIZATION_ENABLE_REFLECTION_FREE_SERIALIZERS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REST_JACKSON_OPTIMIZATION_ENABLE_REFLECTION_FREE_SERIALIZERS+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + h|[[quarkus-rest-kotlin-serialization-common_quarkus-rest-kotlin-serialization-common-rest-kotlin-serialization-common]]link:#quarkus-rest-kotlin-serialization-common_quarkus-rest-kotlin-serialization-common-rest-kotlin-serialization-common[REST Kotlin Serialization Common] h|Type diff --git a/_generated-doc/main/config/quarkus-core.adoc b/_generated-doc/main/config/quarkus-core.adoc index 980fecc57a..7051bc4d5b 100644 --- a/_generated-doc/main/config/quarkus-core.adoc +++ b/_generated-doc/main/config/quarkus-core.adoc @@ -77,42 +77,6 @@ endif::add-copy-button-to-env-var[] |`Build system locale` -a| [[quarkus-core_quarkus-init-and-exit]]`link:#quarkus-core_quarkus-init-and-exit[quarkus.init-and-exit]` - - -[.description] --- -true to quit exit right after the initialization. The option is not meant be used directly by users. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_INIT_AND_EXIT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_INIT_AND_EXIT+++` -endif::add-copy-button-to-env-var[] ---|@io.smallrye.config.WithConverter(io.quarkus.runtime.init.InitRuntimeConfig.BooleanConverter.class) boolean -|`false` - - -a| [[quarkus-core_quarkus-args]]`link:#quarkus-core_quarkus-args[quarkus.args]` - - -[.description] --- -The arguments passed to the command line. - -We don't make it a list as the args are separated by a space, not a comma. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_ARGS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_ARGS+++` -endif::add-copy-button-to-env-var[] ---|string -| - - a| [[quarkus-core_quarkus-profile]]`link:#quarkus-core_quarkus-profile[quarkus.profile]` @@ -218,6 +182,42 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-core_quarkus-init-and-exit]]`link:#quarkus-core_quarkus-init-and-exit[quarkus.init-and-exit]` + + +[.description] +-- +true to quit exit right after the initialization. The option is not meant be used directly by users. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INIT_AND_EXIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INIT_AND_EXIT+++` +endif::add-copy-button-to-env-var[] +--|@io.smallrye.config.WithConverter(io.quarkus.runtime.init.InitRuntimeConfig.BooleanConverter.class) boolean +|`false` + + +a| [[quarkus-core_quarkus-args]]`link:#quarkus-core_quarkus-args[quarkus.args]` + + +[.description] +-- +The arguments passed to the command line. + +We don't make it a list as the args are separated by a space, not a comma. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ARGS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ARGS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-analytics-disabled]]`link:#quarkus-core_quarkus-analytics-disabled[quarkus.analytics.disabled]` diff --git a/_generated-doc/main/config/quarkus-datasource-data-sources-reactive-build-time-config.adoc b/_generated-doc/main/config/quarkus-datasource-data-sources-reactive-build-time-config.adoc index c02eaa014e..269b35a26f 100644 --- a/_generated-doc/main/config/quarkus-datasource-data-sources-reactive-build-time-config.adoc +++ b/_generated-doc/main/config/quarkus-datasource-data-sources-reactive-build-time-config.adoc @@ -48,541 +48,4 @@ endif::add-copy-button-to-env-var[] --|boolean |`true` - -a| [[quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-cache-prepared-statements]]`link:#quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-cache-prepared-statements[quarkus.datasource."datasource-name".reactive.cache-prepared-statements]` - - -[.description] --- -Whether prepared statements should be cached on the client side. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_CACHE_PREPARED_STATEMENTS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_CACHE_PREPARED_STATEMENTS+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-url]]`link:#quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-url[quarkus.datasource."datasource-name".reactive.url]` - - -[.description] --- -The datasource URLs. - -If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses round-robin load balancing for server selection during connection establishment. Note that certain drivers might not accommodate multiple values in this context. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_URL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_URL+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-max-size]]`link:#quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-max-size[quarkus.datasource."datasource-name".reactive.max-size]` - - -[.description] --- -The datasource pool maximum size. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_MAX_SIZE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_MAX_SIZE+++` -endif::add-copy-button-to-env-var[] ---|int -|`20` - - -a| [[quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-event-loop-size]]`link:#quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-event-loop-size[quarkus.datasource."datasource-name".reactive.event-loop-size]` - - -[.description] --- -When a new connection object is created, the pool assigns it an event loop. - -When `++#++event-loop-size` is set to a strictly positive value, the pool assigns as many event loops as specified, in a round-robin fashion. By default, the number of event loops configured or calculated by Quarkus is used. If `++#++event-loop-size` is set to zero or a negative value, the pool assigns the current event loop to the new connection. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_EVENT_LOOP_SIZE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_EVENT_LOOP_SIZE+++` -endif::add-copy-button-to-env-var[] ---|int -| - - -a| [[quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-trust-all]]`link:#quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-trust-all[quarkus.datasource."datasource-name".reactive.trust-all]` - - -[.description] --- -Whether all server certificates should be trusted. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_ALL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_ALL+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-trust-certificate-pem]]`link:#quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-trust-certificate-pem[quarkus.datasource."datasource-name".reactive.trust-certificate-pem]` - - -[.description] --- -PEM Trust config is disabled by default. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PEM+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PEM+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-trust-certificate-pem-certs]]`link:#quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-trust-certificate-pem-certs[quarkus.datasource."datasource-name".reactive.trust-certificate-pem.certs]` - - -[.description] --- -Comma-separated list of the trust certificate files (Pem format). - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PEM_CERTS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PEM_CERTS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-trust-certificate-jks]]`link:#quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-trust-certificate-jks[quarkus.datasource."datasource-name".reactive.trust-certificate-jks]` - - -[.description] --- -JKS config is disabled by default. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-trust-certificate-jks-path]]`link:#quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-trust-certificate-jks-path[quarkus.datasource."datasource-name".reactive.trust-certificate-jks.path]` - - -[.description] --- -Path of the key file (JKS format). - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS_PATH+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS_PATH+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-trust-certificate-jks-password]]`link:#quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-trust-certificate-jks-password[quarkus.datasource."datasource-name".reactive.trust-certificate-jks.password]` - - -[.description] --- -Password of the key file. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-trust-certificate-pfx]]`link:#quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-trust-certificate-pfx[quarkus.datasource."datasource-name".reactive.trust-certificate-pfx]` - - -[.description] --- -PFX config is disabled by default. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-trust-certificate-pfx-path]]`link:#quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-trust-certificate-pfx-path[quarkus.datasource."datasource-name".reactive.trust-certificate-pfx.path]` - - -[.description] --- -Path to the key file (PFX format). - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX_PATH+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX_PATH+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-trust-certificate-pfx-password]]`link:#quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-trust-certificate-pfx-password[quarkus.datasource."datasource-name".reactive.trust-certificate-pfx.password]` - - -[.description] --- -Password of the key. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-pem]]`link:#quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-pem[quarkus.datasource."datasource-name".reactive.key-certificate-pem]` - - -[.description] --- -PEM Key/cert config is disabled by default. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-pem-keys]]`link:#quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-pem-keys[quarkus.datasource."datasource-name".reactive.key-certificate-pem.keys]` - - -[.description] --- -Comma-separated list of the path to the key files (Pem format). - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM_KEYS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM_KEYS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-pem-certs]]`link:#quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-pem-certs[quarkus.datasource."datasource-name".reactive.key-certificate-pem.certs]` - - -[.description] --- -Comma-separated list of the path to the certificate files (Pem format). - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM_CERTS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM_CERTS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-jks]]`link:#quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-jks[quarkus.datasource."datasource-name".reactive.key-certificate-jks]` - - -[.description] --- -JKS config is disabled by default. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-jks-path]]`link:#quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-jks-path[quarkus.datasource."datasource-name".reactive.key-certificate-jks.path]` - - -[.description] --- -Path of the key file (JKS format). - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS_PATH+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS_PATH+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-jks-password]]`link:#quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-jks-password[quarkus.datasource."datasource-name".reactive.key-certificate-jks.password]` - - -[.description] --- -Password of the key file. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-pfx]]`link:#quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-pfx[quarkus.datasource."datasource-name".reactive.key-certificate-pfx]` - - -[.description] --- -PFX config is disabled by default. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-pfx-path]]`link:#quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-pfx-path[quarkus.datasource."datasource-name".reactive.key-certificate-pfx.path]` - - -[.description] --- -Path to the key file (PFX format). - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX_PATH+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX_PATH+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-pfx-password]]`link:#quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-pfx-password[quarkus.datasource."datasource-name".reactive.key-certificate-pfx.password]` - - -[.description] --- -Password of the key. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-reconnect-attempts]]`link:#quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-reconnect-attempts[quarkus.datasource."datasource-name".reactive.reconnect-attempts]` - - -[.description] --- -The number of reconnection attempts when a pooled connection cannot be established on first try. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_RECONNECT_ATTEMPTS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_RECONNECT_ATTEMPTS+++` -endif::add-copy-button-to-env-var[] ---|int -|`0` - - -a| [[quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-reconnect-interval]]`link:#quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-reconnect-interval[quarkus.datasource."datasource-name".reactive.reconnect-interval]` - - -[.description] --- -The interval between reconnection attempts when a pooled connection cannot be established on first try. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_RECONNECT_INTERVAL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_RECONNECT_INTERVAL+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`PT1S` - - -a| [[quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-hostname-verification-algorithm]]`link:#quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-hostname-verification-algorithm[quarkus.datasource."datasource-name".reactive.hostname-verification-algorithm]` - - -[.description] --- -The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS`, `LDAPS` or `NONE`. `NONE` is the default value and disables the verification. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_HOSTNAME_VERIFICATION_ALGORITHM+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_HOSTNAME_VERIFICATION_ALGORITHM+++` -endif::add-copy-button-to-env-var[] ---|string -|`NONE` - - -a| [[quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-idle-timeout]]`link:#quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-idle-timeout[quarkus.datasource."datasource-name".reactive.idle-timeout]` - - -[.description] --- -The maximum time a connection remains unused in the pool before it is closed. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_IDLE_TIMEOUT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_IDLE_TIMEOUT+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`no timeout` - - -a| [[quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-max-lifetime]]`link:#quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-max-lifetime[quarkus.datasource."datasource-name".reactive.max-lifetime]` - - -[.description] --- -The maximum time a connection remains in the pool, after which it will be closed upon return and replaced as necessary. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_MAX_LIFETIME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_MAX_LIFETIME+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`no timeout` - - -a| [[quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-shared]]`link:#quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-shared[quarkus.datasource."datasource-name".reactive.shared]` - - -[.description] --- -Set to true to share the pool among datasources. There can be multiple shared pools distinguished by name, when no specific name is set, the `__vertx.DEFAULT` name is used. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_SHARED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_SHARED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-name]]`link:#quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-name[quarkus.datasource."datasource-name".reactive.name]` - - -[.description] --- -Set the pool name, used when the pool is shared among datasources, otherwise ignored. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_NAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_NAME+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-additional-properties-property-key]]`link:#quarkus-datasource-data-sources-reactive-build-time-config_quarkus-datasource-datasource-name-reactive-additional-properties-property-key[quarkus.datasource."datasource-name".reactive.additional-properties."property-key"]` - - -[.description] --- -Other unspecified properties to be passed through the Reactive SQL Client directly to the database when new connections are initiated. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_ADDITIONAL_PROPERTIES__PROPERTY_KEY_+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_ADDITIONAL_PROPERTIES__PROPERTY_KEY_+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] - -| - -|=== -ifndef::no-duration-note[] -[NOTE] -[id='duration-note-anchor-{summaryTableId}'] -.About the Duration format -==== -To write duration values, use the standard `java.time.Duration` format. -See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. - -You can also use a simplified format, starting with a number: - -* If the value is only a number, it represents time in seconds. -* If the value is a number followed by `ms`, it represents time in milliseconds. - -In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: - -* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. -* If the value is a number followed by `d`, it is prefixed with `P`. -==== -endif::no-duration-note[] +|=== \ No newline at end of file diff --git a/_generated-doc/main/config/quarkus-datasource-data-sources-reactive-runtime-config.adoc b/_generated-doc/main/config/quarkus-datasource-data-sources-reactive-runtime-config.adoc index 85aa4ae3f3..fd4700ff9c 100644 --- a/_generated-doc/main/config/quarkus-datasource-data-sources-reactive-runtime-config.adoc +++ b/_generated-doc/main/config/quarkus-datasource-data-sources-reactive-runtime-config.adoc @@ -533,6 +533,23 @@ h|[[quarkus-datasource-data-sources-reactive-runtime-config_quarkus-datasource-n h|Type h|Default +a|icon:lock[title=Fixed at build time] [[quarkus-datasource-data-sources-reactive-runtime-config_quarkus-datasource-datasource-name-reactive]]`link:#quarkus-datasource-data-sources-reactive-runtime-config_quarkus-datasource-datasource-name-reactive[quarkus.datasource."datasource-name".reactive]` + + +[.description] +-- +If we create a Reactive datasource for this datasource. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + a| [[quarkus-datasource-data-sources-reactive-runtime-config_quarkus-datasource-datasource-name-reactive-cache-prepared-statements]]`link:#quarkus-datasource-data-sources-reactive-runtime-config_quarkus-datasource-datasource-name-reactive-cache-prepared-statements[quarkus.datasource."datasource-name".reactive.cache-prepared-statements]` diff --git a/_generated-doc/main/config/quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit-elasticsearch-backend-build-time-config.adoc b/_generated-doc/main/config/quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit-elasticsearch-backend-build-time-config.adoc index 6b843166d8..d5930c6a0b 100644 --- a/_generated-doc/main/config/quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit-elasticsearch-backend-build-time-config.adoc +++ b/_generated-doc/main/config/quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit-elasticsearch-backend-build-time-config.adoc @@ -300,4 +300,163 @@ endif::add-copy-button-to-env-var[] --|list of string | -|=== \ No newline at end of file + +a| [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit-elasticsearch-backend-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit-elasticsearch-backend-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status[quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".schema-management.required-status]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit-elasticsearch-backend-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".schema-management.required-status]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit-elasticsearch-backend-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexes."index-name".schema-management.required-status]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit-elasticsearch-backend-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexes."index-name".schema-management.required-status]` + + +[.description] +-- +The minimal https://www.elastic.co/guide/en/elasticsearch/reference/7.17/cluster-health.html[Elasticsearch cluster +status] required on startup. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS+++` +endif::add-copy-button-to-env-var[] +-- a| +`green`, `yellow`, `red` +|`yellow` + + +a| [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit-elasticsearch-backend-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status-wait-timeout]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit-elasticsearch-backend-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status-wait-timeout[quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".schema-management.required-status-wait-timeout]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit-elasticsearch-backend-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status-wait-timeout[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".schema-management.required-status-wait-timeout]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit-elasticsearch-backend-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status-wait-timeout[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexes."index-name".schema-management.required-status-wait-timeout]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit-elasticsearch-backend-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status-wait-timeout[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexes."index-name".schema-management.required-status-wait-timeout]` + + +[.description] +-- +How long we should wait for the status before failing the bootstrap. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + + +a| [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit-elasticsearch-backend-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-count]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit-elasticsearch-backend-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-count[quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".indexing.queue-count]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit-elasticsearch-backend-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-count[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".indexing.queue-count]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit-elasticsearch-backend-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-count[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexes."index-name".indexing.queue-count]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit-elasticsearch-backend-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-count[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexes."index-name".indexing.queue-count]` + + +[.description] +-- +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 +https://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[circuit breakers], +leading to Elasticsearch giving up on some request and resulting in indexing failures. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__INDEXING_QUEUE_COUNT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__INDEXING_QUEUE_COUNT+++` +endif::add-copy-button-to-env-var[] +--|int +|`10` + + +a| [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit-elasticsearch-backend-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-size]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit-elasticsearch-backend-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-size[quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".indexing.queue-size]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit-elasticsearch-backend-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-size[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".indexing.queue-size]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit-elasticsearch-backend-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-size[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexes."index-name".indexing.queue-size]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit-elasticsearch-backend-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-size[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexes."index-name".indexing.queue-size]` + + +[.description] +-- +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. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__INDEXING_QUEUE_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__INDEXING_QUEUE_SIZE+++` +endif::add-copy-button-to-env-var[] +--|int +|`1000` + + +a| [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit-elasticsearch-backend-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-max-bulk-size]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit-elasticsearch-backend-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-max-bulk-size[quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".indexing.max-bulk-size]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit-elasticsearch-backend-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-max-bulk-size[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".indexing.max-bulk-size]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit-elasticsearch-backend-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-max-bulk-size[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexes."index-name".indexing.max-bulk-size]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit-elasticsearch-backend-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-max-bulk-size[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexes."index-name".indexing.max-bulk-size]` + + +[.description] +-- +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 +https://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[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. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__INDEXING_MAX_BULK_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__INDEXING_MAX_BULK_SIZE+++` +endif::add-copy-button-to-env-var[] +--|int +|`100` + +|=== +ifndef::no-duration-note[] +[NOTE] +[id='duration-note-anchor-{summaryTableId}'] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* If the value is a number followed by `d`, it is prefixed with `P`. +==== +endif::no-duration-note[] diff --git a/_generated-doc/main/config/quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit.adoc b/_generated-doc/main/config/quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit.adoc index eca11c0178..72b5b33823 100644 --- a/_generated-doc/main/config/quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit.adoc +++ b/_generated-doc/main/config/quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit.adoc @@ -297,6 +297,491 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-hosts]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-hosts[quarkus.hibernate-search-orm.elasticsearch.hosts]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-hosts[quarkus.hibernate-search-orm.elasticsearch."backend-name".hosts]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-hosts[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".hosts]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-hosts[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.hosts]` + + +[.description] +-- +The list of hosts of the Elasticsearch servers. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_HOSTS+++` +endif::add-copy-button-to-env-var[] +--|list of string +|`localhost:9200` + + +a| [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-protocol]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-protocol[quarkus.hibernate-search-orm.elasticsearch.protocol]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-protocol[quarkus.hibernate-search-orm.elasticsearch."backend-name".protocol]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-protocol[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".protocol]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-protocol[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.protocol]` + + +[.description] +-- +The protocol to use when contacting Elasticsearch servers. Set to "https" to enable SSL/TLS. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_PROTOCOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_PROTOCOL+++` +endif::add-copy-button-to-env-var[] +-- a| +`http`, `https` +|`http` + + +a| [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-username]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-username[quarkus.hibernate-search-orm.elasticsearch.username]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-username[quarkus.hibernate-search-orm.elasticsearch."backend-name".username]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-username[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".username]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-username[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.username]` + + +[.description] +-- +The username used for authentication. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_USERNAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-password]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-password[quarkus.hibernate-search-orm.elasticsearch.password]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-password[quarkus.hibernate-search-orm.elasticsearch."backend-name".password]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-password[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".password]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-password[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.password]` + + +[.description] +-- +The password used for authentication. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-connection-timeout]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-connection-timeout[quarkus.hibernate-search-orm.elasticsearch.connection-timeout]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-connection-timeout[quarkus.hibernate-search-orm.elasticsearch."backend-name".connection-timeout]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-connection-timeout[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".connection-timeout]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-connection-timeout[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.connection-timeout]` + + +[.description] +-- +The timeout when establishing a connection to an Elasticsearch server. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`1S` + + +a| [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-read-timeout]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-read-timeout[quarkus.hibernate-search-orm.elasticsearch.read-timeout]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-read-timeout[quarkus.hibernate-search-orm.elasticsearch."backend-name".read-timeout]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-read-timeout[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".read-timeout]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-read-timeout[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.read-timeout]` + + +[.description] +-- +The timeout when reading responses from an Elasticsearch server. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_READ_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_READ_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + + +a| [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-request-timeout]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-request-timeout[quarkus.hibernate-search-orm.elasticsearch.request-timeout]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-request-timeout[quarkus.hibernate-search-orm.elasticsearch."backend-name".request-timeout]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-request-timeout[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".request-timeout]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-request-timeout[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.request-timeout]` + + +[.description] +-- +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. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_REQUEST_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_REQUEST_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + + +a| [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-max-connections]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-max-connections[quarkus.hibernate-search-orm.elasticsearch.max-connections]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-max-connections[quarkus.hibernate-search-orm.elasticsearch."backend-name".max-connections]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-max-connections[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".max-connections]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-max-connections[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.max-connections]` + + +[.description] +-- +The maximum number of connections to all the Elasticsearch servers. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_MAX_CONNECTIONS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_MAX_CONNECTIONS+++` +endif::add-copy-button-to-env-var[] +--|int +|`20` + + +a| [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-max-connections-per-route]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-max-connections-per-route[quarkus.hibernate-search-orm.elasticsearch.max-connections-per-route]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-max-connections-per-route[quarkus.hibernate-search-orm.elasticsearch."backend-name".max-connections-per-route]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-max-connections-per-route[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".max-connections-per-route]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-max-connections-per-route[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.max-connections-per-route]` + + +[.description] +-- +The maximum number of connections per Elasticsearch server. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_MAX_CONNECTIONS_PER_ROUTE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_MAX_CONNECTIONS_PER_ROUTE+++` +endif::add-copy-button-to-env-var[] +--|int +|`10` + + +a| [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-discovery-enabled]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-discovery-enabled[quarkus.hibernate-search-orm.elasticsearch.discovery.enabled]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-discovery-enabled[quarkus.hibernate-search-orm.elasticsearch."backend-name".discovery.enabled]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-discovery-enabled[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".discovery.enabled]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-discovery-enabled[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.discovery.enabled]` + + +[.description] +-- +Defines if automatic discovery is enabled. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_DISCOVERY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_DISCOVERY_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-discovery-refresh-interval]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-discovery-refresh-interval[quarkus.hibernate-search-orm.elasticsearch.discovery.refresh-interval]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-discovery-refresh-interval[quarkus.hibernate-search-orm.elasticsearch."backend-name".discovery.refresh-interval]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-discovery-refresh-interval[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".discovery.refresh-interval]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-discovery-refresh-interval[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.discovery.refresh-interval]` + + +[.description] +-- +Refresh interval of the node list. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_DISCOVERY_REFRESH_INTERVAL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_DISCOVERY_REFRESH_INTERVAL+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + + +a| [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-thread-pool-size]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-thread-pool-size[quarkus.hibernate-search-orm.elasticsearch.thread-pool.size]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-thread-pool-size[quarkus.hibernate-search-orm.elasticsearch."backend-name".thread-pool.size]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-thread-pool-size[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".thread-pool.size]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-thread-pool-size[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.thread-pool.size]` + + +[.description] +-- +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. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_THREAD_POOL_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_THREAD_POOL_SIZE+++` +endif::add-copy-button-to-env-var[] +--|int +| + + +a| [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-query-shard-failure-ignore]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-query-shard-failure-ignore[quarkus.hibernate-search-orm.elasticsearch.query.shard-failure.ignore]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-query-shard-failure-ignore[quarkus.hibernate-search-orm.elasticsearch."backend-name".query.shard-failure.ignore]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-query-shard-failure-ignore[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".query.shard-failure.ignore]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-query-shard-failure-ignore[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.query.shard-failure.ignore]` + + +[.description] +-- +Whether partial shard failures are ignored (`true`) or lead to Hibernate Search throwing an exception (`false`). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_QUERY_SHARD_FAILURE_IGNORE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_QUERY_SHARD_FAILURE_IGNORE+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-version-check-enabled]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-version-check-enabled[quarkus.hibernate-search-orm.elasticsearch.version-check.enabled]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-version-check-enabled[quarkus.hibernate-search-orm.elasticsearch."backend-name".version-check.enabled]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-version-check-enabled[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".version-check.enabled]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-version-check-enabled[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.version-check.enabled]` + + +[.description] +-- +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. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_VERSION_CHECK_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_VERSION_CHECK_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-schema-management-required-status]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-schema-management-required-status[quarkus.hibernate-search-orm.elasticsearch.schema-management.required-status]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-schema-management-required-status[quarkus.hibernate-search-orm.elasticsearch."backend-name".schema-management.required-status]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-schema-management-required-status[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".schema-management.required-status]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-schema-management-required-status[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.schema-management.required-status]` + + +[.description] +-- +The minimal https://www.elastic.co/guide/en/elasticsearch/reference/7.17/cluster-health.html[Elasticsearch cluster +status] required on startup. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_SCHEMA_MANAGEMENT_REQUIRED_STATUS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_SCHEMA_MANAGEMENT_REQUIRED_STATUS+++` +endif::add-copy-button-to-env-var[] +-- a| +`green`, `yellow`, `red` +|`yellow` + + +a| [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-schema-management-required-status-wait-timeout]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-schema-management-required-status-wait-timeout[quarkus.hibernate-search-orm.elasticsearch.schema-management.required-status-wait-timeout]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-schema-management-required-status-wait-timeout[quarkus.hibernate-search-orm.elasticsearch."backend-name".schema-management.required-status-wait-timeout]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-schema-management-required-status-wait-timeout[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".schema-management.required-status-wait-timeout]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-schema-management-required-status-wait-timeout[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.schema-management.required-status-wait-timeout]` + + +[.description] +-- +How long we should wait for the status before failing the bootstrap. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + + +a| [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexing-queue-count]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexing-queue-count[quarkus.hibernate-search-orm.elasticsearch.indexing.queue-count]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexing-queue-count[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexing.queue-count]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexing-queue-count[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexing.queue-count]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexing-queue-count[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexing.queue-count]` + + +[.description] +-- +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 +https://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[circuit breakers], +leading to Elasticsearch giving up on some request and resulting in indexing failures. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXING_QUEUE_COUNT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXING_QUEUE_COUNT+++` +endif::add-copy-button-to-env-var[] +--|int +|`10` + + +a| [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexing-queue-size]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexing-queue-size[quarkus.hibernate-search-orm.elasticsearch.indexing.queue-size]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexing-queue-size[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexing.queue-size]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexing-queue-size[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexing.queue-size]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexing-queue-size[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexing.queue-size]` + + +[.description] +-- +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. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXING_QUEUE_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXING_QUEUE_SIZE+++` +endif::add-copy-button-to-env-var[] +--|int +|`1000` + + +a| [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexing-max-bulk-size]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexing-max-bulk-size[quarkus.hibernate-search-orm.elasticsearch.indexing.max-bulk-size]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexing-max-bulk-size[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexing.max-bulk-size]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexing-max-bulk-size[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexing.max-bulk-size]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexing-max-bulk-size[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexing.max-bulk-size]` + + +[.description] +-- +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 +https://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[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. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXING_MAX_BULK_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXING_MAX_BULK_SIZE+++` +endif::add-copy-button-to-env-var[] +--|int +|`100` + + h|[[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-per-index-configuration-overrides]]link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-per-index-configuration-overrides[Per-index configuration overrides] h|Type @@ -402,4 +887,163 @@ endif::add-copy-button-to-env-var[] --|list of string | -|=== \ No newline at end of file + +a| [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status[quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".schema-management.required-status]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".schema-management.required-status]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexes."index-name".schema-management.required-status]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexes."index-name".schema-management.required-status]` + + +[.description] +-- +The minimal https://www.elastic.co/guide/en/elasticsearch/reference/7.17/cluster-health.html[Elasticsearch cluster +status] required on startup. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS+++` +endif::add-copy-button-to-env-var[] +-- a| +`green`, `yellow`, `red` +|`yellow` + + +a| [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status-wait-timeout]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status-wait-timeout[quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".schema-management.required-status-wait-timeout]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status-wait-timeout[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".schema-management.required-status-wait-timeout]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status-wait-timeout[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexes."index-name".schema-management.required-status-wait-timeout]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status-wait-timeout[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexes."index-name".schema-management.required-status-wait-timeout]` + + +[.description] +-- +How long we should wait for the status before failing the bootstrap. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + + +a| [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-count]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-count[quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".indexing.queue-count]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-count[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".indexing.queue-count]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-count[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexes."index-name".indexing.queue-count]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-count[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexes."index-name".indexing.queue-count]` + + +[.description] +-- +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 +https://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[circuit breakers], +leading to Elasticsearch giving up on some request and resulting in indexing failures. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__INDEXING_QUEUE_COUNT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__INDEXING_QUEUE_COUNT+++` +endif::add-copy-button-to-env-var[] +--|int +|`10` + + +a| [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-size]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-size[quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".indexing.queue-size]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-size[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".indexing.queue-size]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-size[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexes."index-name".indexing.queue-size]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-size[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexes."index-name".indexing.queue-size]` + + +[.description] +-- +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. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__INDEXING_QUEUE_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__INDEXING_QUEUE_SIZE+++` +endif::add-copy-button-to-env-var[] +--|int +|`1000` + + +a| [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-max-bulk-size]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-max-bulk-size[quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".indexing.max-bulk-size]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-max-bulk-size[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".indexing.max-bulk-size]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-max-bulk-size[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexes."index-name".indexing.max-bulk-size]` + +`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-build-time-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-max-bulk-size[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexes."index-name".indexing.max-bulk-size]` + + +[.description] +-- +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 +https://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[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. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__INDEXING_MAX_BULK_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__INDEXING_MAX_BULK_SIZE+++` +endif::add-copy-button-to-env-var[] +--|int +|`100` + +|=== +ifndef::no-duration-note[] +[NOTE] +[id='duration-note-anchor-{summaryTableId}'] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* If the value is a number followed by `d`, it is prefixed with `P`. +==== +endif::no-duration-note[] diff --git a/_generated-doc/main/config/quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit-elasticsearch-backend-runtime-config.adoc b/_generated-doc/main/config/quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit-elasticsearch-backend-runtime-config.adoc index ecec4261a8..0c6cfc9d42 100644 --- a/_generated-doc/main/config/quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit-elasticsearch-backend-runtime-config.adoc +++ b/_generated-doc/main/config/quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit-elasticsearch-backend-runtime-config.adoc @@ -500,107 +500,6 @@ h|[[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-ela h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit-elasticsearch-backend-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-settings-file]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit-elasticsearch-backend-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-settings-file[quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".schema-management.settings-file]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit-elasticsearch-backend-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-settings-file[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".schema-management.settings-file]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit-elasticsearch-backend-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-settings-file[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexes."index-name".schema-management.settings-file]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit-elasticsearch-backend-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-settings-file[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexes."index-name".schema-management.settings-file]` - - -[.description] --- -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. - -See link:{hibernate-search-docs-url}#backend-elasticsearch-configuration-index-settings[this section of the reference documentation] -for more information. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_SETTINGS_FILE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_SETTINGS_FILE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit-elasticsearch-backend-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-mapping-file]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit-elasticsearch-backend-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-mapping-file[quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".schema-management.mapping-file]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit-elasticsearch-backend-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-mapping-file[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".schema-management.mapping-file]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit-elasticsearch-backend-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-mapping-file[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexes."index-name".schema-management.mapping-file]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit-elasticsearch-backend-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-mapping-file[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexes."index-name".schema-management.mapping-file]` - - -[.description] --- -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. - -See link:{hibernate-search-docs-url}#backend-elasticsearch-mapping-custom[this section of the reference documentation] -for more information. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_MAPPING_FILE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_MAPPING_FILE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit-elasticsearch-backend-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-analysis-configurer]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit-elasticsearch-backend-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-analysis-configurer[quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".analysis.configurer]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit-elasticsearch-backend-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-analysis-configurer[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".analysis.configurer]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit-elasticsearch-backend-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-analysis-configurer[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexes."index-name".analysis.configurer]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit-elasticsearch-backend-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-analysis-configurer[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexes."index-name".analysis.configurer]` - - -[.description] --- -One or more xref:hibernate-search-orm-elasticsearch.adoc#bean-reference-note-anchor[bean references] -to the component(s) used to configure full text analysis (e.g. analyzers, normalizers). - -The referenced beans must implement `ElasticsearchAnalysisConfigurer`. - -See xref:hibernate-search-orm-elasticsearch.adoc#analysis-configurer[Setting up the analyzers] for more -information. - -[NOTE] -==== -Instead of setting this configuration property, -you can simply annotate your custom `ElasticsearchAnalysisConfigurer` implementations with `@SearchExtension` -and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically. -See xref:hibernate-search-orm-elasticsearch.adoc#plugging-in-custom-components[this section] -for more information. - -If this configuration property is set, it takes precedence over any `@SearchExtension` annotation. -==== - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__ANALYSIS_CONFIGURER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__ANALYSIS_CONFIGURER+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - a| [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit-elasticsearch-backend-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit-elasticsearch-backend-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status[quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".schema-management.required-status]` `link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit-elasticsearch-backend-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".schema-management.required-status]` diff --git a/_generated-doc/main/config/quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit.adoc b/_generated-doc/main/config/quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit.adoc index f496b36c7f..ea5b3474f7 100644 --- a/_generated-doc/main/config/quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit.adoc +++ b/_generated-doc/main/config/quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit.adoc @@ -263,191 +263,6 @@ h|[[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-ela h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-version]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-version[quarkus.hibernate-search-orm.elasticsearch.version]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-version[quarkus.hibernate-search-orm.elasticsearch."backend-name".version]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-version[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".version]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-version[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.version]` - - -[.description] --- -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. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_VERSION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_VERSION+++` -endif::add-copy-button-to-env-var[] ---|ElasticsearchVersion -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-layout-strategy]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-layout-strategy[quarkus.hibernate-search-orm.elasticsearch.layout.strategy]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-layout-strategy[quarkus.hibernate-search-orm.elasticsearch."backend-name".layout.strategy]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-layout-strategy[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".layout.strategy]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-layout-strategy[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.layout.strategy]` - - -[.description] --- -A xref:hibernate-search-orm-elasticsearch.adoc#bean-reference-note-anchor[bean reference] to the component -used to configure the Elasticsearch layout: 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. - -See -link:{hibernate-search-docs-url}#backend-elasticsearch-indexlayout[this section of the reference documentation] -for more information. - -[NOTE] -==== -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. -See xref:hibernate-search-orm-elasticsearch.adoc#plugging-in-custom-components[this section] -for more information. - -If this configuration property is set, it takes precedence over any `@SearchExtension` annotation. -==== - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_LAYOUT_STRATEGY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_LAYOUT_STRATEGY+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-schema-management-settings-file]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-schema-management-settings-file[quarkus.hibernate-search-orm.elasticsearch.schema-management.settings-file]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-schema-management-settings-file[quarkus.hibernate-search-orm.elasticsearch."backend-name".schema-management.settings-file]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-schema-management-settings-file[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".schema-management.settings-file]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-schema-management-settings-file[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.schema-management.settings-file]` - - -[.description] --- -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. - -See link:{hibernate-search-docs-url}#backend-elasticsearch-configuration-index-settings[this section of the reference documentation] -for more information. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_SCHEMA_MANAGEMENT_SETTINGS_FILE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_SCHEMA_MANAGEMENT_SETTINGS_FILE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-schema-management-mapping-file]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-schema-management-mapping-file[quarkus.hibernate-search-orm.elasticsearch.schema-management.mapping-file]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-schema-management-mapping-file[quarkus.hibernate-search-orm.elasticsearch."backend-name".schema-management.mapping-file]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-schema-management-mapping-file[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".schema-management.mapping-file]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-schema-management-mapping-file[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.schema-management.mapping-file]` - - -[.description] --- -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. - -See link:{hibernate-search-docs-url}#backend-elasticsearch-mapping-custom[this section of the reference documentation] -for more information. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_SCHEMA_MANAGEMENT_MAPPING_FILE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_SCHEMA_MANAGEMENT_MAPPING_FILE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-analysis-configurer]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-analysis-configurer[quarkus.hibernate-search-orm.elasticsearch.analysis.configurer]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-analysis-configurer[quarkus.hibernate-search-orm.elasticsearch."backend-name".analysis.configurer]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-analysis-configurer[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".analysis.configurer]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-analysis-configurer[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.analysis.configurer]` - - -[.description] --- -One or more xref:hibernate-search-orm-elasticsearch.adoc#bean-reference-note-anchor[bean references] -to the component(s) used to configure full text analysis (e.g. analyzers, normalizers). - -The referenced beans must implement `ElasticsearchAnalysisConfigurer`. - -See xref:hibernate-search-orm-elasticsearch.adoc#analysis-configurer[Setting up the analyzers] for more -information. - -[NOTE] -==== -Instead of setting this configuration property, -you can simply annotate your custom `ElasticsearchAnalysisConfigurer` implementations with `@SearchExtension` -and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically. -See xref:hibernate-search-orm-elasticsearch.adoc#plugging-in-custom-components[this section] -for more information. - -If this configuration property is set, it takes precedence over any `@SearchExtension` annotation. -==== - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_ANALYSIS_CONFIGURER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_ANALYSIS_CONFIGURER+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - a| [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-hosts]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-hosts[quarkus.hibernate-search-orm.elasticsearch.hosts]` `link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-hosts[quarkus.hibernate-search-orm.elasticsearch."backend-name".hosts]` @@ -938,107 +753,6 @@ h|[[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-ela h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-settings-file]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-settings-file[quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".schema-management.settings-file]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-settings-file[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".schema-management.settings-file]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-settings-file[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexes."index-name".schema-management.settings-file]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-settings-file[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexes."index-name".schema-management.settings-file]` - - -[.description] --- -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. - -See link:{hibernate-search-docs-url}#backend-elasticsearch-configuration-index-settings[this section of the reference documentation] -for more information. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_SETTINGS_FILE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_SETTINGS_FILE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-mapping-file]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-mapping-file[quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".schema-management.mapping-file]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-mapping-file[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".schema-management.mapping-file]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-mapping-file[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexes."index-name".schema-management.mapping-file]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-mapping-file[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexes."index-name".schema-management.mapping-file]` - - -[.description] --- -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. - -See link:{hibernate-search-docs-url}#backend-elasticsearch-mapping-custom[this section of the reference documentation] -for more information. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_MAPPING_FILE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_MAPPING_FILE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-analysis-configurer]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-analysis-configurer[quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".analysis.configurer]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-analysis-configurer[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".analysis.configurer]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-analysis-configurer[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexes."index-name".analysis.configurer]` - -`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-analysis-configurer[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexes."index-name".analysis.configurer]` - - -[.description] --- -One or more xref:hibernate-search-orm-elasticsearch.adoc#bean-reference-note-anchor[bean references] -to the component(s) used to configure full text analysis (e.g. analyzers, normalizers). - -The referenced beans must implement `ElasticsearchAnalysisConfigurer`. - -See xref:hibernate-search-orm-elasticsearch.adoc#analysis-configurer[Setting up the analyzers] for more -information. - -[NOTE] -==== -Instead of setting this configuration property, -you can simply annotate your custom `ElasticsearchAnalysisConfigurer` implementations with `@SearchExtension` -and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically. -See xref:hibernate-search-orm-elasticsearch.adoc#plugging-in-custom-components[this section] -for more information. - -If this configuration property is set, it takes precedence over any `@SearchExtension` annotation. -==== - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__ANALYSIS_CONFIGURER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__ANALYSIS_CONFIGURER+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - a| [[quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status]]`link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status[quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".schema-management.required-status]` `link:#quarkus-hibernate-search-orm-elasticsearch-config-group-hibernate-search-elasticsearch-runtime-config-persistence-unit_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".schema-management.required-status]` diff --git a/_generated-doc/main/config/quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config.adoc b/_generated-doc/main/config/quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config.adoc index 40e196b9fa..9cf400440f 100644 --- a/_generated-doc/main/config/quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config.adoc +++ b/_generated-doc/main/config/quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config.adoc @@ -318,6 +318,491 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-hosts]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-hosts[quarkus.hibernate-search-orm.elasticsearch.hosts]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-hosts[quarkus.hibernate-search-orm.elasticsearch."backend-name".hosts]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-hosts[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".hosts]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-hosts[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.hosts]` + + +[.description] +-- +The list of hosts of the Elasticsearch servers. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_HOSTS+++` +endif::add-copy-button-to-env-var[] +--|list of string +|`localhost:9200` + + +a| [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-protocol]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-protocol[quarkus.hibernate-search-orm.elasticsearch.protocol]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-protocol[quarkus.hibernate-search-orm.elasticsearch."backend-name".protocol]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-protocol[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".protocol]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-protocol[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.protocol]` + + +[.description] +-- +The protocol to use when contacting Elasticsearch servers. Set to "https" to enable SSL/TLS. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_PROTOCOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_PROTOCOL+++` +endif::add-copy-button-to-env-var[] +-- a| +`http`, `https` +|`http` + + +a| [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-username]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-username[quarkus.hibernate-search-orm.elasticsearch.username]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-username[quarkus.hibernate-search-orm.elasticsearch."backend-name".username]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-username[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".username]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-username[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.username]` + + +[.description] +-- +The username used for authentication. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_USERNAME+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-password]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-password[quarkus.hibernate-search-orm.elasticsearch.password]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-password[quarkus.hibernate-search-orm.elasticsearch."backend-name".password]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-password[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".password]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-password[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.password]` + + +[.description] +-- +The password used for authentication. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_PASSWORD+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-connection-timeout]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-connection-timeout[quarkus.hibernate-search-orm.elasticsearch.connection-timeout]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-connection-timeout[quarkus.hibernate-search-orm.elasticsearch."backend-name".connection-timeout]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-connection-timeout[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".connection-timeout]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-connection-timeout[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.connection-timeout]` + + +[.description] +-- +The timeout when establishing a connection to an Elasticsearch server. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`1S` + + +a| [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-read-timeout]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-read-timeout[quarkus.hibernate-search-orm.elasticsearch.read-timeout]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-read-timeout[quarkus.hibernate-search-orm.elasticsearch."backend-name".read-timeout]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-read-timeout[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".read-timeout]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-read-timeout[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.read-timeout]` + + +[.description] +-- +The timeout when reading responses from an Elasticsearch server. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_READ_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_READ_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + + +a| [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-request-timeout]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-request-timeout[quarkus.hibernate-search-orm.elasticsearch.request-timeout]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-request-timeout[quarkus.hibernate-search-orm.elasticsearch."backend-name".request-timeout]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-request-timeout[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".request-timeout]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-request-timeout[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.request-timeout]` + + +[.description] +-- +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. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_REQUEST_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_REQUEST_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + + +a| [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-max-connections]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-max-connections[quarkus.hibernate-search-orm.elasticsearch.max-connections]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-max-connections[quarkus.hibernate-search-orm.elasticsearch."backend-name".max-connections]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-max-connections[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".max-connections]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-max-connections[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.max-connections]` + + +[.description] +-- +The maximum number of connections to all the Elasticsearch servers. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_MAX_CONNECTIONS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_MAX_CONNECTIONS+++` +endif::add-copy-button-to-env-var[] +--|int +|`20` + + +a| [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-max-connections-per-route]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-max-connections-per-route[quarkus.hibernate-search-orm.elasticsearch.max-connections-per-route]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-max-connections-per-route[quarkus.hibernate-search-orm.elasticsearch."backend-name".max-connections-per-route]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-max-connections-per-route[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".max-connections-per-route]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-max-connections-per-route[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.max-connections-per-route]` + + +[.description] +-- +The maximum number of connections per Elasticsearch server. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_MAX_CONNECTIONS_PER_ROUTE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_MAX_CONNECTIONS_PER_ROUTE+++` +endif::add-copy-button-to-env-var[] +--|int +|`10` + + +a| [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-discovery-enabled]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-discovery-enabled[quarkus.hibernate-search-orm.elasticsearch.discovery.enabled]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-discovery-enabled[quarkus.hibernate-search-orm.elasticsearch."backend-name".discovery.enabled]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-discovery-enabled[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".discovery.enabled]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-discovery-enabled[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.discovery.enabled]` + + +[.description] +-- +Defines if automatic discovery is enabled. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_DISCOVERY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_DISCOVERY_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-discovery-refresh-interval]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-discovery-refresh-interval[quarkus.hibernate-search-orm.elasticsearch.discovery.refresh-interval]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-discovery-refresh-interval[quarkus.hibernate-search-orm.elasticsearch."backend-name".discovery.refresh-interval]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-discovery-refresh-interval[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".discovery.refresh-interval]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-discovery-refresh-interval[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.discovery.refresh-interval]` + + +[.description] +-- +Refresh interval of the node list. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_DISCOVERY_REFRESH_INTERVAL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_DISCOVERY_REFRESH_INTERVAL+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + + +a| [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-thread-pool-size]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-thread-pool-size[quarkus.hibernate-search-orm.elasticsearch.thread-pool.size]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-thread-pool-size[quarkus.hibernate-search-orm.elasticsearch."backend-name".thread-pool.size]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-thread-pool-size[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".thread-pool.size]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-thread-pool-size[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.thread-pool.size]` + + +[.description] +-- +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. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_THREAD_POOL_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_THREAD_POOL_SIZE+++` +endif::add-copy-button-to-env-var[] +--|int +| + + +a| [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-query-shard-failure-ignore]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-query-shard-failure-ignore[quarkus.hibernate-search-orm.elasticsearch.query.shard-failure.ignore]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-query-shard-failure-ignore[quarkus.hibernate-search-orm.elasticsearch."backend-name".query.shard-failure.ignore]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-query-shard-failure-ignore[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".query.shard-failure.ignore]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-query-shard-failure-ignore[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.query.shard-failure.ignore]` + + +[.description] +-- +Whether partial shard failures are ignored (`true`) or lead to Hibernate Search throwing an exception (`false`). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_QUERY_SHARD_FAILURE_IGNORE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_QUERY_SHARD_FAILURE_IGNORE+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-version-check-enabled]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-version-check-enabled[quarkus.hibernate-search-orm.elasticsearch.version-check.enabled]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-version-check-enabled[quarkus.hibernate-search-orm.elasticsearch."backend-name".version-check.enabled]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-version-check-enabled[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".version-check.enabled]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-version-check-enabled[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.version-check.enabled]` + + +[.description] +-- +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. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_VERSION_CHECK_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_VERSION_CHECK_ENABLED+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-schema-management-required-status]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-schema-management-required-status[quarkus.hibernate-search-orm.elasticsearch.schema-management.required-status]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-schema-management-required-status[quarkus.hibernate-search-orm.elasticsearch."backend-name".schema-management.required-status]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-schema-management-required-status[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".schema-management.required-status]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-schema-management-required-status[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.schema-management.required-status]` + + +[.description] +-- +The minimal https://www.elastic.co/guide/en/elasticsearch/reference/7.17/cluster-health.html[Elasticsearch cluster +status] required on startup. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_SCHEMA_MANAGEMENT_REQUIRED_STATUS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_SCHEMA_MANAGEMENT_REQUIRED_STATUS+++` +endif::add-copy-button-to-env-var[] +-- a| +`green`, `yellow`, `red` +|`yellow` + + +a| [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-schema-management-required-status-wait-timeout]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-schema-management-required-status-wait-timeout[quarkus.hibernate-search-orm.elasticsearch.schema-management.required-status-wait-timeout]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-schema-management-required-status-wait-timeout[quarkus.hibernate-search-orm.elasticsearch."backend-name".schema-management.required-status-wait-timeout]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-schema-management-required-status-wait-timeout[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".schema-management.required-status-wait-timeout]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-schema-management-required-status-wait-timeout[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.schema-management.required-status-wait-timeout]` + + +[.description] +-- +How long we should wait for the status before failing the bootstrap. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + + +a| [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexing-queue-count]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexing-queue-count[quarkus.hibernate-search-orm.elasticsearch.indexing.queue-count]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexing-queue-count[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexing.queue-count]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexing-queue-count[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexing.queue-count]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexing-queue-count[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexing.queue-count]` + + +[.description] +-- +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 +https://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[circuit breakers], +leading to Elasticsearch giving up on some request and resulting in indexing failures. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXING_QUEUE_COUNT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXING_QUEUE_COUNT+++` +endif::add-copy-button-to-env-var[] +--|int +|`10` + + +a| [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexing-queue-size]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexing-queue-size[quarkus.hibernate-search-orm.elasticsearch.indexing.queue-size]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexing-queue-size[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexing.queue-size]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexing-queue-size[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexing.queue-size]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexing-queue-size[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexing.queue-size]` + + +[.description] +-- +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. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXING_QUEUE_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXING_QUEUE_SIZE+++` +endif::add-copy-button-to-env-var[] +--|int +|`1000` + + +a| [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexing-max-bulk-size]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexing-max-bulk-size[quarkus.hibernate-search-orm.elasticsearch.indexing.max-bulk-size]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexing-max-bulk-size[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexing.max-bulk-size]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexing-max-bulk-size[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexing.max-bulk-size]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexing-max-bulk-size[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexing.max-bulk-size]` + + +[.description] +-- +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 +https://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[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. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXING_MAX_BULK_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXING_MAX_BULK_SIZE+++` +endif::add-copy-button-to-env-var[] +--|int +|`100` + + h|[[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-per-index-configuration-overrides]]link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-per-index-configuration-overrides[Per-index configuration overrides] h|Type @@ -423,4 +908,163 @@ endif::add-copy-button-to-env-var[] --|list of string | -|=== \ No newline at end of file + +a| [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status[quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".schema-management.required-status]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".schema-management.required-status]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexes."index-name".schema-management.required-status]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexes."index-name".schema-management.required-status]` + + +[.description] +-- +The minimal https://www.elastic.co/guide/en/elasticsearch/reference/7.17/cluster-health.html[Elasticsearch cluster +status] required on startup. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS+++` +endif::add-copy-button-to-env-var[] +-- a| +`green`, `yellow`, `red` +|`yellow` + + +a| [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status-wait-timeout]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status-wait-timeout[quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".schema-management.required-status-wait-timeout]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status-wait-timeout[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".schema-management.required-status-wait-timeout]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status-wait-timeout[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexes."index-name".schema-management.required-status-wait-timeout]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status-wait-timeout[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexes."index-name".schema-management.required-status-wait-timeout]` + + +[.description] +-- +How long we should wait for the status before failing the bootstrap. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + + +a| [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-count]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-count[quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".indexing.queue-count]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-count[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".indexing.queue-count]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-count[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexes."index-name".indexing.queue-count]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-count[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexes."index-name".indexing.queue-count]` + + +[.description] +-- +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 +https://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[circuit breakers], +leading to Elasticsearch giving up on some request and resulting in indexing failures. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__INDEXING_QUEUE_COUNT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__INDEXING_QUEUE_COUNT+++` +endif::add-copy-button-to-env-var[] +--|int +|`10` + + +a| [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-size]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-size[quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".indexing.queue-size]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-size[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".indexing.queue-size]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-size[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexes."index-name".indexing.queue-size]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-size[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexes."index-name".indexing.queue-size]` + + +[.description] +-- +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. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__INDEXING_QUEUE_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__INDEXING_QUEUE_SIZE+++` +endif::add-copy-button-to-env-var[] +--|int +|`1000` + + +a| [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-max-bulk-size]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-max-bulk-size[quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".indexing.max-bulk-size]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-max-bulk-size[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".indexing.max-bulk-size]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-max-bulk-size[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexes."index-name".indexing.max-bulk-size]` + +`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-build-time-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-max-bulk-size[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexes."index-name".indexing.max-bulk-size]` + + +[.description] +-- +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 +https://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[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. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__INDEXING_MAX_BULK_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__INDEXING_MAX_BULK_SIZE+++` +endif::add-copy-button-to-env-var[] +--|int +|`100` + +|=== +ifndef::no-duration-note[] +[NOTE] +[id='duration-note-anchor-{summaryTableId}'] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* If the value is a number followed by `d`, it is prefixed with `P`. +==== +endif::no-duration-note[] diff --git a/_generated-doc/main/config/quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config.adoc b/_generated-doc/main/config/quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config.adoc index e5244f626f..23e999be8d 100644 --- a/_generated-doc/main/config/quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config.adoc +++ b/_generated-doc/main/config/quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config.adoc @@ -263,191 +263,6 @@ h|[[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_q h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-version]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-version[quarkus.hibernate-search-orm.elasticsearch.version]` - -`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-version[quarkus.hibernate-search-orm.elasticsearch."backend-name".version]` - -`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-version[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".version]` - -`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-version[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.version]` - - -[.description] --- -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. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_VERSION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_VERSION+++` -endif::add-copy-button-to-env-var[] ---|ElasticsearchVersion -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-layout-strategy]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-layout-strategy[quarkus.hibernate-search-orm.elasticsearch.layout.strategy]` - -`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-layout-strategy[quarkus.hibernate-search-orm.elasticsearch."backend-name".layout.strategy]` - -`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-layout-strategy[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".layout.strategy]` - -`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-layout-strategy[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.layout.strategy]` - - -[.description] --- -A xref:hibernate-search-orm-elasticsearch.adoc#bean-reference-note-anchor[bean reference] to the component -used to configure the Elasticsearch layout: 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. - -See -link:{hibernate-search-docs-url}#backend-elasticsearch-indexlayout[this section of the reference documentation] -for more information. - -[NOTE] -==== -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. -See xref:hibernate-search-orm-elasticsearch.adoc#plugging-in-custom-components[this section] -for more information. - -If this configuration property is set, it takes precedence over any `@SearchExtension` annotation. -==== - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_LAYOUT_STRATEGY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_LAYOUT_STRATEGY+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-schema-management-settings-file]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-schema-management-settings-file[quarkus.hibernate-search-orm.elasticsearch.schema-management.settings-file]` - -`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-schema-management-settings-file[quarkus.hibernate-search-orm.elasticsearch."backend-name".schema-management.settings-file]` - -`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-schema-management-settings-file[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".schema-management.settings-file]` - -`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-schema-management-settings-file[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.schema-management.settings-file]` - - -[.description] --- -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. - -See link:{hibernate-search-docs-url}#backend-elasticsearch-configuration-index-settings[this section of the reference documentation] -for more information. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_SCHEMA_MANAGEMENT_SETTINGS_FILE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_SCHEMA_MANAGEMENT_SETTINGS_FILE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-schema-management-mapping-file]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-schema-management-mapping-file[quarkus.hibernate-search-orm.elasticsearch.schema-management.mapping-file]` - -`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-schema-management-mapping-file[quarkus.hibernate-search-orm.elasticsearch."backend-name".schema-management.mapping-file]` - -`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-schema-management-mapping-file[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".schema-management.mapping-file]` - -`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-schema-management-mapping-file[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.schema-management.mapping-file]` - - -[.description] --- -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. - -See link:{hibernate-search-docs-url}#backend-elasticsearch-mapping-custom[this section of the reference documentation] -for more information. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_SCHEMA_MANAGEMENT_MAPPING_FILE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_SCHEMA_MANAGEMENT_MAPPING_FILE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-analysis-configurer]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-analysis-configurer[quarkus.hibernate-search-orm.elasticsearch.analysis.configurer]` - -`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-analysis-configurer[quarkus.hibernate-search-orm.elasticsearch."backend-name".analysis.configurer]` - -`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-analysis-configurer[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".analysis.configurer]` - -`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-analysis-configurer[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.analysis.configurer]` - - -[.description] --- -One or more xref:hibernate-search-orm-elasticsearch.adoc#bean-reference-note-anchor[bean references] -to the component(s) used to configure full text analysis (e.g. analyzers, normalizers). - -The referenced beans must implement `ElasticsearchAnalysisConfigurer`. - -See xref:hibernate-search-orm-elasticsearch.adoc#analysis-configurer[Setting up the analyzers] for more -information. - -[NOTE] -==== -Instead of setting this configuration property, -you can simply annotate your custom `ElasticsearchAnalysisConfigurer` implementations with `@SearchExtension` -and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically. -See xref:hibernate-search-orm-elasticsearch.adoc#plugging-in-custom-components[this section] -for more information. - -If this configuration property is set, it takes precedence over any `@SearchExtension` annotation. -==== - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_ANALYSIS_CONFIGURER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_ANALYSIS_CONFIGURER+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - a| [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-hosts]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-hosts[quarkus.hibernate-search-orm.elasticsearch.hosts]` `link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-hosts[quarkus.hibernate-search-orm.elasticsearch."backend-name".hosts]` @@ -938,107 +753,6 @@ h|[[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_q h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-settings-file]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-settings-file[quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".schema-management.settings-file]` - -`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-settings-file[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".schema-management.settings-file]` - -`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-settings-file[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexes."index-name".schema-management.settings-file]` - -`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-settings-file[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexes."index-name".schema-management.settings-file]` - - -[.description] --- -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. - -See link:{hibernate-search-docs-url}#backend-elasticsearch-configuration-index-settings[this section of the reference documentation] -for more information. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_SETTINGS_FILE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_SETTINGS_FILE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-mapping-file]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-mapping-file[quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".schema-management.mapping-file]` - -`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-mapping-file[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".schema-management.mapping-file]` - -`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-mapping-file[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexes."index-name".schema-management.mapping-file]` - -`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-mapping-file[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexes."index-name".schema-management.mapping-file]` - - -[.description] --- -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. - -See link:{hibernate-search-docs-url}#backend-elasticsearch-mapping-custom[this section of the reference documentation] -for more information. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_MAPPING_FILE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_MAPPING_FILE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-analysis-configurer]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-analysis-configurer[quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".analysis.configurer]` - -`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-analysis-configurer[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".analysis.configurer]` - -`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-analysis-configurer[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexes."index-name".analysis.configurer]` - -`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-analysis-configurer[quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexes."index-name".analysis.configurer]` - - -[.description] --- -One or more xref:hibernate-search-orm-elasticsearch.adoc#bean-reference-note-anchor[bean references] -to the component(s) used to configure full text analysis (e.g. analyzers, normalizers). - -The referenced beans must implement `ElasticsearchAnalysisConfigurer`. - -See xref:hibernate-search-orm-elasticsearch.adoc#analysis-configurer[Setting up the analyzers] for more -information. - -[NOTE] -==== -Instead of setting this configuration property, -you can simply annotate your custom `ElasticsearchAnalysisConfigurer` implementations with `@SearchExtension` -and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically. -See xref:hibernate-search-orm-elasticsearch.adoc#plugging-in-custom-components[this section] -for more information. - -If this configuration property is set, it takes precedence over any `@SearchExtension` annotation. -==== - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__ANALYSIS_CONFIGURER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__ANALYSIS_CONFIGURER+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - a| [[quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status]]`link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status[quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".schema-management.required-status]` `link:#quarkus-hibernate-search-orm-hibernate-search-elasticsearch-runtime-config_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-schema-management-required-status[quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".schema-management.required-status]` diff --git a/_generated-doc/main/config/quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config.adoc b/_generated-doc/main/config/quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config.adoc index 7153c0eae8..08edb770c6 100644 --- a/_generated-doc/main/config/quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config.adoc +++ b/_generated-doc/main/config/quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config.adoc @@ -26,541 +26,4 @@ endif::add-copy-button-to-env-var[] --|boolean |`true` - -a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-cache-prepared-statements]]`link:#quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-cache-prepared-statements[quarkus.datasource."datasource-name".reactive.cache-prepared-statements]` - - -[.description] --- -Whether prepared statements should be cached on the client side. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_CACHE_PREPARED_STATEMENTS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_CACHE_PREPARED_STATEMENTS+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-url]]`link:#quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-url[quarkus.datasource."datasource-name".reactive.url]` - - -[.description] --- -The datasource URLs. - -If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses round-robin load balancing for server selection during connection establishment. Note that certain drivers might not accommodate multiple values in this context. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_URL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_URL+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-max-size]]`link:#quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-max-size[quarkus.datasource."datasource-name".reactive.max-size]` - - -[.description] --- -The datasource pool maximum size. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_MAX_SIZE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_MAX_SIZE+++` -endif::add-copy-button-to-env-var[] ---|int -|`20` - - -a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-event-loop-size]]`link:#quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-event-loop-size[quarkus.datasource."datasource-name".reactive.event-loop-size]` - - -[.description] --- -When a new connection object is created, the pool assigns it an event loop. - -When `++#++event-loop-size` is set to a strictly positive value, the pool assigns as many event loops as specified, in a round-robin fashion. By default, the number of event loops configured or calculated by Quarkus is used. If `++#++event-loop-size` is set to zero or a negative value, the pool assigns the current event loop to the new connection. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_EVENT_LOOP_SIZE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_EVENT_LOOP_SIZE+++` -endif::add-copy-button-to-env-var[] ---|int -| - - -a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-trust-all]]`link:#quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-trust-all[quarkus.datasource."datasource-name".reactive.trust-all]` - - -[.description] --- -Whether all server certificates should be trusted. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_ALL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_ALL+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-trust-certificate-pem]]`link:#quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-trust-certificate-pem[quarkus.datasource."datasource-name".reactive.trust-certificate-pem]` - - -[.description] --- -PEM Trust config is disabled by default. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PEM+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PEM+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-trust-certificate-pem-certs]]`link:#quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-trust-certificate-pem-certs[quarkus.datasource."datasource-name".reactive.trust-certificate-pem.certs]` - - -[.description] --- -Comma-separated list of the trust certificate files (Pem format). - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PEM_CERTS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PEM_CERTS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-trust-certificate-jks]]`link:#quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-trust-certificate-jks[quarkus.datasource."datasource-name".reactive.trust-certificate-jks]` - - -[.description] --- -JKS config is disabled by default. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-trust-certificate-jks-path]]`link:#quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-trust-certificate-jks-path[quarkus.datasource."datasource-name".reactive.trust-certificate-jks.path]` - - -[.description] --- -Path of the key file (JKS format). - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS_PATH+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS_PATH+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-trust-certificate-jks-password]]`link:#quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-trust-certificate-jks-password[quarkus.datasource."datasource-name".reactive.trust-certificate-jks.password]` - - -[.description] --- -Password of the key file. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-trust-certificate-pfx]]`link:#quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-trust-certificate-pfx[quarkus.datasource."datasource-name".reactive.trust-certificate-pfx]` - - -[.description] --- -PFX config is disabled by default. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-trust-certificate-pfx-path]]`link:#quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-trust-certificate-pfx-path[quarkus.datasource."datasource-name".reactive.trust-certificate-pfx.path]` - - -[.description] --- -Path to the key file (PFX format). - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX_PATH+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX_PATH+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-trust-certificate-pfx-password]]`link:#quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-trust-certificate-pfx-password[quarkus.datasource."datasource-name".reactive.trust-certificate-pfx.password]` - - -[.description] --- -Password of the key. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-pem]]`link:#quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-pem[quarkus.datasource."datasource-name".reactive.key-certificate-pem]` - - -[.description] --- -PEM Key/cert config is disabled by default. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-pem-keys]]`link:#quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-pem-keys[quarkus.datasource."datasource-name".reactive.key-certificate-pem.keys]` - - -[.description] --- -Comma-separated list of the path to the key files (Pem format). - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM_KEYS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM_KEYS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-pem-certs]]`link:#quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-pem-certs[quarkus.datasource."datasource-name".reactive.key-certificate-pem.certs]` - - -[.description] --- -Comma-separated list of the path to the certificate files (Pem format). - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM_CERTS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM_CERTS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-jks]]`link:#quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-jks[quarkus.datasource."datasource-name".reactive.key-certificate-jks]` - - -[.description] --- -JKS config is disabled by default. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-jks-path]]`link:#quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-jks-path[quarkus.datasource."datasource-name".reactive.key-certificate-jks.path]` - - -[.description] --- -Path of the key file (JKS format). - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS_PATH+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS_PATH+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-jks-password]]`link:#quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-jks-password[quarkus.datasource."datasource-name".reactive.key-certificate-jks.password]` - - -[.description] --- -Password of the key file. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-pfx]]`link:#quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-pfx[quarkus.datasource."datasource-name".reactive.key-certificate-pfx]` - - -[.description] --- -PFX config is disabled by default. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-pfx-path]]`link:#quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-pfx-path[quarkus.datasource."datasource-name".reactive.key-certificate-pfx.path]` - - -[.description] --- -Path to the key file (PFX format). - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX_PATH+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX_PATH+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-pfx-password]]`link:#quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-key-certificate-pfx-password[quarkus.datasource."datasource-name".reactive.key-certificate-pfx.password]` - - -[.description] --- -Password of the key. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-reconnect-attempts]]`link:#quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-reconnect-attempts[quarkus.datasource."datasource-name".reactive.reconnect-attempts]` - - -[.description] --- -The number of reconnection attempts when a pooled connection cannot be established on first try. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_RECONNECT_ATTEMPTS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_RECONNECT_ATTEMPTS+++` -endif::add-copy-button-to-env-var[] ---|int -|`0` - - -a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-reconnect-interval]]`link:#quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-reconnect-interval[quarkus.datasource."datasource-name".reactive.reconnect-interval]` - - -[.description] --- -The interval between reconnection attempts when a pooled connection cannot be established on first try. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_RECONNECT_INTERVAL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_RECONNECT_INTERVAL+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`PT1S` - - -a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-hostname-verification-algorithm]]`link:#quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-hostname-verification-algorithm[quarkus.datasource."datasource-name".reactive.hostname-verification-algorithm]` - - -[.description] --- -The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS`, `LDAPS` or `NONE`. `NONE` is the default value and disables the verification. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_HOSTNAME_VERIFICATION_ALGORITHM+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_HOSTNAME_VERIFICATION_ALGORITHM+++` -endif::add-copy-button-to-env-var[] ---|string -|`NONE` - - -a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-idle-timeout]]`link:#quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-idle-timeout[quarkus.datasource."datasource-name".reactive.idle-timeout]` - - -[.description] --- -The maximum time a connection remains unused in the pool before it is closed. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_IDLE_TIMEOUT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_IDLE_TIMEOUT+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`no timeout` - - -a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-max-lifetime]]`link:#quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-max-lifetime[quarkus.datasource."datasource-name".reactive.max-lifetime]` - - -[.description] --- -The maximum time a connection remains in the pool, after which it will be closed upon return and replaced as necessary. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_MAX_LIFETIME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_MAX_LIFETIME+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`no timeout` - - -a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-shared]]`link:#quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-shared[quarkus.datasource."datasource-name".reactive.shared]` - - -[.description] --- -Set to true to share the pool among datasources. There can be multiple shared pools distinguished by name, when no specific name is set, the `__vertx.DEFAULT` name is used. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_SHARED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_SHARED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-name]]`link:#quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-name[quarkus.datasource."datasource-name".reactive.name]` - - -[.description] --- -Set the pool name, used when the pool is shared among datasources, otherwise ignored. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_NAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_NAME+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-additional-properties-property-key]]`link:#quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config_quarkus-datasource-datasource-name-reactive-additional-properties-property-key[quarkus.datasource."datasource-name".reactive.additional-properties."property-key"]` - - -[.description] --- -Other unspecified properties to be passed through the Reactive SQL Client directly to the database when new connections are initiated. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_ADDITIONAL_PROPERTIES__PROPERTY_KEY_+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_ADDITIONAL_PROPERTIES__PROPERTY_KEY_+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] - -| - -|=== -ifndef::no-duration-note[] -[NOTE] -[id='duration-note-anchor-{summaryTableId}'] -.About the Duration format -==== -To write duration values, use the standard `java.time.Duration` format. -See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. - -You can also use a simplified format, starting with a number: - -* If the value is only a number, it represents time in seconds. -* If the value is a number followed by `ms`, it represents time in milliseconds. - -In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: - -* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. -* If the value is a number followed by `d`, it is prefixed with `P`. -==== -endif::no-duration-note[] +|=== \ No newline at end of file diff --git a/_generated-doc/main/config/quarkus-reactive-datasource-config-group-data-sources-reactive-runtime-config-data-source-reactive-outer-named-runtime-config.adoc b/_generated-doc/main/config/quarkus-reactive-datasource-config-group-data-sources-reactive-runtime-config-data-source-reactive-outer-named-runtime-config.adoc index 38bc6f8158..3633e63aae 100644 --- a/_generated-doc/main/config/quarkus-reactive-datasource-config-group-data-sources-reactive-runtime-config-data-source-reactive-outer-named-runtime-config.adoc +++ b/_generated-doc/main/config/quarkus-reactive-datasource-config-group-data-sources-reactive-runtime-config-data-source-reactive-outer-named-runtime-config.adoc @@ -10,6 +10,23 @@ h|[[quarkus-reactive-datasource-config-group-data-sources-reactive-runtime-confi h|Type h|Default +a|icon:lock[title=Fixed at build time] [[quarkus-reactive-datasource-config-group-data-sources-reactive-runtime-config-data-source-reactive-outer-named-runtime-config_quarkus-datasource-datasource-name-reactive]]`link:#quarkus-reactive-datasource-config-group-data-sources-reactive-runtime-config-data-source-reactive-outer-named-runtime-config_quarkus-datasource-datasource-name-reactive[quarkus.datasource."datasource-name".reactive]` + + +[.description] +-- +If we create a Reactive datasource for this datasource. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-runtime-config-data-source-reactive-outer-named-runtime-config_quarkus-datasource-datasource-name-reactive-cache-prepared-statements]]`link:#quarkus-reactive-datasource-config-group-data-sources-reactive-runtime-config-data-source-reactive-outer-named-runtime-config_quarkus-datasource-datasource-name-reactive-cache-prepared-statements[quarkus.datasource."datasource-name".reactive.cache-prepared-statements]` diff --git a/_generated-doc/main/config/quarkus-rest-jackson-optimization-processor-jackson-optimization-config.adoc b/_generated-doc/main/config/quarkus-rest-jackson-optimization-processor-jackson-optimization-config.adoc new file mode 100644 index 0000000000..8a4403d5ed --- /dev/null +++ b/_generated-doc/main/config/quarkus-rest-jackson-optimization-processor-jackson-optimization-config.adoc @@ -0,0 +1,29 @@ + +:summaryTableId: quarkus-rest-jackson-optimization-processor-jackson-optimization-config +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference, cols="80,.^10,.^10"] +|=== + +h|[[quarkus-rest-jackson-optimization-processor-jackson-optimization-config_configuration]]link:#quarkus-rest-jackson-optimization-processor-jackson-optimization-config_configuration[Configuration property] + +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-rest-jackson-optimization-processor-jackson-optimization-config_quarkus-rest-jackson-optimization-enable-reflection-free-serializers]]`link:#quarkus-rest-jackson-optimization-processor-jackson-optimization-config_quarkus-rest-jackson-optimization-enable-reflection-free-serializers[quarkus.rest.jackson.optimization.enable-reflection-free-serializers]` + + +[.description] +-- +Enable build time generation of reflection-free Jackson serializers. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REST_JACKSON_OPTIMIZATION_ENABLE_REFLECTION_FREE_SERIALIZERS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REST_JACKSON_OPTIMIZATION_ENABLE_REFLECTION_FREE_SERIALIZERS+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + +|=== \ No newline at end of file diff --git a/_generated-doc/main/config/quarkus-resteasy-reactive-jackson.adoc b/_generated-doc/main/config/quarkus-resteasy-reactive-jackson.adoc new file mode 100644 index 0000000000..a1c5b85dfd --- /dev/null +++ b/_generated-doc/main/config/quarkus-resteasy-reactive-jackson.adoc @@ -0,0 +1,29 @@ + +:summaryTableId: quarkus-resteasy-reactive-jackson +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[[quarkus-resteasy-reactive-jackson_configuration]]link:#quarkus-resteasy-reactive-jackson_configuration[Configuration property] + +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-resteasy-reactive-jackson_quarkus-rest-jackson-optimization-enable-reflection-free-serializers]]`link:#quarkus-resteasy-reactive-jackson_quarkus-rest-jackson-optimization-enable-reflection-free-serializers[quarkus.rest.jackson.optimization.enable-reflection-free-serializers]` + + +[.description] +-- +Enable build time generation of reflection-free Jackson serializers. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REST_JACKSON_OPTIMIZATION_ENABLE_REFLECTION_FREE_SERIALIZERS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REST_JACKSON_OPTIMIZATION_ENABLE_REFLECTION_FREE_SERIALIZERS+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + +|=== \ No newline at end of file diff --git a/_versions/main/guides/qute-reference.adoc b/_versions/main/guides/qute-reference.adoc index f93422a0e1..9eb8dd6cc2 100644 --- a/_versions/main/guides/qute-reference.adoc +++ b/_versions/main/guides/qute-reference.adoc @@ -10,6 +10,7 @@ include::_attributes.adoc[] :numbered: :sectnums: :sectnumlevels: 4 +:toclevels: 3 :topics: templating,qute :extensions: io.quarkus:quarkus-qute,io.quarkus:quarkus-resteasy-qute,io.quarkus:quarkus-rest-qute diff --git a/_versions/main/guides/rest.adoc b/_versions/main/guides/rest.adoc index 7a45e13eac..e38650b354 100644 --- a/_versions/main/guides/rest.adoc +++ b/_versions/main/guides/rest.adoc @@ -1581,6 +1581,12 @@ public User userPrivate() { When the result the `userPublic` method is serialized, the `id` field will not be contained in the response as the `Public` view does not include it. The result of `userPrivate` however will include the `id` as expected when serialized. +===== Reflection-free Jackson serialization + +Out-of-the-box Jackson serialization converts objects into their JSON representation by introspecting them through a heavy use of reflection. However, the general Quarkus philosophy is to avoid reflection as much as possible, often replacing it with build time code generation. For this reason it is possible to automatically generate at build time implementations of the Jackson `StdSerializer`, one for each class to be converted in JSON. These generated serializers can be subsequently used by Quarkus at runtime to perform the JSON serialization of the objects returned by a REST endpoint without any use of reflection. + +This feature is turned off by default, but it can be enabled by setting the configuration property `quarkus.rest.jackson.optimization.enable-reflection-free-serializers=true`. + ===== Completely customized per method serialization/deserialization There are times when you need to completely customize the serialization/deserialization of a POJO on a per Jakarta REST method basis or on a per Jakarta REST resource basis. For such use cases, you can use the `@io.quarkus.resteasy.reactive.jackson.CustomSerialization` and `@io.quarkus.resteasy.reactive.jackson.CustomDeserialization` annotations in the REST method or in the REST resource at class level. These annotations allow you to fully configure the `com.fasterxml.jackson.databind.ObjectWriter`/`com.fasterxml.jackson.databind.ObjectReader`. diff --git a/_versions/main/guides/scripting.adoc b/_versions/main/guides/scripting.adoc index c2ea4bddbe..6f0fe640c3 100644 --- a/_versions/main/guides/scripting.adoc +++ b/_versions/main/guides/scripting.adoc @@ -112,7 +112,7 @@ The next lines [source,java] ---- -// //DEPS +//DEPS ---- illustrate how you add dependencies to this script. This is a feature of JBang.