From b652a3b1a5c70c9bb8281ca8fc4d8be0bb6d89cb Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Fri, 3 Nov 2023 01:51:40 +0000 Subject: [PATCH] Sync documentation of main branch --- ...y.runtime.config.runtime.OTelRuntimeConfig | 2 +- .../main/config/quarkus-all-config.adoc | 18 + _generated-doc/main/config/quarkus-core.adoc | 38 +- ...ta-sources-reactive-build-time-config.adoc | 538 +++++++++- ...-data-sources-reactive-runtime-config.adoc | 17 - ...-config-hibernate-orm-config-database.adoc | 85 ++ ...e-orm-config-hibernate-orm-config-log.adoc | 70 ++ ...hibernate-orm-config-persistence-unit.adoc | 272 +++++ ...us-hibernate-orm-general-config-items.adoc | 936 +++++++++--------- ...us-hibernate-orm-hibernate-orm-config.adoc | 427 ++++++++ .../main/config/quarkus-hibernate-orm.adoc | 936 +++++++++--------- ...asticsearch-backend-build-time-config.adoc | 161 ++- ...ch-build-time-config-persistence-unit.adoc | 648 +++++++++++- ...-elasticsearch-backend-runtime-config.adoc | 98 -- ...earch-runtime-config-persistence-unit.adoc | 277 ------ ...earch-elasticsearch-build-time-config.adoc | 648 +++++++++++- ...e-search-elasticsearch-runtime-config.adoc | 277 ------ .../main/config/quarkus-opentelemetry.adoc | 18 + ...l-config-runtime-o-tel-runtime-config.adoc | 18 + ...eactive-outer-named-build-time-config.adoc | 538 +++++++++- ...e-reactive-outer-named-runtime-config.adoc | 17 - _versions/main/guides/datasource.adoc | 10 +- _versions/main/guides/logging.adoc | 8 +- 23 files changed, 4401 insertions(+), 1656 deletions(-) diff --git a/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.opentelemetry.runtime.config.runtime.OTelRuntimeConfig b/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.opentelemetry.runtime.config.runtime.OTelRuntimeConfig index 2633e35962..f9946ccf8c 100644 --- a/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.opentelemetry.runtime.config.runtime.OTelRuntimeConfig +++ b/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.opentelemetry.runtime.config.runtime.OTelRuntimeConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"boolean","key":"quarkus.otel.sdk.disabled","additionalKeys":[],"configDoc":"If true, disable the OpenTelemetry SDK. Runtime configuration.\n\nDefaults to `false`.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"sdk-disabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.otel.traces.suppress-non-application-uris","additionalKeys":[],"configDoc":"Suppress non-application uris from trace collection. This will suppress tracing of `/q` endpoints.\n\nProviding a custom `io.opentelemetry.sdk.trace.samplers.Sampler` CDI Bean will ignore this setting.\n\nThis is a Quarkus specific property. Suppressing non-application uris is enabled by default.\n\nFallbacks to the legacy property `quarkus.opentelemetry.tracer.suppress-non-application-uris` or defaults to `true`.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"suppress-non-application-uris","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.otel.traces.include-static-resources","additionalKeys":[],"configDoc":"Include static resources from trace collection.\n\nThis is a Quarkus specific property. Include static resources is disabled by default. Providing a custom `io.opentelemetry.sdk.trace.samplers.Sampler` CDI Bean will ignore this setting.\n\nFallbacks to the legacy property `quarkus.opentelemetry.tracer.include-static-resources` or defaults to `false`.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"include-static-resources","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.traces.sampler.arg","additionalKeys":[],"configDoc":"Sampler argument. Depends on the `quarkus.otel.traces.sampler` property. Fallbacks to the legacy property `quarkus.opentelemetry.tracer.sampler.ratio`.\n\nWhen setting the stock sampler to `traceidratio` or `parentbased_traceidratio` you need to set a `double` compatible value between `0.0d` and `1.0d`, like `0.01d` or `0.5d`. It is kept as a `String` to allow the flexible customisation of alternative samplers.\n\nDefaults to `1.0d`.","withinAMap":false,"defaultValue":"1.0d","javaDocSiteLink":"","docMapKey":"sampler-arg","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.attribute.value.length.limit","additionalKeys":[],"configDoc":"The maximum length of attribute values. Applies to spans and logs.\n\nBy default, there is no limit.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"value-length-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.otel.attribute.count.limit","additionalKeys":[],"configDoc":"The maximum number of attributes. Applies to spans, span events, span links, and logs.\n\nDefault is `128`.","withinAMap":false,"defaultValue":"128","javaDocSiteLink":"","docMapKey":"count-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.otel.span.attribute.value.length.limit","additionalKeys":[],"configDoc":"The maximum length of span attribute values. Takes precedence over `otel.attribute.value.length.limit`.\n\nBy default, there is no limit.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"attribute-value-length-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.otel.span.attribute.count.limit","additionalKeys":[],"configDoc":"The maximum number of attributes per span. Takes precedence over `otel.attribute.count.limit`.\n\nDefault is `128`.","withinAMap":false,"defaultValue":"128","javaDocSiteLink":"","docMapKey":"attribute-count-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.otel.span.event.count.limit","additionalKeys":[],"configDoc":"The maximum number of events per span.\n\nDefault is `128`.","withinAMap":false,"defaultValue":"128","javaDocSiteLink":"","docMapKey":"event-count-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.otel.span.link.count.limit","additionalKeys":[],"configDoc":"The maximum number of links per span.\n\nDefault is `128`.","withinAMap":false,"defaultValue":"128","javaDocSiteLink":"","docMapKey":"link-count-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.otel.bsp.schedule.delay","additionalKeys":[],"configDoc":"The interval, in milliseconds, between two consecutive exports.\n\nDefault is `5000`.","withinAMap":false,"defaultValue":"5S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"schedule-delay","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.otel.bsp.max.queue.size","additionalKeys":[],"configDoc":"The maximum queue size.\n\nDefault is `2048`.","withinAMap":false,"defaultValue":"2048","javaDocSiteLink":"","docMapKey":"max-queue-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.otel.bsp.max.export.batch.size","additionalKeys":[],"configDoc":"The maximum batch size.\n\nDefault is `512`.","withinAMap":false,"defaultValue":"512","javaDocSiteLink":"","docMapKey":"max-export-batch-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.otel.bsp.export.timeout","additionalKeys":[],"configDoc":"The maximum allowed time, in milliseconds, to export data.\n\nDefault is `30s`.","withinAMap":false,"defaultValue":"30S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"export-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.resource.attributes","additionalKeys":[],"configDoc":"Specify resource attributes in the following format: `key1=val1,key2=val2,key3=val3`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"resource-attributes","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.service.name","additionalKeys":[],"configDoc":"Specify logical service name. Takes precedence over service.name defined with otel.resource.attributes and from quarkus.application.name.\n\nDefaults to `quarkus.application.name`.","withinAMap":false,"defaultValue":"${quarkus.application.name:unset}","javaDocSiteLink":"","docMapKey":"service-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.experimental.resource.disabled-keys","additionalKeys":[],"configDoc":"Specify resource attribute keys that are filtered.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"experimental-resource-disabled-keys","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.otel","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"boolean","key":"quarkus.otel.sdk.disabled","additionalKeys":[],"configDoc":"If true, disable the OpenTelemetry SDK. Runtime configuration.\n\nDefaults to `false`.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"sdk-disabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.otel.traces.suppress-non-application-uris","additionalKeys":[],"configDoc":"Suppress non-application uris from trace collection. This will suppress tracing of `/q` endpoints.\n\nProviding a custom `io.opentelemetry.sdk.trace.samplers.Sampler` CDI Bean will ignore this setting.\n\nThis is a Quarkus specific property. Suppressing non-application uris is enabled by default.\n\nFallbacks to the legacy property `quarkus.opentelemetry.tracer.suppress-non-application-uris` or defaults to `true`.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"suppress-non-application-uris","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.otel.traces.include-static-resources","additionalKeys":[],"configDoc":"Include static resources from trace collection.\n\nThis is a Quarkus specific property. Include static resources is disabled by default. Providing a custom `io.opentelemetry.sdk.trace.samplers.Sampler` CDI Bean will ignore this setting.\n\nFallbacks to the legacy property `quarkus.opentelemetry.tracer.include-static-resources` or defaults to `false`.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"include-static-resources","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.traces.sampler.arg","additionalKeys":[],"configDoc":"Sampler argument. Depends on the `quarkus.otel.traces.sampler` property. Fallbacks to the legacy property `quarkus.opentelemetry.tracer.sampler.ratio`.\n\nWhen setting the stock sampler to `traceidratio` or `parentbased_traceidratio` you need to set a `double` compatible value between `0.0d` and `1.0d`, like `0.01d` or `0.5d`. It is kept as a `String` to allow the flexible customisation of alternative samplers.\n\nDefaults to `1.0d`.","withinAMap":false,"defaultValue":"1.0d","javaDocSiteLink":"","docMapKey":"sampler-arg","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.attribute.value.length.limit","additionalKeys":[],"configDoc":"The maximum length of attribute values. Applies to spans and logs.\n\nBy default, there is no limit.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"value-length-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.otel.attribute.count.limit","additionalKeys":[],"configDoc":"The maximum number of attributes. Applies to spans, span events, span links, and logs.\n\nDefault is `128`.","withinAMap":false,"defaultValue":"128","javaDocSiteLink":"","docMapKey":"count-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.otel.span.attribute.value.length.limit","additionalKeys":[],"configDoc":"The maximum length of span attribute values. Takes precedence over `otel.attribute.value.length.limit`.\n\nBy default, there is no limit.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"attribute-value-length-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.otel.span.attribute.count.limit","additionalKeys":[],"configDoc":"The maximum number of attributes per span. Takes precedence over `otel.attribute.count.limit`.\n\nDefault is `128`.","withinAMap":false,"defaultValue":"128","javaDocSiteLink":"","docMapKey":"attribute-count-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.otel.span.event.count.limit","additionalKeys":[],"configDoc":"The maximum number of events per span.\n\nDefault is `128`.","withinAMap":false,"defaultValue":"128","javaDocSiteLink":"","docMapKey":"event-count-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.otel.span.link.count.limit","additionalKeys":[],"configDoc":"The maximum number of links per span.\n\nDefault is `128`.","withinAMap":false,"defaultValue":"128","javaDocSiteLink":"","docMapKey":"link-count-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.otel.bsp.schedule.delay","additionalKeys":[],"configDoc":"The interval, in milliseconds, between two consecutive exports.\n\nDefault is `5000`.","withinAMap":false,"defaultValue":"5S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"schedule-delay","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.otel.bsp.max.queue.size","additionalKeys":[],"configDoc":"The maximum queue size.\n\nDefault is `2048`.","withinAMap":false,"defaultValue":"2048","javaDocSiteLink":"","docMapKey":"max-queue-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.otel.bsp.max.export.batch.size","additionalKeys":[],"configDoc":"The maximum batch size.\n\nDefault is `512`.","withinAMap":false,"defaultValue":"512","javaDocSiteLink":"","docMapKey":"max-export-batch-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.otel.bsp.export.timeout","additionalKeys":[],"configDoc":"The maximum allowed time, in milliseconds, to export data.\n\nDefault is `30s`.","withinAMap":false,"defaultValue":"30S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"export-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.resource.attributes","additionalKeys":[],"configDoc":"Specify resource attributes in the following format: `key1=val1,key2=val2,key3=val3`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"resource-attributes","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.service.name","additionalKeys":[],"configDoc":"Specify logical service name. Takes precedence over service.name defined with otel.resource.attributes and from quarkus.application.name.\n\nDefaults to `quarkus.application.name`.","withinAMap":false,"defaultValue":"${quarkus.application.name:unset}","javaDocSiteLink":"","docMapKey":"service-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.experimental.resource.disabled-keys","additionalKeys":[],"configDoc":"Specify resource attribute keys that are filtered.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"experimental-resource-disabled-keys","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.otel.experimental.shutdown-wait-time","additionalKeys":[],"configDoc":"The maximum amount of time Quarkus will wait for the OpenTelemetry SDK to flush unsent spans and shutdown.","withinAMap":false,"defaultValue":"1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"experimental-shutdown-wait-time","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.otel","enum":false}}] \ 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 27e2729cb8..eab8aed894 100644 --- a/_generated-doc/main/config/quarkus-all-config.adoc +++ b/_generated-doc/main/config/quarkus-all-config.adoc @@ -51470,6 +51470,24 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-opentelemetry_quarkus.otel.experimental.shutdown-wait-time]]`link:#quarkus-opentelemetry_quarkus.otel.experimental.shutdown-wait-time[quarkus.otel.experimental.shutdown-wait-time]` + + +[.description] +-- +The maximum amount of time Quarkus will wait for the OpenTelemetry SDK to flush unsent spans and shutdown. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPERIMENTAL_SHUTDOWN_WAIT_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPERIMENTAL_SHUTDOWN_WAIT_TIME+++` +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-opentelemetry_quarkus.otel.exporter.otlp.endpoint]]`link:#quarkus-opentelemetry_quarkus.otel.exporter.otlp.endpoint[quarkus.otel.exporter.otlp.endpoint]` diff --git a/_generated-doc/main/config/quarkus-core.adoc b/_generated-doc/main/config/quarkus-core.adoc index 45912fce13..dca2216ecf 100644 --- a/_generated-doc/main/config/quarkus-core.adoc +++ b/_generated-doc/main/config/quarkus-core.adoc @@ -75,6 +75,25 @@ endif::add-copy-button-to-env-var[] |`Build system locale` +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]` @@ -197,25 +216,6 @@ endif::add-copy-button-to-env-var[] |`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 011e49c488..8f3eb6c111 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,4 +48,540 @@ endif::add-copy-button-to-env-var[] --|boolean |`true` -|=== \ No newline at end of file + +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 a round-robin load balancing when a connection is created to select different servers. Note: some driver may not support multiple values here. + +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 an empty string. + +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 +| + + +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-additional-properties]]`link:#quarkus-datasource-data-sources-reactive-build-time-config_quarkus.datasource.-datasource-name-.reactive.additional-properties-additional-properties[quarkus.datasource."datasource-name".reactive.additional-properties]` + + +[.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+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_ADDITIONAL_PROPERTIES+++` +endif::add-copy-button-to-env-var[] +--|`Map` +| + +|=== +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/11/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() javadoc] 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-datasource-data-sources-reactive-runtime-config.adoc b/_generated-doc/main/config/quarkus-datasource-data-sources-reactive-runtime-config.adoc index efacdee4e2..dd6537077a 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 @@ -532,23 +532,6 @@ 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-orm-config-group-hibernate-orm-config-hibernate-orm-config-database.adoc b/_generated-doc/main/config/quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database.adoc index c2ace4c10b..5476ede14f 100644 --- a/_generated-doc/main/config/quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database.adoc +++ b/_generated-doc/main/config/quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database.adoc @@ -65,4 +65,89 @@ endif::add-copy-button-to-env-var[] |`UTF-8` + +a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database_quarkus.hibernate-orm.database.generation]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database_quarkus.hibernate-orm.database.generation[quarkus.hibernate-orm.database.generation]` + + +[.description] +-- +Select whether the database schema is generated or not. `drop-and-create` is awesome in development mode. This defaults to 'none', however if Dev Services is in use and no other extensions that manage the schema are present this will default to 'drop-and-create'. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION+++` +endif::add-copy-button-to-env-var[] +--|string +|`none` + + +a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database_quarkus.hibernate-orm.database.generation.create-schemas]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database_quarkus.hibernate-orm.database.generation.create-schemas[quarkus.hibernate-orm.database.generation.create-schemas]` + + +[.description] +-- +If Hibernate ORM should create the schemas automatically (for databases supporting them). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_CREATE_SCHEMAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_CREATE_SCHEMAS+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database_quarkus.hibernate-orm.database.generation.halt-on-error]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database_quarkus.hibernate-orm.database.generation.halt-on-error[quarkus.hibernate-orm.database.generation.halt-on-error]` + + +[.description] +-- +Whether we should stop on the first error when applying the schema. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_HALT_ON_ERROR+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_HALT_ON_ERROR+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database_quarkus.hibernate-orm.database.default-catalog]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database_quarkus.hibernate-orm.database.default-catalog[quarkus.hibernate-orm.database.default-catalog]` + + +[.description] +-- +The default catalog to use for the database objects. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_CATALOG+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_CATALOG+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database_quarkus.hibernate-orm.database.default-schema]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database_quarkus.hibernate-orm.database.default-schema[quarkus.hibernate-orm.database.default-schema]` + + +[.description] +-- +The default schema to use for the database objects. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_SCHEMA+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_SCHEMA+++` +endif::add-copy-button-to-env-var[] +--|string +| + |=== \ No newline at end of file diff --git a/_generated-doc/main/config/quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log.adoc b/_generated-doc/main/config/quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log.adoc index 45220df5b7..eac64f791e 100644 --- a/_generated-doc/main/config/quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log.adoc +++ b/_generated-doc/main/config/quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log.adoc @@ -28,4 +28,74 @@ endif::add-copy-button-to-env-var[] --|boolean |`false` + +a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log_quarkus.hibernate-orm.log.sql]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log_quarkus.hibernate-orm.log.sql[quarkus.hibernate-orm.log.sql]` + + +[.description] +-- +Show SQL logs and format them nicely. + +Setting it to true is obviously not recommended in production. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_SQL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_SQL+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log_quarkus.hibernate-orm.log.format-sql]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log_quarkus.hibernate-orm.log.format-sql[quarkus.hibernate-orm.log.format-sql]` + + +[.description] +-- +Format the SQL logs if SQL log is enabled + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_FORMAT_SQL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_FORMAT_SQL+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log_quarkus.hibernate-orm.log.jdbc-warnings]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log_quarkus.hibernate-orm.log.jdbc-warnings[quarkus.hibernate-orm.log.jdbc-warnings]` + + +[.description] +-- +Whether JDBC warnings should be collected and logged. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_JDBC_WARNINGS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_JDBC_WARNINGS+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`depends on dialect` + + +a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log_quarkus.hibernate-orm.log.queries-slower-than-ms]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log_quarkus.hibernate-orm.log.queries-slower-than-ms[quarkus.hibernate-orm.log.queries-slower-than-ms]` + + +[.description] +-- +If set, Hibernate will log queries that took more than specified number of milliseconds to execute. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_QUERIES_SLOWER_THAN_MS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_QUERIES_SLOWER_THAN_MS+++` +endif::add-copy-button-to-env-var[] +--|long +| + |=== \ No newline at end of file diff --git a/_generated-doc/main/config/quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit.adoc b/_generated-doc/main/config/quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit.adoc index b962fca101..95bcb161e7 100644 --- a/_generated-doc/main/config/quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit.adoc +++ b/_generated-doc/main/config/quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit.adoc @@ -954,6 +954,62 @@ endif::add-copy-button-to-env-var[] |`true` +a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.active]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.active[quarkus.hibernate-orm."persistence-unit-name".active]` + + +[.description] +-- +Whether this persistence unit should be active at runtime. + +If the persistence unit is not active, it won't start with the application, +and accessing the corresponding EntityManagerFactory/EntityManager or SessionFactory/Session +will not be possible. + +Note that if Hibernate ORM is disabled (i.e. `quarkus.hibernate-orm.enabled` is set to `false`), +all persistence units are deactivated, and setting this property to `true` will fail. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__ACTIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__ACTIVE+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`'true' if Hibernate ORM is enabled; 'false' otherwise` + + +a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.unsupported-properties-full-property-key]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.unsupported-properties-full-property-key[quarkus.hibernate-orm."persistence-unit-name".unsupported-properties]` + + +[.description] +-- +Properties that should be passed on directly to Hibernate ORM. +Use the full configuration property key here, +for instance `quarkus.hibernate-orm.unsupported-properties."hibernate.order_inserts" = true`. + +[WARNING] +==== +Properties set here are completely unsupported: +as Quarkus doesn't generally know about these properties and their purpose, +there is absolutely no guarantee that they will work correctly, +and even if they do, that may change when upgrading to a newer version of Quarkus +(even just a micro/patch version). +==== + +Consider using a supported configuration property before falling back to unsupported ones. +If none exists, make sure to file a feature request so that a supported configuration property can be added to Quarkus, +and more importantly so that the configuration property is tested regularly. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__UNSUPPORTED_PROPERTIES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__UNSUPPORTED_PROPERTIES+++` +endif::add-copy-button-to-env-var[] +--|`Map` +| + + h|[[quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.dialect-dialect-related-configuration]]link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.dialect-dialect-related-configuration[Dialect related configuration] h|Type @@ -1180,6 +1236,91 @@ endif::add-copy-button-to-env-var[] |`UTF-8` +a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.database.generation]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.database.generation[quarkus.hibernate-orm."persistence-unit-name".database.generation]` + + +[.description] +-- +Select whether the database schema is generated or not. `drop-and-create` is awesome in development mode. This defaults to 'none', however if Dev Services is in use and no other extensions that manage the schema are present this will default to 'drop-and-create'. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION+++` +endif::add-copy-button-to-env-var[] +--|string +|`none` + + +a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.database.generation.create-schemas]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.database.generation.create-schemas[quarkus.hibernate-orm."persistence-unit-name".database.generation.create-schemas]` + + +[.description] +-- +If Hibernate ORM should create the schemas automatically (for databases supporting them). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION_CREATE_SCHEMAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION_CREATE_SCHEMAS+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.database.generation.halt-on-error]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.database.generation.halt-on-error[quarkus.hibernate-orm."persistence-unit-name".database.generation.halt-on-error]` + + +[.description] +-- +Whether we should stop on the first error when applying the schema. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION_HALT_ON_ERROR+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION_HALT_ON_ERROR+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.database.default-catalog]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.database.default-catalog[quarkus.hibernate-orm."persistence-unit-name".database.default-catalog]` + + +[.description] +-- +The default catalog to use for the database objects. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_DEFAULT_CATALOG+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_DEFAULT_CATALOG+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.database.default-schema]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.database.default-schema[quarkus.hibernate-orm."persistence-unit-name".database.default-schema]` + + +[.description] +-- +The default schema to use for the database objects. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_DEFAULT_SCHEMA+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_DEFAULT_SCHEMA+++` +endif::add-copy-button-to-env-var[] +--|string +| + + h|[[quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.jdbc-jdbc-related-configuration]]link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.jdbc-jdbc-related-configuration[JDBC related configuration] h|Type @@ -1340,6 +1481,137 @@ endif::add-copy-button-to-env-var[] --|boolean |`false` + +h|[[quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.scripts-database-scripts-related-configuration]]link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.scripts-database-scripts-related-configuration[Database scripts related configuration] + +h|Type +h|Default + +a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation[quarkus.hibernate-orm."persistence-unit-name".scripts.generation]` + + +[.description] +-- +Select whether the database schema DDL files are generated or not. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION+++` +endif::add-copy-button-to-env-var[] +--|string +|`none` + + +a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation.create-target]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation.create-target[quarkus.hibernate-orm."persistence-unit-name".scripts.generation.create-target]` + + +[.description] +-- +Filename or URL where the database create DDL file should be generated. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION_CREATE_TARGET+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION_CREATE_TARGET+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation.drop-target]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation.drop-target[quarkus.hibernate-orm."persistence-unit-name".scripts.generation.drop-target]` + + +[.description] +-- +Filename or URL where the database drop DDL file should be generated. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION_DROP_TARGET+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION_DROP_TARGET+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.log-logging-configuration]]link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.log-logging-configuration[Logging configuration] + +h|Type +h|Default + +a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.log.sql]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.log.sql[quarkus.hibernate-orm."persistence-unit-name".log.sql]` + + +[.description] +-- +Show SQL logs and format them nicely. + +Setting it to true is obviously not recommended in production. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_SQL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_SQL+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.log.format-sql]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.log.format-sql[quarkus.hibernate-orm."persistence-unit-name".log.format-sql]` + + +[.description] +-- +Format the SQL logs if SQL log is enabled + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_FORMAT_SQL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_FORMAT_SQL+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.log.jdbc-warnings]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.log.jdbc-warnings[quarkus.hibernate-orm."persistence-unit-name".log.jdbc-warnings]` + + +[.description] +-- +Whether JDBC warnings should be collected and logged. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_JDBC_WARNINGS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_JDBC_WARNINGS+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`depends on dialect` + + +a| [[quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.log.queries-slower-than-ms]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-persistence-unit_quarkus.hibernate-orm.-persistence-unit-name-.log.queries-slower-than-ms[quarkus.hibernate-orm."persistence-unit-name".log.queries-slower-than-ms]` + + +[.description] +-- +If set, Hibernate will log queries that took more than specified number of milliseconds to execute. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_QUERIES_SLOWER_THAN_MS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_QUERIES_SLOWER_THAN_MS+++` +endif::add-copy-button-to-env-var[] +--|long +| + |=== ifndef::no-duration-note[] [NOTE] diff --git a/_generated-doc/main/config/quarkus-hibernate-orm-general-config-items.adoc b/_generated-doc/main/config/quarkus-hibernate-orm-general-config-items.adoc index dd0d7a6c53..8e4a1bcbf6 100644 --- a/_generated-doc/main/config/quarkus-hibernate-orm-general-config-items.adoc +++ b/_generated-doc/main/config/quarkus-hibernate-orm-general-config-items.adoc @@ -376,6 +376,152 @@ endif::add-copy-button-to-env-var[] | +h|[[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.database-database-related-configuration]]link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.database-database-related-configuration[Database related configuration] + +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.database.orm-compatibility.version]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.database.orm-compatibility.version[quarkus.hibernate-orm.database.orm-compatibility.version]` + + +[.description] +-- +When set, attempts to exchange data with the database +as the given version of Hibernate ORM would have, +*on a best-effort basis*. + +Please note: + +* schema validation may still fail in some cases: +this attempts to make Hibernate ORM 6+ behave correctly at runtime, +but it may still expect a different (but runtime-compatible) schema. +* robust test suites are still useful and recommended: +you should still check that your application behaves as intended with your legacy schema. +* this feature is inherently unstable: +some aspects of it may stop working in future versions of Quarkus, +and older versions will be dropped as Hibernate ORM changes pile up +and support for those older versions becomes too unreliable. +* you should still plan a migration of your schema to a newer version of Hibernate ORM. +For help with migration, refer to +link:https://github.com/quarkusio/quarkus/wiki/Migration-Guide-3.0:-Hibernate-ORM-5-to-6-migration[the Quarkus 3 +migration guide from Hibernate ORM 5 to 6]. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_ORM_COMPATIBILITY_VERSION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_ORM_COMPATIBILITY_VERSION+++` +endif::add-copy-button-to-env-var[] +-- a| +`5.6`, `latest` +|`latest` + + +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.database.charset]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.database.charset[quarkus.hibernate-orm.database.charset]` + + +[.description] +-- +The charset of the database. + +Used for DDL generation and also for the SQL import scripts. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_CHARSET+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_CHARSET+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html[Charset] + +|`UTF-8` + + +a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.database.generation]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.database.generation[quarkus.hibernate-orm.database.generation]` + + +[.description] +-- +Select whether the database schema is generated or not. `drop-and-create` is awesome in development mode. This defaults to 'none', however if Dev Services is in use and no other extensions that manage the schema are present this will default to 'drop-and-create'. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION+++` +endif::add-copy-button-to-env-var[] +--|string +|`none` + + +a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.database.generation.create-schemas]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.database.generation.create-schemas[quarkus.hibernate-orm.database.generation.create-schemas]` + + +[.description] +-- +If Hibernate ORM should create the schemas automatically (for databases supporting them). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_CREATE_SCHEMAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_CREATE_SCHEMAS+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.database.generation.halt-on-error]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.database.generation.halt-on-error[quarkus.hibernate-orm.database.generation.halt-on-error]` + + +[.description] +-- +Whether we should stop on the first error when applying the schema. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_HALT_ON_ERROR+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_HALT_ON_ERROR+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.database.default-catalog]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.database.default-catalog[quarkus.hibernate-orm.database.default-catalog]` + + +[.description] +-- +The default catalog to use for the database objects. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_CATALOG+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_CATALOG+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.database.default-schema]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.database.default-schema[quarkus.hibernate-orm.database.default-schema]` + + +[.description] +-- +The default schema to use for the database objects. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_SCHEMA+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_SCHEMA+++` +endif::add-copy-button-to-env-var[] +--|string +| + + h|[[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.dialect-dialect-related-configuration]]link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.dialect-dialect-related-configuration[Dialect related configuration] h|Type @@ -738,419 +884,123 @@ endif::add-copy-button-to-env-var[] |`false` -h|[[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.database-database-related-configuration]]link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.database-database-related-configuration[Database related configuration] +h|[[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.persistence-units-additional-named-persistence-units]]link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.persistence-units-additional-named-persistence-units[Additional named persistence units] h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.database.orm-compatibility.version]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.database.orm-compatibility.version[quarkus.hibernate-orm.database.orm-compatibility.version]` +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.datasource]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.datasource[quarkus.hibernate-orm."persistence-unit-name".datasource]` [.description] -- -When set, attempts to exchange data with the database -as the given version of Hibernate ORM would have, -*on a best-effort basis*. - -Please note: +The name of the datasource which this persistence unit uses. -* schema validation may still fail in some cases: -this attempts to make Hibernate ORM 6+ behave correctly at runtime, -but it may still expect a different (but runtime-compatible) schema. -* robust test suites are still useful and recommended: -you should still check that your application behaves as intended with your legacy schema. -* this feature is inherently unstable: -some aspects of it may stop working in future versions of Quarkus, -and older versions will be dropped as Hibernate ORM changes pile up -and support for those older versions becomes too unreliable. -* you should still plan a migration of your schema to a newer version of Hibernate ORM. -For help with migration, refer to -link:https://github.com/quarkusio/quarkus/wiki/Migration-Guide-3.0:-Hibernate-ORM-5-to-6-migration[the Quarkus 3 -migration guide from Hibernate ORM 5 to 6]. +If undefined, it will use the default datasource. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_ORM_COMPATIBILITY_VERSION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATASOURCE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_ORM_COMPATIBILITY_VERSION+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATASOURCE+++` endif::add-copy-button-to-env-var[] --- a| -`5.6`, `latest` -|`latest` +--|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.database.charset]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.database.charset[quarkus.hibernate-orm.database.charset]` +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.packages]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.packages[quarkus.hibernate-orm."persistence-unit-name".packages]` [.description] -- -The charset of the database. - -Used for DDL generation and also for the SQL import scripts. +The packages in which the entities affected to this persistence unit are located. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_CHARSET+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__PACKAGES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_CHARSET+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__PACKAGES+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html[Charset] - -|`UTF-8` +--|list of string +| -a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.database.generation]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.database.generation[quarkus.hibernate-orm.database.generation]` +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.sql-load-script]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.sql-load-script[quarkus.hibernate-orm."persistence-unit-name".sql-load-script]` [.description] -- -Select whether the database schema is generated or not. `drop-and-create` is awesome in development mode. This defaults to 'none', however if Dev Services is in use and no other extensions that manage the schema are present this will default to 'drop-and-create'. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`. +Path to a file containing the SQL statements to execute when Hibernate ORM starts. + +The file is retrieved from the classpath resources, +so it must be located in the resources directory (e.g. `src/main/resources`). + +The default value for this setting differs depending on the Quarkus launch mode: + +* In dev and test modes, it defaults to `import.sql`. + Simply add an `import.sql` file in the root of your resources directory + and it will be picked up without having to set this property. + Pass `no-file` to force Hibernate ORM to ignore the SQL import file. +* In production mode, it defaults to `no-file`. + It means Hibernate ORM won't try to execute any SQL import file by default. + Pass an explicit value to force Hibernate ORM to execute the SQL import file. + +If you need different SQL statements between dev mode, test (`@QuarkusTest`) and in production, use Quarkus +https://quarkus.io/guides/config#configuration-profiles[configuration profiles facility]. + +[source,property] +.application.properties +---- +%dev.quarkus.hibernate-orm.sql-load-script = import-dev.sql +%test.quarkus.hibernate-orm.sql-load-script = import-test.sql +%prod.quarkus.hibernate-orm.sql-load-script = no-file +---- + +[NOTE] +==== +Quarkus supports `.sql` file with SQL statements or comments spread over multiple lines. +Each SQL statement must be terminated by a semicolon. +==== ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SQL_LOAD_SCRIPT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SQL_LOAD_SCRIPT+++` endif::add-copy-button-to-env-var[] ---|string -|`none` +--|list of string +|`import.sql in DEV, TEST ; no-file otherwise` -a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.database.generation.create-schemas]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.database.generation.create-schemas[quarkus.hibernate-orm.database.generation.create-schemas]` +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.physical-naming-strategy]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.physical-naming-strategy[quarkus.hibernate-orm."persistence-unit-name".physical-naming-strategy]` [.description] -- -If Hibernate ORM should create the schemas automatically (for databases supporting them). +Pluggable strategy contract for applying physical naming rules for database object names. Class name of the Hibernate PhysicalNamingStrategy implementation ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_CREATE_SCHEMAS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__PHYSICAL_NAMING_STRATEGY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_CREATE_SCHEMAS+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__PHYSICAL_NAMING_STRATEGY+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` +--|string +| -a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.database.generation.halt-on-error]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.database.generation.halt-on-error[quarkus.hibernate-orm.database.generation.halt-on-error]` +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.implicit-naming-strategy]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.implicit-naming-strategy[quarkus.hibernate-orm."persistence-unit-name".implicit-naming-strategy]` [.description] -- -Whether we should stop on the first error when applying the schema. +Pluggable strategy for applying implicit naming rules when an explicit name is not given. Class name of the Hibernate ImplicitNamingStrategy implementation ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_HALT_ON_ERROR+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__IMPLICIT_NAMING_STRATEGY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_HALT_ON_ERROR+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.database.default-catalog]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.database.default-catalog[quarkus.hibernate-orm.database.default-catalog]` - - -[.description] --- -The default catalog to use for the database objects. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_CATALOG+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_CATALOG+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.database.default-schema]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.database.default-schema[quarkus.hibernate-orm.database.default-schema]` - - -[.description] --- -The default schema to use for the database objects. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_SCHEMA+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_SCHEMA+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -h|[[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.scripts-database-scripts-related-configuration]]link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.scripts-database-scripts-related-configuration[Database scripts related configuration] - -h|Type -h|Default - -a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.scripts.generation]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.scripts.generation[quarkus.hibernate-orm.scripts.generation]` - - -[.description] --- -Select whether the database schema DDL files are generated or not. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION+++` -endif::add-copy-button-to-env-var[] ---|string -|`none` - - -a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.scripts.generation.create-target]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.scripts.generation.create-target[quarkus.hibernate-orm.scripts.generation.create-target]` - - -[.description] --- -Filename or URL where the database create DDL file should be generated. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION_CREATE_TARGET+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION_CREATE_TARGET+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.scripts.generation.drop-target]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.scripts.generation.drop-target[quarkus.hibernate-orm.scripts.generation.drop-target]` - - -[.description] --- -Filename or URL where the database drop DDL file should be generated. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION_DROP_TARGET+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION_DROP_TARGET+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -h|[[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.log-logging-configuration]]link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.log-logging-configuration[Logging configuration] - -h|Type -h|Default - -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.log.bind-parameters]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.log.bind-parameters[quarkus.hibernate-orm.log.bind-parameters]` - - -[.description] --- -Logs SQL bind parameters. - -Setting it to true is obviously not recommended in production. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_BIND_PARAMETERS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_BIND_PARAMETERS+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.log.sql]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.log.sql[quarkus.hibernate-orm.log.sql]` - - -[.description] --- -Show SQL logs and format them nicely. - -Setting it to true is obviously not recommended in production. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_SQL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_SQL+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.log.format-sql]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.log.format-sql[quarkus.hibernate-orm.log.format-sql]` - - -[.description] --- -Format the SQL logs if SQL log is enabled - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_FORMAT_SQL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_FORMAT_SQL+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.log.jdbc-warnings]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.log.jdbc-warnings[quarkus.hibernate-orm.log.jdbc-warnings]` - - -[.description] --- -Whether JDBC warnings should be collected and logged. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_JDBC_WARNINGS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_JDBC_WARNINGS+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`depends on dialect` - - -a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.log.queries-slower-than-ms]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.log.queries-slower-than-ms[quarkus.hibernate-orm.log.queries-slower-than-ms]` - - -[.description] --- -If set, Hibernate will log queries that took more than specified number of milliseconds to execute. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_QUERIES_SLOWER_THAN_MS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_QUERIES_SLOWER_THAN_MS+++` -endif::add-copy-button-to-env-var[] ---|long -| - - -h|[[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.persistence-units-additional-named-persistence-units]]link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.persistence-units-additional-named-persistence-units[Additional named persistence units] - -h|Type -h|Default - -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.datasource]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.datasource[quarkus.hibernate-orm."persistence-unit-name".datasource]` - - -[.description] --- -The name of the datasource which this persistence unit uses. - -If undefined, it will use the default datasource. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATASOURCE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATASOURCE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.packages]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.packages[quarkus.hibernate-orm."persistence-unit-name".packages]` - - -[.description] --- -The packages in which the entities affected to this persistence unit are located. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__PACKAGES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__PACKAGES+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.sql-load-script]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.sql-load-script[quarkus.hibernate-orm."persistence-unit-name".sql-load-script]` - - -[.description] --- -Path to a file containing the SQL statements to execute when Hibernate ORM starts. - -The file is retrieved from the classpath resources, -so it must be located in the resources directory (e.g. `src/main/resources`). - -The default value for this setting differs depending on the Quarkus launch mode: - -* In dev and test modes, it defaults to `import.sql`. - Simply add an `import.sql` file in the root of your resources directory - and it will be picked up without having to set this property. - Pass `no-file` to force Hibernate ORM to ignore the SQL import file. -* In production mode, it defaults to `no-file`. - It means Hibernate ORM won't try to execute any SQL import file by default. - Pass an explicit value to force Hibernate ORM to execute the SQL import file. - -If you need different SQL statements between dev mode, test (`@QuarkusTest`) and in production, use Quarkus -https://quarkus.io/guides/config#configuration-profiles[configuration profiles facility]. - -[source,property] -.application.properties ----- -%dev.quarkus.hibernate-orm.sql-load-script = import-dev.sql -%test.quarkus.hibernate-orm.sql-load-script = import-test.sql -%prod.quarkus.hibernate-orm.sql-load-script = no-file ----- - -[NOTE] -==== -Quarkus supports `.sql` file with SQL statements or comments spread over multiple lines. -Each SQL statement must be terminated by a semicolon. -==== - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SQL_LOAD_SCRIPT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SQL_LOAD_SCRIPT+++` -endif::add-copy-button-to-env-var[] ---|list of string -|`import.sql in DEV, TEST ; no-file otherwise` - - -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.physical-naming-strategy]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.physical-naming-strategy[quarkus.hibernate-orm."persistence-unit-name".physical-naming-strategy]` - - -[.description] --- -Pluggable strategy contract for applying physical naming rules for database object names. Class name of the Hibernate PhysicalNamingStrategy implementation - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__PHYSICAL_NAMING_STRATEGY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__PHYSICAL_NAMING_STRATEGY+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.implicit-naming-strategy]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.implicit-naming-strategy[quarkus.hibernate-orm."persistence-unit-name".implicit-naming-strategy]` - - -[.description] --- -Pluggable strategy for applying implicit naming rules when an explicit name is not given. Class name of the Hibernate ImplicitNamingStrategy implementation - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__IMPLICIT_NAMING_STRATEGY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__IMPLICIT_NAMING_STRATEGY+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__IMPLICIT_NAMING_STRATEGY+++` endif::add-copy-button-to-env-var[] --|string | @@ -1503,73 +1353,183 @@ in order to reduce the frequency of database calls to retrieve those values and thereby improve performance. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__MAPPING_ID_OPTIMIZER_DEFAULT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__MAPPING_ID_OPTIMIZER_DEFAULT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__MAPPING_ID_OPTIMIZER_DEFAULT+++` +endif::add-copy-button-to-env-var[] +-- a| +`pooled-lo`, `pooled`, `none` +|`pooled-lo` + + +h|[[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.query-query-related-configuration]]link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.query-query-related-configuration[Query related configuration] + +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.query.query-plan-cache-max-size]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.query.query-plan-cache-max-size[quarkus.hibernate-orm."persistence-unit-name".query.query-plan-cache-max-size]` + + +[.description] +-- +The maximum size of the query plan cache. see ++#++`org.hibernate.cfg.AvailableSettings++#++QUERY_PLAN_CACHE_MAX_SIZE` + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUERY_QUERY_PLAN_CACHE_MAX_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUERY_QUERY_PLAN_CACHE_MAX_SIZE+++` +endif::add-copy-button-to-env-var[] +--|int +|`2048` + + +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.query.default-null-ordering]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.query.default-null-ordering[quarkus.hibernate-orm."persistence-unit-name".query.default-null-ordering]` + + +[.description] +-- +Default precedence of null values in `ORDER BY` clauses. + +Valid values are: `none`, `first`, `last`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUERY_DEFAULT_NULL_ORDERING+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUERY_DEFAULT_NULL_ORDERING+++` +endif::add-copy-button-to-env-var[] +-- a| +`none`, `first`, `last` +|`none` + + +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.query.in-clause-parameter-padding]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.query.in-clause-parameter-padding[quarkus.hibernate-orm."persistence-unit-name".query.in-clause-parameter-padding]` + + +[.description] +-- +Enables IN clause parameter padding which improves statement caching. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUERY_IN_CLAUSE_PARAMETER_PADDING+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUERY_IN_CLAUSE_PARAMETER_PADDING+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +h|[[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.database-database-related-configuration]]link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.database-database-related-configuration[Database related configuration] + +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.database.charset]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.database.charset[quarkus.hibernate-orm."persistence-unit-name".database.charset]` + + +[.description] +-- +The charset of the database. + +Used for DDL generation and also for the SQL import scripts. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_CHARSET+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_CHARSET+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html[Charset] + +|`UTF-8` + + +a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.database.generation]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.database.generation[quarkus.hibernate-orm."persistence-unit-name".database.generation]` + + +[.description] +-- +Select whether the database schema is generated or not. `drop-and-create` is awesome in development mode. This defaults to 'none', however if Dev Services is in use and no other extensions that manage the schema are present this will default to 'drop-and-create'. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION+++` +endif::add-copy-button-to-env-var[] +--|string +|`none` + + +a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.database.generation.create-schemas]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.database.generation.create-schemas[quarkus.hibernate-orm."persistence-unit-name".database.generation.create-schemas]` + + +[.description] +-- +If Hibernate ORM should create the schemas automatically (for databases supporting them). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION_CREATE_SCHEMAS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__MAPPING_ID_OPTIMIZER_DEFAULT+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION_CREATE_SCHEMAS+++` endif::add-copy-button-to-env-var[] --- a| -`pooled-lo`, `pooled`, `none` -|`pooled-lo` - - -h|[[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.query-query-related-configuration]]link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.query-query-related-configuration[Query related configuration] +--|boolean +|`false` -h|Type -h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.query.query-plan-cache-max-size]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.query.query-plan-cache-max-size[quarkus.hibernate-orm."persistence-unit-name".query.query-plan-cache-max-size]` +a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.database.generation.halt-on-error]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.database.generation.halt-on-error[quarkus.hibernate-orm."persistence-unit-name".database.generation.halt-on-error]` [.description] -- -The maximum size of the query plan cache. see ++#++`org.hibernate.cfg.AvailableSettings++#++QUERY_PLAN_CACHE_MAX_SIZE` +Whether we should stop on the first error when applying the schema. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUERY_QUERY_PLAN_CACHE_MAX_SIZE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION_HALT_ON_ERROR+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUERY_QUERY_PLAN_CACHE_MAX_SIZE+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION_HALT_ON_ERROR+++` endif::add-copy-button-to-env-var[] ---|int -|`2048` +--|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.query.default-null-ordering]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.query.default-null-ordering[quarkus.hibernate-orm."persistence-unit-name".query.default-null-ordering]` +a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.database.default-catalog]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.database.default-catalog[quarkus.hibernate-orm."persistence-unit-name".database.default-catalog]` [.description] -- -Default precedence of null values in `ORDER BY` clauses. - -Valid values are: `none`, `first`, `last`. +The default catalog to use for the database objects. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUERY_DEFAULT_NULL_ORDERING+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_DEFAULT_CATALOG+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUERY_DEFAULT_NULL_ORDERING+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_DEFAULT_CATALOG+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `first`, `last` -|`none` +--|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.query.in-clause-parameter-padding]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.query.in-clause-parameter-padding[quarkus.hibernate-orm."persistence-unit-name".query.in-clause-parameter-padding]` +a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.database.default-schema]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.database.default-schema[quarkus.hibernate-orm."persistence-unit-name".database.default-schema]` [.description] -- -Enables IN clause parameter padding which improves statement caching. +The default schema to use for the database objects. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUERY_IN_CLAUSE_PARAMETER_PADDING+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_DEFAULT_SCHEMA+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUERY_IN_CLAUSE_PARAMETER_PADDING+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_DEFAULT_SCHEMA+++` endif::add-copy-button-to-env-var[] ---|boolean -|`true` +--|string +| h|[[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.jdbc-jdbc-related-configuration]]link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.jdbc-jdbc-related-configuration[JDBC related configuration] @@ -1733,244 +1693,284 @@ endif::add-copy-button-to-env-var[] |`false` -h|[[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.database-database-related-configuration]]link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.database-database-related-configuration[Database related configuration] +h|[[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.scripts-database-scripts-related-configuration]]link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.scripts-database-scripts-related-configuration[Database scripts related configuration] h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.database.charset]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.database.charset[quarkus.hibernate-orm."persistence-unit-name".database.charset]` +a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation[quarkus.hibernate-orm."persistence-unit-name".scripts.generation]` [.description] -- -The charset of the database. +Select whether the database schema DDL files are generated or not. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`. -Used for DDL generation and also for the SQL import scripts. +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION+++` +endif::add-copy-button-to-env-var[] +--|string +|`none` + + +a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation.create-target]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation.create-target[quarkus.hibernate-orm."persistence-unit-name".scripts.generation.create-target]` + + +[.description] +-- +Filename or URL where the database create DDL file should be generated. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_CHARSET+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION_CREATE_TARGET+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_CHARSET+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION_CREATE_TARGET+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html[Charset] - -|`UTF-8` +--|string +| -a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.database.generation]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.database.generation[quarkus.hibernate-orm."persistence-unit-name".database.generation]` +a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation.drop-target]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation.drop-target[quarkus.hibernate-orm."persistence-unit-name".scripts.generation.drop-target]` [.description] -- -Select whether the database schema is generated or not. `drop-and-create` is awesome in development mode. This defaults to 'none', however if Dev Services is in use and no other extensions that manage the schema are present this will default to 'drop-and-create'. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`. +Filename or URL where the database drop DDL file should be generated. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION_DROP_TARGET+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION_DROP_TARGET+++` endif::add-copy-button-to-env-var[] --|string -|`none` +| -a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.database.generation.create-schemas]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.database.generation.create-schemas[quarkus.hibernate-orm."persistence-unit-name".database.generation.create-schemas]` +h|[[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.log-logging-configuration]]link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.log-logging-configuration[Logging configuration] + +h|Type +h|Default + +a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.log.sql]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.log.sql[quarkus.hibernate-orm."persistence-unit-name".log.sql]` [.description] -- -If Hibernate ORM should create the schemas automatically (for databases supporting them). +Show SQL logs and format them nicely. + +Setting it to true is obviously not recommended in production. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION_CREATE_SCHEMAS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_SQL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION_CREATE_SCHEMAS+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_SQL+++` endif::add-copy-button-to-env-var[] --|boolean |`false` -a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.database.generation.halt-on-error]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.database.generation.halt-on-error[quarkus.hibernate-orm."persistence-unit-name".database.generation.halt-on-error]` +a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.log.format-sql]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.log.format-sql[quarkus.hibernate-orm."persistence-unit-name".log.format-sql]` [.description] -- -Whether we should stop on the first error when applying the schema. +Format the SQL logs if SQL log is enabled ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION_HALT_ON_ERROR+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_FORMAT_SQL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION_HALT_ON_ERROR+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_FORMAT_SQL+++` endif::add-copy-button-to-env-var[] --|boolean -|`false` +|`true` -a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.database.default-catalog]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.database.default-catalog[quarkus.hibernate-orm."persistence-unit-name".database.default-catalog]` +a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.log.jdbc-warnings]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.log.jdbc-warnings[quarkus.hibernate-orm."persistence-unit-name".log.jdbc-warnings]` [.description] -- -The default catalog to use for the database objects. +Whether JDBC warnings should be collected and logged. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_DEFAULT_CATALOG+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_JDBC_WARNINGS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_DEFAULT_CATALOG+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_JDBC_WARNINGS+++` endif::add-copy-button-to-env-var[] ---|string -| +--|boolean +|`depends on dialect` -a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.database.default-schema]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.database.default-schema[quarkus.hibernate-orm."persistence-unit-name".database.default-schema]` +a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.log.queries-slower-than-ms]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.log.queries-slower-than-ms[quarkus.hibernate-orm."persistence-unit-name".log.queries-slower-than-ms]` [.description] -- -The default schema to use for the database objects. +If set, Hibernate will log queries that took more than specified number of milliseconds to execute. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_DEFAULT_SCHEMA+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_QUERIES_SLOWER_THAN_MS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_DEFAULT_SCHEMA+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_QUERIES_SLOWER_THAN_MS+++` endif::add-copy-button-to-env-var[] ---|string +--|long | -h|[[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.scripts-database-scripts-related-configuration]]link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.scripts-database-scripts-related-configuration[Database scripts related configuration] +h|[[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.log-logging-configuration]]link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.log-logging-configuration[Logging configuration] h|Type h|Default -a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation[quarkus.hibernate-orm."persistence-unit-name".scripts.generation]` +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.log.bind-parameters]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.log.bind-parameters[quarkus.hibernate-orm.log.bind-parameters]` [.description] -- -Select whether the database schema DDL files are generated or not. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`. +Logs SQL bind parameters. + +Setting it to true is obviously not recommended in production. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_BIND_PARAMETERS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_BIND_PARAMETERS+++` endif::add-copy-button-to-env-var[] ---|string -|`none` +--|boolean +|`false` -a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation.create-target]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation.create-target[quarkus.hibernate-orm."persistence-unit-name".scripts.generation.create-target]` +a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.log.sql]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.log.sql[quarkus.hibernate-orm.log.sql]` [.description] -- -Filename or URL where the database create DDL file should be generated. +Show SQL logs and format them nicely. + +Setting it to true is obviously not recommended in production. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION_CREATE_TARGET+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_SQL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION_CREATE_TARGET+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_SQL+++` endif::add-copy-button-to-env-var[] ---|string -| +--|boolean +|`false` -a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation.drop-target]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation.drop-target[quarkus.hibernate-orm."persistence-unit-name".scripts.generation.drop-target]` +a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.log.format-sql]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.log.format-sql[quarkus.hibernate-orm.log.format-sql]` [.description] -- -Filename or URL where the database drop DDL file should be generated. +Format the SQL logs if SQL log is enabled ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION_DROP_TARGET+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_FORMAT_SQL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION_DROP_TARGET+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_FORMAT_SQL+++` endif::add-copy-button-to-env-var[] ---|string -| +--|boolean +|`true` -h|[[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.log-logging-configuration]]link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.log-logging-configuration[Logging configuration] +a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.log.jdbc-warnings]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.log.jdbc-warnings[quarkus.hibernate-orm.log.jdbc-warnings]` -h|Type -h|Default -a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.log.sql]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.log.sql[quarkus.hibernate-orm."persistence-unit-name".log.sql]` +[.description] +-- +Whether JDBC warnings should be collected and logged. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_JDBC_WARNINGS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_JDBC_WARNINGS+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`depends on dialect` + + +a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.log.queries-slower-than-ms]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.log.queries-slower-than-ms[quarkus.hibernate-orm.log.queries-slower-than-ms]` [.description] -- -Show SQL logs and format them nicely. - -Setting it to true is obviously not recommended in production. +If set, Hibernate will log queries that took more than specified number of milliseconds to execute. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_SQL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_QUERIES_SLOWER_THAN_MS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_SQL+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_QUERIES_SLOWER_THAN_MS+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` +--|long +| -a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.log.format-sql]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.log.format-sql[quarkus.hibernate-orm."persistence-unit-name".log.format-sql]` +h|[[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.scripts-database-scripts-related-configuration]]link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.scripts-database-scripts-related-configuration[Database scripts related configuration] + +h|Type +h|Default + +a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.scripts.generation]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.scripts.generation[quarkus.hibernate-orm.scripts.generation]` [.description] -- -Format the SQL logs if SQL log is enabled +Select whether the database schema DDL files are generated or not. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_FORMAT_SQL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_FORMAT_SQL+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION+++` endif::add-copy-button-to-env-var[] ---|boolean -|`true` +--|string +|`none` -a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.log.jdbc-warnings]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.log.jdbc-warnings[quarkus.hibernate-orm."persistence-unit-name".log.jdbc-warnings]` +a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.scripts.generation.create-target]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.scripts.generation.create-target[quarkus.hibernate-orm.scripts.generation.create-target]` [.description] -- -Whether JDBC warnings should be collected and logged. +Filename or URL where the database create DDL file should be generated. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_JDBC_WARNINGS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION_CREATE_TARGET+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_JDBC_WARNINGS+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION_CREATE_TARGET+++` endif::add-copy-button-to-env-var[] ---|boolean -|`depends on dialect` +--|string +| -a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.log.queries-slower-than-ms]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.-persistence-unit-name-.log.queries-slower-than-ms[quarkus.hibernate-orm."persistence-unit-name".log.queries-slower-than-ms]` +a| [[quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.scripts.generation.drop-target]]`link:#quarkus-hibernate-orm-general-config-items_quarkus.hibernate-orm.scripts.generation.drop-target[quarkus.hibernate-orm.scripts.generation.drop-target]` [.description] -- -If set, Hibernate will log queries that took more than specified number of milliseconds to execute. +Filename or URL where the database drop DDL file should be generated. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_QUERIES_SLOWER_THAN_MS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION_DROP_TARGET+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_QUERIES_SLOWER_THAN_MS+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION_DROP_TARGET+++` endif::add-copy-button-to-env-var[] ---|long +--|string | |=== diff --git a/_generated-doc/main/config/quarkus-hibernate-orm-hibernate-orm-config.adoc b/_generated-doc/main/config/quarkus-hibernate-orm-hibernate-orm-config.adoc index 4de830149a..04c304477b 100644 --- a/_generated-doc/main/config/quarkus-hibernate-orm-hibernate-orm-config.adoc +++ b/_generated-doc/main/config/quarkus-hibernate-orm-hibernate-orm-config.adoc @@ -436,6 +436,91 @@ endif::add-copy-button-to-env-var[] |`UTF-8` +a| [[quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.database.generation]]`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.database.generation[quarkus.hibernate-orm.database.generation]` + + +[.description] +-- +Select whether the database schema is generated or not. `drop-and-create` is awesome in development mode. This defaults to 'none', however if Dev Services is in use and no other extensions that manage the schema are present this will default to 'drop-and-create'. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION+++` +endif::add-copy-button-to-env-var[] +--|string +|`none` + + +a| [[quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.database.generation.create-schemas]]`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.database.generation.create-schemas[quarkus.hibernate-orm.database.generation.create-schemas]` + + +[.description] +-- +If Hibernate ORM should create the schemas automatically (for databases supporting them). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_CREATE_SCHEMAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_CREATE_SCHEMAS+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.database.generation.halt-on-error]]`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.database.generation.halt-on-error[quarkus.hibernate-orm.database.generation.halt-on-error]` + + +[.description] +-- +Whether we should stop on the first error when applying the schema. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_HALT_ON_ERROR+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_HALT_ON_ERROR+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.database.default-catalog]]`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.database.default-catalog[quarkus.hibernate-orm.database.default-catalog]` + + +[.description] +-- +The default catalog to use for the database objects. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_CATALOG+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_CATALOG+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.database.default-schema]]`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.database.default-schema[quarkus.hibernate-orm.database.default-schema]` + + +[.description] +-- +The default schema to use for the database objects. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_SCHEMA+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_SCHEMA+++` +endif::add-copy-button-to-env-var[] +--|string +| + + h|[[quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.dialect-dialect-related-configuration]]link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.dialect-dialect-related-configuration[Dialect related configuration] h|Type @@ -1079,6 +1164,62 @@ endif::add-copy-button-to-env-var[] |`true` +a| [[quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.active]]`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.active[quarkus.hibernate-orm."persistence-unit-name".active]` + + +[.description] +-- +Whether this persistence unit should be active at runtime. + +If the persistence unit is not active, it won't start with the application, +and accessing the corresponding EntityManagerFactory/EntityManager or SessionFactory/Session +will not be possible. + +Note that if Hibernate ORM is disabled (i.e. `quarkus.hibernate-orm.enabled` is set to `false`), +all persistence units are deactivated, and setting this property to `true` will fail. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__ACTIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__ACTIVE+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`'true' if Hibernate ORM is enabled; 'false' otherwise` + + +a| [[quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.unsupported-properties-full-property-key]]`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.unsupported-properties-full-property-key[quarkus.hibernate-orm."persistence-unit-name".unsupported-properties]` + + +[.description] +-- +Properties that should be passed on directly to Hibernate ORM. +Use the full configuration property key here, +for instance `quarkus.hibernate-orm.unsupported-properties."hibernate.order_inserts" = true`. + +[WARNING] +==== +Properties set here are completely unsupported: +as Quarkus doesn't generally know about these properties and their purpose, +there is absolutely no guarantee that they will work correctly, +and even if they do, that may change when upgrading to a newer version of Quarkus +(even just a micro/patch version). +==== + +Consider using a supported configuration property before falling back to unsupported ones. +If none exists, make sure to file a feature request so that a supported configuration property can be added to Quarkus, +and more importantly so that the configuration property is tested regularly. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__UNSUPPORTED_PROPERTIES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__UNSUPPORTED_PROPERTIES+++` +endif::add-copy-button-to-env-var[] +--|`Map` +| + + h|[[quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.dialect-dialect-related-configuration]]link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.dialect-dialect-related-configuration[Dialect related configuration] h|Type @@ -1305,6 +1446,91 @@ endif::add-copy-button-to-env-var[] |`UTF-8` +a| [[quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.database.generation]]`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.database.generation[quarkus.hibernate-orm."persistence-unit-name".database.generation]` + + +[.description] +-- +Select whether the database schema is generated or not. `drop-and-create` is awesome in development mode. This defaults to 'none', however if Dev Services is in use and no other extensions that manage the schema are present this will default to 'drop-and-create'. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION+++` +endif::add-copy-button-to-env-var[] +--|string +|`none` + + +a| [[quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.database.generation.create-schemas]]`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.database.generation.create-schemas[quarkus.hibernate-orm."persistence-unit-name".database.generation.create-schemas]` + + +[.description] +-- +If Hibernate ORM should create the schemas automatically (for databases supporting them). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION_CREATE_SCHEMAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION_CREATE_SCHEMAS+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.database.generation.halt-on-error]]`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.database.generation.halt-on-error[quarkus.hibernate-orm."persistence-unit-name".database.generation.halt-on-error]` + + +[.description] +-- +Whether we should stop on the first error when applying the schema. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION_HALT_ON_ERROR+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION_HALT_ON_ERROR+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.database.default-catalog]]`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.database.default-catalog[quarkus.hibernate-orm."persistence-unit-name".database.default-catalog]` + + +[.description] +-- +The default catalog to use for the database objects. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_DEFAULT_CATALOG+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_DEFAULT_CATALOG+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.database.default-schema]]`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.database.default-schema[quarkus.hibernate-orm."persistence-unit-name".database.default-schema]` + + +[.description] +-- +The default schema to use for the database objects. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_DEFAULT_SCHEMA+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_DEFAULT_SCHEMA+++` +endif::add-copy-button-to-env-var[] +--|string +| + + h|[[quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.jdbc-jdbc-related-configuration]]link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.jdbc-jdbc-related-configuration[JDBC related configuration] h|Type @@ -1466,6 +1692,137 @@ endif::add-copy-button-to-env-var[] |`false` +h|[[quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.scripts-database-scripts-related-configuration]]link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.scripts-database-scripts-related-configuration[Database scripts related configuration] + +h|Type +h|Default + +a| [[quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation]]`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation[quarkus.hibernate-orm."persistence-unit-name".scripts.generation]` + + +[.description] +-- +Select whether the database schema DDL files are generated or not. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION+++` +endif::add-copy-button-to-env-var[] +--|string +|`none` + + +a| [[quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation.create-target]]`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation.create-target[quarkus.hibernate-orm."persistence-unit-name".scripts.generation.create-target]` + + +[.description] +-- +Filename or URL where the database create DDL file should be generated. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION_CREATE_TARGET+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION_CREATE_TARGET+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation.drop-target]]`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation.drop-target[quarkus.hibernate-orm."persistence-unit-name".scripts.generation.drop-target]` + + +[.description] +-- +Filename or URL where the database drop DDL file should be generated. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION_DROP_TARGET+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION_DROP_TARGET+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +h|[[quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.log-logging-configuration]]link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.log-logging-configuration[Logging configuration] + +h|Type +h|Default + +a| [[quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.log.sql]]`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.log.sql[quarkus.hibernate-orm."persistence-unit-name".log.sql]` + + +[.description] +-- +Show SQL logs and format them nicely. + +Setting it to true is obviously not recommended in production. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_SQL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_SQL+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.log.format-sql]]`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.log.format-sql[quarkus.hibernate-orm."persistence-unit-name".log.format-sql]` + + +[.description] +-- +Format the SQL logs if SQL log is enabled + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_FORMAT_SQL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_FORMAT_SQL+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.log.jdbc-warnings]]`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.log.jdbc-warnings[quarkus.hibernate-orm."persistence-unit-name".log.jdbc-warnings]` + + +[.description] +-- +Whether JDBC warnings should be collected and logged. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_JDBC_WARNINGS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_JDBC_WARNINGS+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`depends on dialect` + + +a| [[quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.log.queries-slower-than-ms]]`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.-persistence-unit-name-.log.queries-slower-than-ms[quarkus.hibernate-orm."persistence-unit-name".log.queries-slower-than-ms]` + + +[.description] +-- +If set, Hibernate will log queries that took more than specified number of milliseconds to execute. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_QUERIES_SLOWER_THAN_MS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_QUERIES_SLOWER_THAN_MS+++` +endif::add-copy-button-to-env-var[] +--|long +| + + h|[[quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.log-logging-configuration]]link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.log-logging-configuration[Logging configuration] h|Type @@ -1489,6 +1846,76 @@ endif::add-copy-button-to-env-var[] --|boolean |`false` + +a| [[quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.log.sql]]`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.log.sql[quarkus.hibernate-orm.log.sql]` + + +[.description] +-- +Show SQL logs and format them nicely. + +Setting it to true is obviously not recommended in production. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_SQL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_SQL+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.log.format-sql]]`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.log.format-sql[quarkus.hibernate-orm.log.format-sql]` + + +[.description] +-- +Format the SQL logs if SQL log is enabled + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_FORMAT_SQL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_FORMAT_SQL+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.log.jdbc-warnings]]`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.log.jdbc-warnings[quarkus.hibernate-orm.log.jdbc-warnings]` + + +[.description] +-- +Whether JDBC warnings should be collected and logged. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_JDBC_WARNINGS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_JDBC_WARNINGS+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`depends on dialect` + + +a| [[quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.log.queries-slower-than-ms]]`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus.hibernate-orm.log.queries-slower-than-ms[quarkus.hibernate-orm.log.queries-slower-than-ms]` + + +[.description] +-- +If set, Hibernate will log queries that took more than specified number of milliseconds to execute. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_QUERIES_SLOWER_THAN_MS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_QUERIES_SLOWER_THAN_MS+++` +endif::add-copy-button-to-env-var[] +--|long +| + |=== ifndef::no-duration-note[] [NOTE] diff --git a/_generated-doc/main/config/quarkus-hibernate-orm.adoc b/_generated-doc/main/config/quarkus-hibernate-orm.adoc index c8253ea6b8..ecb608c84c 100644 --- a/_generated-doc/main/config/quarkus-hibernate-orm.adoc +++ b/_generated-doc/main/config/quarkus-hibernate-orm.adoc @@ -431,6 +431,152 @@ endif::add-copy-button-to-env-var[] | +h|[[quarkus-hibernate-orm_quarkus.hibernate-orm.database-database-related-configuration]]link:#quarkus-hibernate-orm_quarkus.hibernate-orm.database-database-related-configuration[Database related configuration] + +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus.hibernate-orm.database.orm-compatibility.version]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.database.orm-compatibility.version[quarkus.hibernate-orm.database.orm-compatibility.version]` + + +[.description] +-- +When set, attempts to exchange data with the database +as the given version of Hibernate ORM would have, +*on a best-effort basis*. + +Please note: + +* schema validation may still fail in some cases: +this attempts to make Hibernate ORM 6+ behave correctly at runtime, +but it may still expect a different (but runtime-compatible) schema. +* robust test suites are still useful and recommended: +you should still check that your application behaves as intended with your legacy schema. +* this feature is inherently unstable: +some aspects of it may stop working in future versions of Quarkus, +and older versions will be dropped as Hibernate ORM changes pile up +and support for those older versions becomes too unreliable. +* you should still plan a migration of your schema to a newer version of Hibernate ORM. +For help with migration, refer to +link:https://github.com/quarkusio/quarkus/wiki/Migration-Guide-3.0:-Hibernate-ORM-5-to-6-migration[the Quarkus 3 +migration guide from Hibernate ORM 5 to 6]. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_ORM_COMPATIBILITY_VERSION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_ORM_COMPATIBILITY_VERSION+++` +endif::add-copy-button-to-env-var[] +-- a| +`5.6`, `latest` +|`latest` + + +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus.hibernate-orm.database.charset]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.database.charset[quarkus.hibernate-orm.database.charset]` + + +[.description] +-- +The charset of the database. + +Used for DDL generation and also for the SQL import scripts. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_CHARSET+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_CHARSET+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html[Charset] + +|`UTF-8` + + +a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.database.generation]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.database.generation[quarkus.hibernate-orm.database.generation]` + + +[.description] +-- +Select whether the database schema is generated or not. `drop-and-create` is awesome in development mode. This defaults to 'none', however if Dev Services is in use and no other extensions that manage the schema are present this will default to 'drop-and-create'. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION+++` +endif::add-copy-button-to-env-var[] +--|string +|`none` + + +a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.database.generation.create-schemas]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.database.generation.create-schemas[quarkus.hibernate-orm.database.generation.create-schemas]` + + +[.description] +-- +If Hibernate ORM should create the schemas automatically (for databases supporting them). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_CREATE_SCHEMAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_CREATE_SCHEMAS+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.database.generation.halt-on-error]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.database.generation.halt-on-error[quarkus.hibernate-orm.database.generation.halt-on-error]` + + +[.description] +-- +Whether we should stop on the first error when applying the schema. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_HALT_ON_ERROR+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_HALT_ON_ERROR+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.database.default-catalog]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.database.default-catalog[quarkus.hibernate-orm.database.default-catalog]` + + +[.description] +-- +The default catalog to use for the database objects. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_CATALOG+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_CATALOG+++` +endif::add-copy-button-to-env-var[] +--|string +| + + +a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.database.default-schema]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.database.default-schema[quarkus.hibernate-orm.database.default-schema]` + + +[.description] +-- +The default schema to use for the database objects. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_SCHEMA+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_SCHEMA+++` +endif::add-copy-button-to-env-var[] +--|string +| + + h|[[quarkus-hibernate-orm_quarkus.hibernate-orm.dialect-dialect-related-configuration]]link:#quarkus-hibernate-orm_quarkus.hibernate-orm.dialect-dialect-related-configuration[Dialect related configuration] h|Type @@ -793,419 +939,123 @@ endif::add-copy-button-to-env-var[] |`false` -h|[[quarkus-hibernate-orm_quarkus.hibernate-orm.database-database-related-configuration]]link:#quarkus-hibernate-orm_quarkus.hibernate-orm.database-database-related-configuration[Database related configuration] +h|[[quarkus-hibernate-orm_quarkus.hibernate-orm.persistence-units-additional-named-persistence-units]]link:#quarkus-hibernate-orm_quarkus.hibernate-orm.persistence-units-additional-named-persistence-units[Additional named persistence units] h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus.hibernate-orm.database.orm-compatibility.version]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.database.orm-compatibility.version[quarkus.hibernate-orm.database.orm-compatibility.version]` +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.datasource]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.datasource[quarkus.hibernate-orm."persistence-unit-name".datasource]` [.description] -- -When set, attempts to exchange data with the database -as the given version of Hibernate ORM would have, -*on a best-effort basis*. - -Please note: +The name of the datasource which this persistence unit uses. -* schema validation may still fail in some cases: -this attempts to make Hibernate ORM 6+ behave correctly at runtime, -but it may still expect a different (but runtime-compatible) schema. -* robust test suites are still useful and recommended: -you should still check that your application behaves as intended with your legacy schema. -* this feature is inherently unstable: -some aspects of it may stop working in future versions of Quarkus, -and older versions will be dropped as Hibernate ORM changes pile up -and support for those older versions becomes too unreliable. -* you should still plan a migration of your schema to a newer version of Hibernate ORM. -For help with migration, refer to -link:https://github.com/quarkusio/quarkus/wiki/Migration-Guide-3.0:-Hibernate-ORM-5-to-6-migration[the Quarkus 3 -migration guide from Hibernate ORM 5 to 6]. +If undefined, it will use the default datasource. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_ORM_COMPATIBILITY_VERSION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATASOURCE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_ORM_COMPATIBILITY_VERSION+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATASOURCE+++` endif::add-copy-button-to-env-var[] --- a| -`5.6`, `latest` -|`latest` +--|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus.hibernate-orm.database.charset]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.database.charset[quarkus.hibernate-orm.database.charset]` +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.packages]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.packages[quarkus.hibernate-orm."persistence-unit-name".packages]` [.description] -- -The charset of the database. - -Used for DDL generation and also for the SQL import scripts. +The packages in which the entities affected to this persistence unit are located. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_CHARSET+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__PACKAGES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_CHARSET+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__PACKAGES+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html[Charset] - -|`UTF-8` +--|list of string +| -a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.database.generation]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.database.generation[quarkus.hibernate-orm.database.generation]` +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.sql-load-script]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.sql-load-script[quarkus.hibernate-orm."persistence-unit-name".sql-load-script]` [.description] -- -Select whether the database schema is generated or not. `drop-and-create` is awesome in development mode. This defaults to 'none', however if Dev Services is in use and no other extensions that manage the schema are present this will default to 'drop-and-create'. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`. +Path to a file containing the SQL statements to execute when Hibernate ORM starts. + +The file is retrieved from the classpath resources, +so it must be located in the resources directory (e.g. `src/main/resources`). + +The default value for this setting differs depending on the Quarkus launch mode: + +* In dev and test modes, it defaults to `import.sql`. + Simply add an `import.sql` file in the root of your resources directory + and it will be picked up without having to set this property. + Pass `no-file` to force Hibernate ORM to ignore the SQL import file. +* In production mode, it defaults to `no-file`. + It means Hibernate ORM won't try to execute any SQL import file by default. + Pass an explicit value to force Hibernate ORM to execute the SQL import file. + +If you need different SQL statements between dev mode, test (`@QuarkusTest`) and in production, use Quarkus +https://quarkus.io/guides/config#configuration-profiles[configuration profiles facility]. + +[source,property] +.application.properties +---- +%dev.quarkus.hibernate-orm.sql-load-script = import-dev.sql +%test.quarkus.hibernate-orm.sql-load-script = import-test.sql +%prod.quarkus.hibernate-orm.sql-load-script = no-file +---- + +[NOTE] +==== +Quarkus supports `.sql` file with SQL statements or comments spread over multiple lines. +Each SQL statement must be terminated by a semicolon. +==== ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SQL_LOAD_SCRIPT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SQL_LOAD_SCRIPT+++` endif::add-copy-button-to-env-var[] ---|string -|`none` +--|list of string +|`import.sql in DEV, TEST ; no-file otherwise` -a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.database.generation.create-schemas]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.database.generation.create-schemas[quarkus.hibernate-orm.database.generation.create-schemas]` +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.physical-naming-strategy]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.physical-naming-strategy[quarkus.hibernate-orm."persistence-unit-name".physical-naming-strategy]` [.description] -- -If Hibernate ORM should create the schemas automatically (for databases supporting them). +Pluggable strategy contract for applying physical naming rules for database object names. Class name of the Hibernate PhysicalNamingStrategy implementation ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_CREATE_SCHEMAS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__PHYSICAL_NAMING_STRATEGY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_CREATE_SCHEMAS+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__PHYSICAL_NAMING_STRATEGY+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` +--|string +| -a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.database.generation.halt-on-error]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.database.generation.halt-on-error[quarkus.hibernate-orm.database.generation.halt-on-error]` +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.implicit-naming-strategy]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.implicit-naming-strategy[quarkus.hibernate-orm."persistence-unit-name".implicit-naming-strategy]` [.description] -- -Whether we should stop on the first error when applying the schema. +Pluggable strategy for applying implicit naming rules when an explicit name is not given. Class name of the Hibernate ImplicitNamingStrategy implementation ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_HALT_ON_ERROR+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__IMPLICIT_NAMING_STRATEGY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_HALT_ON_ERROR+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.database.default-catalog]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.database.default-catalog[quarkus.hibernate-orm.database.default-catalog]` - - -[.description] --- -The default catalog to use for the database objects. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_CATALOG+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_CATALOG+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.database.default-schema]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.database.default-schema[quarkus.hibernate-orm.database.default-schema]` - - -[.description] --- -The default schema to use for the database objects. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_SCHEMA+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_SCHEMA+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -h|[[quarkus-hibernate-orm_quarkus.hibernate-orm.scripts-database-scripts-related-configuration]]link:#quarkus-hibernate-orm_quarkus.hibernate-orm.scripts-database-scripts-related-configuration[Database scripts related configuration] - -h|Type -h|Default - -a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.scripts.generation]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.scripts.generation[quarkus.hibernate-orm.scripts.generation]` - - -[.description] --- -Select whether the database schema DDL files are generated or not. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION+++` -endif::add-copy-button-to-env-var[] ---|string -|`none` - - -a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.scripts.generation.create-target]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.scripts.generation.create-target[quarkus.hibernate-orm.scripts.generation.create-target]` - - -[.description] --- -Filename or URL where the database create DDL file should be generated. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION_CREATE_TARGET+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION_CREATE_TARGET+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.scripts.generation.drop-target]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.scripts.generation.drop-target[quarkus.hibernate-orm.scripts.generation.drop-target]` - - -[.description] --- -Filename or URL where the database drop DDL file should be generated. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION_DROP_TARGET+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION_DROP_TARGET+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -h|[[quarkus-hibernate-orm_quarkus.hibernate-orm.log-logging-configuration]]link:#quarkus-hibernate-orm_quarkus.hibernate-orm.log-logging-configuration[Logging configuration] - -h|Type -h|Default - -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus.hibernate-orm.log.bind-parameters]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.log.bind-parameters[quarkus.hibernate-orm.log.bind-parameters]` - - -[.description] --- -Logs SQL bind parameters. - -Setting it to true is obviously not recommended in production. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_BIND_PARAMETERS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_BIND_PARAMETERS+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.log.sql]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.log.sql[quarkus.hibernate-orm.log.sql]` - - -[.description] --- -Show SQL logs and format them nicely. - -Setting it to true is obviously not recommended in production. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_SQL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_SQL+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.log.format-sql]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.log.format-sql[quarkus.hibernate-orm.log.format-sql]` - - -[.description] --- -Format the SQL logs if SQL log is enabled - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_FORMAT_SQL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_FORMAT_SQL+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.log.jdbc-warnings]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.log.jdbc-warnings[quarkus.hibernate-orm.log.jdbc-warnings]` - - -[.description] --- -Whether JDBC warnings should be collected and logged. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_JDBC_WARNINGS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_JDBC_WARNINGS+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`depends on dialect` - - -a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.log.queries-slower-than-ms]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.log.queries-slower-than-ms[quarkus.hibernate-orm.log.queries-slower-than-ms]` - - -[.description] --- -If set, Hibernate will log queries that took more than specified number of milliseconds to execute. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_QUERIES_SLOWER_THAN_MS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_QUERIES_SLOWER_THAN_MS+++` -endif::add-copy-button-to-env-var[] ---|long -| - - -h|[[quarkus-hibernate-orm_quarkus.hibernate-orm.persistence-units-additional-named-persistence-units]]link:#quarkus-hibernate-orm_quarkus.hibernate-orm.persistence-units-additional-named-persistence-units[Additional named persistence units] - -h|Type -h|Default - -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.datasource]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.datasource[quarkus.hibernate-orm."persistence-unit-name".datasource]` - - -[.description] --- -The name of the datasource which this persistence unit uses. - -If undefined, it will use the default datasource. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATASOURCE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATASOURCE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.packages]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.packages[quarkus.hibernate-orm."persistence-unit-name".packages]` - - -[.description] --- -The packages in which the entities affected to this persistence unit are located. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__PACKAGES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__PACKAGES+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.sql-load-script]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.sql-load-script[quarkus.hibernate-orm."persistence-unit-name".sql-load-script]` - - -[.description] --- -Path to a file containing the SQL statements to execute when Hibernate ORM starts. - -The file is retrieved from the classpath resources, -so it must be located in the resources directory (e.g. `src/main/resources`). - -The default value for this setting differs depending on the Quarkus launch mode: - -* In dev and test modes, it defaults to `import.sql`. - Simply add an `import.sql` file in the root of your resources directory - and it will be picked up without having to set this property. - Pass `no-file` to force Hibernate ORM to ignore the SQL import file. -* In production mode, it defaults to `no-file`. - It means Hibernate ORM won't try to execute any SQL import file by default. - Pass an explicit value to force Hibernate ORM to execute the SQL import file. - -If you need different SQL statements between dev mode, test (`@QuarkusTest`) and in production, use Quarkus -https://quarkus.io/guides/config#configuration-profiles[configuration profiles facility]. - -[source,property] -.application.properties ----- -%dev.quarkus.hibernate-orm.sql-load-script = import-dev.sql -%test.quarkus.hibernate-orm.sql-load-script = import-test.sql -%prod.quarkus.hibernate-orm.sql-load-script = no-file ----- - -[NOTE] -==== -Quarkus supports `.sql` file with SQL statements or comments spread over multiple lines. -Each SQL statement must be terminated by a semicolon. -==== - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SQL_LOAD_SCRIPT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SQL_LOAD_SCRIPT+++` -endif::add-copy-button-to-env-var[] ---|list of string -|`import.sql in DEV, TEST ; no-file otherwise` - - -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.physical-naming-strategy]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.physical-naming-strategy[quarkus.hibernate-orm."persistence-unit-name".physical-naming-strategy]` - - -[.description] --- -Pluggable strategy contract for applying physical naming rules for database object names. Class name of the Hibernate PhysicalNamingStrategy implementation - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__PHYSICAL_NAMING_STRATEGY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__PHYSICAL_NAMING_STRATEGY+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.implicit-naming-strategy]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.implicit-naming-strategy[quarkus.hibernate-orm."persistence-unit-name".implicit-naming-strategy]` - - -[.description] --- -Pluggable strategy for applying implicit naming rules when an explicit name is not given. Class name of the Hibernate ImplicitNamingStrategy implementation - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__IMPLICIT_NAMING_STRATEGY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__IMPLICIT_NAMING_STRATEGY+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__IMPLICIT_NAMING_STRATEGY+++` endif::add-copy-button-to-env-var[] --|string | @@ -1558,73 +1408,183 @@ in order to reduce the frequency of database calls to retrieve those values and thereby improve performance. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__MAPPING_ID_OPTIMIZER_DEFAULT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__MAPPING_ID_OPTIMIZER_DEFAULT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__MAPPING_ID_OPTIMIZER_DEFAULT+++` +endif::add-copy-button-to-env-var[] +-- a| +`pooled-lo`, `pooled`, `none` +|`pooled-lo` + + +h|[[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.query-query-related-configuration]]link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.query-query-related-configuration[Query related configuration] + +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.query.query-plan-cache-max-size]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.query.query-plan-cache-max-size[quarkus.hibernate-orm."persistence-unit-name".query.query-plan-cache-max-size]` + + +[.description] +-- +The maximum size of the query plan cache. see ++#++`org.hibernate.cfg.AvailableSettings++#++QUERY_PLAN_CACHE_MAX_SIZE` + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUERY_QUERY_PLAN_CACHE_MAX_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUERY_QUERY_PLAN_CACHE_MAX_SIZE+++` +endif::add-copy-button-to-env-var[] +--|int +|`2048` + + +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.query.default-null-ordering]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.query.default-null-ordering[quarkus.hibernate-orm."persistence-unit-name".query.default-null-ordering]` + + +[.description] +-- +Default precedence of null values in `ORDER BY` clauses. + +Valid values are: `none`, `first`, `last`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUERY_DEFAULT_NULL_ORDERING+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUERY_DEFAULT_NULL_ORDERING+++` +endif::add-copy-button-to-env-var[] +-- a| +`none`, `first`, `last` +|`none` + + +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.query.in-clause-parameter-padding]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.query.in-clause-parameter-padding[quarkus.hibernate-orm."persistence-unit-name".query.in-clause-parameter-padding]` + + +[.description] +-- +Enables IN clause parameter padding which improves statement caching. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUERY_IN_CLAUSE_PARAMETER_PADDING+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUERY_IN_CLAUSE_PARAMETER_PADDING+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +h|[[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.database-database-related-configuration]]link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.database-database-related-configuration[Database related configuration] + +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.database.charset]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.database.charset[quarkus.hibernate-orm."persistence-unit-name".database.charset]` + + +[.description] +-- +The charset of the database. + +Used for DDL generation and also for the SQL import scripts. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_CHARSET+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_CHARSET+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html[Charset] + +|`UTF-8` + + +a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.database.generation]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.database.generation[quarkus.hibernate-orm."persistence-unit-name".database.generation]` + + +[.description] +-- +Select whether the database schema is generated or not. `drop-and-create` is awesome in development mode. This defaults to 'none', however if Dev Services is in use and no other extensions that manage the schema are present this will default to 'drop-and-create'. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION+++` +endif::add-copy-button-to-env-var[] +--|string +|`none` + + +a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.database.generation.create-schemas]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.database.generation.create-schemas[quarkus.hibernate-orm."persistence-unit-name".database.generation.create-schemas]` + + +[.description] +-- +If Hibernate ORM should create the schemas automatically (for databases supporting them). + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION_CREATE_SCHEMAS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__MAPPING_ID_OPTIMIZER_DEFAULT+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION_CREATE_SCHEMAS+++` endif::add-copy-button-to-env-var[] --- a| -`pooled-lo`, `pooled`, `none` -|`pooled-lo` - - -h|[[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.query-query-related-configuration]]link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.query-query-related-configuration[Query related configuration] +--|boolean +|`false` -h|Type -h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.query.query-plan-cache-max-size]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.query.query-plan-cache-max-size[quarkus.hibernate-orm."persistence-unit-name".query.query-plan-cache-max-size]` +a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.database.generation.halt-on-error]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.database.generation.halt-on-error[quarkus.hibernate-orm."persistence-unit-name".database.generation.halt-on-error]` [.description] -- -The maximum size of the query plan cache. see ++#++`org.hibernate.cfg.AvailableSettings++#++QUERY_PLAN_CACHE_MAX_SIZE` +Whether we should stop on the first error when applying the schema. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUERY_QUERY_PLAN_CACHE_MAX_SIZE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION_HALT_ON_ERROR+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUERY_QUERY_PLAN_CACHE_MAX_SIZE+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION_HALT_ON_ERROR+++` endif::add-copy-button-to-env-var[] ---|int -|`2048` +--|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.query.default-null-ordering]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.query.default-null-ordering[quarkus.hibernate-orm."persistence-unit-name".query.default-null-ordering]` +a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.database.default-catalog]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.database.default-catalog[quarkus.hibernate-orm."persistence-unit-name".database.default-catalog]` [.description] -- -Default precedence of null values in `ORDER BY` clauses. - -Valid values are: `none`, `first`, `last`. +The default catalog to use for the database objects. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUERY_DEFAULT_NULL_ORDERING+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_DEFAULT_CATALOG+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUERY_DEFAULT_NULL_ORDERING+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_DEFAULT_CATALOG+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `first`, `last` -|`none` +--|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.query.in-clause-parameter-padding]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.query.in-clause-parameter-padding[quarkus.hibernate-orm."persistence-unit-name".query.in-clause-parameter-padding]` +a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.database.default-schema]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.database.default-schema[quarkus.hibernate-orm."persistence-unit-name".database.default-schema]` [.description] -- -Enables IN clause parameter padding which improves statement caching. +The default schema to use for the database objects. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUERY_IN_CLAUSE_PARAMETER_PADDING+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_DEFAULT_SCHEMA+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__QUERY_IN_CLAUSE_PARAMETER_PADDING+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_DEFAULT_SCHEMA+++` endif::add-copy-button-to-env-var[] ---|boolean -|`true` +--|string +| h|[[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.jdbc-jdbc-related-configuration]]link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.jdbc-jdbc-related-configuration[JDBC related configuration] @@ -1788,244 +1748,284 @@ endif::add-copy-button-to-env-var[] |`false` -h|[[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.database-database-related-configuration]]link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.database-database-related-configuration[Database related configuration] +h|[[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.scripts-database-scripts-related-configuration]]link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.scripts-database-scripts-related-configuration[Database scripts related configuration] h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.database.charset]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.database.charset[quarkus.hibernate-orm."persistence-unit-name".database.charset]` +a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation[quarkus.hibernate-orm."persistence-unit-name".scripts.generation]` [.description] -- -The charset of the database. +Select whether the database schema DDL files are generated or not. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`. -Used for DDL generation and also for the SQL import scripts. +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION+++` +endif::add-copy-button-to-env-var[] +--|string +|`none` + + +a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation.create-target]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation.create-target[quarkus.hibernate-orm."persistence-unit-name".scripts.generation.create-target]` + + +[.description] +-- +Filename or URL where the database create DDL file should be generated. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_CHARSET+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION_CREATE_TARGET+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_CHARSET+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION_CREATE_TARGET+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html[Charset] - -|`UTF-8` +--|string +| -a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.database.generation]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.database.generation[quarkus.hibernate-orm."persistence-unit-name".database.generation]` +a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation.drop-target]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation.drop-target[quarkus.hibernate-orm."persistence-unit-name".scripts.generation.drop-target]` [.description] -- -Select whether the database schema is generated or not. `drop-and-create` is awesome in development mode. This defaults to 'none', however if Dev Services is in use and no other extensions that manage the schema are present this will default to 'drop-and-create'. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`. +Filename or URL where the database drop DDL file should be generated. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION_DROP_TARGET+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION_DROP_TARGET+++` endif::add-copy-button-to-env-var[] --|string -|`none` +| -a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.database.generation.create-schemas]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.database.generation.create-schemas[quarkus.hibernate-orm."persistence-unit-name".database.generation.create-schemas]` +h|[[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.log-logging-configuration]]link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.log-logging-configuration[Logging configuration] + +h|Type +h|Default + +a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.log.sql]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.log.sql[quarkus.hibernate-orm."persistence-unit-name".log.sql]` [.description] -- -If Hibernate ORM should create the schemas automatically (for databases supporting them). +Show SQL logs and format them nicely. + +Setting it to true is obviously not recommended in production. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION_CREATE_SCHEMAS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_SQL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION_CREATE_SCHEMAS+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_SQL+++` endif::add-copy-button-to-env-var[] --|boolean |`false` -a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.database.generation.halt-on-error]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.database.generation.halt-on-error[quarkus.hibernate-orm."persistence-unit-name".database.generation.halt-on-error]` +a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.log.format-sql]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.log.format-sql[quarkus.hibernate-orm."persistence-unit-name".log.format-sql]` [.description] -- -Whether we should stop on the first error when applying the schema. +Format the SQL logs if SQL log is enabled ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION_HALT_ON_ERROR+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_FORMAT_SQL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_GENERATION_HALT_ON_ERROR+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_FORMAT_SQL+++` endif::add-copy-button-to-env-var[] --|boolean -|`false` +|`true` -a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.database.default-catalog]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.database.default-catalog[quarkus.hibernate-orm."persistence-unit-name".database.default-catalog]` +a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.log.jdbc-warnings]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.log.jdbc-warnings[quarkus.hibernate-orm."persistence-unit-name".log.jdbc-warnings]` [.description] -- -The default catalog to use for the database objects. +Whether JDBC warnings should be collected and logged. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_DEFAULT_CATALOG+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_JDBC_WARNINGS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_DEFAULT_CATALOG+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_JDBC_WARNINGS+++` endif::add-copy-button-to-env-var[] ---|string -| +--|boolean +|`depends on dialect` -a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.database.default-schema]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.database.default-schema[quarkus.hibernate-orm."persistence-unit-name".database.default-schema]` +a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.log.queries-slower-than-ms]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.log.queries-slower-than-ms[quarkus.hibernate-orm."persistence-unit-name".log.queries-slower-than-ms]` [.description] -- -The default schema to use for the database objects. +If set, Hibernate will log queries that took more than specified number of milliseconds to execute. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_DEFAULT_SCHEMA+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_QUERIES_SLOWER_THAN_MS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__DATABASE_DEFAULT_SCHEMA+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_QUERIES_SLOWER_THAN_MS+++` endif::add-copy-button-to-env-var[] ---|string +--|long | -h|[[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.scripts-database-scripts-related-configuration]]link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.scripts-database-scripts-related-configuration[Database scripts related configuration] +h|[[quarkus-hibernate-orm_quarkus.hibernate-orm.log-logging-configuration]]link:#quarkus-hibernate-orm_quarkus.hibernate-orm.log-logging-configuration[Logging configuration] h|Type h|Default -a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation[quarkus.hibernate-orm."persistence-unit-name".scripts.generation]` +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus.hibernate-orm.log.bind-parameters]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.log.bind-parameters[quarkus.hibernate-orm.log.bind-parameters]` [.description] -- -Select whether the database schema DDL files are generated or not. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`. +Logs SQL bind parameters. + +Setting it to true is obviously not recommended in production. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_BIND_PARAMETERS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_BIND_PARAMETERS+++` endif::add-copy-button-to-env-var[] ---|string -|`none` +--|boolean +|`false` -a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation.create-target]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation.create-target[quarkus.hibernate-orm."persistence-unit-name".scripts.generation.create-target]` +a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.log.sql]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.log.sql[quarkus.hibernate-orm.log.sql]` [.description] -- -Filename or URL where the database create DDL file should be generated. +Show SQL logs and format them nicely. + +Setting it to true is obviously not recommended in production. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION_CREATE_TARGET+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_SQL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION_CREATE_TARGET+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_SQL+++` endif::add-copy-button-to-env-var[] ---|string -| +--|boolean +|`false` -a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation.drop-target]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.scripts.generation.drop-target[quarkus.hibernate-orm."persistence-unit-name".scripts.generation.drop-target]` +a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.log.format-sql]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.log.format-sql[quarkus.hibernate-orm.log.format-sql]` [.description] -- -Filename or URL where the database drop DDL file should be generated. +Format the SQL logs if SQL log is enabled ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION_DROP_TARGET+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_FORMAT_SQL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__SCRIPTS_GENERATION_DROP_TARGET+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_FORMAT_SQL+++` endif::add-copy-button-to-env-var[] ---|string -| +--|boolean +|`true` -h|[[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.log-logging-configuration]]link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.log-logging-configuration[Logging configuration] +a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.log.jdbc-warnings]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.log.jdbc-warnings[quarkus.hibernate-orm.log.jdbc-warnings]` -h|Type -h|Default -a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.log.sql]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.log.sql[quarkus.hibernate-orm."persistence-unit-name".log.sql]` +[.description] +-- +Whether JDBC warnings should be collected and logged. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_JDBC_WARNINGS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_JDBC_WARNINGS+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`depends on dialect` + + +a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.log.queries-slower-than-ms]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.log.queries-slower-than-ms[quarkus.hibernate-orm.log.queries-slower-than-ms]` [.description] -- -Show SQL logs and format them nicely. - -Setting it to true is obviously not recommended in production. +If set, Hibernate will log queries that took more than specified number of milliseconds to execute. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_SQL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_QUERIES_SLOWER_THAN_MS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_SQL+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_QUERIES_SLOWER_THAN_MS+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` +--|long +| -a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.log.format-sql]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.log.format-sql[quarkus.hibernate-orm."persistence-unit-name".log.format-sql]` +h|[[quarkus-hibernate-orm_quarkus.hibernate-orm.scripts-database-scripts-related-configuration]]link:#quarkus-hibernate-orm_quarkus.hibernate-orm.scripts-database-scripts-related-configuration[Database scripts related configuration] + +h|Type +h|Default + +a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.scripts.generation]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.scripts.generation[quarkus.hibernate-orm.scripts.generation]` [.description] -- -Format the SQL logs if SQL log is enabled +Select whether the database schema DDL files are generated or not. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_FORMAT_SQL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_FORMAT_SQL+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION+++` endif::add-copy-button-to-env-var[] ---|boolean -|`true` +--|string +|`none` -a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.log.jdbc-warnings]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.log.jdbc-warnings[quarkus.hibernate-orm."persistence-unit-name".log.jdbc-warnings]` +a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.scripts.generation.create-target]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.scripts.generation.create-target[quarkus.hibernate-orm.scripts.generation.create-target]` [.description] -- -Whether JDBC warnings should be collected and logged. +Filename or URL where the database create DDL file should be generated. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_JDBC_WARNINGS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION_CREATE_TARGET+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_JDBC_WARNINGS+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION_CREATE_TARGET+++` endif::add-copy-button-to-env-var[] ---|boolean -|`depends on dialect` +--|string +| -a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.log.queries-slower-than-ms]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.-persistence-unit-name-.log.queries-slower-than-ms[quarkus.hibernate-orm."persistence-unit-name".log.queries-slower-than-ms]` +a| [[quarkus-hibernate-orm_quarkus.hibernate-orm.scripts.generation.drop-target]]`link:#quarkus-hibernate-orm_quarkus.hibernate-orm.scripts.generation.drop-target[quarkus.hibernate-orm.scripts.generation.drop-target]` [.description] -- -If set, Hibernate will log queries that took more than specified number of milliseconds to execute. +Filename or URL where the database drop DDL file should be generated. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_QUERIES_SLOWER_THAN_MS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION_DROP_TARGET+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM__PERSISTENCE_UNIT_NAME__LOG_QUERIES_SLOWER_THAN_MS+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION_DROP_TARGET+++` endif::add-copy-button-to-env-var[] ---|long +--|string | |=== 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 2607f2788a..666d8dfb58 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 @@ -291,4 +291,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/11/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() javadoc] 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 038887676d..5463b81bd2 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 @@ -280,6 +280,493 @@ 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`). + +Will default to `false` in Hibernate Search 7. + +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 +|`true` + + +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 @@ -382,4 +869,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/11/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() javadoc] 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 687012f6ff..c482875c6e 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 @@ -502,104 +502,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 https://docs.jboss.org/hibernate/stable/search/reference/en-US/html_single/#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 https://docs.jboss.org/hibernate/stable/search/reference/en-US/html_single/#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. -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 2c0df8ce71..4faf529176 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 @@ -260,185 +260,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 layout (e.g. index names, index aliases). - -The referenced bean must implement `IndexLayoutStrategy`. - -Available built-in implementations: - -`simple`:: -The default, future-proof strategy: if the index name in Hibernate Search is `myIndex`, -this strategy will create an index named `myindex-000001`, an alias for write operations named `myindex-write`, -and an alias for read operations named `myindex-read`. -`no-alias`:: -A strategy without index aliases, mostly useful on legacy clusters: -if the index name in Hibernate Search is `myIndex`, -this strategy will create an index named `myindex`, and will not use any alias. - -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. -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 https://docs.jboss.org/hibernate/stable/search/reference/en-US/html_single/#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 https://docs.jboss.org/hibernate/stable/search/reference/en-US/html_single/#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. -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]` @@ -931,104 +752,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 https://docs.jboss.org/hibernate/stable/search/reference/en-US/html_single/#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 https://docs.jboss.org/hibernate/stable/search/reference/en-US/html_single/#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. -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 d4c84b60ec..22626b2fe3 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 @@ -301,6 +301,493 @@ 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`). + +Will default to `false` in Hibernate Search 7. + +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 +|`true` + + +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 @@ -403,4 +890,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/11/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() javadoc] 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 b7bddfb5d9..4f6f3e936d 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 @@ -260,185 +260,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 layout (e.g. index names, index aliases). - -The referenced bean must implement `IndexLayoutStrategy`. - -Available built-in implementations: - -`simple`:: -The default, future-proof strategy: if the index name in Hibernate Search is `myIndex`, -this strategy will create an index named `myindex-000001`, an alias for write operations named `myindex-write`, -and an alias for read operations named `myindex-read`. -`no-alias`:: -A strategy without index aliases, mostly useful on legacy clusters: -if the index name in Hibernate Search is `myIndex`, -this strategy will create an index named `myindex`, and will not use any alias. - -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. -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 https://docs.jboss.org/hibernate/stable/search/reference/en-US/html_single/#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 https://docs.jboss.org/hibernate/stable/search/reference/en-US/html_single/#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. -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]` @@ -931,104 +752,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 https://docs.jboss.org/hibernate/stable/search/reference/en-US/html_single/#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 https://docs.jboss.org/hibernate/stable/search/reference/en-US/html_single/#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. -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-opentelemetry.adoc b/_generated-doc/main/config/quarkus-opentelemetry.adoc index 190ddbccb9..ab8e7461e9 100644 --- a/_generated-doc/main/config/quarkus-opentelemetry.adoc +++ b/_generated-doc/main/config/quarkus-opentelemetry.adoc @@ -455,6 +455,24 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-opentelemetry_quarkus.otel.experimental.shutdown-wait-time]]`link:#quarkus-opentelemetry_quarkus.otel.experimental.shutdown-wait-time[quarkus.otel.experimental.shutdown-wait-time]` + + +[.description] +-- +The maximum amount of time Quarkus will wait for the OpenTelemetry SDK to flush unsent spans and shutdown. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPERIMENTAL_SHUTDOWN_WAIT_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPERIMENTAL_SHUTDOWN_WAIT_TIME+++` +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-opentelemetry_quarkus.otel.exporter.otlp.endpoint]]`link:#quarkus-opentelemetry_quarkus.otel.exporter.otlp.endpoint[quarkus.otel.exporter.otlp.endpoint]` diff --git a/_generated-doc/main/config/quarkus-otel-config-runtime-o-tel-runtime-config.adoc b/_generated-doc/main/config/quarkus-otel-config-runtime-o-tel-runtime-config.adoc index e8f865eb26..4925f9c68b 100644 --- a/_generated-doc/main/config/quarkus-otel-config-runtime-o-tel-runtime-config.adoc +++ b/_generated-doc/main/config/quarkus-otel-config-runtime-o-tel-runtime-config.adoc @@ -338,6 +338,24 @@ endif::add-copy-button-to-env-var[] --|list of string | + +a| [[quarkus-otel-config-runtime-o-tel-runtime-config_quarkus.otel.experimental.shutdown-wait-time]]`link:#quarkus-otel-config-runtime-o-tel-runtime-config_quarkus.otel.experimental.shutdown-wait-time[quarkus.otel.experimental.shutdown-wait-time]` + + +[.description] +-- +The maximum amount of time Quarkus will wait for the OpenTelemetry SDK to flush unsent spans and shutdown. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPERIMENTAL_SHUTDOWN_WAIT_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPERIMENTAL_SHUTDOWN_WAIT_TIME+++` +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` + |=== ifndef::no-duration-note[] [NOTE] 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 dd552e690a..aa9b721c5d 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,4 +26,540 @@ endif::add-copy-button-to-env-var[] --|boolean |`true` -|=== \ No newline at end of file + +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 a round-robin load balancing when a connection is created to select different servers. Note: some driver may not support multiple values here. + +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 an empty string. + +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 +| + + +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-additional-properties]]`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-additional-properties[quarkus.datasource."datasource-name".reactive.additional-properties]` + + +[.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+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_ADDITIONAL_PROPERTIES+++` +endif::add-copy-button-to-env-var[] +--|`Map` +| + +|=== +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/11/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() javadoc] 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-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 ac67fd8f6a..5d068d9f2b 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,23 +10,6 @@ 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/_versions/main/guides/datasource.adoc b/_versions/main/guides/datasource.adoc index fae706a1b1..825a977676 100644 --- a/_versions/main/guides/datasource.adoc +++ b/_versions/main/guides/datasource.adoc @@ -15,7 +15,7 @@ Use a unified configuration model to define data sources for Java Database Conne //// Note for contributors and writers: -In text, use `data source` in code, `datasource` or `DataSource` is more common. +In text, use "data source". In code, "datasource" or "DataSource" is more common. See, https://docs.oracle.com/javase/tutorial/jdbc/basics/connecting.html //// @@ -32,7 +32,7 @@ Additionally, refer to the Quarkus xref:hibernate-orm.adoc[Hibernate ORM] guide == Get started with configuring `datasources` in Quarkus -For rapid configuration of datasources, this section offers a brief overview and code samples for testing and utilization, suitable for users familiar with the fundamentals. +For users familiar with the fundamentals, this section provides an overview and code samples to set up data sources quickly. For more advanced configuration with examples, see xref:datasource-reference[References]. @@ -48,7 +48,7 @@ In dev mode, if you do not provide any explicit database connection details, Qua If you provide user credentials, the underlying database will be configured to use them. This is useful if you want to connect to the database with an external tool. -To utilize this feature, ensure a Docker or Podman container runtime is installed, depending on the database type. Certain databases, such as H2, operate in in-memory mode and do not require a container runtime. +To use this feature, ensure a Docker or Podman container runtime is installed, depending on the database type. Certain databases, such as H2, operate in in-memory mode and do not require a container runtime. TIP: Prefix the actual connection details for prod mode with `%prod.` to ensure they are not applied in dev mode. For more information, see the xref:config-reference.adoc#profiles[Profiles] section of the "Configuration reference" guide. @@ -160,7 +160,7 @@ Quarkus currently includes the following built-in database kinds: You can use any JDBC driver in a Quarkus app in JVM mode as described in xref:other-databases[Using other databases]. However, using a non-built-in database kind is unlikely to work when compiling your application to a native executable. -For native executable builds, it is recommended to either utilize the available JDBC Quarkus extensions or contribute a custom extension for your specific driver. +For native executable builds, it is recommended to either use the available JDBC Quarkus extensions or contribute a custom extension for your specific driver. ==== . Configure the following properties to define credentials: @@ -216,7 +216,7 @@ However, for custom drivers, Agroal needs to be added explicitly. ==== -.. For use with a custom JDBC driver, add the `quarkus-agroal` dependency to your project alongside the extension for your relational database driver: +.. For use with a custom JDBC driver, add the `quarkus-agroal` dependency to your project alongside the extension for your relational database driver: + [source,bash] ---- diff --git a/_versions/main/guides/logging.adoc b/_versions/main/guides/logging.adoc index 147a5b48b9..7f6db47cde 100644 --- a/_versions/main/guides/logging.adoc +++ b/_versions/main/guides/logging.adoc @@ -14,7 +14,7 @@ include::_attributes.adoc[] Read about the use of logging API in Quarkus, configuring logging output, and using logging adapters to unify the output from other logging APIs. Quarkus uses the JBoss Log Manager logging backend for publishing application and framework logs. -Quarkus supports the JBoss Logging API as well as multiple other logging APIs, seamlessly integrated with JBoss Log Manager. +Quarkus supports the JBoss Logging API and multiple other logging APIs, seamlessly integrated with JBoss Log Manager. You can use any of the xref:logging-apis[following APIs]: * link:https://github.com/jboss-logging/jboss-logging[JBoss Logging] @@ -334,7 +334,7 @@ The logging format string supports the following symbols: |%e|Exception|Renders the thrown exception, if any. |%F|Source file|Renders the source file name.footnote:calc[] |%h|Host name|Renders the system simple host name. -|%H|Qualified host name|Renders the system's fully qualified host name, which may be the same as the simple host name, depending on OS configuration. +|%H|Qualified host name|Renders the system's fully qualified host name, which may be the same as the simple host name, depending on operating system configuration. |%i|Process ID|Render the current process PID. |%l|Source location|Renders the source location information, which includes source file name, line number, class name, and method name.footnote:calc[] |%L|Source line|Renders the source line number.footnote:calc[] @@ -474,7 +474,7 @@ For details about its configuration, see the xref:#quarkus-log-logging-log-confi === Syslog log handler -The syslog handler in Quarkus follows the link:https://en.wikipedia.org/wiki/Syslog[Syslog] protocol, which is used to send log messages on Unix-like systems. +The syslog handler in Quarkus follows the link:https://en.wikipedia.org/wiki/Syslog[Syslog] protocol, which is used to send log messages on UNIX-like systems. It utilizes the protocol defined in link:https://tools.ietf.org/html/rfc5424[RFC 5424]. By default, the syslog handler is disabled. @@ -813,7 +813,7 @@ You get messages containing the MDC data: [source, text] ---- -08:48:13 INFO request.id=c37a3a36-b7f6-4492-83a1-de41dbc26fe2 request.path=/hello/test [me.sa.GreetingResourceJbossLogging] (executor-thread-1) request received +08:48:13 INFO request.id=c37a3a36-b7f6-4492-83a1-de41dbc26fe2 request.path=/hello/test [me.sa.GreetingResourceJbossLogging] (executor-thread-1) request received ---- ==== MDC and supported logging APIs