From b11d02cf8415971f4253060e7d4ebc22aae6e91b Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Thu, 8 Aug 2024 01:54:33 +0000 Subject: [PATCH] Sync documentation of main branch --- .../main/config/quarkus-all-build-items.adoc | 8 + _generated-doc/main/config/quarkus-core.adoc | 72 +- ...-config-hibernate-orm-config-database.adoc | 96 --- ...e-orm-config-hibernate-orm-config-log.adoc | 97 --- ...us-hibernate-orm-general-config-items.adoc | 678 +++++++++--------- ...us-hibernate-orm-hibernate-orm-config.adoc | 193 ----- .../main/config/quarkus-hibernate-orm.adoc | 678 +++++++++--------- ...rkus-smallrye-reactivemessaging-kafka.adoc | 28 +- _versions/main/guides/_attributes.adoc | 2 +- _versions/main/guides/hibernate-orm.adoc | 2 +- 10 files changed, 738 insertions(+), 1116 deletions(-) diff --git a/_generated-doc/main/config/quarkus-all-build-items.adoc b/_generated-doc/main/config/quarkus-all-build-items.adoc index b0a7f70afc5..98c7d19c575 100644 --- a/_generated-doc/main/config/quarkus-all-build-items.adoc +++ b/_generated-doc/main/config/quarkus-all-build-items.adoc @@ -701,6 +701,10 @@ _No Javadoc found_ _No Javadoc found_ +`java.lang.String description` + +_No Javadoc found_ + `io.quarkus.deployment.dev.devservices.ContainerInfo containerInfo` _No Javadoc found_ @@ -760,6 +764,10 @@ BuildItem for running dev services. Combines injected configs to the application _No Javadoc found_ +`java.lang.String description` + +_No Javadoc found_ + `java.lang.String containerId` _No Javadoc found_ diff --git a/_generated-doc/main/config/quarkus-core.adoc b/_generated-doc/main/config/quarkus-core.adoc index 7051bc4d5bd..980fecc57a4 100644 --- a/_generated-doc/main/config/quarkus-core.adoc +++ b/_generated-doc/main/config/quarkus-core.adoc @@ -77,6 +77,42 @@ endif::add-copy-button-to-env-var[] |`Build system locale` +a| [[quarkus-core_quarkus-init-and-exit]]`link:#quarkus-core_quarkus-init-and-exit[quarkus.init-and-exit]` + + +[.description] +-- +true to quit exit right after the initialization. The option is not meant be used directly by users. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INIT_AND_EXIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INIT_AND_EXIT+++` +endif::add-copy-button-to-env-var[] +--|@io.smallrye.config.WithConverter(io.quarkus.runtime.init.InitRuntimeConfig.BooleanConverter.class) boolean +|`false` + + +a| [[quarkus-core_quarkus-args]]`link:#quarkus-core_quarkus-args[quarkus.args]` + + +[.description] +-- +The arguments passed to the command line. + +We don't make it a list as the args are separated by a space, not a comma. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ARGS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ARGS+++` +endif::add-copy-button-to-env-var[] +--|string +| + + a| [[quarkus-core_quarkus-profile]]`link:#quarkus-core_quarkus-profile[quarkus.profile]` @@ -182,42 +218,6 @@ endif::add-copy-button-to-env-var[] | -a| [[quarkus-core_quarkus-init-and-exit]]`link:#quarkus-core_quarkus-init-and-exit[quarkus.init-and-exit]` - - -[.description] --- -true to quit exit right after the initialization. The option is not meant be used directly by users. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_INIT_AND_EXIT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_INIT_AND_EXIT+++` -endif::add-copy-button-to-env-var[] ---|@io.smallrye.config.WithConverter(io.quarkus.runtime.init.InitRuntimeConfig.BooleanConverter.class) boolean -|`false` - - -a| [[quarkus-core_quarkus-args]]`link:#quarkus-core_quarkus-args[quarkus.args]` - - -[.description] --- -The arguments passed to the command line. - -We don't make it a list as the args are separated by a space, not a comma. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_ARGS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_ARGS+++` -endif::add-copy-button-to-env-var[] ---|string -| - - a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-analytics-disabled]]`link:#quarkus-core_quarkus-analytics-disabled[quarkus.analytics.disabled]` diff --git a/_generated-doc/main/config/quarkus-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 3739c646cd5..68a86a3ce0d 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 @@ -67,100 +67,4 @@ 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]` - -`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database_quarkus-hibernate-orm-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_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[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[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]` - -`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database_quarkus-hibernate-orm-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_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]` - -`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database_quarkus-hibernate-orm-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_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]` - -`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database_quarkus-hibernate-orm-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_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]` - -`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-database_quarkus-hibernate-orm-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_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 f41b043be8d..95b2b442bdf 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,101 +28,4 @@ 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]` - -`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log_quarkus-hibernate-orm-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_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]` - -`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log_quarkus-hibernate-orm-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_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-highlight-sql]]`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log_quarkus-hibernate-orm-log-highlight-sql[quarkus.hibernate-orm.log.highlight-sql]` - -`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log_quarkus-hibernate-orm-log-highlight-sql[quarkus.hibernate-orm."persistence-unit-name".log.highlight-sql]` - - -[.description] --- -Highlight 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_HIGHLIGHT_SQL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_HIGHLIGHT_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]` - -`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log_quarkus-hibernate-orm-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_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]` - -`link:#quarkus-hibernate-orm-config-group-hibernate-orm-config-hibernate-orm-config-log_quarkus-hibernate-orm-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_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-general-config-items.adoc b/_generated-doc/main/config/quarkus-hibernate-orm-general-config-items.adoc index d07a2697380..cad9ed66c11 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 @@ -393,740 +393,740 @@ 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|[[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 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-dialect]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-dialect[quarkus.hibernate-orm.dialect]` + +`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-dialect[quarkus.hibernate-orm."persistence-unit-name".dialect]` [.description] -- -When set, attempts to exchange data with the database -as the given version of Hibernate ORM would have, -*on a best-effort basis*. +Name of the Hibernate ORM dialect. -Please note: +For xref:datasource.adoc#extensions-and-database-drivers-reference[supported databases], +this property does not need to be set explicitly: +it is selected automatically based on the datasource, +and configured using the xref:datasource.adoc#quarkus-datasource_quarkus.datasource.db-version[DB version set on the +datasource] +to benefit from the best performance and latest features. -* 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 your database does not have a corresponding Quarkus extension, +you *will* need to set this property explicitly. +In that case, keep in mind that the JDBC driver and Hibernate ORM dialect +may not work properly in GraalVM native executables. + +For built-in dialects, the expected value is one of the names +in the link:{hibernate-orm-dialect-docs-url}[official list of dialects], +*without* the `Dialect` suffix, +for example `Cockroach` for `CockroachDialect`. + +For third-party dialects, the expected value is the fully-qualified class name, +for example `com.acme.hibernate.AcmeDbDialect`. 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_DIALECT+++[] 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_DIALECT+++` endif::add-copy-button-to-env-var[] --- a| -`5.6`, `latest` -|`latest` +--|string +|`selected automatically for most popular databases` -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-dialect-storage-engine]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-dialect-storage-engine[quarkus.hibernate-orm.dialect.storage-engine]` -`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-database-charset[quarkus.hibernate-orm."persistence-unit-name".database.charset]` +`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-dialect-storage-engine[quarkus.hibernate-orm."persistence-unit-name".dialect.storage-engine]` [.description] -- -The charset of the database. +The storage engine to use when the dialect supports multiple storage engines. -Used for DDL generation and also for the SQL import scripts. +E.g. `MyISAM` or `InnoDB` for MySQL. 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_DIALECT_STORAGE_ENGINE+++[] 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_DIALECT_STORAGE_ENGINE+++` 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-database-generation]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-database-generation[quarkus.hibernate-orm.database.generation]` +h|[[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-mapping-mapping-configuration]]link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-mapping-mapping-configuration[Mapping configuration] -`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-database-generation[quarkus.hibernate-orm."persistence-unit-name".database.generation]` +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-mapping-timezone-default-storage]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-mapping-timezone-default-storage[quarkus.hibernate-orm.mapping.timezone.default-storage]` + +`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-mapping-timezone-default-storage[quarkus.hibernate-orm."persistence-unit-name".mapping.timezone.default-storage]` [.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`. +How to store timezones in the database by default +for properties of type `OffsetDateTime` and `ZonedDateTime`. + +This default may be overridden on a per-property basis using `@TimeZoneStorage`. + +NOTE: Properties of type `OffsetTime` are https://hibernate.atlassian.net/browse/HHH-16287[not affected by this +setting]. + +`default`:: +Equivalent to `native` if supported, `normalize-utc` otherwise. +`auto`:: +Equivalent to `native` if supported, `column` otherwise. +`native`:: +Stores the timestamp and timezone in a column of type `timestamp with time zone`. ++ +Only available on some databases/dialects; +if not supported, an exception will be thrown during static initialization. +`column`:: +Stores the timezone in a separate column next to the timestamp column. ++ +Use `@TimeZoneColumn` on the relevant entity property to customize the timezone column. +`normalize-utc`:: +Does not store the timezone, and loses timezone information upon persisting. ++ +Instead, normalizes the value to a timestamp in the UTC timezone. +`normalize`:: +Does not store the timezone, and loses timezone information upon persisting. ++ +Instead, normalizes the value: +* upon persisting to the database, to a timestamp in the JDBC timezone +set through `quarkus.hibernate-orm.jdbc.timezone`, +or the JVM default timezone if not set. +* upon reading back from the database, to the JVM default timezone. ++ +Use this to get the legacy behavior of Quarkus 2 / Hibernate ORM 5 or older. 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_MAPPING_TIMEZONE_DEFAULT_STORAGE+++[] 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_MAPPING_TIMEZONE_DEFAULT_STORAGE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] - -|`none` +-- a| +`native`, `normalize`, `normalize-utc`, `column`, `auto`, `default` +|`default` -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-mapping-id-optimizer-default]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-mapping-id-optimizer-default[quarkus.hibernate-orm.mapping.id.optimizer.default]` -`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-database-generation-create-schemas[quarkus.hibernate-orm."persistence-unit-name".database.generation.create-schemas]` +`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-mapping-id-optimizer-default[quarkus.hibernate-orm."persistence-unit-name".mapping.id.optimizer.default]` [.description] -- -If Hibernate ORM should create the schemas automatically (for databases supporting them). +The optimizer to apply to identifier generators +whose optimizer is not configured explicitly. + +Only relevant for table- and sequence-based identifier generators. +Other generators, such as UUID-based generators, will ignore this setting. + +The optimizer is responsible for pooling new identifier values, +in order to reduce the frequency of database calls to retrieve those values +and thereby improve performance. 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_MAPPING_ID_OPTIMIZER_DEFAULT+++[] 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_MAPPING_ID_OPTIMIZER_DEFAULT+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` +-- a| +`pooled-lo`, `pooled`, `none` +|`pooled-lo` -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]` +h|[[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-query-query-related-configuration]]link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-query-query-related-configuration[Query related configuration] -`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-database-generation-halt-on-error[quarkus.hibernate-orm."persistence-unit-name".database.generation.halt-on-error]` +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-query-query-plan-cache-max-size]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-query-query-plan-cache-max-size[quarkus.hibernate-orm.query.query-plan-cache-max-size]` + +`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-query-query-plan-cache-max-size[quarkus.hibernate-orm."persistence-unit-name".query.query-plan-cache-max-size]` [.description] -- -Whether we should stop on the first error when applying the schema. +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_DATABASE_GENERATION_HALT_ON_ERROR+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_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_DATABASE_GENERATION_HALT_ON_ERROR+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_QUERY_QUERY_PLAN_CACHE_MAX_SIZE+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` +--|int +|`2048` -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]` +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-query-default-null-ordering]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-query-default-null-ordering[quarkus.hibernate-orm.query.default-null-ordering]` -`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-database-default-catalog[quarkus.hibernate-orm."persistence-unit-name".database.default-catalog]` +`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-query-default-null-ordering[quarkus.hibernate-orm."persistence-unit-name".query.default-null-ordering]` [.description] -- -The default catalog to use for the database objects. +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_DATABASE_DEFAULT_CATALOG+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_QUERY_DEFAULT_NULL_ORDERING+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_CATALOG+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_QUERY_DEFAULT_NULL_ORDERING+++` endif::add-copy-button-to-env-var[] ---|string -| +-- a| +`none`, `first`, `last` +|`none` -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]` +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-query-in-clause-parameter-padding]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-query-in-clause-parameter-padding[quarkus.hibernate-orm.query.in-clause-parameter-padding]` -`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-database-default-schema[quarkus.hibernate-orm."persistence-unit-name".database.default-schema]` +`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-query-in-clause-parameter-padding[quarkus.hibernate-orm."persistence-unit-name".query.in-clause-parameter-padding]` [.description] -- -The default schema to use for the database objects. +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_DATABASE_DEFAULT_SCHEMA+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_QUERY_IN_CLAUSE_PARAMETER_PADDING+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_SCHEMA+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_QUERY_IN_CLAUSE_PARAMETER_PADDING+++` endif::add-copy-button-to-env-var[] ---|string -| +--|boolean +|`true` -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|[[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-jdbc-jdbc-related-configuration]]link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-jdbc-jdbc-related-configuration[JDBC related 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]` +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-jdbc-timezone]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-jdbc-timezone[quarkus.hibernate-orm.jdbc.timezone]` + +`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-jdbc-timezone[quarkus.hibernate-orm."persistence-unit-name".jdbc.timezone]` [.description] -- -Logs SQL bind parameters. - -Setting it to true is obviously not recommended in production. +The time zone pushed to the JDBC driver. See `quarkus.hibernate-orm.mapping.timezone.default-storage`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_BIND_PARAMETERS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_JDBC_TIMEZONE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_BIND_PARAMETERS+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_JDBC_TIMEZONE+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` +--|string +| -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]` +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-jdbc-statement-fetch-size]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-jdbc-statement-fetch-size[quarkus.hibernate-orm.jdbc.statement-fetch-size]` -`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-log-sql[quarkus.hibernate-orm."persistence-unit-name".log.sql]` +`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-jdbc-statement-fetch-size[quarkus.hibernate-orm."persistence-unit-name".jdbc.statement-fetch-size]` [.description] -- -Show SQL logs and format them nicely. - -Setting it to true is obviously not recommended in production. +How many rows are fetched at a time by the JDBC driver. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_SQL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_JDBC_STATEMENT_FETCH_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_SQL+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_JDBC_STATEMENT_FETCH_SIZE+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` +--|int +| -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]` +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-jdbc-statement-batch-size]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-jdbc-statement-batch-size[quarkus.hibernate-orm.jdbc.statement-batch-size]` -`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-log-format-sql[quarkus.hibernate-orm."persistence-unit-name".log.format-sql]` +`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-jdbc-statement-batch-size[quarkus.hibernate-orm."persistence-unit-name".jdbc.statement-batch-size]` [.description] -- -Format the SQL logs if SQL log is enabled +The number of updates (inserts, updates and deletes) that are sent by the JDBC driver at one time for execution. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_FORMAT_SQL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_JDBC_STATEMENT_BATCH_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_FORMAT_SQL+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_JDBC_STATEMENT_BATCH_SIZE+++` endif::add-copy-button-to-env-var[] ---|boolean -|`true` +--|int +| -a| [[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-log-highlight-sql]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-log-highlight-sql[quarkus.hibernate-orm.log.highlight-sql]` +h|[[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-fetch-fetching-logic-configuration]]link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-fetch-fetching-logic-configuration[Fetching logic configuration] -`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-log-highlight-sql[quarkus.hibernate-orm."persistence-unit-name".log.highlight-sql]` +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-fetch-batch-size]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-fetch-batch-size[quarkus.hibernate-orm.fetch.batch-size]` + +`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-fetch-batch-size[quarkus.hibernate-orm."persistence-unit-name".fetch.batch-size]` [.description] -- -Highlight the SQL logs if SQL log is enabled +The size of the batches used when loading entities and collections. + +`-1` means batch loading is disabled. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_HIGHLIGHT_SQL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_FETCH_BATCH_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_HIGHLIGHT_SQL+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_FETCH_BATCH_SIZE+++` endif::add-copy-button-to-env-var[] ---|boolean -|`true` +--|int +|`16` -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]` +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-fetch-max-depth]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-fetch-max-depth[quarkus.hibernate-orm.fetch.max-depth]` -`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-log-jdbc-warnings[quarkus.hibernate-orm."persistence-unit-name".log.jdbc-warnings]` +`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-fetch-max-depth[quarkus.hibernate-orm."persistence-unit-name".fetch.max-depth]` [.description] -- -Whether JDBC warnings should be collected and logged. +The maximum depth of outer join fetch tree for single-ended associations (one-to-one, many-to-one). + +A `0` disables default outer join fetching. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_JDBC_WARNINGS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_FETCH_MAX_DEPTH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_JDBC_WARNINGS+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_FETCH_MAX_DEPTH+++` endif::add-copy-button-to-env-var[] ---|boolean -|`depends on dialect` +--|int +| -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]` +h|[[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-cache-caching-configuration]]link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-cache-caching-configuration[Caching configuration] -`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-log-queries-slower-than-ms[quarkus.hibernate-orm."persistence-unit-name".log.queries-slower-than-ms]` +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-cache-cache-expiration-max-idle]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-cache-cache-expiration-max-idle[quarkus.hibernate-orm.cache."cache".expiration.max-idle]` + +`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-cache-cache-expiration-max-idle[quarkus.hibernate-orm."persistence-unit-name".cache."cache".expiration.max-idle]` [.description] -- -If set, Hibernate will log queries that took more than specified number of milliseconds to execute. +The maximum time before an object of the cache is considered expired. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_QUERIES_SLOWER_THAN_MS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_CACHE__CACHE__EXPIRATION_MAX_IDLE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_QUERIES_SLOWER_THAN_MS+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_CACHE__CACHE__EXPIRATION_MAX_IDLE+++` endif::add-copy-button-to-env-var[] ---|long +--|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]] | -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 -h|Default - -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-dialect]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-dialect[quarkus.hibernate-orm.dialect]` +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-cache-cache-memory-object-count]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-cache-cache-memory-object-count[quarkus.hibernate-orm.cache."cache".memory.object-count]` -`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-dialect[quarkus.hibernate-orm."persistence-unit-name".dialect]` +`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-cache-cache-memory-object-count[quarkus.hibernate-orm."persistence-unit-name".cache."cache".memory.object-count]` [.description] -- -Name of the Hibernate ORM dialect. - -For xref:datasource.adoc#extensions-and-database-drivers-reference[supported databases], -this property does not need to be set explicitly: -it is selected automatically based on the datasource, -and configured using the xref:datasource.adoc#quarkus-datasource_quarkus.datasource.db-version[DB version set on the -datasource] -to benefit from the best performance and latest features. - -If your database does not have a corresponding Quarkus extension, -you *will* need to set this property explicitly. -In that case, keep in mind that the JDBC driver and Hibernate ORM dialect -may not work properly in GraalVM native executables. - -For built-in dialects, the expected value is one of the names -in the link:{hibernate-orm-dialect-docs-url}[official list of dialects], -*without* the `Dialect` suffix, -for example `Cockroach` for `CockroachDialect`. - -For third-party dialects, the expected value is the fully-qualified class name, -for example `com.acme.hibernate.AcmeDbDialect`. +The maximum number of objects kept in memory in the cache. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DIALECT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_CACHE__CACHE__MEMORY_OBJECT_COUNT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_DIALECT+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_CACHE__CACHE__MEMORY_OBJECT_COUNT+++` endif::add-copy-button-to-env-var[] ---|string -|`selected automatically for most popular databases` +--|long +| -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-dialect-storage-engine]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-dialect-storage-engine[quarkus.hibernate-orm.dialect.storage-engine]` +h|[[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-discriminator-discriminator-related-configuration]]link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-discriminator-discriminator-related-configuration[Discriminator related configuration] -`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-dialect-storage-engine[quarkus.hibernate-orm."persistence-unit-name".dialect.storage-engine]` +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-discriminator-ignore-explicit-for-joined]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-discriminator-ignore-explicit-for-joined[quarkus.hibernate-orm.discriminator.ignore-explicit-for-joined]` + +`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-discriminator-ignore-explicit-for-joined[quarkus.hibernate-orm."persistence-unit-name".discriminator.ignore-explicit-for-joined]` [.description] -- -The storage engine to use when the dialect supports multiple storage engines. - -E.g. `MyISAM` or `InnoDB` for MySQL. +Existing applications rely (implicitly or explicitly) on Hibernate ignoring any DiscriminatorColumn declarations on joined inheritance hierarchies. This setting allows these applications to maintain the legacy behavior of DiscriminatorColumn annotations being ignored when paired with joined inheritance. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DIALECT_STORAGE_ENGINE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DISCRIMINATOR_IGNORE_EXPLICIT_FOR_JOINED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_DIALECT_STORAGE_ENGINE+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DISCRIMINATOR_IGNORE_EXPLICIT_FOR_JOINED+++` endif::add-copy-button-to-env-var[] ---|string -| +--|boolean +|`false` -h|[[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-mapping-mapping-configuration]]link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-mapping-mapping-configuration[Mapping configuration] +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-mapping-timezone-default-storage]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-mapping-timezone-default-storage[quarkus.hibernate-orm.mapping.timezone.default-storage]` - -`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-mapping-timezone-default-storage[quarkus.hibernate-orm."persistence-unit-name".mapping.timezone.default-storage]` +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] -- -How to store timezones in the database by default -for properties of type `OffsetDateTime` and `ZonedDateTime`. - -This default may be overridden on a per-property basis using `@TimeZoneStorage`. +When set, attempts to exchange data with the database +as the given version of Hibernate ORM would have, +*on a best-effort basis*. -NOTE: Properties of type `OffsetTime` are https://hibernate.atlassian.net/browse/HHH-16287[not affected by this -setting]. +Please note: -`default`:: -Equivalent to `native` if supported, `normalize-utc` otherwise. -`auto`:: -Equivalent to `native` if supported, `column` otherwise. -`native`:: -Stores the timestamp and timezone in a column of type `timestamp with time zone`. -+ -Only available on some databases/dialects; -if not supported, an exception will be thrown during static initialization. -`column`:: -Stores the timezone in a separate column next to the timestamp column. -+ -Use `@TimeZoneColumn` on the relevant entity property to customize the timezone column. -`normalize-utc`:: -Does not store the timezone, and loses timezone information upon persisting. -+ -Instead, normalizes the value to a timestamp in the UTC timezone. -`normalize`:: -Does not store the timezone, and loses timezone information upon persisting. -+ -Instead, normalizes the value: -* upon persisting to the database, to a timestamp in the JDBC timezone -set through `quarkus.hibernate-orm.jdbc.timezone`, -or the JVM default timezone if not set. -* upon reading back from the database, to the JVM default timezone. -+ -Use this to get the legacy behavior of Quarkus 2 / Hibernate ORM 5 or older. +* 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_MAPPING_TIMEZONE_DEFAULT_STORAGE+++[] +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_MAPPING_TIMEZONE_DEFAULT_STORAGE+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_ORM_COMPATIBILITY_VERSION+++` endif::add-copy-button-to-env-var[] --- a| -`native`, `normalize`, `normalize-utc`, `column`, `auto`, `default` -|`default` +-- a| +`5.6`, `latest` +|`latest` -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-mapping-id-optimizer-default]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-mapping-id-optimizer-default[quarkus.hibernate-orm.mapping.id.optimizer.default]` +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]` -`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-mapping-id-optimizer-default[quarkus.hibernate-orm."persistence-unit-name".mapping.id.optimizer.default]` +`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-database-charset[quarkus.hibernate-orm."persistence-unit-name".database.charset]` [.description] -- -The optimizer to apply to identifier generators -whose optimizer is not configured explicitly. - -Only relevant for table- and sequence-based identifier generators. -Other generators, such as UUID-based generators, will ignore this setting. +The charset of the database. -The optimizer is responsible for pooling new identifier values, -in order to reduce the frequency of database calls to retrieve those values -and thereby improve performance. +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_MAPPING_ID_OPTIMIZER_DEFAULT+++[] +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_MAPPING_ID_OPTIMIZER_DEFAULT+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_CHARSET+++` endif::add-copy-button-to-env-var[] --- a| -`pooled-lo`, `pooled`, `none` -|`pooled-lo` - - -h|[[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-query-query-related-configuration]]link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-query-query-related-configuration[Query related configuration] +--|link:https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html[Charset] + +|`UTF-8` -h|Type -h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-query-query-plan-cache-max-size]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-query-query-plan-cache-max-size[quarkus.hibernate-orm.query.query-plan-cache-max-size]` +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]` -`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-query-query-plan-cache-max-size[quarkus.hibernate-orm."persistence-unit-name".query.query-plan-cache-max-size]` +`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-database-generation[quarkus.hibernate-orm."persistence-unit-name".database.generation]` [.description] -- -The maximum size of the query plan cache. see ++#++`org.hibernate.cfg.AvailableSettings++#++QUERY_PLAN_CACHE_MAX_SIZE` +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_QUERY_QUERY_PLAN_CACHE_MAX_SIZE+++[] +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_QUERY_QUERY_PLAN_CACHE_MAX_SIZE+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION+++` endif::add-copy-button-to-env-var[] ---|int -|`2048` +--|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] + +|`none` -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-query-default-null-ordering]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-query-default-null-ordering[quarkus.hibernate-orm.query.default-null-ordering]` +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]` -`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-query-default-null-ordering[quarkus.hibernate-orm."persistence-unit-name".query.default-null-ordering]` +`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-database-generation-create-schemas[quarkus.hibernate-orm."persistence-unit-name".database.generation.create-schemas]` [.description] -- -Default precedence of null values in `ORDER BY` clauses. - -Valid values are: `none`, `first`, `last`. +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_QUERY_DEFAULT_NULL_ORDERING+++[] +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_QUERY_DEFAULT_NULL_ORDERING+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_CREATE_SCHEMAS+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `first`, `last` -|`none` +--|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-query-in-clause-parameter-padding]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-query-in-clause-parameter-padding[quarkus.hibernate-orm.query.in-clause-parameter-padding]` +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]` -`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-query-in-clause-parameter-padding[quarkus.hibernate-orm."persistence-unit-name".query.in-clause-parameter-padding]` +`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-database-generation-halt-on-error[quarkus.hibernate-orm."persistence-unit-name".database.generation.halt-on-error]` [.description] -- -Enables IN clause parameter padding which improves statement caching. +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_QUERY_IN_CLAUSE_PARAMETER_PADDING+++[] +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_QUERY_IN_CLAUSE_PARAMETER_PADDING+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_HALT_ON_ERROR+++` endif::add-copy-button-to-env-var[] --|boolean -|`true` - - -h|[[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-jdbc-jdbc-related-configuration]]link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-jdbc-jdbc-related-configuration[JDBC related configuration] +|`false` -h|Type -h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-jdbc-timezone]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-jdbc-timezone[quarkus.hibernate-orm.jdbc.timezone]` +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]` -`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-jdbc-timezone[quarkus.hibernate-orm."persistence-unit-name".jdbc.timezone]` +`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-database-default-catalog[quarkus.hibernate-orm."persistence-unit-name".database.default-catalog]` [.description] -- -The time zone pushed to the JDBC driver. See `quarkus.hibernate-orm.mapping.timezone.default-storage`. +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_JDBC_TIMEZONE+++[] +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_JDBC_TIMEZONE+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_CATALOG+++` 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-jdbc-statement-fetch-size]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-jdbc-statement-fetch-size[quarkus.hibernate-orm.jdbc.statement-fetch-size]` +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]` -`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-jdbc-statement-fetch-size[quarkus.hibernate-orm."persistence-unit-name".jdbc.statement-fetch-size]` +`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-database-default-schema[quarkus.hibernate-orm."persistence-unit-name".database.default-schema]` [.description] -- -How many rows are fetched at a time by the JDBC driver. +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_JDBC_STATEMENT_FETCH_SIZE+++[] +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_JDBC_STATEMENT_FETCH_SIZE+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_SCHEMA+++` endif::add-copy-button-to-env-var[] ---|int +--|string | -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-jdbc-statement-batch-size]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-jdbc-statement-batch-size[quarkus.hibernate-orm.jdbc.statement-batch-size]` +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] -`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-jdbc-statement-batch-size[quarkus.hibernate-orm."persistence-unit-name".jdbc.statement-batch-size]` +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]` + +`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-scripts-generation[quarkus.hibernate-orm."persistence-unit-name".scripts.generation]` [.description] -- -The number of updates (inserts, updates and deletes) that are sent by the JDBC driver at one time for execution. +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_JDBC_STATEMENT_BATCH_SIZE+++[] +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_JDBC_STATEMENT_BATCH_SIZE+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION+++` endif::add-copy-button-to-env-var[] ---|int -| - - -h|[[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-fetch-fetching-logic-configuration]]link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-fetch-fetching-logic-configuration[Fetching logic configuration] +--|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] + +|`none` -h|Type -h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-fetch-batch-size]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-fetch-batch-size[quarkus.hibernate-orm.fetch.batch-size]` +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]` -`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-fetch-batch-size[quarkus.hibernate-orm."persistence-unit-name".fetch.batch-size]` +`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-scripts-generation-create-target[quarkus.hibernate-orm."persistence-unit-name".scripts.generation.create-target]` [.description] -- -The size of the batches used when loading entities and collections. - -`-1` means batch loading is disabled. +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_FETCH_BATCH_SIZE+++[] +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_FETCH_BATCH_SIZE+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION_CREATE_TARGET+++` endif::add-copy-button-to-env-var[] ---|int -|`16` +--|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-fetch-max-depth]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-fetch-max-depth[quarkus.hibernate-orm.fetch.max-depth]` +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]` -`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-fetch-max-depth[quarkus.hibernate-orm."persistence-unit-name".fetch.max-depth]` +`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-scripts-generation-drop-target[quarkus.hibernate-orm."persistence-unit-name".scripts.generation.drop-target]` [.description] -- -The maximum depth of outer join fetch tree for single-ended associations (one-to-one, many-to-one). - -A `0` disables default outer join fetching. +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_FETCH_MAX_DEPTH+++[] +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_FETCH_MAX_DEPTH+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION_DROP_TARGET+++` endif::add-copy-button-to-env-var[] ---|int +--|string | -h|[[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-cache-caching-configuration]]link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-cache-caching-configuration[Caching 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|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-cache-cache-expiration-max-idle]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-cache-cache-expiration-max-idle[quarkus.hibernate-orm.cache."cache".expiration.max-idle]` - -`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-cache-cache-expiration-max-idle[quarkus.hibernate-orm."persistence-unit-name".cache."cache".expiration.max-idle]` +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] -- -The maximum time before an object of the cache is considered expired. +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_CACHE__CACHE__EXPIRATION_MAX_IDLE+++[] +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_CACHE__CACHE__EXPIRATION_MAX_IDLE+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_BIND_PARAMETERS+++` 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]] -| +--|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-cache-cache-memory-object-count]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-cache-cache-memory-object-count[quarkus.hibernate-orm.cache."cache".memory.object-count]` +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]` -`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-cache-cache-memory-object-count[quarkus.hibernate-orm."persistence-unit-name".cache."cache".memory.object-count]` +`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-log-sql[quarkus.hibernate-orm."persistence-unit-name".log.sql]` [.description] -- -The maximum number of objects kept in memory in the cache. +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_CACHE__CACHE__MEMORY_OBJECT_COUNT+++[] +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_CACHE__CACHE__MEMORY_OBJECT_COUNT+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_SQL+++` endif::add-copy-button-to-env-var[] ---|long -| - - -h|[[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-discriminator-discriminator-related-configuration]]link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-discriminator-discriminator-related-configuration[Discriminator 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-discriminator-ignore-explicit-for-joined]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-discriminator-ignore-explicit-for-joined[quarkus.hibernate-orm.discriminator.ignore-explicit-for-joined]` +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]` -`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-discriminator-ignore-explicit-for-joined[quarkus.hibernate-orm."persistence-unit-name".discriminator.ignore-explicit-for-joined]` +`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-log-format-sql[quarkus.hibernate-orm."persistence-unit-name".log.format-sql]` [.description] -- -Existing applications rely (implicitly or explicitly) on Hibernate ignoring any DiscriminatorColumn declarations on joined inheritance hierarchies. This setting allows these applications to maintain the legacy behavior of DiscriminatorColumn annotations being ignored when paired with joined inheritance. +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_DISCRIMINATOR_IGNORE_EXPLICIT_FOR_JOINED+++[] +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_DISCRIMINATOR_IGNORE_EXPLICIT_FOR_JOINED+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_FORMAT_SQL+++` endif::add-copy-button-to-env-var[] --|boolean -|`false` - - -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] +|`true` -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]` +a| [[quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-log-highlight-sql]]`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-log-highlight-sql[quarkus.hibernate-orm.log.highlight-sql]` -`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-scripts-generation[quarkus.hibernate-orm."persistence-unit-name".scripts.generation]` +`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-log-highlight-sql[quarkus.hibernate-orm."persistence-unit-name".log.highlight-sql]` [.description] -- -Select whether the database schema DDL files are generated or not. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`. +Highlight 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_SCRIPTS_GENERATION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_HIGHLIGHT_SQL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_HIGHLIGHT_SQL+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] - -|`none` +--|boolean +|`true` -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]` +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]` -`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-scripts-generation-create-target[quarkus.hibernate-orm."persistence-unit-name".scripts.generation.create-target]` +`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-log-jdbc-warnings[quarkus.hibernate-orm."persistence-unit-name".log.jdbc-warnings]` [.description] -- -Filename or URL where the database create DDL file should be generated. +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_SCRIPTS_GENERATION_CREATE_TARGET+++[] +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_SCRIPTS_GENERATION_CREATE_TARGET+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_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-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]` +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]` -`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-scripts-generation-drop-target[quarkus.hibernate-orm."persistence-unit-name".scripts.generation.drop-target]` +`link:#quarkus-hibernate-orm-general-config-items_quarkus-hibernate-orm-log-queries-slower-than-ms[quarkus.hibernate-orm."persistence-unit-name".log.queries-slower-than-ms]` [.description] -- -Filename or URL where the database drop DDL file should be generated. +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_SCRIPTS_GENERATION_DROP_TARGET+++[] +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_SCRIPTS_GENERATION_DROP_TARGET+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_QUERIES_SLOWER_THAN_MS+++` endif::add-copy-button-to-env-var[] ---|string +--|long | |=== 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 ca4d65af2b3..5e3003117b0 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 @@ -448,102 +448,6 @@ 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]` - -`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus-hibernate-orm-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_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[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[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]` - -`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus-hibernate-orm-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_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]` - -`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus-hibernate-orm-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_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]` - -`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus-hibernate-orm-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_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]` - -`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus-hibernate-orm-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_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-log-logging-configuration]]link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus-hibernate-orm-log-logging-configuration[Logging configuration] h|Type @@ -568,103 +472,6 @@ endif::add-copy-button-to-env-var[] |`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]` - -`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus-hibernate-orm-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_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]` - -`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus-hibernate-orm-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_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-highlight-sql]]`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus-hibernate-orm-log-highlight-sql[quarkus.hibernate-orm.log.highlight-sql]` - -`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus-hibernate-orm-log-highlight-sql[quarkus.hibernate-orm."persistence-unit-name".log.highlight-sql]` - - -[.description] --- -Highlight 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_HIGHLIGHT_SQL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_HIGHLIGHT_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]` - -`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus-hibernate-orm-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_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]` - -`link:#quarkus-hibernate-orm-hibernate-orm-config_quarkus-hibernate-orm-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_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-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 diff --git a/_generated-doc/main/config/quarkus-hibernate-orm.adoc b/_generated-doc/main/config/quarkus-hibernate-orm.adoc index 18c10268d56..8a1c7c97b14 100644 --- a/_generated-doc/main/config/quarkus-hibernate-orm.adoc +++ b/_generated-doc/main/config/quarkus-hibernate-orm.adoc @@ -448,740 +448,740 @@ 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|[[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 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-dialect]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-dialect[quarkus.hibernate-orm.dialect]` + +`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-dialect[quarkus.hibernate-orm."persistence-unit-name".dialect]` [.description] -- -When set, attempts to exchange data with the database -as the given version of Hibernate ORM would have, -*on a best-effort basis*. +Name of the Hibernate ORM dialect. -Please note: +For xref:datasource.adoc#extensions-and-database-drivers-reference[supported databases], +this property does not need to be set explicitly: +it is selected automatically based on the datasource, +and configured using the xref:datasource.adoc#quarkus-datasource_quarkus.datasource.db-version[DB version set on the +datasource] +to benefit from the best performance and latest features. -* 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 your database does not have a corresponding Quarkus extension, +you *will* need to set this property explicitly. +In that case, keep in mind that the JDBC driver and Hibernate ORM dialect +may not work properly in GraalVM native executables. + +For built-in dialects, the expected value is one of the names +in the link:{hibernate-orm-dialect-docs-url}[official list of dialects], +*without* the `Dialect` suffix, +for example `Cockroach` for `CockroachDialect`. + +For third-party dialects, the expected value is the fully-qualified class name, +for example `com.acme.hibernate.AcmeDbDialect`. 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_DIALECT+++[] 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_DIALECT+++` endif::add-copy-button-to-env-var[] --- a| -`5.6`, `latest` -|`latest` +--|string +|`selected automatically for most popular databases` -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-dialect-storage-engine]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-dialect-storage-engine[quarkus.hibernate-orm.dialect.storage-engine]` -`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-database-charset[quarkus.hibernate-orm."persistence-unit-name".database.charset]` +`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-dialect-storage-engine[quarkus.hibernate-orm."persistence-unit-name".dialect.storage-engine]` [.description] -- -The charset of the database. +The storage engine to use when the dialect supports multiple storage engines. -Used for DDL generation and also for the SQL import scripts. +E.g. `MyISAM` or `InnoDB` for MySQL. 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_DIALECT_STORAGE_ENGINE+++[] 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_DIALECT_STORAGE_ENGINE+++` 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-database-generation]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-database-generation[quarkus.hibernate-orm.database.generation]` +h|[[quarkus-hibernate-orm_quarkus-hibernate-orm-mapping-mapping-configuration]]link:#quarkus-hibernate-orm_quarkus-hibernate-orm-mapping-mapping-configuration[Mapping configuration] -`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-database-generation[quarkus.hibernate-orm."persistence-unit-name".database.generation]` +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-mapping-timezone-default-storage]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-mapping-timezone-default-storage[quarkus.hibernate-orm.mapping.timezone.default-storage]` + +`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-mapping-timezone-default-storage[quarkus.hibernate-orm."persistence-unit-name".mapping.timezone.default-storage]` [.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`. +How to store timezones in the database by default +for properties of type `OffsetDateTime` and `ZonedDateTime`. + +This default may be overridden on a per-property basis using `@TimeZoneStorage`. + +NOTE: Properties of type `OffsetTime` are https://hibernate.atlassian.net/browse/HHH-16287[not affected by this +setting]. + +`default`:: +Equivalent to `native` if supported, `normalize-utc` otherwise. +`auto`:: +Equivalent to `native` if supported, `column` otherwise. +`native`:: +Stores the timestamp and timezone in a column of type `timestamp with time zone`. ++ +Only available on some databases/dialects; +if not supported, an exception will be thrown during static initialization. +`column`:: +Stores the timezone in a separate column next to the timestamp column. ++ +Use `@TimeZoneColumn` on the relevant entity property to customize the timezone column. +`normalize-utc`:: +Does not store the timezone, and loses timezone information upon persisting. ++ +Instead, normalizes the value to a timestamp in the UTC timezone. +`normalize`:: +Does not store the timezone, and loses timezone information upon persisting. ++ +Instead, normalizes the value: +* upon persisting to the database, to a timestamp in the JDBC timezone +set through `quarkus.hibernate-orm.jdbc.timezone`, +or the JVM default timezone if not set. +* upon reading back from the database, to the JVM default timezone. ++ +Use this to get the legacy behavior of Quarkus 2 / Hibernate ORM 5 or older. 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_MAPPING_TIMEZONE_DEFAULT_STORAGE+++[] 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_MAPPING_TIMEZONE_DEFAULT_STORAGE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] - -|`none` +-- a| +`native`, `normalize`, `normalize-utc`, `column`, `auto`, `default` +|`default` -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-mapping-id-optimizer-default]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-mapping-id-optimizer-default[quarkus.hibernate-orm.mapping.id.optimizer.default]` -`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-database-generation-create-schemas[quarkus.hibernate-orm."persistence-unit-name".database.generation.create-schemas]` +`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-mapping-id-optimizer-default[quarkus.hibernate-orm."persistence-unit-name".mapping.id.optimizer.default]` [.description] -- -If Hibernate ORM should create the schemas automatically (for databases supporting them). +The optimizer to apply to identifier generators +whose optimizer is not configured explicitly. + +Only relevant for table- and sequence-based identifier generators. +Other generators, such as UUID-based generators, will ignore this setting. + +The optimizer is responsible for pooling new identifier values, +in order to reduce the frequency of database calls to retrieve those values +and thereby improve performance. 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_MAPPING_ID_OPTIMIZER_DEFAULT+++[] 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_MAPPING_ID_OPTIMIZER_DEFAULT+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` +-- a| +`pooled-lo`, `pooled`, `none` +|`pooled-lo` -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]` +h|[[quarkus-hibernate-orm_quarkus-hibernate-orm-query-query-related-configuration]]link:#quarkus-hibernate-orm_quarkus-hibernate-orm-query-query-related-configuration[Query related configuration] -`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-database-generation-halt-on-error[quarkus.hibernate-orm."persistence-unit-name".database.generation.halt-on-error]` +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-query-query-plan-cache-max-size]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-query-query-plan-cache-max-size[quarkus.hibernate-orm.query.query-plan-cache-max-size]` + +`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-query-query-plan-cache-max-size[quarkus.hibernate-orm."persistence-unit-name".query.query-plan-cache-max-size]` [.description] -- -Whether we should stop on the first error when applying the schema. +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_DATABASE_GENERATION_HALT_ON_ERROR+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_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_DATABASE_GENERATION_HALT_ON_ERROR+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_QUERY_QUERY_PLAN_CACHE_MAX_SIZE+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` +--|int +|`2048` -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]` +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-query-default-null-ordering]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-query-default-null-ordering[quarkus.hibernate-orm.query.default-null-ordering]` -`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-database-default-catalog[quarkus.hibernate-orm."persistence-unit-name".database.default-catalog]` +`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-query-default-null-ordering[quarkus.hibernate-orm."persistence-unit-name".query.default-null-ordering]` [.description] -- -The default catalog to use for the database objects. +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_DATABASE_DEFAULT_CATALOG+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_QUERY_DEFAULT_NULL_ORDERING+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_CATALOG+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_QUERY_DEFAULT_NULL_ORDERING+++` endif::add-copy-button-to-env-var[] ---|string -| +-- a| +`none`, `first`, `last` +|`none` -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]` +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-query-in-clause-parameter-padding]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-query-in-clause-parameter-padding[quarkus.hibernate-orm.query.in-clause-parameter-padding]` -`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-database-default-schema[quarkus.hibernate-orm."persistence-unit-name".database.default-schema]` +`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-query-in-clause-parameter-padding[quarkus.hibernate-orm."persistence-unit-name".query.in-clause-parameter-padding]` [.description] -- -The default schema to use for the database objects. +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_DATABASE_DEFAULT_SCHEMA+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_QUERY_IN_CLAUSE_PARAMETER_PADDING+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_SCHEMA+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_QUERY_IN_CLAUSE_PARAMETER_PADDING+++` endif::add-copy-button-to-env-var[] ---|string -| +--|boolean +|`true` -h|[[quarkus-hibernate-orm_quarkus-hibernate-orm-log-logging-configuration]]link:#quarkus-hibernate-orm_quarkus-hibernate-orm-log-logging-configuration[Logging configuration] +h|[[quarkus-hibernate-orm_quarkus-hibernate-orm-jdbc-jdbc-related-configuration]]link:#quarkus-hibernate-orm_quarkus-hibernate-orm-jdbc-jdbc-related-configuration[JDBC related 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]` +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-jdbc-timezone]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-jdbc-timezone[quarkus.hibernate-orm.jdbc.timezone]` + +`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-jdbc-timezone[quarkus.hibernate-orm."persistence-unit-name".jdbc.timezone]` [.description] -- -Logs SQL bind parameters. - -Setting it to true is obviously not recommended in production. +The time zone pushed to the JDBC driver. See `quarkus.hibernate-orm.mapping.timezone.default-storage`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_BIND_PARAMETERS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_JDBC_TIMEZONE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_BIND_PARAMETERS+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_JDBC_TIMEZONE+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` +--|string +| -a| [[quarkus-hibernate-orm_quarkus-hibernate-orm-log-sql]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-log-sql[quarkus.hibernate-orm.log.sql]` +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-jdbc-statement-fetch-size]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-jdbc-statement-fetch-size[quarkus.hibernate-orm.jdbc.statement-fetch-size]` -`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-log-sql[quarkus.hibernate-orm."persistence-unit-name".log.sql]` +`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-jdbc-statement-fetch-size[quarkus.hibernate-orm."persistence-unit-name".jdbc.statement-fetch-size]` [.description] -- -Show SQL logs and format them nicely. - -Setting it to true is obviously not recommended in production. +How many rows are fetched at a time by the JDBC driver. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_SQL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_JDBC_STATEMENT_FETCH_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_SQL+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_JDBC_STATEMENT_FETCH_SIZE+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` +--|int +| -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]` +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-jdbc-statement-batch-size]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-jdbc-statement-batch-size[quarkus.hibernate-orm.jdbc.statement-batch-size]` -`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-log-format-sql[quarkus.hibernate-orm."persistence-unit-name".log.format-sql]` +`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-jdbc-statement-batch-size[quarkus.hibernate-orm."persistence-unit-name".jdbc.statement-batch-size]` [.description] -- -Format the SQL logs if SQL log is enabled +The number of updates (inserts, updates and deletes) that are sent by the JDBC driver at one time for execution. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_FORMAT_SQL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_JDBC_STATEMENT_BATCH_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_FORMAT_SQL+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_JDBC_STATEMENT_BATCH_SIZE+++` endif::add-copy-button-to-env-var[] ---|boolean -|`true` +--|int +| -a| [[quarkus-hibernate-orm_quarkus-hibernate-orm-log-highlight-sql]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-log-highlight-sql[quarkus.hibernate-orm.log.highlight-sql]` +h|[[quarkus-hibernate-orm_quarkus-hibernate-orm-fetch-fetching-logic-configuration]]link:#quarkus-hibernate-orm_quarkus-hibernate-orm-fetch-fetching-logic-configuration[Fetching logic configuration] -`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-log-highlight-sql[quarkus.hibernate-orm."persistence-unit-name".log.highlight-sql]` +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-fetch-batch-size]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-fetch-batch-size[quarkus.hibernate-orm.fetch.batch-size]` + +`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-fetch-batch-size[quarkus.hibernate-orm."persistence-unit-name".fetch.batch-size]` [.description] -- -Highlight the SQL logs if SQL log is enabled +The size of the batches used when loading entities and collections. + +`-1` means batch loading is disabled. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_HIGHLIGHT_SQL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_FETCH_BATCH_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_HIGHLIGHT_SQL+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_FETCH_BATCH_SIZE+++` endif::add-copy-button-to-env-var[] ---|boolean -|`true` +--|int +|`16` -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]` +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-fetch-max-depth]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-fetch-max-depth[quarkus.hibernate-orm.fetch.max-depth]` -`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-log-jdbc-warnings[quarkus.hibernate-orm."persistence-unit-name".log.jdbc-warnings]` +`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-fetch-max-depth[quarkus.hibernate-orm."persistence-unit-name".fetch.max-depth]` [.description] -- -Whether JDBC warnings should be collected and logged. +The maximum depth of outer join fetch tree for single-ended associations (one-to-one, many-to-one). + +A `0` disables default outer join fetching. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_JDBC_WARNINGS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_FETCH_MAX_DEPTH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_JDBC_WARNINGS+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_FETCH_MAX_DEPTH+++` endif::add-copy-button-to-env-var[] ---|boolean -|`depends on dialect` +--|int +| -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]` +h|[[quarkus-hibernate-orm_quarkus-hibernate-orm-cache-caching-configuration]]link:#quarkus-hibernate-orm_quarkus-hibernate-orm-cache-caching-configuration[Caching configuration] -`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-log-queries-slower-than-ms[quarkus.hibernate-orm."persistence-unit-name".log.queries-slower-than-ms]` +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-cache-cache-expiration-max-idle]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-cache-cache-expiration-max-idle[quarkus.hibernate-orm.cache."cache".expiration.max-idle]` + +`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-cache-cache-expiration-max-idle[quarkus.hibernate-orm."persistence-unit-name".cache."cache".expiration.max-idle]` [.description] -- -If set, Hibernate will log queries that took more than specified number of milliseconds to execute. +The maximum time before an object of the cache is considered expired. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_QUERIES_SLOWER_THAN_MS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_CACHE__CACHE__EXPIRATION_MAX_IDLE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_QUERIES_SLOWER_THAN_MS+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_CACHE__CACHE__EXPIRATION_MAX_IDLE+++` endif::add-copy-button-to-env-var[] ---|long +--|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]] | -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 -h|Default - -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-dialect]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-dialect[quarkus.hibernate-orm.dialect]` +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-cache-cache-memory-object-count]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-cache-cache-memory-object-count[quarkus.hibernate-orm.cache."cache".memory.object-count]` -`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-dialect[quarkus.hibernate-orm."persistence-unit-name".dialect]` +`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-cache-cache-memory-object-count[quarkus.hibernate-orm."persistence-unit-name".cache."cache".memory.object-count]` [.description] -- -Name of the Hibernate ORM dialect. - -For xref:datasource.adoc#extensions-and-database-drivers-reference[supported databases], -this property does not need to be set explicitly: -it is selected automatically based on the datasource, -and configured using the xref:datasource.adoc#quarkus-datasource_quarkus.datasource.db-version[DB version set on the -datasource] -to benefit from the best performance and latest features. - -If your database does not have a corresponding Quarkus extension, -you *will* need to set this property explicitly. -In that case, keep in mind that the JDBC driver and Hibernate ORM dialect -may not work properly in GraalVM native executables. - -For built-in dialects, the expected value is one of the names -in the link:{hibernate-orm-dialect-docs-url}[official list of dialects], -*without* the `Dialect` suffix, -for example `Cockroach` for `CockroachDialect`. - -For third-party dialects, the expected value is the fully-qualified class name, -for example `com.acme.hibernate.AcmeDbDialect`. +The maximum number of objects kept in memory in the cache. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DIALECT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_CACHE__CACHE__MEMORY_OBJECT_COUNT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_DIALECT+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_CACHE__CACHE__MEMORY_OBJECT_COUNT+++` endif::add-copy-button-to-env-var[] ---|string -|`selected automatically for most popular databases` +--|long +| -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-dialect-storage-engine]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-dialect-storage-engine[quarkus.hibernate-orm.dialect.storage-engine]` +h|[[quarkus-hibernate-orm_quarkus-hibernate-orm-discriminator-discriminator-related-configuration]]link:#quarkus-hibernate-orm_quarkus-hibernate-orm-discriminator-discriminator-related-configuration[Discriminator related configuration] -`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-dialect-storage-engine[quarkus.hibernate-orm."persistence-unit-name".dialect.storage-engine]` +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-discriminator-ignore-explicit-for-joined]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-discriminator-ignore-explicit-for-joined[quarkus.hibernate-orm.discriminator.ignore-explicit-for-joined]` + +`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-discriminator-ignore-explicit-for-joined[quarkus.hibernate-orm."persistence-unit-name".discriminator.ignore-explicit-for-joined]` [.description] -- -The storage engine to use when the dialect supports multiple storage engines. - -E.g. `MyISAM` or `InnoDB` for MySQL. +Existing applications rely (implicitly or explicitly) on Hibernate ignoring any DiscriminatorColumn declarations on joined inheritance hierarchies. This setting allows these applications to maintain the legacy behavior of DiscriminatorColumn annotations being ignored when paired with joined inheritance. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DIALECT_STORAGE_ENGINE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DISCRIMINATOR_IGNORE_EXPLICIT_FOR_JOINED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_DIALECT_STORAGE_ENGINE+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DISCRIMINATOR_IGNORE_EXPLICIT_FOR_JOINED+++` endif::add-copy-button-to-env-var[] ---|string -| +--|boolean +|`false` -h|[[quarkus-hibernate-orm_quarkus-hibernate-orm-mapping-mapping-configuration]]link:#quarkus-hibernate-orm_quarkus-hibernate-orm-mapping-mapping-configuration[Mapping configuration] +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-mapping-timezone-default-storage]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-mapping-timezone-default-storage[quarkus.hibernate-orm.mapping.timezone.default-storage]` - -`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-mapping-timezone-default-storage[quarkus.hibernate-orm."persistence-unit-name".mapping.timezone.default-storage]` +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] -- -How to store timezones in the database by default -for properties of type `OffsetDateTime` and `ZonedDateTime`. - -This default may be overridden on a per-property basis using `@TimeZoneStorage`. +When set, attempts to exchange data with the database +as the given version of Hibernate ORM would have, +*on a best-effort basis*. -NOTE: Properties of type `OffsetTime` are https://hibernate.atlassian.net/browse/HHH-16287[not affected by this -setting]. +Please note: -`default`:: -Equivalent to `native` if supported, `normalize-utc` otherwise. -`auto`:: -Equivalent to `native` if supported, `column` otherwise. -`native`:: -Stores the timestamp and timezone in a column of type `timestamp with time zone`. -+ -Only available on some databases/dialects; -if not supported, an exception will be thrown during static initialization. -`column`:: -Stores the timezone in a separate column next to the timestamp column. -+ -Use `@TimeZoneColumn` on the relevant entity property to customize the timezone column. -`normalize-utc`:: -Does not store the timezone, and loses timezone information upon persisting. -+ -Instead, normalizes the value to a timestamp in the UTC timezone. -`normalize`:: -Does not store the timezone, and loses timezone information upon persisting. -+ -Instead, normalizes the value: -* upon persisting to the database, to a timestamp in the JDBC timezone -set through `quarkus.hibernate-orm.jdbc.timezone`, -or the JVM default timezone if not set. -* upon reading back from the database, to the JVM default timezone. -+ -Use this to get the legacy behavior of Quarkus 2 / Hibernate ORM 5 or older. +* 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_MAPPING_TIMEZONE_DEFAULT_STORAGE+++[] +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_MAPPING_TIMEZONE_DEFAULT_STORAGE+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_ORM_COMPATIBILITY_VERSION+++` endif::add-copy-button-to-env-var[] --- a| -`native`, `normalize`, `normalize-utc`, `column`, `auto`, `default` -|`default` +-- a| +`5.6`, `latest` +|`latest` -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-mapping-id-optimizer-default]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-mapping-id-optimizer-default[quarkus.hibernate-orm.mapping.id.optimizer.default]` +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]` -`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-mapping-id-optimizer-default[quarkus.hibernate-orm."persistence-unit-name".mapping.id.optimizer.default]` +`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-database-charset[quarkus.hibernate-orm."persistence-unit-name".database.charset]` [.description] -- -The optimizer to apply to identifier generators -whose optimizer is not configured explicitly. - -Only relevant for table- and sequence-based identifier generators. -Other generators, such as UUID-based generators, will ignore this setting. +The charset of the database. -The optimizer is responsible for pooling new identifier values, -in order to reduce the frequency of database calls to retrieve those values -and thereby improve performance. +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_MAPPING_ID_OPTIMIZER_DEFAULT+++[] +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_MAPPING_ID_OPTIMIZER_DEFAULT+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_CHARSET+++` endif::add-copy-button-to-env-var[] --- a| -`pooled-lo`, `pooled`, `none` -|`pooled-lo` - - -h|[[quarkus-hibernate-orm_quarkus-hibernate-orm-query-query-related-configuration]]link:#quarkus-hibernate-orm_quarkus-hibernate-orm-query-query-related-configuration[Query related configuration] +--|link:https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html[Charset] + +|`UTF-8` -h|Type -h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-query-query-plan-cache-max-size]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-query-query-plan-cache-max-size[quarkus.hibernate-orm.query.query-plan-cache-max-size]` +a| [[quarkus-hibernate-orm_quarkus-hibernate-orm-database-generation]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-database-generation[quarkus.hibernate-orm.database.generation]` -`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-query-query-plan-cache-max-size[quarkus.hibernate-orm."persistence-unit-name".query.query-plan-cache-max-size]` +`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-database-generation[quarkus.hibernate-orm."persistence-unit-name".database.generation]` [.description] -- -The maximum size of the query plan cache. see ++#++`org.hibernate.cfg.AvailableSettings++#++QUERY_PLAN_CACHE_MAX_SIZE` +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_QUERY_QUERY_PLAN_CACHE_MAX_SIZE+++[] +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_QUERY_QUERY_PLAN_CACHE_MAX_SIZE+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION+++` endif::add-copy-button-to-env-var[] ---|int -|`2048` +--|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] + +|`none` -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-query-default-null-ordering]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-query-default-null-ordering[quarkus.hibernate-orm.query.default-null-ordering]` +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]` -`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-query-default-null-ordering[quarkus.hibernate-orm."persistence-unit-name".query.default-null-ordering]` +`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-database-generation-create-schemas[quarkus.hibernate-orm."persistence-unit-name".database.generation.create-schemas]` [.description] -- -Default precedence of null values in `ORDER BY` clauses. - -Valid values are: `none`, `first`, `last`. +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_QUERY_DEFAULT_NULL_ORDERING+++[] +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_QUERY_DEFAULT_NULL_ORDERING+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_CREATE_SCHEMAS+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `first`, `last` -|`none` +--|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-query-in-clause-parameter-padding]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-query-in-clause-parameter-padding[quarkus.hibernate-orm.query.in-clause-parameter-padding]` +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]` -`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-query-in-clause-parameter-padding[quarkus.hibernate-orm."persistence-unit-name".query.in-clause-parameter-padding]` +`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-database-generation-halt-on-error[quarkus.hibernate-orm."persistence-unit-name".database.generation.halt-on-error]` [.description] -- -Enables IN clause parameter padding which improves statement caching. +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_QUERY_IN_CLAUSE_PARAMETER_PADDING+++[] +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_QUERY_IN_CLAUSE_PARAMETER_PADDING+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_HALT_ON_ERROR+++` endif::add-copy-button-to-env-var[] --|boolean -|`true` - - -h|[[quarkus-hibernate-orm_quarkus-hibernate-orm-jdbc-jdbc-related-configuration]]link:#quarkus-hibernate-orm_quarkus-hibernate-orm-jdbc-jdbc-related-configuration[JDBC related configuration] +|`false` -h|Type -h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-jdbc-timezone]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-jdbc-timezone[quarkus.hibernate-orm.jdbc.timezone]` +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]` -`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-jdbc-timezone[quarkus.hibernate-orm."persistence-unit-name".jdbc.timezone]` +`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-database-default-catalog[quarkus.hibernate-orm."persistence-unit-name".database.default-catalog]` [.description] -- -The time zone pushed to the JDBC driver. See `quarkus.hibernate-orm.mapping.timezone.default-storage`. +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_JDBC_TIMEZONE+++[] +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_JDBC_TIMEZONE+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_CATALOG+++` endif::add-copy-button-to-env-var[] --|string | -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-jdbc-statement-fetch-size]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-jdbc-statement-fetch-size[quarkus.hibernate-orm.jdbc.statement-fetch-size]` +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]` -`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-jdbc-statement-fetch-size[quarkus.hibernate-orm."persistence-unit-name".jdbc.statement-fetch-size]` +`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-database-default-schema[quarkus.hibernate-orm."persistence-unit-name".database.default-schema]` [.description] -- -How many rows are fetched at a time by the JDBC driver. +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_JDBC_STATEMENT_FETCH_SIZE+++[] +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_JDBC_STATEMENT_FETCH_SIZE+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_SCHEMA+++` endif::add-copy-button-to-env-var[] ---|int +--|string | -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-jdbc-statement-batch-size]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-jdbc-statement-batch-size[quarkus.hibernate-orm.jdbc.statement-batch-size]` +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] -`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-jdbc-statement-batch-size[quarkus.hibernate-orm."persistence-unit-name".jdbc.statement-batch-size]` +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]` + +`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-scripts-generation[quarkus.hibernate-orm."persistence-unit-name".scripts.generation]` [.description] -- -The number of updates (inserts, updates and deletes) that are sent by the JDBC driver at one time for execution. +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_JDBC_STATEMENT_BATCH_SIZE+++[] +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_JDBC_STATEMENT_BATCH_SIZE+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION+++` endif::add-copy-button-to-env-var[] ---|int -| - - -h|[[quarkus-hibernate-orm_quarkus-hibernate-orm-fetch-fetching-logic-configuration]]link:#quarkus-hibernate-orm_quarkus-hibernate-orm-fetch-fetching-logic-configuration[Fetching logic configuration] +--|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] + +|`none` -h|Type -h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-fetch-batch-size]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-fetch-batch-size[quarkus.hibernate-orm.fetch.batch-size]` +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]` -`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-fetch-batch-size[quarkus.hibernate-orm."persistence-unit-name".fetch.batch-size]` +`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-scripts-generation-create-target[quarkus.hibernate-orm."persistence-unit-name".scripts.generation.create-target]` [.description] -- -The size of the batches used when loading entities and collections. - -`-1` means batch loading is disabled. +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_FETCH_BATCH_SIZE+++[] +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_FETCH_BATCH_SIZE+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION_CREATE_TARGET+++` endif::add-copy-button-to-env-var[] ---|int -|`16` +--|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-fetch-max-depth]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-fetch-max-depth[quarkus.hibernate-orm.fetch.max-depth]` +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]` -`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-fetch-max-depth[quarkus.hibernate-orm."persistence-unit-name".fetch.max-depth]` +`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-scripts-generation-drop-target[quarkus.hibernate-orm."persistence-unit-name".scripts.generation.drop-target]` [.description] -- -The maximum depth of outer join fetch tree for single-ended associations (one-to-one, many-to-one). - -A `0` disables default outer join fetching. +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_FETCH_MAX_DEPTH+++[] +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_FETCH_MAX_DEPTH+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION_DROP_TARGET+++` endif::add-copy-button-to-env-var[] ---|int +--|string | -h|[[quarkus-hibernate-orm_quarkus-hibernate-orm-cache-caching-configuration]]link:#quarkus-hibernate-orm_quarkus-hibernate-orm-cache-caching-configuration[Caching 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|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-cache-cache-expiration-max-idle]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-cache-cache-expiration-max-idle[quarkus.hibernate-orm.cache."cache".expiration.max-idle]` - -`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-cache-cache-expiration-max-idle[quarkus.hibernate-orm."persistence-unit-name".cache."cache".expiration.max-idle]` +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] -- -The maximum time before an object of the cache is considered expired. +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_CACHE__CACHE__EXPIRATION_MAX_IDLE+++[] +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_CACHE__CACHE__EXPIRATION_MAX_IDLE+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_BIND_PARAMETERS+++` 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]] -| +--|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-cache-cache-memory-object-count]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-cache-cache-memory-object-count[quarkus.hibernate-orm.cache."cache".memory.object-count]` +a| [[quarkus-hibernate-orm_quarkus-hibernate-orm-log-sql]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-log-sql[quarkus.hibernate-orm.log.sql]` -`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-cache-cache-memory-object-count[quarkus.hibernate-orm."persistence-unit-name".cache."cache".memory.object-count]` +`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-log-sql[quarkus.hibernate-orm."persistence-unit-name".log.sql]` [.description] -- -The maximum number of objects kept in memory in the cache. +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_CACHE__CACHE__MEMORY_OBJECT_COUNT+++[] +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_CACHE__CACHE__MEMORY_OBJECT_COUNT+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_SQL+++` endif::add-copy-button-to-env-var[] ---|long -| - - -h|[[quarkus-hibernate-orm_quarkus-hibernate-orm-discriminator-discriminator-related-configuration]]link:#quarkus-hibernate-orm_quarkus-hibernate-orm-discriminator-discriminator-related-configuration[Discriminator related configuration] +--|boolean +|`false` -h|Type -h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-discriminator-ignore-explicit-for-joined]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-discriminator-ignore-explicit-for-joined[quarkus.hibernate-orm.discriminator.ignore-explicit-for-joined]` +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]` -`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-discriminator-ignore-explicit-for-joined[quarkus.hibernate-orm."persistence-unit-name".discriminator.ignore-explicit-for-joined]` +`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-log-format-sql[quarkus.hibernate-orm."persistence-unit-name".log.format-sql]` [.description] -- -Existing applications rely (implicitly or explicitly) on Hibernate ignoring any DiscriminatorColumn declarations on joined inheritance hierarchies. This setting allows these applications to maintain the legacy behavior of DiscriminatorColumn annotations being ignored when paired with joined inheritance. +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_DISCRIMINATOR_IGNORE_EXPLICIT_FOR_JOINED+++[] +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_DISCRIMINATOR_IGNORE_EXPLICIT_FOR_JOINED+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_FORMAT_SQL+++` endif::add-copy-button-to-env-var[] --|boolean -|`false` - - -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] +|`true` -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]` +a| [[quarkus-hibernate-orm_quarkus-hibernate-orm-log-highlight-sql]]`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-log-highlight-sql[quarkus.hibernate-orm.log.highlight-sql]` -`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-scripts-generation[quarkus.hibernate-orm."persistence-unit-name".scripts.generation]` +`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-log-highlight-sql[quarkus.hibernate-orm."persistence-unit-name".log.highlight-sql]` [.description] -- -Select whether the database schema DDL files are generated or not. Accepted values: `none`, `create`, `drop-and-create`, `drop`, `update`, `validate`. +Highlight 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_SCRIPTS_GENERATION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_LOG_HIGHLIGHT_SQL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_HIGHLIGHT_SQL+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] - -|`none` +--|boolean +|`true` -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]` +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]` -`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-scripts-generation-create-target[quarkus.hibernate-orm."persistence-unit-name".scripts.generation.create-target]` +`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-log-jdbc-warnings[quarkus.hibernate-orm."persistence-unit-name".log.jdbc-warnings]` [.description] -- -Filename or URL where the database create DDL file should be generated. +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_SCRIPTS_GENERATION_CREATE_TARGET+++[] +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_SCRIPTS_GENERATION_CREATE_TARGET+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_JDBC_WARNINGS+++` endif::add-copy-button-to-env-var[] ---|string -| +--|boolean +|`depends on dialect` -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]` +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]` -`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-scripts-generation-drop-target[quarkus.hibernate-orm."persistence-unit-name".scripts.generation.drop-target]` +`link:#quarkus-hibernate-orm_quarkus-hibernate-orm-log-queries-slower-than-ms[quarkus.hibernate-orm."persistence-unit-name".log.queries-slower-than-ms]` [.description] -- -Filename or URL where the database drop DDL file should be generated. +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_SCRIPTS_GENERATION_DROP_TARGET+++[] +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_SCRIPTS_GENERATION_DROP_TARGET+++` +Environment variable: `+++QUARKUS_HIBERNATE_ORM_LOG_QUERIES_SLOWER_THAN_MS+++` endif::add-copy-button-to-env-var[] ---|string +--|long | |=== diff --git a/_generated-doc/main/config/quarkus-smallrye-reactivemessaging-kafka.adoc b/_generated-doc/main/config/quarkus-smallrye-reactivemessaging-kafka.adoc index 6f126d90fbd..87017004668 100644 --- a/_generated-doc/main/config/quarkus-smallrye-reactivemessaging-kafka.adoc +++ b/_generated-doc/main/config/quarkus-smallrye-reactivemessaging-kafka.adoc @@ -10,54 +10,54 @@ h|[[quarkus-smallrye-reactivemessaging-kafka_configuration]]link:#quarkus-smallr h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-smallrye-reactivemessaging-kafka_quarkus-messaging-kafka-serializer-autodetection-enabled]]`link:#quarkus-smallrye-reactivemessaging-kafka_quarkus-messaging-kafka-serializer-autodetection-enabled[quarkus.messaging.kafka.serializer-autodetection.enabled]` +a|icon:lock[title=Fixed at build time] [[quarkus-smallrye-reactivemessaging-kafka_quarkus-messaging-kafka-enable-graceful-shutdown-in-dev-and-test-mode]]`link:#quarkus-smallrye-reactivemessaging-kafka_quarkus-messaging-kafka-enable-graceful-shutdown-in-dev-and-test-mode[quarkus.messaging.kafka.enable-graceful-shutdown-in-dev-and-test-mode]` [.description] -- -Whether or not Kafka serializer/deserializer auto-detection is enabled. +Enables the graceful shutdown in dev and test modes. The graceful shutdown waits until the inflight records have been processed and the offset committed to Kafka. While this setting is highly recommended in production, in dev and test modes, it's disabled by default. This setting allows to re-enable it. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MESSAGING_KAFKA_SERIALIZER_AUTODETECTION_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MESSAGING_KAFKA_ENABLE_GRACEFUL_SHUTDOWN_IN_DEV_AND_TEST_MODE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MESSAGING_KAFKA_SERIALIZER_AUTODETECTION_ENABLED+++` +Environment variable: `+++QUARKUS_MESSAGING_KAFKA_ENABLE_GRACEFUL_SHUTDOWN_IN_DEV_AND_TEST_MODE+++` endif::add-copy-button-to-env-var[] --|boolean -|`true` +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-smallrye-reactivemessaging-kafka_quarkus-messaging-kafka-serializer-generation-enabled]]`link:#quarkus-smallrye-reactivemessaging-kafka_quarkus-messaging-kafka-serializer-generation-enabled[quarkus.messaging.kafka.serializer-generation.enabled]` +a|icon:lock[title=Fixed at build time] [[quarkus-smallrye-reactivemessaging-kafka_quarkus-messaging-kafka-serializer-autodetection-enabled]]`link:#quarkus-smallrye-reactivemessaging-kafka_quarkus-messaging-kafka-serializer-autodetection-enabled[quarkus.messaging.kafka.serializer-autodetection.enabled]` [.description] -- -Whether Kafka serializer/deserializer generation is enabled. When no serializer/deserializer are found and not set, Quarkus generates a Jackson-based serde. +Whether or not Kafka serializer/deserializer auto-detection is enabled. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MESSAGING_KAFKA_SERIALIZER_GENERATION_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MESSAGING_KAFKA_SERIALIZER_AUTODETECTION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MESSAGING_KAFKA_SERIALIZER_GENERATION_ENABLED+++` +Environment variable: `+++QUARKUS_MESSAGING_KAFKA_SERIALIZER_AUTODETECTION_ENABLED+++` endif::add-copy-button-to-env-var[] --|boolean |`true` -a|icon:lock[title=Fixed at build time] [[quarkus-smallrye-reactivemessaging-kafka_quarkus-messaging-kafka-enable-graceful-shutdown-in-dev-and-test-mode]]`link:#quarkus-smallrye-reactivemessaging-kafka_quarkus-messaging-kafka-enable-graceful-shutdown-in-dev-and-test-mode[quarkus.messaging.kafka.enable-graceful-shutdown-in-dev-and-test-mode]` +a|icon:lock[title=Fixed at build time] [[quarkus-smallrye-reactivemessaging-kafka_quarkus-messaging-kafka-serializer-generation-enabled]]`link:#quarkus-smallrye-reactivemessaging-kafka_quarkus-messaging-kafka-serializer-generation-enabled[quarkus.messaging.kafka.serializer-generation.enabled]` [.description] -- -Enables the graceful shutdown in dev and test modes. The graceful shutdown waits until the inflight records have been processed and the offset committed to Kafka. While this setting is highly recommended in production, in dev and test modes, it's disabled by default. This setting allows to re-enable it. +Whether Kafka serializer/deserializer generation is enabled. When no serializer/deserializer are found and not set, Quarkus generates a Jackson-based serde. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MESSAGING_KAFKA_ENABLE_GRACEFUL_SHUTDOWN_IN_DEV_AND_TEST_MODE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_MESSAGING_KAFKA_SERIALIZER_GENERATION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MESSAGING_KAFKA_ENABLE_GRACEFUL_SHUTDOWN_IN_DEV_AND_TEST_MODE+++` +Environment variable: `+++QUARKUS_MESSAGING_KAFKA_SERIALIZER_GENERATION_ENABLED+++` endif::add-copy-button-to-env-var[] --|boolean -|`false` +|`true` |=== \ No newline at end of file diff --git a/_versions/main/guides/_attributes.adoc b/_versions/main/guides/_attributes.adoc index d1db3c04cad..7bbf6a791a3 100644 --- a/_versions/main/guides/_attributes.adoc +++ b/_versions/main/guides/_attributes.adoc @@ -21,7 +21,7 @@ :keycloak-docker-image: quay.io/keycloak/keycloak:25.0.0 :jandex-version: 3.2.1 :jandex-gradle-plugin-version: 1.0.0 -:kotlin-version: 2.0.0 +:kotlin-version: 2.0.10 :grpc-version: 1.65.1 :protoc-version: 3.25.3 :gcf-invoker-version: 1.3.0 diff --git a/_versions/main/guides/hibernate-orm.adoc b/_versions/main/guides/hibernate-orm.adoc index a323321d9dc..80430dcb18c 100644 --- a/_versions/main/guides/hibernate-orm.adoc +++ b/_versions/main/guides/hibernate-orm.adoc @@ -263,7 +263,7 @@ Since we're targeting CockroachDB here, we're passing the CockroachDB version, n <2> Set the Hibernate ORM dialect. [[hibernate-dialect-varying-database]] -== Varying database +==== Varying database When enabling <>, Hibernate ORM will use multiple datasources at runtime for the same persistence unit,