Skip to content

Commit 21c7d0a

Browse files
committed
Sync documentation of main branch
1 parent b0c1e33 commit 21c7d0a

File tree

38 files changed

+2615
-2677
lines changed

38 files changed

+2615
-2677
lines changed

_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
[{"configDocKey":{"type":"string","key":"","additionalKeys":[],"configDoc":"Class name of the Hibernate ORM dialect.\n\nThe complete list of bundled dialects is available in the\nhttps://docs.jboss.org/hibernate/stable/orm/javadocs/org/hibernate/dialect/package-summary.html[Hibernate ORM\nJavaDoc].\n\nSetting the dialect directly is only recommended as a last resort:\nmost popular databases have a corresponding Quarkus extension,\nallowing Quarkus to select the dialect automatically,\nin which case you do not need to set the dialect at all,\nthough you may want to set\nxref:datasource.adoc#quarkus-datasource_quarkus.datasource.db-version[`quarkus.datasource.db-version`] as\nhigh as possible\nto benefit from the best performance and latest features.\n\nIf your database does not have a corresponding Quarkus extension,\nyou will need to set the dialect directly.\nIn that case, keep in mind that the JDBC driver and Hibernate ORM dialect\nmay not work properly in GraalVM native executables.","withinAMap":false,"defaultValue":"selected automatically for most popular databases","javaDocSiteLink":"","docMapKey":"dialect","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"","enum":false}},{"configDocKey":{"type":"string","key":".storage-engine","additionalKeys":[],"configDoc":"The storage engine to use when the dialect supports multiple storage engines.\n\nE.g. `MyISAM` or `InnoDB` for MySQL.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"storage-engine","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_STORAGE_ENGINE","enum":false}}]
1+
[{"configDocKey":{"type":"string","key":"","additionalKeys":[],"configDoc":"Name of the Hibernate ORM dialect.\n\nFor xref:datasource.adoc#extensions-and-database-drivers-reference[supported databases],\nthis property does not need to be set explicitly:\nit is selected automatically based on the datasource,\nand configured using the xref:datasource.adoc#quarkus-datasource_quarkus.datasource.db-version[DB version set on the\ndatasource]\nto benefit from the best performance and latest features.\n\nIf your database does not have a corresponding Quarkus extension,\nyou *will* need to set this property explicitly.\nIn that case, keep in mind that the JDBC driver and Hibernate ORM dialect\nmay not work properly in GraalVM native executables.\n\nFor built-in dialects, the expected value is one of the names\nin the link:{hibernate-orm-dialect-docs-url}[official list of dialects],\n*without* the `Dialect` suffix,\nfor example `Cockroach` for `CockroachDialect`.\n\nFor third-party dialects, the expected value is the fully-qualified class name,\nfor example `com.acme.hibernate.AcmeDbDialect`.","withinAMap":false,"defaultValue":"selected automatically for most popular databases","javaDocSiteLink":"","docMapKey":"dialect","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"","enum":false}},{"configDocKey":{"type":"string","key":".storage-engine","additionalKeys":[],"configDoc":"The storage engine to use when the dialect supports multiple storage engines.\n\nE.g. `MyISAM` or `InnoDB` for MySQL.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"storage-engine","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_STORAGE_ENGINE","enum":false}}]
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
[{"configDocKey":{"type":"string","key":".configurer","additionalKeys":[],"configDoc":"One or more xref:hibernate-search-standalone-elasticsearch.adoc#bean-reference-note-anchor[bean references]\nto the component(s) used to configure the Hibernate Search mapping,\nin particular programmatically.\n\nThe referenced beans must implement `StandalonePojoMappingConfigurer`.\n\nSee xref:hibernate-search-standalone-elasticsearch.adoc#programmatic-mapping[Programmatic mapping] for an example\non how mapping configurers can be used to apply programmatic mappings.\n\n[NOTE]\n====\nInstead of setting this configuration property,\nyou can simply annotate your custom `StandalonePojoMappingConfigurer` implementations with `@SearchExtension`\nand leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.\nSee xref:hibernate-search-standalone-elasticsearch.adoc#plugging-in-custom-components[this section]\nfor more information.\n\nIf this configuration property is set, it takes precedence over any `@SearchExtension` annotation.\n====","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"configurer","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CONFIGURER","enum":false}},{"configDocKey":{"type":"io.quarkus.hibernate.search.standalone.elasticsearch.runtime.MappingStructure","key":".structure","additionalKeys":[],"configDoc":"The structure of the Hibernate Search entity mapping.\n\nThis must match the structure of the application model being indexed with Hibernate Search:\n\n`graph` (default)::\nEntities indexed through Hibernate Search are nodes in an entity graph,\ni.e. an indexed entity is independent of other entities it references through associations,\nwhich *can* be updated independently of the indexed entity.\n+\nAssociations between entities must be bi-directional:\nspecifying the inverse side of associations through `@AssociationInverseSide` *is required*,\nunless reindexing is disabled for that association through `@IndexingDependency(reindexOnUpdate = ...)`.\n`tree`::\nEntities indexed through Hibernate Search are the root of a document,\ni.e. an indexed entity \"owns\" other entities it references through associations,\nwhich *cannot* be updated independently of the indexed entity.\n+\nAssociations between entities can be uni-directional:\nspecifying the inverse side of associations through `@AssociationInverseSide` *is not required*.\n\nSee also link:{hibernate-search-docs-url}#mapping-reindexing-associationinverseside[`@AssociationInverseSide`]\nlink:{hibernate-search-docs-url}#mapping-reindexing-reindexonupdate[`@IndexingDependency(reindexOnUpdate = ...)`].","withinAMap":false,"defaultValue":"graph","javaDocSiteLink":"","docMapKey":"structure","configPhase":"BUILD_TIME","acceptedValues":["`graph`","`document`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_STRUCTURE","enum":true}}]
1+
[{"configDocKey":{"type":"string","key":".configurer","additionalKeys":[],"configDoc":"One or more xref:hibernate-search-standalone-elasticsearch.adoc#bean-reference-note-anchor[bean references]\nto the component(s) used to configure the Hibernate Search mapping,\nin particular programmatically.\n\nThe referenced beans must implement `StandalonePojoMappingConfigurer`.\n\nSee xref:hibernate-search-standalone-elasticsearch.adoc#programmatic-mapping[Programmatic mapping] for an example\non how mapping configurers can be used to apply programmatic mappings.\n\n[NOTE]\n====\nInstead of setting this configuration property,\nyou can simply annotate your custom `StandalonePojoMappingConfigurer` implementations with `@SearchExtension`\nand leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.\nSee xref:hibernate-search-standalone-elasticsearch.adoc#plugging-in-custom-components[this section]\nfor more information.\n\nIf this configuration property is set, it takes precedence over any `@SearchExtension` annotation.\n====","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"configurer","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CONFIGURER","enum":false}},{"configDocKey":{"type":"io.quarkus.hibernate.search.standalone.elasticsearch.runtime.MappingStructure","key":".structure","additionalKeys":[],"configDoc":"The structure of the Hibernate Search entity mapping.\n\nThis must match the structure of the application model being indexed with Hibernate Search:\n\n`graph` (default)::\nEntities indexed through Hibernate Search are nodes in an entity graph,\ni.e. an indexed entity is independent of other entities it references through associations,\nwhich *can* be updated independently of the indexed entity.\n+\nAssociations between entities must be bi-directional:\nspecifying the inverse side of associations through `@AssociationInverseSide` *is required*,\nunless reindexing is disabled for that association through `@IndexingDependency(reindexOnUpdate = ...)`.\n`document`::\nEntities indexed through Hibernate Search are the root of a document,\ni.e. an indexed entity \"owns\" other entities it references through associations,\nwhich *cannot* be updated independently of the indexed entity.\n+\nAssociations between entities can be uni-directional:\nspecifying the inverse side of associations through `@AssociationInverseSide` *is not required*.\n\nSee also link:{hibernate-search-docs-url}#mapping-reindexing-associationinverseside[`@AssociationInverseSide`]\nlink:{hibernate-search-docs-url}#mapping-reindexing-reindexonupdate[`@IndexingDependency(reindexOnUpdate = ...)`].","withinAMap":false,"defaultValue":"graph","javaDocSiteLink":"","docMapKey":"structure","configPhase":"BUILD_TIME","acceptedValues":["`graph`","`document`"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_STRUCTURE","enum":true}}]

_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.hibernate.orm.deployment.HibernateOrmConfig

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.hibernate.search.standalone.elasticsearch.runtime.HibernateSearchStandaloneBuildTimeConfig

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

_generated-doc/main/config/quarkus-all-build-items.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ a| `Holder holder` :: +++<i>No Javadoc found</i>+++
8383
a| https://github.com/quarkusio/quarkus/blob/main/core/deployment/src/main/java/io/quarkus/deployment/builditem/BytecodeRecorderObjectLoaderBuildItem.java[`io.quarkus.deployment.builditem.BytecodeRecorderObjectLoaderBuildItem`, window="_blank"] :: ++++++
8484
a| `ObjectLoader objectLoader` :: +++<i>No Javadoc found</i>+++
8585
86-
a| https://github.com/quarkusio/quarkus/blob/main/core/deployment/src/main/java/io/quarkus/deployment/builditem/BytecodeTransformerBuildItem.java[`io.quarkus.deployment.builditem.BytecodeTransformerBuildItem`, window="_blank"] :: +++<i>No Javadoc found</i>+++
86+
a| https://github.com/quarkusio/quarkus/blob/main/core/deployment/src/main/java/io/quarkus/deployment/builditem/BytecodeTransformerBuildItem.java[`io.quarkus.deployment.builditem.BytecodeTransformerBuildItem`, window="_blank"] :: +++Transform a class using ASM . Note that the transformation is performed after assembling the index and thus the changes won't be visible to any processor steps relying on the index. <p> You may consider using if your transformation should be visible for Arc. See also <a href="https://quarkus.io/version/main/guides/cdi-integration#annotations_transformer_build_item">I Need To Transform Annotation Metadata</a> section of Quarkus CDI integration guide.+++
8787
a| `String classToTransform` :: +++<i>No Javadoc found</i>+++
8888
`BiFunction visitorFunction` :: +++<i>No Javadoc found</i>+++
8989
`BiFunction inputTransformer` :: +++Function that can be applied to the input bytes before it is passed into ASM. This should only be used in very specific circumstances. At the moment the only known valid use case is JaCoCo, which needs access to the unmodified class file bytes.+++

_generated-doc/main/config/quarkus-all-config.adoc

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14620,26 +14620,28 @@ a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate
1462014620

1462114621
[.description]
1462214622
--
14623-
Class name of the Hibernate ORM dialect.
14623+
Name of the Hibernate ORM dialect.
1462414624

14625-
The complete list of bundled dialects is available in the
14626-
https://docs.jboss.org/hibernate/stable/orm/javadocs/org/hibernate/dialect/package-summary.html[Hibernate ORM
14627-
JavaDoc].
14628-
14629-
Setting the dialect directly is only recommended as a last resort:
14630-
most popular databases have a corresponding Quarkus extension,
14631-
allowing Quarkus to select the dialect automatically,
14632-
in which case you do not need to set the dialect at all,
14633-
though you may want to set
14634-
xref:datasource.adoc#quarkus-datasource_quarkus.datasource.db-version[`quarkus.datasource.db-version`] as
14635-
high as possible
14625+
For xref:datasource.adoc#extensions-and-database-drivers-reference[supported databases],
14626+
this property does not need to be set explicitly:
14627+
it is selected automatically based on the datasource,
14628+
and configured using the xref:datasource.adoc#quarkus-datasource_quarkus.datasource.db-version[DB version set on the
14629+
datasource]
1463614630
to benefit from the best performance and latest features.
1463714631

1463814632
If your database does not have a corresponding Quarkus extension,
14639-
you will need to set the dialect directly.
14633+
you *will* need to set this property explicitly.
1464014634
In that case, keep in mind that the JDBC driver and Hibernate ORM dialect
1464114635
may not work properly in GraalVM native executables.
1464214636

14637+
For built-in dialects, the expected value is one of the names
14638+
in the link:{hibernate-orm-dialect-docs-url}[official list of dialects],
14639+
*without* the `Dialect` suffix,
14640+
for example `Cockroach` for `CockroachDialect`.
14641+
14642+
For third-party dialects, the expected value is the fully-qualified class name,
14643+
for example `com.acme.hibernate.AcmeDbDialect`.
14644+
1464314645
ifdef::add-copy-button-to-env-var[]
1464414646
Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DIALECT+++[]
1464514647
endif::add-copy-button-to-env-var[]
@@ -17509,7 +17511,7 @@ which *can* be updated independently of the indexed entity.
1750917511
Associations between entities must be bi-directional:
1751017512
specifying the inverse side of associations through `@AssociationInverseSide` *is required*,
1751117513
unless reindexing is disabled for that association through `@IndexingDependency(reindexOnUpdate = ...)`.
17512-
`tree`::
17514+
`document`::
1751317515
Entities indexed through Hibernate Search are the root of a document,
1751417516
i.e. an indexed entity "owns" other entities it references through associations,
1751517517
which *cannot* be updated independently of the indexed entity.

_generated-doc/main/config/quarkus-core.adoc

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,25 @@ endif::add-copy-button-to-env-var[]
9494
|`false`
9595

9696

97+
a| [[quarkus-core_quarkus-args]]`link:#quarkus-core_quarkus-args[quarkus.args]`
98+
99+
100+
[.description]
101+
--
102+
The arguments passed to the command line.
103+
104+
We don't make it a list as the args are separated by a space, not a comma.
105+
106+
ifdef::add-copy-button-to-env-var[]
107+
Environment variable: env_var_with_copy_button:+++QUARKUS_ARGS+++[]
108+
endif::add-copy-button-to-env-var[]
109+
ifndef::add-copy-button-to-env-var[]
110+
Environment variable: `+++QUARKUS_ARGS+++`
111+
endif::add-copy-button-to-env-var[]
112+
--|string
113+
|
114+
115+
97116
a| [[quarkus-core_quarkus-profile]]`link:#quarkus-core_quarkus-profile[quarkus.profile]`
98117

99118

@@ -199,25 +218,6 @@ endif::add-copy-button-to-env-var[]
199218
|
200219

201220

202-
a| [[quarkus-core_quarkus-args]]`link:#quarkus-core_quarkus-args[quarkus.args]`
203-
204-
205-
[.description]
206-
--
207-
The arguments passed to the command line.
208-
209-
We don't make it a list as the args are separated by a space, not a comma.
210-
211-
ifdef::add-copy-button-to-env-var[]
212-
Environment variable: env_var_with_copy_button:+++QUARKUS_ARGS+++[]
213-
endif::add-copy-button-to-env-var[]
214-
ifndef::add-copy-button-to-env-var[]
215-
Environment variable: `+++QUARKUS_ARGS+++`
216-
endif::add-copy-button-to-env-var[]
217-
--|string
218-
|
219-
220-
221221
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-analytics-disabled]]`link:#quarkus-core_quarkus-analytics-disabled[quarkus.analytics.disabled]`
222222

223223

0 commit comments

Comments
 (0)