Skip to content

Commit c2d383c

Browse files
actions-useractions-user
committed
Sync documentation of main branch
1 parent e674ad4 commit c2d383c

8 files changed

+338
-365
lines changed

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

Lines changed: 100 additions & 100 deletions
Original file line numberDiff line numberDiff line change
@@ -20046,58 +20046,6 @@ endif::add-copy-button-to-env-var[]
2004620046
|ElasticsearchVersion
2004720047
|
2004820048

20049-
a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-layout-strategy]] [.property-path]##`quarkus.hibernate-search-orm.elasticsearch.layout.strategy`##
20050-
20051-
`quarkus.hibernate-search-orm.elasticsearch."backend-name".layout.strategy`
20052-
20053-
`quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.layout.strategy`
20054-
20055-
`quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".layout.strategy`
20056-
20057-
[.description]
20058-
--
20059-
A xref:hibernate-search-orm-elasticsearch.adoc#bean-reference-note-anchor[bean reference] to the component
20060-
used to configure the Elasticsearch layout: index names, index aliases, ...
20061-
20062-
The referenced bean must implement `IndexLayoutStrategy`.
20063-
20064-
Available built-in implementations:
20065-
20066-
`simple`::
20067-
The default, future-proof strategy: if the index name in Hibernate Search is `myIndex`,
20068-
this strategy will create an index named `myindex-000001`, an alias for write operations named `myindex-write`,
20069-
and an alias for read operations named `myindex-read`.
20070-
`no-alias`::
20071-
A strategy without index aliases, mostly useful on legacy clusters:
20072-
if the index name in Hibernate Search is `myIndex`,
20073-
this strategy will create an index named `myindex`, and will not use any alias.
20074-
20075-
See
20076-
link:{hibernate-search-docs-url}#backend-elasticsearch-indexlayout[this section of the reference documentation]
20077-
for more information.
20078-
20079-
[NOTE]
20080-
====
20081-
Instead of setting this configuration property,
20082-
you can simply annotate your custom `IndexLayoutStrategy` implementation with `@SearchExtension`
20083-
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
20084-
See xref:hibernate-search-orm-elasticsearch.adoc#plugging-in-custom-components[this section]
20085-
for more information.
20086-
20087-
If this configuration property is set, it takes precedence over any `@SearchExtension` annotation.
20088-
====
20089-
20090-
20091-
ifdef::add-copy-button-to-env-var[]
20092-
Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_LAYOUT_STRATEGY+++[]
20093-
endif::add-copy-button-to-env-var[]
20094-
ifndef::add-copy-button-to-env-var[]
20095-
Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_LAYOUT_STRATEGY+++`
20096-
endif::add-copy-button-to-env-var[]
20097-
--
20098-
|string
20099-
|
20100-
2010120049
a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-schema-management-settings-file]] [.property-path]##`quarkus.hibernate-search-orm.elasticsearch.schema-management.settings-file`##
2010220050

2010320051
`quarkus.hibernate-search-orm.elasticsearch."backend-name".schema-management.settings-file`
@@ -20677,6 +20625,58 @@ endif::add-copy-button-to-env-var[]
2067720625
|int
2067820626
|`100`
2067920627

20628+
a| [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-layout-strategy]] [.property-path]##`quarkus.hibernate-search-orm.elasticsearch.layout.strategy`##
20629+
20630+
`quarkus.hibernate-search-orm.elasticsearch."backend-name".layout.strategy`
20631+
20632+
`quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.layout.strategy`
20633+
20634+
`quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".layout.strategy`
20635+
20636+
[.description]
20637+
--
20638+
A xref:hibernate-search-orm-elasticsearch.adoc#bean-reference-note-anchor[bean reference] to the component
20639+
used to configure the Elasticsearch layout: index names, index aliases, ...
20640+
20641+
The referenced bean must implement `IndexLayoutStrategy`.
20642+
20643+
Available built-in implementations:
20644+
20645+
`simple`::
20646+
The default, future-proof strategy: if the index name in Hibernate Search is `myIndex`,
20647+
this strategy will create an index named `myindex-000001`, an alias for write operations named `myindex-write`,
20648+
and an alias for read operations named `myindex-read`.
20649+
`no-alias`::
20650+
A strategy without index aliases, mostly useful on legacy clusters:
20651+
if the index name in Hibernate Search is `myIndex`,
20652+
this strategy will create an index named `myindex`, and will not use any alias.
20653+
20654+
See
20655+
link:{hibernate-search-docs-url}#backend-elasticsearch-indexlayout[this section of the reference documentation]
20656+
for more information.
20657+
20658+
[NOTE]
20659+
====
20660+
Instead of setting this configuration property,
20661+
you can simply annotate your custom `IndexLayoutStrategy` implementation with `@SearchExtension`
20662+
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
20663+
See xref:hibernate-search-orm-elasticsearch.adoc#plugging-in-custom-components[this section]
20664+
for more information.
20665+
20666+
If this configuration property is set, it takes precedence over any `@SearchExtension` annotation.
20667+
====
20668+
20669+
20670+
ifdef::add-copy-button-to-env-var[]
20671+
Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_LAYOUT_STRATEGY+++[]
20672+
endif::add-copy-button-to-env-var[]
20673+
ifndef::add-copy-button-to-env-var[]
20674+
Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_LAYOUT_STRATEGY+++`
20675+
endif::add-copy-button-to-env-var[]
20676+
--
20677+
|string
20678+
|
20679+
2068020680
h|[[quarkus-hibernate-search-orm-elasticsearch_section_quarkus-hibernate-search-orm-elasticsearch-indexes]] [.section-name.section-level1]##Per-index configuration overrides##
2068120681
h|Type
2068220682
h|Default
@@ -22285,54 +22285,6 @@ endif::add-copy-button-to-env-var[]
2228522285
|ElasticsearchVersion
2228622286
|
2228722287

22288-
a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-layout-strategy]] [.property-path]##`quarkus.hibernate-search-standalone.elasticsearch.layout.strategy`##
22289-
22290-
`quarkus.hibernate-search-standalone.elasticsearch."backend-name".layout.strategy`
22291-
22292-
[.description]
22293-
--
22294-
A xref:hibernate-search-standalone-elasticsearch.adoc#bean-reference-note-anchor[bean reference] to the component
22295-
used to configure the Elasticsearch layout: index names, index aliases, ...
22296-
22297-
The referenced bean must implement `IndexLayoutStrategy`.
22298-
22299-
Available built-in implementations:
22300-
22301-
`simple`::
22302-
The default, future-proof strategy: if the index name in Hibernate Search is `myIndex`,
22303-
this strategy will create an index named `myindex-000001`, an alias for write operations named `myindex-write`,
22304-
and an alias for read operations named `myindex-read`.
22305-
`no-alias`::
22306-
A strategy without index aliases, mostly useful on legacy clusters:
22307-
if the index name in Hibernate Search is `myIndex`,
22308-
this strategy will create an index named `myindex`, and will not use any alias.
22309-
22310-
See
22311-
link:{hibernate-search-docs-url}#backend-elasticsearch-indexlayout[this section of the reference documentation]
22312-
for more information.
22313-
22314-
[NOTE]
22315-
====
22316-
Instead of setting this configuration property,
22317-
you can simply annotate your custom `IndexLayoutStrategy` implementation with `@SearchExtension`
22318-
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
22319-
See xref:hibernate-search-standalone-elasticsearch.adoc#plugging-in-custom-components[this section]
22320-
for more information.
22321-
22322-
If this configuration property is set, it takes precedence over any `@SearchExtension` annotation.
22323-
====
22324-
22325-
22326-
ifdef::add-copy-button-to-env-var[]
22327-
Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_LAYOUT_STRATEGY+++[]
22328-
endif::add-copy-button-to-env-var[]
22329-
ifndef::add-copy-button-to-env-var[]
22330-
Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_LAYOUT_STRATEGY+++`
22331-
endif::add-copy-button-to-env-var[]
22332-
--
22333-
|string
22334-
|
22335-
2233622288
a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-schema-management-settings-file]] [.property-path]##`quarkus.hibernate-search-standalone.elasticsearch.schema-management.settings-file`##
2233722289

