Sync documentation of main branch

actions-user · actions-user · commit feb07b55d752 · 2025-04-11T01:59:37.000Z
diff --git a/_generated-doc/main/config/quarkus-agroal.adoc b/_generated-doc/main/config/quarkus-agroal.adoc
@@ -641,6 +641,32 @@ endif::add-copy-button-to-env-var[]
 |string
 |
 
+a| [[quarkus-agroal_quarkus-datasource-jdbc-validation-query-timeout]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-validation-query-timeout[`quarkus.datasource.jdbc.validation-query-timeout`]##
+ifdef::add-copy-button-to-config-props[]
+config_property_copy_button:+++quarkus.datasource.jdbc.validation-query-timeout+++[]
+endif::add-copy-button-to-config-props[]
+
+
+`quarkus.datasource."datasource-name".jdbc.validation-query-timeout`
+ifdef::add-copy-button-to-config-props[]
+config_property_copy_button:+++quarkus.datasource."datasource-name".jdbc.validation-query-timeout+++[]
+endif::add-copy-button-to-config-props[]
+
+[.description]
+--
+The timeout for the connection validation query
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_JDBC_VALIDATION_QUERY_TIMEOUT+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_DATASOURCE_JDBC_VALIDATION_QUERY_TIMEOUT+++`
+endif::add-copy-button-to-env-var[]
+--
+|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-agroal_quarkus-datasource[icon:question-circle[title=More information about the Duration format]]
+|
+
 a| [[quarkus-agroal_quarkus-datasource-jdbc-validate-on-borrow]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-validate-on-borrow[`quarkus.datasource.jdbc.validate-on-borrow`]##
 ifdef::add-copy-button-to-config-props[]
 config_property_copy_button:+++quarkus.datasource.jdbc.validate-on-borrow+++[]
@@ -695,6 +721,34 @@ endif::add-copy-button-to-env-var[]
 |boolean
 |`true`
 
+a| [[quarkus-agroal_quarkus-datasource-jdbc-enable-recovery]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-enable-recovery[`quarkus.datasource.jdbc.enable-recovery`]##
+ifdef::add-copy-button-to-config-props[]
+config_property_copy_button:+++quarkus.datasource.jdbc.enable-recovery+++[]
+endif::add-copy-button-to-config-props[]
+
+
+`quarkus.datasource."datasource-name".jdbc.enable-recovery`
+ifdef::add-copy-button-to-config-props[]
+config_property_copy_button:+++quarkus.datasource."datasource-name".jdbc.enable-recovery+++[]
+endif::add-copy-button-to-config-props[]
+
+[.description]
+--
+Whether to enable recovery for this datasource.
+
+Normally a transaction manager will call xa_recover () on an XA connection during recovery to obtain a list of transaction branches that are currently in a prepared or heuristically completed state. However, it can happen that multiple XA connections connect to the same datasource which would all return the same set of branches and for reasons of improved performance only one should be used for recover() calls. The default value for this configuration property is true because when there is only one connection it is vital for data consistency that the connection is able to report its list of prepared or heuristically completed branches.
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_JDBC_ENABLE_RECOVERY+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_DATASOURCE_JDBC_ENABLE_RECOVERY+++`
+endif::add-copy-button-to-env-var[]
+--
+|boolean
+|`true`
+
 a| [[quarkus-agroal_quarkus-datasource-jdbc-transaction-requirement]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-transaction-requirement[`quarkus.datasource.jdbc.transaction-requirement`]##
 ifdef::add-copy-button-to-config-props[]
 config_property_copy_button:+++quarkus.datasource.jdbc.transaction-requirement+++[]
diff --git a/_generated-doc/main/config/quarkus-agroal_quarkus.datasource.adoc b/_generated-doc/main/config/quarkus-agroal_quarkus.datasource.adoc
@@ -641,6 +641,32 @@ endif::add-copy-button-to-env-var[]
 |string
 |
 
+a| [[quarkus-agroal_quarkus-datasource-jdbc-validation-query-timeout]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-validation-query-timeout[`quarkus.datasource.jdbc.validation-query-timeout`]##
+ifdef::add-copy-button-to-config-props[]
+config_property_copy_button:+++quarkus.datasource.jdbc.validation-query-timeout+++[]
+endif::add-copy-button-to-config-props[]
+
+
+`quarkus.datasource."datasource-name".jdbc.validation-query-timeout`
+ifdef::add-copy-button-to-config-props[]
+config_property_copy_button:+++quarkus.datasource."datasource-name".jdbc.validation-query-timeout+++[]
+endif::add-copy-button-to-config-props[]
+
+[.description]
+--
+The timeout for the connection validation query
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_JDBC_VALIDATION_QUERY_TIMEOUT+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_DATASOURCE_JDBC_VALIDATION_QUERY_TIMEOUT+++`
+endif::add-copy-button-to-env-var[]
+--
+|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-agroal_quarkus-datasource[icon:question-circle[title=More information about the Duration format]]
+|
+
 a| [[quarkus-agroal_quarkus-datasource-jdbc-validate-on-borrow]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-validate-on-borrow[`quarkus.datasource.jdbc.validate-on-borrow`]##
 ifdef::add-copy-button-to-config-props[]
 config_property_copy_button:+++quarkus.datasource.jdbc.validate-on-borrow+++[]
@@ -695,6 +721,34 @@ endif::add-copy-button-to-env-var[]
 |boolean
 |`true`
 
+a| [[quarkus-agroal_quarkus-datasource-jdbc-enable-recovery]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-enable-recovery[`quarkus.datasource.jdbc.enable-recovery`]##
+ifdef::add-copy-button-to-config-props[]
+config_property_copy_button:+++quarkus.datasource.jdbc.enable-recovery+++[]
+endif::add-copy-button-to-config-props[]
+
+
+`quarkus.datasource."datasource-name".jdbc.enable-recovery`
+ifdef::add-copy-button-to-config-props[]
+config_property_copy_button:+++quarkus.datasource."datasource-name".jdbc.enable-recovery+++[]
+endif::add-copy-button-to-config-props[]
+
+[.description]
+--
+Whether to enable recovery for this datasource.
+
+Normally a transaction manager will call xa_recover () on an XA connection during recovery to obtain a list of transaction branches that are currently in a prepared or heuristically completed state. However, it can happen that multiple XA connections connect to the same datasource which would all return the same set of branches and for reasons of improved performance only one should be used for recover() calls. The default value for this configuration property is true because when there is only one connection it is vital for data consistency that the connection is able to report its list of prepared or heuristically completed branches.
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_JDBC_ENABLE_RECOVERY+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_DATASOURCE_JDBC_ENABLE_RECOVERY+++`
+endif::add-copy-button-to-env-var[]
+--
+|boolean
+|`true`
+
 a| [[quarkus-agroal_quarkus-datasource-jdbc-transaction-requirement]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-transaction-requirement[`quarkus.datasource.jdbc.transaction-requirement`]##
 ifdef::add-copy-button-to-config-props[]
 config_property_copy_button:+++quarkus.datasource.jdbc.transaction-requirement+++[]
diff --git a/_generated-doc/main/config/quarkus-all-config.adoc b/_generated-doc/main/config/quarkus-all-config.adoc
@@ -641,6 +641,32 @@ endif::add-copy-button-to-env-var[]
 |string
 |
 
+a| [[quarkus-agroal_quarkus-datasource-jdbc-validation-query-timeout]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-validation-query-timeout[`quarkus.datasource.jdbc.validation-query-timeout`]##
+ifdef::add-copy-button-to-config-props[]
+config_property_copy_button:+++quarkus.datasource.jdbc.validation-query-timeout+++[]
+endif::add-copy-button-to-config-props[]
+
+
+`quarkus.datasource."datasource-name".jdbc.validation-query-timeout`
+ifdef::add-copy-button-to-config-props[]
+config_property_copy_button:+++quarkus.datasource."datasource-name".jdbc.validation-query-timeout+++[]
+endif::add-copy-button-to-config-props[]
+
+[.description]
+--
+The timeout for the connection validation query
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_JDBC_VALIDATION_QUERY_TIMEOUT+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_DATASOURCE_JDBC_VALIDATION_QUERY_TIMEOUT+++`
+endif::add-copy-button-to-env-var[]
+--
+|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]]
+|
+
 a| [[quarkus-agroal_quarkus-datasource-jdbc-validate-on-borrow]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-validate-on-borrow[`quarkus.datasource.jdbc.validate-on-borrow`]##
 ifdef::add-copy-button-to-config-props[]
 config_property_copy_button:+++quarkus.datasource.jdbc.validate-on-borrow+++[]
@@ -695,6 +721,34 @@ endif::add-copy-button-to-env-var[]
 |boolean
 |`true`
 
+a| [[quarkus-agroal_quarkus-datasource-jdbc-enable-recovery]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-enable-recovery[`quarkus.datasource.jdbc.enable-recovery`]##
+ifdef::add-copy-button-to-config-props[]
+config_property_copy_button:+++quarkus.datasource.jdbc.enable-recovery+++[]
+endif::add-copy-button-to-config-props[]
+
+
+`quarkus.datasource."datasource-name".jdbc.enable-recovery`
+ifdef::add-copy-button-to-config-props[]
+config_property_copy_button:+++quarkus.datasource."datasource-name".jdbc.enable-recovery+++[]
+endif::add-copy-button-to-config-props[]
+
+[.description]
+--
+Whether to enable recovery for this datasource.
+
+Normally a transaction manager will call xa_recover () on an XA connection during recovery to obtain a list of transaction branches that are currently in a prepared or heuristically completed state. However, it can happen that multiple XA connections connect to the same datasource which would all return the same set of branches and for reasons of improved performance only one should be used for recover() calls. The default value for this configuration property is true because when there is only one connection it is vital for data consistency that the connection is able to report its list of prepared or heuristically completed branches.
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_JDBC_ENABLE_RECOVERY+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_DATASOURCE_JDBC_ENABLE_RECOVERY+++`
+endif::add-copy-button-to-env-var[]
+--
+|boolean
+|`true`
+
 a| [[quarkus-agroal_quarkus-datasource-jdbc-transaction-requirement]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-transaction-requirement[`quarkus.datasource.jdbc.transaction-requirement`]##
 ifdef::add-copy-button-to-config-props[]
 config_property_copy_button:+++quarkus.datasource.jdbc.transaction-requirement+++[]
@@ -25766,6 +25820,32 @@ endif::add-copy-button-to-env-var[]
 |boolean
 |`true`
 
+a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-blocking]] [.property-path]##link:#quarkus-hibernate-orm_quarkus-hibernate-orm-blocking[`quarkus.hibernate-orm.blocking`]##
+ifdef::add-copy-button-to-config-props[]
+config_property_copy_button:+++quarkus.hibernate-orm.blocking+++[]
+endif::add-copy-button-to-config-props[]
+
+
+[.description]
+--
+Whether Hibernate ORM is working in blocking mode.
+
+Hibernate ORM's blocking `EntityManager`/`Session`/`SessionFactory`
+are normally disabled by default if no JDBC datasource is found.
+You can set this property to `false` if you want to disable them
+despite having a JDBC datasource.
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_BLOCKING+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_HIBERNATE_ORM_BLOCKING+++`
+endif::add-copy-button-to-env-var[]
+--
+|boolean
+|`true`
+
 a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-persistence-xml-ignore]] [.property-path]##link:#quarkus-hibernate-orm_quarkus-hibernate-orm-persistence-xml-ignore[`quarkus.hibernate-orm.persistence-xml.ignore`]##
 ifdef::add-copy-button-to-config-props[]
 config_property_copy_button:+++quarkus.hibernate-orm.persistence-xml.ignore+++[]
diff --git a/_generated-doc/main/config/quarkus-hibernate-orm.adoc b/_generated-doc/main/config/quarkus-hibernate-orm.adoc
@@ -32,6 +32,32 @@ endif::add-copy-button-to-env-var[]
 |boolean
 |`true`
 
+a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-blocking]] [.property-path]##link:#quarkus-hibernate-orm_quarkus-hibernate-orm-blocking[`quarkus.hibernate-orm.blocking`]##
+ifdef::add-copy-button-to-config-props[]
+config_property_copy_button:+++quarkus.hibernate-orm.blocking+++[]
+endif::add-copy-button-to-config-props[]
+
+
+[.description]
+--
+Whether Hibernate ORM is working in blocking mode.
+
+Hibernate ORM's blocking `EntityManager`/`Session`/`SessionFactory`
+are normally disabled by default if no JDBC datasource is found.
+You can set this property to `false` if you want to disable them
+despite having a JDBC datasource.
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_BLOCKING+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_HIBERNATE_ORM_BLOCKING+++`
+endif::add-copy-button-to-env-var[]
+--
+|boolean
+|`true`
+
 a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-persistence-xml-ignore]] [.property-path]##link:#quarkus-hibernate-orm_quarkus-hibernate-orm-persistence-xml-ignore[`quarkus.hibernate-orm.persistence-xml.ignore`]##
 ifdef::add-copy-button-to-config-props[]
 config_property_copy_button:+++quarkus.hibernate-orm.persistence-xml.ignore+++[]
diff --git a/_generated-doc/main/config/quarkus-hibernate-orm_quarkus.hibernate-orm.adoc b/_generated-doc/main/config/quarkus-hibernate-orm_quarkus.hibernate-orm.adoc
@@ -32,6 +32,32 @@ endif::add-copy-button-to-env-var[]
 |boolean
 |`true`
 
+a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-blocking]] [.property-path]##link:#quarkus-hibernate-orm_quarkus-hibernate-orm-blocking[`quarkus.hibernate-orm.blocking`]##
+ifdef::add-copy-button-to-config-props[]
+config_property_copy_button:+++quarkus.hibernate-orm.blocking+++[]
+endif::add-copy-button-to-config-props[]
+
+
+[.description]
+--
+Whether Hibernate ORM is working in blocking mode.
+
+Hibernate ORM's blocking `EntityManager`/`Session`/`SessionFactory`
+are normally disabled by default if no JDBC datasource is found.
+You can set this property to `false` if you want to disable them
+despite having a JDBC datasource.
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_BLOCKING+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_HIBERNATE_ORM_BLOCKING+++`
+endif::add-copy-button-to-env-var[]
+--
+|boolean
+|`true`
+
 a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-persistence-xml-ignore]] [.property-path]##link:#quarkus-hibernate-orm_quarkus-hibernate-orm-persistence-xml-ignore[`quarkus.hibernate-orm.persistence-xml.ignore`]##
 ifdef::add-copy-button-to-config-props[]
 config_property_copy_button:+++quarkus.hibernate-orm.persistence-xml.ignore+++[]
diff --git a/_generated-doc/main/infra/quarkus-all-build-items.adoc b/_generated-doc/main/infra/quarkus-all-build-items.adoc
@@ -4175,10 +4175,6 @@ _No Javadoc found_
 
 _No Javadoc found_
 
-`boolean isReactive` 
-
-_No Javadoc found_
-
 `boolean fromPersistenceXml` 
 
 _No Javadoc found_
diff --git a/_versions/main/guides/datasource.adoc b/_versions/main/guides/datasource.adoc
@@ -680,6 +680,8 @@ You can override this by setting the `transactions` configuration property:
 * `quarkus.datasource.jdbc.transactions` for default unnamed datasource
 * `quarkus.datasource._<datasource-name>_.jdbc.transactions` for named datasource
 
+When a datasource is enabled for XA (by setting `quarkus.datasource[.optional name].jdbc.transactions to xa)` and the transaction recovery system is enabled (by setting the property `quarkus.transaction-manager.enable-recovery` to true) then the datasource is automatically registered for recovery. This is a safe default, but you can override this behaviour on a per-datasource basis by setting `quarkus.datasource.jdbc.enable-recovery`/`quarkus.datasource."datasource-name".jdbc.enable-recovery` to `false`. Only use this for advanced use cases and if you know recovery will not be necessary, otherwise it may result in data loss and/or data unavailability because resources may become locked indefinitely.
+
 For more information, see the <<configuration-reference,Configuration reference>> section below.
 
 To facilitate the storage of transaction logs in a database by using JDBC, see xref:transaction.adoc#jdbcstore[Configuring transaction logs to be stored in a datasource] section of the xref:transaction.adoc[Using transactions in Quarkus] guide.
diff --git a/_versions/main/guides/hibernate-reactive.adoc b/_versions/main/guides/hibernate-reactive.adoc
