Skip to content

Commit

Permalink
Sync documentation of main branch
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Nov 7, 2023
1 parent c8b2ac9 commit 558a66f
Show file tree
Hide file tree
Showing 7 changed files with 58 additions and 6 deletions.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
[{"configDocKey":{"type":"string","key":"quarkus.transaction-manager.node-name","additionalKeys":[],"configDoc":"The node name used by the transaction manager.","withinAMap":false,"defaultValue":"quarkus","javaDocSiteLink":"","docMapKey":"node-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.transaction-manager","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.transaction-manager.default-transaction-timeout","additionalKeys":[],"configDoc":"The default transaction timeout.","withinAMap":false,"defaultValue":"60S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"default-transaction-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.transaction-manager","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.transaction-manager.enable-recovery","additionalKeys":[],"configDoc":"Start the recovery service on startup.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enable-recovery","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.transaction-manager","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.transaction-manager.recovery-modules","additionalKeys":[],"configDoc":"The list of recovery modules.","withinAMap":false,"defaultValue":"com.arjuna.ats.internal.arjuna.recovery.AtomicActionRecoveryModule,com.arjuna.ats.internal.jta.recovery.arjunacore.XARecoveryModule","javaDocSiteLink":"","docMapKey":"recovery-modules","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.transaction-manager","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.transaction-manager.expiry-scanners","additionalKeys":[],"configDoc":"The list of expiry scanners.","withinAMap":false,"defaultValue":"com.arjuna.ats.internal.arjuna.recovery.ExpiredTransactionStatusManagerScanner","javaDocSiteLink":"","docMapKey":"expiry-scanners","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.transaction-manager","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.transaction-manager.xa-resource-orphan-filters","additionalKeys":[],"configDoc":"The list of orphan filters.","withinAMap":false,"defaultValue":"com.arjuna.ats.internal.jta.recovery.arjunacore.JTATransactionLogXAResourceOrphanFilter,com.arjuna.ats.internal.jta.recovery.arjunacore.JTANodeNameXAResourceOrphanFilter,com.arjuna.ats.internal.jta.recovery.arjunacore.JTAActionStatusServiceXAResourceOrphanFilter","javaDocSiteLink":"","docMapKey":"xa-resource-orphan-filters","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.transaction-manager","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.transaction-manager.object-store.directory","additionalKeys":[],"configDoc":"The name of the directory where the transaction logs will be stored when using the `file-system` object store. If the value is not absolute then the directory is relative to the _user.dir_ system property.","withinAMap":false,"defaultValue":"ObjectStore","javaDocSiteLink":"","docMapKey":"directory","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.transaction-manager","enum":false}},{"configDocKey":{"type":"io.quarkus.narayana.jta.runtime.ObjectStoreType","key":"quarkus.transaction-manager.object-store.type","additionalKeys":[],"configDoc":"The type of object store.","withinAMap":false,"defaultValue":"file-system","javaDocSiteLink":"","docMapKey":"type","configPhase":"RUN_TIME","acceptedValues":["`file-system`","`jdbc`"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.transaction-manager","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.transaction-manager.object-store.datasource","additionalKeys":[],"configDoc":"The name of the datasource where the transaction logs will be stored when using the `jdbc` object store.\n\nIf undefined, it will use the default datasource.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"datasource","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.transaction-manager","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.transaction-manager.object-store.create-table","additionalKeys":[],"configDoc":"Whether to create the table if it does not exist.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"create-table","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.transaction-manager","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.transaction-manager.object-store.drop-table","additionalKeys":[],"configDoc":"Whether to drop the table on startup.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"drop-table","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.transaction-manager","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.transaction-manager.object-store.table-prefix","additionalKeys":[],"configDoc":"The prefix to apply to the table.","withinAMap":false,"defaultValue":"quarkus_","javaDocSiteLink":"","docMapKey":"table-prefix","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.transaction-manager","enum":false}}]
[{"configDocKey":{"type":"string","key":"quarkus.transaction-manager.node-name","additionalKeys":[],"configDoc":"The node name used by the transaction manager. Must not exceed a length of 28 bytes.","withinAMap":false,"defaultValue":"quarkus","javaDocSiteLink":"","docMapKey":"node-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.transaction-manager","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.transaction-manager.shorten-node-name-if-necessary","additionalKeys":[],"configDoc":"Whether the node name should be shortened if necessary. The node name must not exceed a length of 28 bytes. If this property is set to `true`, and the node name exceeds 28 bytes, the node name is shortened by calculating the link:https://en.wikipedia.org/wiki/SHA-2[SHA-224] hash, which has a length of 28 bytes.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"shorten-node-name-if-necessary","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.transaction-manager","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.transaction-manager.default-transaction-timeout","additionalKeys":[],"configDoc":"The default transaction timeout.","withinAMap":false,"defaultValue":"60S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"default-transaction-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.transaction-manager","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.transaction-manager.enable-recovery","additionalKeys":[],"configDoc":"Start the recovery service on startup.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enable-recovery","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.transaction-manager","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.transaction-manager.recovery-modules","additionalKeys":[],"configDoc":"The list of recovery modules.","withinAMap":false,"defaultValue":"com.arjuna.ats.internal.arjuna.recovery.AtomicActionRecoveryModule,com.arjuna.ats.internal.jta.recovery.arjunacore.XARecoveryModule","javaDocSiteLink":"","docMapKey":"recovery-modules","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.transaction-manager","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.transaction-manager.expiry-scanners","additionalKeys":[],"configDoc":"The list of expiry scanners.","withinAMap":false,"defaultValue":"com.arjuna.ats.internal.arjuna.recovery.ExpiredTransactionStatusManagerScanner","javaDocSiteLink":"","docMapKey":"expiry-scanners","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.transaction-manager","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.transaction-manager.xa-resource-orphan-filters","additionalKeys":[],"configDoc":"The list of orphan filters.","withinAMap":false,"defaultValue":"com.arjuna.ats.internal.jta.recovery.arjunacore.JTATransactionLogXAResourceOrphanFilter,com.arjuna.ats.internal.jta.recovery.arjunacore.JTANodeNameXAResourceOrphanFilter,com.arjuna.ats.internal.jta.recovery.arjunacore.JTAActionStatusServiceXAResourceOrphanFilter","javaDocSiteLink":"","docMapKey":"xa-resource-orphan-filters","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.transaction-manager","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.transaction-manager.object-store.directory","additionalKeys":[],"configDoc":"The name of the directory where the transaction logs will be stored when using the `file-system` object store. If the value is not absolute then the directory is relative to the _user.dir_ system property.","withinAMap":false,"defaultValue":"ObjectStore","javaDocSiteLink":"","docMapKey":"directory","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.transaction-manager","enum":false}},{"configDocKey":{"type":"io.quarkus.narayana.jta.runtime.ObjectStoreType","key":"quarkus.transaction-manager.object-store.type","additionalKeys":[],"configDoc":"The type of object store.","withinAMap":false,"defaultValue":"file-system","javaDocSiteLink":"","docMapKey":"type","configPhase":"RUN_TIME","acceptedValues":["`file-system`","`jdbc`"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.transaction-manager","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.transaction-manager.object-store.datasource","additionalKeys":[],"configDoc":"The name of the datasource where the transaction logs will be stored when using the `jdbc` object store.\n\nIf undefined, it will use the default datasource.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"datasource","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.transaction-manager","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.transaction-manager.object-store.create-table","additionalKeys":[],"configDoc":"Whether to create the table if it does not exist.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"create-table","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.transaction-manager","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.transaction-manager.object-store.drop-table","additionalKeys":[],"configDoc":"Whether to drop the table on startup.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"drop-table","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.transaction-manager","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.transaction-manager.object-store.table-prefix","additionalKeys":[],"configDoc":"The prefix to apply to the table.","withinAMap":false,"defaultValue":"quarkus_","javaDocSiteLink":"","docMapKey":"table-prefix","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.transaction-manager","enum":false}}]
2 changes: 1 addition & 1 deletion _generated-doc/main/config/quarkus-all-build-items.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ a| `String name` :: +++<i>No Javadoc found</i>+++
`byte[] data` :: +++<i>No Javadoc found</i>+++
`boolean excludeFromDevCL` :: +++<i>No Javadoc found</i>+++
a| https://github.com/quarkusio/quarkus/blob/main/core/deployment/src/main/java/io/quarkus/deployment/builditem/HotDeploymentWatchedFileBuildItem.java[`io.quarkus.deployment.builditem.HotDeploymentWatchedFileBuildItem`, window="_blank"] :: +++Identifies a file from a that, if modified, may result in a hot redeployment when in the dev mode. <p> A file may be identified with an exact location or a matching predicate. See and . <p> If multiple build items match the same file then the final value of is computed as a logical OR of all the values.+++
a| https://github.com/quarkusio/quarkus/blob/main/core/deployment/src/main/java/io/quarkus/deployment/builditem/HotDeploymentWatchedFileBuildItem.java[`io.quarkus.deployment.builditem.HotDeploymentWatchedFileBuildItem`, window="_blank"] :: +++Identifies a file from a that, if modified, may result in a hot redeployment when in the dev mode. <p> A file may be identified with an location or a matching predicate. See and . The location may be: <ul> <li>a relative OS-agnostic file path where is used as a separator; e.g. </li> <li>an absolute OS-specific file path; e.g. </li> <li>a glob pattern as defined in ; e.g. </li> </ul> <p> If multiple build items match the same file then the final value of is computed as a logical OR of all the values.+++
a| `String location` :: +++<i>No Javadoc found</i>+++
`Predicate locationPredicate` :: +++<i>No Javadoc found</i>+++
`boolean restartNeeded` :: +++<i>No Javadoc found</i>+++
Expand Down
19 changes: 18 additions & 1 deletion _generated-doc/main/config/quarkus-all-config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -43636,7 +43636,7 @@ a| [[quarkus-narayana-jta_quarkus.transaction-manager.node-name]]`link:#quarkus-

[.description]
--
The node name used by the transaction manager.
The node name used by the transaction manager. Must not exceed a length of 28 bytes.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_TRANSACTION_MANAGER_NODE_NAME+++[]
Expand All @@ -43648,6 +43648,23 @@ endif::add-copy-button-to-env-var[]
|`quarkus`


a| [[quarkus-narayana-jta_quarkus.transaction-manager.shorten-node-name-if-necessary]]`link:#quarkus-narayana-jta_quarkus.transaction-manager.shorten-node-name-if-necessary[quarkus.transaction-manager.shorten-node-name-if-necessary]`


[.description]
--
Whether the node name should be shortened if necessary. The node name must not exceed a length of 28 bytes. If this property is set to `true`, and the node name exceeds 28 bytes, the node name is shortened by calculating the link:https://en.wikipedia.org/wiki/SHA-2[SHA-224] hash, which has a length of 28 bytes.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_TRANSACTION_MANAGER_SHORTEN_NODE_NAME_IF_NECESSARY+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_TRANSACTION_MANAGER_SHORTEN_NODE_NAME_IF_NECESSARY+++`
endif::add-copy-button-to-env-var[]
--|boolean
|`false`


a| [[quarkus-narayana-jta_quarkus.transaction-manager.default-transaction-timeout]]`link:#quarkus-narayana-jta_quarkus.transaction-manager.default-transaction-timeout[quarkus.transaction-manager.default-transaction-timeout]`


Expand Down
19 changes: 18 additions & 1 deletion _generated-doc/main/config/quarkus-narayana-jta.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ a| [[quarkus-narayana-jta_quarkus.transaction-manager.node-name]]`link:#quarkus-

[.description]
--
The node name used by the transaction manager.
The node name used by the transaction manager. Must not exceed a length of 28 bytes.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_TRANSACTION_MANAGER_NODE_NAME+++[]
Expand All @@ -27,6 +27,23 @@ endif::add-copy-button-to-env-var[]
|`quarkus`


a| [[quarkus-narayana-jta_quarkus.transaction-manager.shorten-node-name-if-necessary]]`link:#quarkus-narayana-jta_quarkus.transaction-manager.shorten-node-name-if-necessary[quarkus.transaction-manager.shorten-node-name-if-necessary]`


[.description]
--
Whether the node name should be shortened if necessary. The node name must not exceed a length of 28 bytes. If this property is set to `true`, and the node name exceeds 28 bytes, the node name is shortened by calculating the link:https://en.wikipedia.org/wiki/SHA-2[SHA-224] hash, which has a length of 28 bytes.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_TRANSACTION_MANAGER_SHORTEN_NODE_NAME_IF_NECESSARY+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_TRANSACTION_MANAGER_SHORTEN_NODE_NAME_IF_NECESSARY+++`
endif::add-copy-button-to-env-var[]
--|boolean
|`false`


a| [[quarkus-narayana-jta_quarkus.transaction-manager.default-transaction-timeout]]`link:#quarkus-narayana-jta_quarkus.transaction-manager.default-transaction-timeout[quarkus.transaction-manager.default-transaction-timeout]`


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ a| [[quarkus-transaction-manager-transaction-manager-configuration_quarkus.trans

[.description]
--
The node name used by the transaction manager.
The node name used by the transaction manager. Must not exceed a length of 28 bytes.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_TRANSACTION_MANAGER_NODE_NAME+++[]
Expand All @@ -27,6 +27,23 @@ endif::add-copy-button-to-env-var[]
|`quarkus`


a| [[quarkus-transaction-manager-transaction-manager-configuration_quarkus.transaction-manager.shorten-node-name-if-necessary]]`link:#quarkus-transaction-manager-transaction-manager-configuration_quarkus.transaction-manager.shorten-node-name-if-necessary[quarkus.transaction-manager.shorten-node-name-if-necessary]`


[.description]
--
Whether the node name should be shortened if necessary. The node name must not exceed a length of 28 bytes. If this property is set to `true`, and the node name exceeds 28 bytes, the node name is shortened by calculating the link:https://en.wikipedia.org/wiki/SHA-2[SHA-224] hash, which has a length of 28 bytes.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_TRANSACTION_MANAGER_SHORTEN_NODE_NAME_IF_NECESSARY+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_TRANSACTION_MANAGER_SHORTEN_NODE_NAME_IF_NECESSARY+++`
endif::add-copy-button-to-env-var[]
--|boolean
|`false`


a| [[quarkus-transaction-manager-transaction-manager-configuration_quarkus.transaction-manager.default-transaction-timeout]]`link:#quarkus-transaction-manager-transaction-manager-configuration_quarkus.transaction-manager.default-transaction-timeout[quarkus.transaction-manager.default-transaction-timeout]`


Expand Down
2 changes: 1 addition & 1 deletion _versions/main/guides/datasource.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -638,7 +638,7 @@ When using one of the built-in datasource kinds, the JDBC and Reactive drivers a

|`db2`
|`quarkus-jdbc-db2`
a|* JDBC: `com.ibm.db2.jcc.DBDriver`
a|* JDBC: `com.ibm.db2.jcc.DB2Driver`

* XA: `com.ibm.db2.jcc.DB2XADataSource`

Expand Down
Loading

0 comments on commit 558a66f

Please sign in to comment.