2233822290
`quarkus.hibernate-search-standalone.elasticsearch."backend-name".schema-management.settings-file`
@@ -22824,6 +22776,54 @@ endif::add-copy-button-to-env-var[]
2282422776
|int
2282522777
|`100`
2282622778

22779+
a| [[quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-layout-strategy]] [.property-path]##`quarkus.hibernate-search-standalone.elasticsearch.layout.strategy`##
22780+
22781+
`quarkus.hibernate-search-standalone.elasticsearch."backend-name".layout.strategy`
22782+
22783+
[.description]
22784+
--
22785+
A xref:hibernate-search-standalone-elasticsearch.adoc#bean-reference-note-anchor[bean reference] to the component
22786+
used to configure the Elasticsearch layout: index names, index aliases, ...
22787+
22788+
The referenced bean must implement `IndexLayoutStrategy`.
22789+
22790+
Available built-in implementations:
22791+
22792+
`simple`::
22793+
The default, future-proof strategy: if the index name in Hibernate Search is `myIndex`,
22794+
this strategy will create an index named `myindex-000001`, an alias for write operations named `myindex-write`,
22795+
and an alias for read operations named `myindex-read`.
22796+
`no-alias`::
22797+
A strategy without index aliases, mostly useful on legacy clusters:
22798+
if the index name in Hibernate Search is `myIndex`,
22799+
this strategy will create an index named `myindex`, and will not use any alias.
22800+
22801+
See
22802+
link:{hibernate-search-docs-url}#backend-elasticsearch-indexlayout[this section of the reference documentation]
22803+
for more information.
22804+
22805+
[NOTE]
22806+
====
22807+
Instead of setting this configuration property,
22808+
you can simply annotate your custom `IndexLayoutStrategy` implementation with `@SearchExtension`
22809+
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
22810+
See xref:hibernate-search-standalone-elasticsearch.adoc#plugging-in-custom-components[this section]
22811+
for more information.
22812+
22813+
If this configuration property is set, it takes precedence over any `@SearchExtension` annotation.
22814+
====
22815+
22816+
22817+
ifdef::add-copy-button-to-env-var[]
22818+
Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_LAYOUT_STRATEGY+++[]
22819+
endif::add-copy-button-to-env-var[]
22820+
ifndef::add-copy-button-to-env-var[]
22821+
Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_LAYOUT_STRATEGY+++`
22822+
endif::add-copy-button-to-env-var[]
22823+
--
22824+
|string
22825+
|
22826+
2282722827
h|[[quarkus-hibernate-search-standalone-elasticsearch_section_quarkus-hibernate-search-standalone-elasticsearch-indexes]] [.section-name.section-level1]##Per-index configuration overrides##
2282822828
h|Type
2282922829
h|Default

‎_generated-doc/main/config/quarkus-hibernate-search-orm-elasticsearch.adoc‎

Lines changed: 52 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -409,58 +409,6 @@ endif::add-copy-button-to-env-var[]
409409
|ElasticsearchVersion
410410
|
411411

412-
a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-layout-strategy]] [.property-path]##`quarkus.hibernate-search-orm.elasticsearch.layout.strategy`##
413-
414-
`quarkus.hibernate-search-orm.elasticsearch."backend-name".layout.strategy`
415-
416-
`quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.layout.strategy`
417-
418-
`quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".layout.strategy`
419-
420-
[.description]
421-
--
422-
A xref:hibernate-search-orm-elasticsearch.adoc#bean-reference-note-anchor[bean reference] to the component
423-
used to configure the Elasticsearch layout: index names, index aliases, ...
424-
425-
The referenced bean must implement `IndexLayoutStrategy`.
426-
427-
Available built-in implementations:
428-
429-
`simple`::
430-
The default, future-proof strategy: if the index name in Hibernate Search is `myIndex`,
431-
this strategy will create an index named `myindex-000001`, an alias for write operations named `myindex-write`,
432-
and an alias for read operations named `myindex-read`.
433-
`no-alias`::
434-
A strategy without index aliases, mostly useful on legacy clusters:
435-
if the index name in Hibernate Search is `myIndex`,
436-
this strategy will create an index named `myindex`, and will not use any alias.
437-
438-
See
439-
link:{hibernate-search-docs-url}#backend-elasticsearch-indexlayout[this section of the reference documentation]
440-
for more information.
441-
442-
[NOTE]
443-
====
444-
Instead of setting this configuration property,
445-
you can simply annotate your custom `IndexLayoutStrategy` implementation with `@SearchExtension`
446-
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
447-
See xref:hibernate-search-orm-elasticsearch.adoc#plugging-in-custom-components[this section]
448-
for more information.
449-
450-
If this configuration property is set, it takes precedence over any `@SearchExtension` annotation.
451-
====
452-
453-
454-
ifdef::add-copy-button-to-env-var[]
455-
Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_LAYOUT_STRATEGY+++[]
456-
endif::add-copy-button-to-env-var[]
457-
ifndef::add-copy-button-to-env-var[]
458-
Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_LAYOUT_STRATEGY+++`
459-
endif::add-copy-button-to-env-var[]
460-
--
461-
|string
462-
|
463-
464412
a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-schema-management-settings-file]] [.property-path]##`quarkus.hibernate-search-orm.elasticsearch.schema-management.settings-file`##
465413

466414
`quarkus.hibernate-search-orm.elasticsearch."backend-name".schema-management.settings-file`
@@ -1040,6 +988,58 @@ endif::add-copy-button-to-env-var[]
1040988
|int
1041989
|`100`
1042990

991+
a| [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-layout-strategy]] [.property-path]##`quarkus.hibernate-search-orm.elasticsearch.layout.strategy`##
992+
993+
`quarkus.hibernate-search-orm.elasticsearch."backend-name".layout.strategy`
994+
995+
`quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.layout.strategy`
996+
997+
`quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".layout.strategy`
998+
999+
[.description]
1000+
--
1001+
A xref:hibernate-search-orm-elasticsearch.adoc#bean-reference-note-anchor[bean reference] to the component
1002+
used to configure the Elasticsearch layout: index names, index aliases, ...
1003+
1004+
The referenced bean must implement `IndexLayoutStrategy`.
1005+
1006+
Available built-in implementations:
1007+
1008+
`simple`::
1009+
The default, future-proof strategy: if the index name in Hibernate Search is `myIndex`,
1010+
this strategy will create an index named `myindex-000001`, an alias for write operations named `myindex-write`,
1011+
and an alias for read operations named `myindex-read`.
1012+
`no-alias`::
1013+
A strategy without index aliases, mostly useful on legacy clusters:
1014+
if the index name in Hibernate Search is `myIndex`,
1015+
this strategy will create an index named `myindex`, and will not use any alias.
1016+
1017+
See
1018+
link:{hibernate-search-docs-url}#backend-elasticsearch-indexlayout[this section of the reference documentation]
1019+
for more information.
1020+
1021+
[NOTE]
1022+
====
1023+
Instead of setting this configuration property,
1024+
you can simply annotate your custom `IndexLayoutStrategy` implementation with `@SearchExtension`
1025+
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
1026+
See xref:hibernate-search-orm-elasticsearch.adoc#plugging-in-custom-components[this section]
1027+
for more information.
1028+
1029+
If this configuration property is set, it takes precedence over any `@SearchExtension` annotation.
1030+
====
1031+
1032+
1033+
ifdef::add-copy-button-to-env-var[]
1034+
Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_LAYOUT_STRATEGY+++[]
1035+
endif::add-copy-button-to-env-var[]
1036+
ifndef::add-copy-button-to-env-var[]
1037+
Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_LAYOUT_STRATEGY+++`
1038+
endif::add-copy-button-to-env-var[]
1039+
--
1040+
|string
1041+
|
1042+
10431043
h|[[quarkus-hibernate-search-orm-elasticsearch_section_quarkus-hibernate-search-orm-elasticsearch-indexes]] [.section-name.section-level1]##Per-index configuration overrides##
10441044
h|Type
10451045
h|Default

0 commit comments

Comments
 (0)