From dbdd0a442944df2332d560cd4996f6e288570379 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Tue, 30 Jan 2024 01:47:21 +0000 Subject: [PATCH] Sync documentation of main branch --- ...ime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit | 2 +- ...ntimeConfigPersistenceUnit.ElasticsearchBackendRuntimeConfig | 2 +- ...RuntimeConfigPersistenceUnit.ElasticsearchVersionCheckConfig | 1 + ...sticsearch.runtime.HibernateSearchElasticsearchRuntimeConfig | 2 +- 4 files changed, 4 insertions(+), 3 deletions(-) create mode 100644 _generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.ElasticsearchVersionCheckConfig diff --git a/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit b/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit index 309405be517..378fa265b74 100644 --- a/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit +++ b/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit @@ -1 +1 @@ -[{"configDocKey":{"type":"java.lang.Boolean","key":".active","additionalKeys":[],"configDoc":"Whether Hibernate Search should be active for this persistence unit at runtime.\n\nIf Hibernate Search is not active, it won't index Hibernate ORM entities,\nand accessing the SearchMapping/SearchSession of the relevant persistence unit\nfor search or other operation will not be possible.\n\nNote that if Hibernate Search is disabled (i.e. `quarkus.hibernate-search-orm.enabled` is set to `false`),\nit won't be active for any persistence unit, and setting this property to `true` will fail.","withinAMap":false,"defaultValue":"'true' if Hibernate Search is enabled; 'false' otherwise","javaDocSiteLink":"","docMapKey":"active","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocSection":{"name":".backends","optional":false,"withinAMap":false,"sectionDetails":"== Configuration for backends","sectionDetailsTitle":"Configuration for backends","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.ElasticsearchBackendRuntimeConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"string","key":".elasticsearch.hosts","additionalKeys":[".elasticsearch.\"backend-name\".hosts"],"configDoc":"The list of hosts of the Elasticsearch servers.","withinAMap":true,"defaultValue":"localhost:9200","javaDocSiteLink":"","docMapKey":"hosts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.ElasticsearchClientProtocol","key":".elasticsearch.protocol","additionalKeys":[".elasticsearch.\"backend-name\".protocol"],"configDoc":"The protocol to use when contacting Elasticsearch servers. Set to \"https\" to enable SSL/TLS.","withinAMap":true,"defaultValue":"http","javaDocSiteLink":"","docMapKey":"protocol","configPhase":"BUILD_TIME","acceptedValues":["`http`","`https`"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"string","key":".elasticsearch.username","additionalKeys":[".elasticsearch.\"backend-name\".username"],"configDoc":"The username used for authentication.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".elasticsearch.password","additionalKeys":[".elasticsearch.\"backend-name\".password"],"configDoc":"The password used for authentication.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".elasticsearch.connection-timeout","additionalKeys":[".elasticsearch.\"backend-name\".connection-timeout"],"configDoc":"The timeout when establishing a connection to an Elasticsearch server.","withinAMap":true,"defaultValue":"1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"connection-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".elasticsearch.read-timeout","additionalKeys":[".elasticsearch.\"backend-name\".read-timeout"],"configDoc":"The timeout when reading responses from an Elasticsearch server.","withinAMap":true,"defaultValue":"30S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"read-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".elasticsearch.request-timeout","additionalKeys":[".elasticsearch.\"backend-name\".request-timeout"],"configDoc":"The timeout when executing a request to an Elasticsearch server.\n\nThis includes the time needed to wait for a connection to be available,\nsend the request and read the response.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"request-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"int","key":".elasticsearch.max-connections","additionalKeys":[".elasticsearch.\"backend-name\".max-connections"],"configDoc":"The maximum number of connections to all the Elasticsearch servers.","withinAMap":true,"defaultValue":"20","javaDocSiteLink":"","docMapKey":"max-connections","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"int","key":".elasticsearch.max-connections-per-route","additionalKeys":[".elasticsearch.\"backend-name\".max-connections-per-route"],"configDoc":"The maximum number of connections per Elasticsearch server.","withinAMap":true,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"max-connections-per-route","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".elasticsearch.discovery.enabled","additionalKeys":[".elasticsearch.\"backend-name\".discovery.enabled"],"configDoc":"Defines if automatic discovery is enabled.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".elasticsearch.discovery.refresh-interval","additionalKeys":[".elasticsearch.\"backend-name\".discovery.refresh-interval"],"configDoc":"Refresh interval of the node list.","withinAMap":true,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"refresh-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".elasticsearch.thread-pool.size","additionalKeys":[".elasticsearch.\"backend-name\".thread-pool.size"],"configDoc":"The size of the thread pool assigned to the backend.\n\nNote that number is **per backend**, not per index.\nAdding more indexes will not add more threads.\n\nAs all operations happening in this thread-pool are non-blocking,\nraising its size above the number of processor cores available to the JVM will not bring noticeable performance\nbenefit.\nThe only reason to alter this setting would be to reduce the number of threads;\nfor example, in an application with a single index with a single indexing queue,\nrunning on a machine with 64 processor cores,\nyou might want to bring down the number of threads.\n\nDefaults to the number of processor cores available to the JVM on startup.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".elasticsearch.query.shard-failure.ignore","additionalKeys":[".elasticsearch.\"backend-name\".query.shard-failure.ignore"],"configDoc":"Whether partial shard failures are ignored (`true`) or lead to Hibernate Search throwing an exception (`false`).","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"ignore","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".elasticsearch.version-check.enabled","additionalKeys":[".elasticsearch.\"backend-name\".version-check.enabled"],"configDoc":"Whether Hibernate Search should check the version of the Elasticsearch cluster on startup.\n\nSet to `false` if the Elasticsearch cluster may not be available on startup.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"version-check","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"org.hibernate.search.backend.elasticsearch.index.IndexStatus","key":".elasticsearch.schema-management.required-status","additionalKeys":[".elasticsearch.\"backend-name\".schema-management.required-status"],"configDoc":"The minimal https://www.elastic.co/guide/en/elasticsearch/reference/7.17/cluster-health.html[Elasticsearch cluster\nstatus] required on startup.","withinAMap":true,"defaultValue":"yellow","javaDocSiteLink":"","docMapKey":"required-status","configPhase":"BUILD_TIME","acceptedValues":["`green`","`yellow`","`red`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"java.time.Duration","key":".elasticsearch.schema-management.required-status-wait-timeout","additionalKeys":[".elasticsearch.\"backend-name\".schema-management.required-status-wait-timeout"],"configDoc":"How long we should wait for the status before failing the bootstrap.","withinAMap":true,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"required-status-wait-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".elasticsearch.indexing.queue-count","additionalKeys":[".elasticsearch.\"backend-name\".indexing.queue-count"],"configDoc":"The number of indexing queues assigned to each index.\n\nHigher values will lead to more connections being used in parallel,\nwhich may lead to higher indexing throughput,\nbut incurs a risk of overloading Elasticsearch,\ni.e. of overflowing its HTTP request buffers and tripping\nhttps://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[circuit breakers],\nleading to Elasticsearch giving up on some request and resulting in indexing failures.","withinAMap":true,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"queue-count","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".elasticsearch.indexing.queue-size","additionalKeys":[".elasticsearch.\"backend-name\".indexing.queue-size"],"configDoc":"The size of indexing queues.\n\nLower values may lead to lower memory usage, especially if there are many queues,\nbut values that are too low will reduce the likeliness of reaching the max bulk size\nand increase the likeliness of application threads blocking because the queue is full,\nwhich may lead to lower indexing throughput.","withinAMap":true,"defaultValue":"1000","javaDocSiteLink":"","docMapKey":"queue-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".elasticsearch.indexing.max-bulk-size","additionalKeys":[".elasticsearch.\"backend-name\".indexing.max-bulk-size"],"configDoc":"The maximum size of bulk requests created when processing indexing queues.\n\nHigher values will lead to more documents being sent in each HTTP request sent to Elasticsearch,\nwhich may lead to higher indexing throughput,\nbut incurs a risk of overloading Elasticsearch,\ni.e. of overflowing its HTTP request buffers and tripping\nhttps://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[circuit breakers],\nleading to Elasticsearch giving up on some request and resulting in indexing failures.\n\nNote that raising this number above the queue size has no effect,\nas bulks cannot include more requests than are contained in the queue.","withinAMap":true,"defaultValue":"100","javaDocSiteLink":"","docMapKey":"max-bulk-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocSection":{"name":".elasticsearch.indexes","optional":false,"withinAMap":true,"sectionDetails":"== Per-index configuration overrides","sectionDetailsTitle":"Per-index configuration overrides","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.ElasticsearchIndexRuntimeConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"org.hibernate.search.backend.elasticsearch.index.IndexStatus","key":".elasticsearch.indexes.\"index-name\".schema-management.required-status","additionalKeys":[".elasticsearch.\"backend-name\".indexes.\"index-name\".schema-management.required-status"],"configDoc":"The minimal https://www.elastic.co/guide/en/elasticsearch/reference/7.17/cluster-health.html[Elasticsearch cluster\nstatus] required on startup.","withinAMap":true,"defaultValue":"yellow","javaDocSiteLink":"","docMapKey":"required-status","configPhase":"BUILD_TIME","acceptedValues":["`green`","`yellow`","`red`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"java.time.Duration","key":".elasticsearch.indexes.\"index-name\".schema-management.required-status-wait-timeout","additionalKeys":[".elasticsearch.\"backend-name\".indexes.\"index-name\".schema-management.required-status-wait-timeout"],"configDoc":"How long we should wait for the status before failing the bootstrap.","withinAMap":true,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"required-status-wait-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".elasticsearch.indexes.\"index-name\".indexing.queue-count","additionalKeys":[".elasticsearch.\"backend-name\".indexes.\"index-name\".indexing.queue-count"],"configDoc":"The number of indexing queues assigned to each index.\n\nHigher values will lead to more connections being used in parallel,\nwhich may lead to higher indexing throughput,\nbut incurs a risk of overloading Elasticsearch,\ni.e. of overflowing its HTTP request buffers and tripping\nhttps://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[circuit breakers],\nleading to Elasticsearch giving up on some request and resulting in indexing failures.","withinAMap":true,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"queue-count","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".elasticsearch.indexes.\"index-name\".indexing.queue-size","additionalKeys":[".elasticsearch.\"backend-name\".indexes.\"index-name\".indexing.queue-size"],"configDoc":"The size of indexing queues.\n\nLower values may lead to lower memory usage, especially if there are many queues,\nbut values that are too low will reduce the likeliness of reaching the max bulk size\nand increase the likeliness of application threads blocking because the queue is full,\nwhich may lead to lower indexing throughput.","withinAMap":true,"defaultValue":"1000","javaDocSiteLink":"","docMapKey":"queue-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".elasticsearch.indexes.\"index-name\".indexing.max-bulk-size","additionalKeys":[".elasticsearch.\"backend-name\".indexes.\"index-name\".indexing.max-bulk-size"],"configDoc":"The maximum size of bulk requests created when processing indexing queues.\n\nHigher values will lead to more documents being sent in each HTTP request sent to Elasticsearch,\nwhich may lead to higher indexing throughput,\nbut incurs a risk of overloading Elasticsearch,\ni.e. of overflowing its HTTP request buffers and tripping\nhttps://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[circuit breakers],\nleading to Elasticsearch giving up on some request and resulting in indexing failures.\n\nNote that raising this number above the queue size has no effect,\nas bulks cannot include more requests than are contained in the queue.","withinAMap":true,"defaultValue":"100","javaDocSiteLink":"","docMapKey":"max-bulk-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".schema-management","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.SchemaManagementConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"org.hibernate.search.mapper.orm.schema.management.SchemaManagementStrategyName","key":".schema-management.strategy","additionalKeys":[],"configDoc":"The schema management strategy, controlling how indexes and their schema\nare created, updated, validated or dropped on startup and shutdown.\n\nAvailable values:\n\n[cols=2]\n!===\nh!Strategy\nh!Definition\n\n!none\n!Do nothing: assume that indexes already exist and that their schema matches Hibernate Search's expectations.\n\n!validate\n!Validate that indexes exist and that their schema matches Hibernate Search's expectations.\n\nIf it does not, throw an exception, but make no attempt to fix the problem.\n\n!create\n!For indexes that do not exist, create them along with their schema.\n\nFor indexes that already exist, do nothing: assume that their schema matches Hibernate Search's expectations.\n\n!create-or-validate (**default** unless using Dev Services)\n!For indexes that do not exist, create them along with their schema.\n\nFor indexes that already exist, validate that their schema matches Hibernate Search's expectations.\n\nIf it does not, throw an exception, but make no attempt to fix the problem.\n\n!create-or-update\n!For indexes that do not exist, create them along with their schema.\n\nFor indexes that already exist, validate that their schema matches Hibernate Search's expectations;\nif it does not match expectations, try to update it.\n\n**This strategy is unfit for production environments**,\ndue to several important limitations,\nbut can be useful when developing.\n\n!drop-and-create\n!For indexes that do not exist, create them along with their schema.\n\nFor indexes that already exist, drop them, then create them along with their schema.\n\n!drop-and-create-and-drop (**default** when using Dev Services)\n!For indexes that do not exist, create them along with their schema.\n\nFor indexes that already exist, drop them, then create them along with their schema.\n\nAlso, drop indexes and their schema on shutdown.\n!===\n\nSee https://docs.jboss.org/hibernate/stable/search/reference/en-US/html_single/#mapper-orm-schema-management-strategy[this section of the reference documentation]\nfor more information.","withinAMap":false,"defaultValue":"drop-and-create-and-drop when using Dev Services; create-or-validate otherwise","javaDocSiteLink":"","docMapKey":"strategy","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".query.loading","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.SearchQueryLoadingConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"org.hibernate.search.mapper.orm.search.loading.EntityLoadingCacheLookupStrategy","key":".query.loading.cache-lookup.strategy","additionalKeys":[],"configDoc":"The strategy to use when loading entities during the execution of a search query.","withinAMap":false,"defaultValue":"skip","javaDocSiteLink":"","docMapKey":"strategy","configPhase":"BUILD_TIME","acceptedValues":["`skip`","`persistence-context`","`persistence-context-then-second-level-cache`"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"int","key":".query.loading.fetch-size","additionalKeys":[],"configDoc":"The fetch size to use when loading entities during the execution of a search query.","withinAMap":false,"defaultValue":"100","javaDocSiteLink":"","docMapKey":"fetch-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".indexing","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.IndexingConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".indexing.plan.synchronization.strategy","additionalKeys":[],"configDoc":"How to synchronize between application threads and indexing,\nin particular when relying on (implicit) listener-triggered indexing on entity change,\nbut also when using a `SearchIndexingPlan` explicitly.\n\nDefines how complete indexing should be before resuming the application thread\nafter a database transaction is committed.\n\n[WARNING]\n====\nIndexing synchronization is only relevant when coordination is disabled (which is the default).\n\nWith the xref:hibernate-search-orm-elasticsearch.adoc#coordination[`outbox-polling` coordination strategy],\nindexing happens in background threads and is always asynchronous;\nthe behavior is equivalent to the `write-sync` synchronization strategy.\n====\n\nAvailable values:\n\n[cols=5]\n!===\n.2+h!Strategy\n.2+h!Throughput\n3+^h!Guarantees when the application thread resumes\n\nh!Changes applied\nh!Changes safe from crash/power loss\nh!Changes visible on search\n\n!async\n!Best\n^!icon:times[role=red]\n^!icon:times[role=red]\n^!icon:times[role=red]\n\n!write-sync (**default**)\n!Medium\n^!icon:check[role=lime]\n^!icon:check[role=lime]\n^!icon:times[role=red]\n\n!read-sync\n!Medium to worst\n^!icon:check[role=lime]\n^!icon:times[role=red]\n^!icon:check[role=lime]\n\n!sync\n!Worst\n^!icon:check[role=lime]\n^!icon:check[role=lime]\n^!icon:check[role=lime]\n!===\n\nThis property also accepts a xref:hibernate-search-orm-elasticsearch.adoc#bean-reference-note-anchor[bean reference]\nto a custom implementations of `IndexingPlanSynchronizationStrategy`.\n\nSee\nlink:{hibernate-search-docs-url}#indexing-plan-synchronization[this section of the reference documentation]\nfor more information.\n\n[NOTE]\n====\nInstead of setting this configuration property,\nyou can simply annotate your custom `IndexingPlanSynchronizationStrategy` implementation with `@SearchExtension`\nand leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.\nIf this configuration property is set, it takes precedence over any `@SearchExtension` annotation.\n====","withinAMap":false,"defaultValue":"write-sync","javaDocSiteLink":"","docMapKey":"strategy","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".multi-tenancy","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.MultiTenancyConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".multi-tenancy.tenant-ids","additionalKeys":[],"configDoc":"An exhaustive list of all tenant identifiers that may be used by the application when multi-tenancy is enabled.\n\nMainly useful when using the {@code outbox-polling} coordination strategy,\nsince it involves setting up one background processor per tenant.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tenant-ids","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}}] \ No newline at end of file +[{"configDocKey":{"type":"java.lang.Boolean","key":".active","additionalKeys":[],"configDoc":"Whether Hibernate Search should be active for this persistence unit at runtime.\n\nIf Hibernate Search is not active, it won't index Hibernate ORM entities,\nand accessing the SearchMapping/SearchSession of the relevant persistence unit\nfor search or other operation will not be possible.\n\nNote that if Hibernate Search is disabled (i.e. `quarkus.hibernate-search-orm.enabled` is set to `false`),\nit won't be active for any persistence unit, and setting this property to `true` will fail.","withinAMap":false,"defaultValue":"'true' if Hibernate Search is enabled; 'false' otherwise","javaDocSiteLink":"","docMapKey":"active","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocSection":{"name":".backends","optional":false,"withinAMap":false,"sectionDetails":"== Configuration for backends","sectionDetailsTitle":"Configuration for backends","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.ElasticsearchBackendRuntimeConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"string","key":".elasticsearch.hosts","additionalKeys":[".elasticsearch.\"backend-name\".hosts"],"configDoc":"The list of hosts of the Elasticsearch servers.","withinAMap":true,"defaultValue":"localhost:9200","javaDocSiteLink":"","docMapKey":"hosts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.ElasticsearchClientProtocol","key":".elasticsearch.protocol","additionalKeys":[".elasticsearch.\"backend-name\".protocol"],"configDoc":"The protocol to use when contacting Elasticsearch servers. Set to \"https\" to enable SSL/TLS.","withinAMap":true,"defaultValue":"http","javaDocSiteLink":"","docMapKey":"protocol","configPhase":"BUILD_TIME","acceptedValues":["`http`","`https`"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"string","key":".elasticsearch.username","additionalKeys":[".elasticsearch.\"backend-name\".username"],"configDoc":"The username used for authentication.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".elasticsearch.password","additionalKeys":[".elasticsearch.\"backend-name\".password"],"configDoc":"The password used for authentication.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".elasticsearch.connection-timeout","additionalKeys":[".elasticsearch.\"backend-name\".connection-timeout"],"configDoc":"The timeout when establishing a connection to an Elasticsearch server.","withinAMap":true,"defaultValue":"1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"connection-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".elasticsearch.read-timeout","additionalKeys":[".elasticsearch.\"backend-name\".read-timeout"],"configDoc":"The timeout when reading responses from an Elasticsearch server.","withinAMap":true,"defaultValue":"30S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"read-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".elasticsearch.request-timeout","additionalKeys":[".elasticsearch.\"backend-name\".request-timeout"],"configDoc":"The timeout when executing a request to an Elasticsearch server.\n\nThis includes the time needed to wait for a connection to be available,\nsend the request and read the response.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"request-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"int","key":".elasticsearch.max-connections","additionalKeys":[".elasticsearch.\"backend-name\".max-connections"],"configDoc":"The maximum number of connections to all the Elasticsearch servers.","withinAMap":true,"defaultValue":"20","javaDocSiteLink":"","docMapKey":"max-connections","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"int","key":".elasticsearch.max-connections-per-route","additionalKeys":[".elasticsearch.\"backend-name\".max-connections-per-route"],"configDoc":"The maximum number of connections per Elasticsearch server.","withinAMap":true,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"max-connections-per-route","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".elasticsearch.discovery.enabled","additionalKeys":[".elasticsearch.\"backend-name\".discovery.enabled"],"configDoc":"Defines if automatic discovery is enabled.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".elasticsearch.discovery.refresh-interval","additionalKeys":[".elasticsearch.\"backend-name\".discovery.refresh-interval"],"configDoc":"Refresh interval of the node list.","withinAMap":true,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"refresh-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".elasticsearch.thread-pool.size","additionalKeys":[".elasticsearch.\"backend-name\".thread-pool.size"],"configDoc":"The size of the thread pool assigned to the backend.\n\nNote that number is **per backend**, not per index.\nAdding more indexes will not add more threads.\n\nAs all operations happening in this thread-pool are non-blocking,\nraising its size above the number of processor cores available to the JVM will not bring noticeable performance\nbenefit.\nThe only reason to alter this setting would be to reduce the number of threads;\nfor example, in an application with a single index with a single indexing queue,\nrunning on a machine with 64 processor cores,\nyou might want to bring down the number of threads.\n\nDefaults to the number of processor cores available to the JVM on startup.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".elasticsearch.query.shard-failure.ignore","additionalKeys":[".elasticsearch.\"backend-name\".query.shard-failure.ignore"],"configDoc":"Whether partial shard failures are ignored (`true`) or lead to Hibernate Search throwing an exception (`false`).","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"ignore","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".elasticsearch.version-check.enabled","additionalKeys":[".elasticsearch.\"backend-name\".version-check.enabled"],"configDoc":"Whether Hibernate Search should check the version of the Elasticsearch cluster on startup.\n\nSet to `false` if the Elasticsearch cluster may not be available on startup.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"org.hibernate.search.backend.elasticsearch.index.IndexStatus","key":".elasticsearch.schema-management.required-status","additionalKeys":[".elasticsearch.\"backend-name\".schema-management.required-status"],"configDoc":"The minimal https://www.elastic.co/guide/en/elasticsearch/reference/7.17/cluster-health.html[Elasticsearch cluster\nstatus] required on startup.","withinAMap":true,"defaultValue":"yellow","javaDocSiteLink":"","docMapKey":"required-status","configPhase":"BUILD_TIME","acceptedValues":["`green`","`yellow`","`red`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"java.time.Duration","key":".elasticsearch.schema-management.required-status-wait-timeout","additionalKeys":[".elasticsearch.\"backend-name\".schema-management.required-status-wait-timeout"],"configDoc":"How long we should wait for the status before failing the bootstrap.","withinAMap":true,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"required-status-wait-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".elasticsearch.indexing.queue-count","additionalKeys":[".elasticsearch.\"backend-name\".indexing.queue-count"],"configDoc":"The number of indexing queues assigned to each index.\n\nHigher values will lead to more connections being used in parallel,\nwhich may lead to higher indexing throughput,\nbut incurs a risk of overloading Elasticsearch,\ni.e. of overflowing its HTTP request buffers and tripping\nhttps://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[circuit breakers],\nleading to Elasticsearch giving up on some request and resulting in indexing failures.","withinAMap":true,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"queue-count","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".elasticsearch.indexing.queue-size","additionalKeys":[".elasticsearch.\"backend-name\".indexing.queue-size"],"configDoc":"The size of indexing queues.\n\nLower values may lead to lower memory usage, especially if there are many queues,\nbut values that are too low will reduce the likeliness of reaching the max bulk size\nand increase the likeliness of application threads blocking because the queue is full,\nwhich may lead to lower indexing throughput.","withinAMap":true,"defaultValue":"1000","javaDocSiteLink":"","docMapKey":"queue-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".elasticsearch.indexing.max-bulk-size","additionalKeys":[".elasticsearch.\"backend-name\".indexing.max-bulk-size"],"configDoc":"The maximum size of bulk requests created when processing indexing queues.\n\nHigher values will lead to more documents being sent in each HTTP request sent to Elasticsearch,\nwhich may lead to higher indexing throughput,\nbut incurs a risk of overloading Elasticsearch,\ni.e. of overflowing its HTTP request buffers and tripping\nhttps://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[circuit breakers],\nleading to Elasticsearch giving up on some request and resulting in indexing failures.\n\nNote that raising this number above the queue size has no effect,\nas bulks cannot include more requests than are contained in the queue.","withinAMap":true,"defaultValue":"100","javaDocSiteLink":"","docMapKey":"max-bulk-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocSection":{"name":".elasticsearch.indexes","optional":false,"withinAMap":true,"sectionDetails":"== Per-index configuration overrides","sectionDetailsTitle":"Per-index configuration overrides","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.ElasticsearchIndexRuntimeConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"org.hibernate.search.backend.elasticsearch.index.IndexStatus","key":".elasticsearch.indexes.\"index-name\".schema-management.required-status","additionalKeys":[".elasticsearch.\"backend-name\".indexes.\"index-name\".schema-management.required-status"],"configDoc":"The minimal https://www.elastic.co/guide/en/elasticsearch/reference/7.17/cluster-health.html[Elasticsearch cluster\nstatus] required on startup.","withinAMap":true,"defaultValue":"yellow","javaDocSiteLink":"","docMapKey":"required-status","configPhase":"BUILD_TIME","acceptedValues":["`green`","`yellow`","`red`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"java.time.Duration","key":".elasticsearch.indexes.\"index-name\".schema-management.required-status-wait-timeout","additionalKeys":[".elasticsearch.\"backend-name\".indexes.\"index-name\".schema-management.required-status-wait-timeout"],"configDoc":"How long we should wait for the status before failing the bootstrap.","withinAMap":true,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"required-status-wait-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".elasticsearch.indexes.\"index-name\".indexing.queue-count","additionalKeys":[".elasticsearch.\"backend-name\".indexes.\"index-name\".indexing.queue-count"],"configDoc":"The number of indexing queues assigned to each index.\n\nHigher values will lead to more connections being used in parallel,\nwhich may lead to higher indexing throughput,\nbut incurs a risk of overloading Elasticsearch,\ni.e. of overflowing its HTTP request buffers and tripping\nhttps://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[circuit breakers],\nleading to Elasticsearch giving up on some request and resulting in indexing failures.","withinAMap":true,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"queue-count","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".elasticsearch.indexes.\"index-name\".indexing.queue-size","additionalKeys":[".elasticsearch.\"backend-name\".indexes.\"index-name\".indexing.queue-size"],"configDoc":"The size of indexing queues.\n\nLower values may lead to lower memory usage, especially if there are many queues,\nbut values that are too low will reduce the likeliness of reaching the max bulk size\nand increase the likeliness of application threads blocking because the queue is full,\nwhich may lead to lower indexing throughput.","withinAMap":true,"defaultValue":"1000","javaDocSiteLink":"","docMapKey":"queue-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".elasticsearch.indexes.\"index-name\".indexing.max-bulk-size","additionalKeys":[".elasticsearch.\"backend-name\".indexes.\"index-name\".indexing.max-bulk-size"],"configDoc":"The maximum size of bulk requests created when processing indexing queues.\n\nHigher values will lead to more documents being sent in each HTTP request sent to Elasticsearch,\nwhich may lead to higher indexing throughput,\nbut incurs a risk of overloading Elasticsearch,\ni.e. of overflowing its HTTP request buffers and tripping\nhttps://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[circuit breakers],\nleading to Elasticsearch giving up on some request and resulting in indexing failures.\n\nNote that raising this number above the queue size has no effect,\nas bulks cannot include more requests than are contained in the queue.","withinAMap":true,"defaultValue":"100","javaDocSiteLink":"","docMapKey":"max-bulk-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".schema-management","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.SchemaManagementConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"org.hibernate.search.mapper.orm.schema.management.SchemaManagementStrategyName","key":".schema-management.strategy","additionalKeys":[],"configDoc":"The schema management strategy, controlling how indexes and their schema\nare created, updated, validated or dropped on startup and shutdown.\n\nAvailable values:\n\n[cols=2]\n!===\nh!Strategy\nh!Definition\n\n!none\n!Do nothing: assume that indexes already exist and that their schema matches Hibernate Search's expectations.\n\n!validate\n!Validate that indexes exist and that their schema matches Hibernate Search's expectations.\n\nIf it does not, throw an exception, but make no attempt to fix the problem.\n\n!create\n!For indexes that do not exist, create them along with their schema.\n\nFor indexes that already exist, do nothing: assume that their schema matches Hibernate Search's expectations.\n\n!create-or-validate (**default** unless using Dev Services)\n!For indexes that do not exist, create them along with their schema.\n\nFor indexes that already exist, validate that their schema matches Hibernate Search's expectations.\n\nIf it does not, throw an exception, but make no attempt to fix the problem.\n\n!create-or-update\n!For indexes that do not exist, create them along with their schema.\n\nFor indexes that already exist, validate that their schema matches Hibernate Search's expectations;\nif it does not match expectations, try to update it.\n\n**This strategy is unfit for production environments**,\ndue to several important limitations,\nbut can be useful when developing.\n\n!drop-and-create\n!For indexes that do not exist, create them along with their schema.\n\nFor indexes that already exist, drop them, then create them along with their schema.\n\n!drop-and-create-and-drop (**default** when using Dev Services)\n!For indexes that do not exist, create them along with their schema.\n\nFor indexes that already exist, drop them, then create them along with their schema.\n\nAlso, drop indexes and their schema on shutdown.\n!===\n\nSee https://docs.jboss.org/hibernate/stable/search/reference/en-US/html_single/#mapper-orm-schema-management-strategy[this section of the reference documentation]\nfor more information.","withinAMap":false,"defaultValue":"drop-and-create-and-drop when using Dev Services; create-or-validate otherwise","javaDocSiteLink":"","docMapKey":"strategy","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".query.loading","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.SearchQueryLoadingConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"org.hibernate.search.mapper.orm.search.loading.EntityLoadingCacheLookupStrategy","key":".query.loading.cache-lookup.strategy","additionalKeys":[],"configDoc":"The strategy to use when loading entities during the execution of a search query.","withinAMap":false,"defaultValue":"skip","javaDocSiteLink":"","docMapKey":"strategy","configPhase":"BUILD_TIME","acceptedValues":["`skip`","`persistence-context`","`persistence-context-then-second-level-cache`"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"int","key":".query.loading.fetch-size","additionalKeys":[],"configDoc":"The fetch size to use when loading entities during the execution of a search query.","withinAMap":false,"defaultValue":"100","javaDocSiteLink":"","docMapKey":"fetch-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".indexing","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.IndexingConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".indexing.plan.synchronization.strategy","additionalKeys":[],"configDoc":"How to synchronize between application threads and indexing,\nin particular when relying on (implicit) listener-triggered indexing on entity change,\nbut also when using a `SearchIndexingPlan` explicitly.\n\nDefines how complete indexing should be before resuming the application thread\nafter a database transaction is committed.\n\n[WARNING]\n====\nIndexing synchronization is only relevant when coordination is disabled (which is the default).\n\nWith the xref:hibernate-search-orm-elasticsearch.adoc#coordination[`outbox-polling` coordination strategy],\nindexing happens in background threads and is always asynchronous;\nthe behavior is equivalent to the `write-sync` synchronization strategy.\n====\n\nAvailable values:\n\n[cols=5]\n!===\n.2+h!Strategy\n.2+h!Throughput\n3+^h!Guarantees when the application thread resumes\n\nh!Changes applied\nh!Changes safe from crash/power loss\nh!Changes visible on search\n\n!async\n!Best\n^!icon:times[role=red]\n^!icon:times[role=red]\n^!icon:times[role=red]\n\n!write-sync (**default**)\n!Medium\n^!icon:check[role=lime]\n^!icon:check[role=lime]\n^!icon:times[role=red]\n\n!read-sync\n!Medium to worst\n^!icon:check[role=lime]\n^!icon:times[role=red]\n^!icon:check[role=lime]\n\n!sync\n!Worst\n^!icon:check[role=lime]\n^!icon:check[role=lime]\n^!icon:check[role=lime]\n!===\n\nThis property also accepts a xref:hibernate-search-orm-elasticsearch.adoc#bean-reference-note-anchor[bean reference]\nto a custom implementations of `IndexingPlanSynchronizationStrategy`.\n\nSee\nlink:{hibernate-search-docs-url}#indexing-plan-synchronization[this section of the reference documentation]\nfor more information.\n\n[NOTE]\n====\nInstead of setting this configuration property,\nyou can simply annotate your custom `IndexingPlanSynchronizationStrategy` implementation with `@SearchExtension`\nand leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.\nIf this configuration property is set, it takes precedence over any `@SearchExtension` annotation.\n====","withinAMap":false,"defaultValue":"write-sync","javaDocSiteLink":"","docMapKey":"strategy","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".multi-tenancy","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.MultiTenancyConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".multi-tenancy.tenant-ids","additionalKeys":[],"configDoc":"An exhaustive list of all tenant identifiers that may be used by the application when multi-tenancy is enabled.\n\nMainly useful when using the {@code outbox-polling} coordination strategy,\nsince it involves setting up one background processor per tenant.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tenant-ids","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}}] \ No newline at end of file diff --git a/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.ElasticsearchBackendRuntimeConfig b/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.ElasticsearchBackendRuntimeConfig index f04e99edb40..1a47516ce53 100644 --- a/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.ElasticsearchBackendRuntimeConfig +++ b/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.ElasticsearchBackendRuntimeConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"string","key":".hosts","additionalKeys":[],"configDoc":"The list of hosts of the Elasticsearch servers.","withinAMap":false,"defaultValue":"localhost:9200","javaDocSiteLink":"","docMapKey":"hosts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.ElasticsearchClientProtocol","key":".protocol","additionalKeys":[],"configDoc":"The protocol to use when contacting Elasticsearch servers. Set to \"https\" to enable SSL/TLS.","withinAMap":false,"defaultValue":"http","javaDocSiteLink":"","docMapKey":"protocol","configPhase":"BUILD_TIME","acceptedValues":["`http`","`https`"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"string","key":".username","additionalKeys":[],"configDoc":"The username used for authentication.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".password","additionalKeys":[],"configDoc":"The password used for authentication.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".connection-timeout","additionalKeys":[],"configDoc":"The timeout when establishing a connection to an Elasticsearch server.","withinAMap":false,"defaultValue":"1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"connection-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".read-timeout","additionalKeys":[],"configDoc":"The timeout when reading responses from an Elasticsearch server.","withinAMap":false,"defaultValue":"30S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"read-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".request-timeout","additionalKeys":[],"configDoc":"The timeout when executing a request to an Elasticsearch server.\n\nThis includes the time needed to wait for a connection to be available,\nsend the request and read the response.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"request-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"int","key":".max-connections","additionalKeys":[],"configDoc":"The maximum number of connections to all the Elasticsearch servers.","withinAMap":false,"defaultValue":"20","javaDocSiteLink":"","docMapKey":"max-connections","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"int","key":".max-connections-per-route","additionalKeys":[],"configDoc":"The maximum number of connections per Elasticsearch server.","withinAMap":false,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"max-connections-per-route","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".discovery","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.DiscoveryConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"java.lang.Boolean","key":".discovery.enabled","additionalKeys":[],"configDoc":"Defines if automatic discovery is enabled.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".discovery.refresh-interval","additionalKeys":[],"configDoc":"Refresh interval of the node list.","withinAMap":false,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"refresh-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".thread-pool","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.ThreadPoolConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"java.lang.Integer","key":".thread-pool.size","additionalKeys":[],"configDoc":"The size of the thread pool assigned to the backend.\n\nNote that number is **per backend**, not per index.\nAdding more indexes will not add more threads.\n\nAs all operations happening in this thread-pool are non-blocking,\nraising its size above the number of processor cores available to the JVM will not bring noticeable performance\nbenefit.\nThe only reason to alter this setting would be to reduce the number of threads;\nfor example, in an application with a single index with a single indexing queue,\nrunning on a machine with 64 processor cores,\nyou might want to bring down the number of threads.\n\nDefaults to the number of processor cores available to the JVM on startup.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".query","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.ElasticsearchQueryConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".query.shard-failure.ignore","additionalKeys":[],"configDoc":"Whether partial shard failures are ignored (`true`) or lead to Hibernate Search throwing an exception (`false`).","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"ignore","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"boolean","key":".version-check.enabled","additionalKeys":[],"configDoc":"Whether Hibernate Search should check the version of the Elasticsearch cluster on startup.\n\nSet to `false` if the Elasticsearch cluster may not be available on startup.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"version-check","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":"","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.ElasticsearchIndexRuntimeConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"org.hibernate.search.backend.elasticsearch.index.IndexStatus","key":".schema-management.required-status","additionalKeys":[],"configDoc":"The minimal https://www.elastic.co/guide/en/elasticsearch/reference/7.17/cluster-health.html[Elasticsearch cluster\nstatus] required on startup.","withinAMap":false,"defaultValue":"yellow","javaDocSiteLink":"","docMapKey":"required-status","configPhase":"BUILD_TIME","acceptedValues":["`green`","`yellow`","`red`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"java.time.Duration","key":".schema-management.required-status-wait-timeout","additionalKeys":[],"configDoc":"How long we should wait for the status before failing the bootstrap.","withinAMap":false,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"required-status-wait-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".indexing.queue-count","additionalKeys":[],"configDoc":"The number of indexing queues assigned to each index.\n\nHigher values will lead to more connections being used in parallel,\nwhich may lead to higher indexing throughput,\nbut incurs a risk of overloading Elasticsearch,\ni.e. of overflowing its HTTP request buffers and tripping\nhttps://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[circuit breakers],\nleading to Elasticsearch giving up on some request and resulting in indexing failures.","withinAMap":false,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"queue-count","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".indexing.queue-size","additionalKeys":[],"configDoc":"The size of indexing queues.\n\nLower values may lead to lower memory usage, especially if there are many queues,\nbut values that are too low will reduce the likeliness of reaching the max bulk size\nand increase the likeliness of application threads blocking because the queue is full,\nwhich may lead to lower indexing throughput.","withinAMap":false,"defaultValue":"1000","javaDocSiteLink":"","docMapKey":"queue-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".indexing.max-bulk-size","additionalKeys":[],"configDoc":"The maximum size of bulk requests created when processing indexing queues.\n\nHigher values will lead to more documents being sent in each HTTP request sent to Elasticsearch,\nwhich may lead to higher indexing throughput,\nbut incurs a risk of overloading Elasticsearch,\ni.e. of overflowing its HTTP request buffers and tripping\nhttps://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[circuit breakers],\nleading to Elasticsearch giving up on some request and resulting in indexing failures.\n\nNote that raising this number above the queue size has no effect,\nas bulks cannot include more requests than are contained in the queue.","withinAMap":false,"defaultValue":"100","javaDocSiteLink":"","docMapKey":"max-bulk-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":".indexes","optional":false,"withinAMap":false,"sectionDetails":"== Per-index configuration overrides","sectionDetailsTitle":"Per-index configuration overrides","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.ElasticsearchIndexRuntimeConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"org.hibernate.search.backend.elasticsearch.index.IndexStatus","key":".indexes.\"index-name\".schema-management.required-status","additionalKeys":[],"configDoc":"The minimal https://www.elastic.co/guide/en/elasticsearch/reference/7.17/cluster-health.html[Elasticsearch cluster\nstatus] required on startup.","withinAMap":true,"defaultValue":"yellow","javaDocSiteLink":"","docMapKey":"required-status","configPhase":"BUILD_TIME","acceptedValues":["`green`","`yellow`","`red`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"java.time.Duration","key":".indexes.\"index-name\".schema-management.required-status-wait-timeout","additionalKeys":[],"configDoc":"How long we should wait for the status before failing the bootstrap.","withinAMap":true,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"required-status-wait-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".indexes.\"index-name\".indexing.queue-count","additionalKeys":[],"configDoc":"The number of indexing queues assigned to each index.\n\nHigher values will lead to more connections being used in parallel,\nwhich may lead to higher indexing throughput,\nbut incurs a risk of overloading Elasticsearch,\ni.e. of overflowing its HTTP request buffers and tripping\nhttps://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[circuit breakers],\nleading to Elasticsearch giving up on some request and resulting in indexing failures.","withinAMap":true,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"queue-count","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".indexes.\"index-name\".indexing.queue-size","additionalKeys":[],"configDoc":"The size of indexing queues.\n\nLower values may lead to lower memory usage, especially if there are many queues,\nbut values that are too low will reduce the likeliness of reaching the max bulk size\nand increase the likeliness of application threads blocking because the queue is full,\nwhich may lead to lower indexing throughput.","withinAMap":true,"defaultValue":"1000","javaDocSiteLink":"","docMapKey":"queue-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".indexes.\"index-name\".indexing.max-bulk-size","additionalKeys":[],"configDoc":"The maximum size of bulk requests created when processing indexing queues.\n\nHigher values will lead to more documents being sent in each HTTP request sent to Elasticsearch,\nwhich may lead to higher indexing throughput,\nbut incurs a risk of overloading Elasticsearch,\ni.e. of overflowing its HTTP request buffers and tripping\nhttps://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[circuit breakers],\nleading to Elasticsearch giving up on some request and resulting in indexing failures.\n\nNote that raising this number above the queue size has no effect,\nas bulks cannot include more requests than are contained in the queue.","withinAMap":true,"defaultValue":"100","javaDocSiteLink":"","docMapKey":"max-bulk-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}}] \ No newline at end of file +[{"configDocKey":{"type":"string","key":".hosts","additionalKeys":[],"configDoc":"The list of hosts of the Elasticsearch servers.","withinAMap":false,"defaultValue":"localhost:9200","javaDocSiteLink":"","docMapKey":"hosts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.ElasticsearchClientProtocol","key":".protocol","additionalKeys":[],"configDoc":"The protocol to use when contacting Elasticsearch servers. Set to \"https\" to enable SSL/TLS.","withinAMap":false,"defaultValue":"http","javaDocSiteLink":"","docMapKey":"protocol","configPhase":"BUILD_TIME","acceptedValues":["`http`","`https`"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"string","key":".username","additionalKeys":[],"configDoc":"The username used for authentication.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".password","additionalKeys":[],"configDoc":"The password used for authentication.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".connection-timeout","additionalKeys":[],"configDoc":"The timeout when establishing a connection to an Elasticsearch server.","withinAMap":false,"defaultValue":"1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"connection-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".read-timeout","additionalKeys":[],"configDoc":"The timeout when reading responses from an Elasticsearch server.","withinAMap":false,"defaultValue":"30S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"read-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".request-timeout","additionalKeys":[],"configDoc":"The timeout when executing a request to an Elasticsearch server.\n\nThis includes the time needed to wait for a connection to be available,\nsend the request and read the response.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"request-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"int","key":".max-connections","additionalKeys":[],"configDoc":"The maximum number of connections to all the Elasticsearch servers.","withinAMap":false,"defaultValue":"20","javaDocSiteLink":"","docMapKey":"max-connections","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"int","key":".max-connections-per-route","additionalKeys":[],"configDoc":"The maximum number of connections per Elasticsearch server.","withinAMap":false,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"max-connections-per-route","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".discovery","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.DiscoveryConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"java.lang.Boolean","key":".discovery.enabled","additionalKeys":[],"configDoc":"Defines if automatic discovery is enabled.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".discovery.refresh-interval","additionalKeys":[],"configDoc":"Refresh interval of the node list.","withinAMap":false,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"refresh-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".thread-pool","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.ThreadPoolConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"java.lang.Integer","key":".thread-pool.size","additionalKeys":[],"configDoc":"The size of the thread pool assigned to the backend.\n\nNote that number is **per backend**, not per index.\nAdding more indexes will not add more threads.\n\nAs all operations happening in this thread-pool are non-blocking,\nraising its size above the number of processor cores available to the JVM will not bring noticeable performance\nbenefit.\nThe only reason to alter this setting would be to reduce the number of threads;\nfor example, in an application with a single index with a single indexing queue,\nrunning on a machine with 64 processor cores,\nyou might want to bring down the number of threads.\n\nDefaults to the number of processor cores available to the JVM on startup.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".query","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.ElasticsearchQueryConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".query.shard-failure.ignore","additionalKeys":[],"configDoc":"Whether partial shard failures are ignored (`true`) or lead to Hibernate Search throwing an exception (`false`).","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"ignore","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".version-check","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.ElasticsearchVersionCheckConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".version-check.enabled","additionalKeys":[],"configDoc":"Whether Hibernate Search should check the version of the Elasticsearch cluster on startup.\n\nSet to `false` if the Elasticsearch cluster may not be available on startup.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":"","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.ElasticsearchIndexRuntimeConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"org.hibernate.search.backend.elasticsearch.index.IndexStatus","key":".schema-management.required-status","additionalKeys":[],"configDoc":"The minimal https://www.elastic.co/guide/en/elasticsearch/reference/7.17/cluster-health.html[Elasticsearch cluster\nstatus] required on startup.","withinAMap":false,"defaultValue":"yellow","javaDocSiteLink":"","docMapKey":"required-status","configPhase":"BUILD_TIME","acceptedValues":["`green`","`yellow`","`red`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"java.time.Duration","key":".schema-management.required-status-wait-timeout","additionalKeys":[],"configDoc":"How long we should wait for the status before failing the bootstrap.","withinAMap":false,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"required-status-wait-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".indexing.queue-count","additionalKeys":[],"configDoc":"The number of indexing queues assigned to each index.\n\nHigher values will lead to more connections being used in parallel,\nwhich may lead to higher indexing throughput,\nbut incurs a risk of overloading Elasticsearch,\ni.e. of overflowing its HTTP request buffers and tripping\nhttps://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[circuit breakers],\nleading to Elasticsearch giving up on some request and resulting in indexing failures.","withinAMap":false,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"queue-count","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".indexing.queue-size","additionalKeys":[],"configDoc":"The size of indexing queues.\n\nLower values may lead to lower memory usage, especially if there are many queues,\nbut values that are too low will reduce the likeliness of reaching the max bulk size\nand increase the likeliness of application threads blocking because the queue is full,\nwhich may lead to lower indexing throughput.","withinAMap":false,"defaultValue":"1000","javaDocSiteLink":"","docMapKey":"queue-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".indexing.max-bulk-size","additionalKeys":[],"configDoc":"The maximum size of bulk requests created when processing indexing queues.\n\nHigher values will lead to more documents being sent in each HTTP request sent to Elasticsearch,\nwhich may lead to higher indexing throughput,\nbut incurs a risk of overloading Elasticsearch,\ni.e. of overflowing its HTTP request buffers and tripping\nhttps://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[circuit breakers],\nleading to Elasticsearch giving up on some request and resulting in indexing failures.\n\nNote that raising this number above the queue size has no effect,\nas bulks cannot include more requests than are contained in the queue.","withinAMap":false,"defaultValue":"100","javaDocSiteLink":"","docMapKey":"max-bulk-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":".indexes","optional":false,"withinAMap":false,"sectionDetails":"== Per-index configuration overrides","sectionDetailsTitle":"Per-index configuration overrides","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.ElasticsearchIndexRuntimeConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"org.hibernate.search.backend.elasticsearch.index.IndexStatus","key":".indexes.\"index-name\".schema-management.required-status","additionalKeys":[],"configDoc":"The minimal https://www.elastic.co/guide/en/elasticsearch/reference/7.17/cluster-health.html[Elasticsearch cluster\nstatus] required on startup.","withinAMap":true,"defaultValue":"yellow","javaDocSiteLink":"","docMapKey":"required-status","configPhase":"BUILD_TIME","acceptedValues":["`green`","`yellow`","`red`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"java.time.Duration","key":".indexes.\"index-name\".schema-management.required-status-wait-timeout","additionalKeys":[],"configDoc":"How long we should wait for the status before failing the bootstrap.","withinAMap":true,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"required-status-wait-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".indexes.\"index-name\".indexing.queue-count","additionalKeys":[],"configDoc":"The number of indexing queues assigned to each index.\n\nHigher values will lead to more connections being used in parallel,\nwhich may lead to higher indexing throughput,\nbut incurs a risk of overloading Elasticsearch,\ni.e. of overflowing its HTTP request buffers and tripping\nhttps://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[circuit breakers],\nleading to Elasticsearch giving up on some request and resulting in indexing failures.","withinAMap":true,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"queue-count","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".indexes.\"index-name\".indexing.queue-size","additionalKeys":[],"configDoc":"The size of indexing queues.\n\nLower values may lead to lower memory usage, especially if there are many queues,\nbut values that are too low will reduce the likeliness of reaching the max bulk size\nand increase the likeliness of application threads blocking because the queue is full,\nwhich may lead to lower indexing throughput.","withinAMap":true,"defaultValue":"1000","javaDocSiteLink":"","docMapKey":"queue-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".indexes.\"index-name\".indexing.max-bulk-size","additionalKeys":[],"configDoc":"The maximum size of bulk requests created when processing indexing queues.\n\nHigher values will lead to more documents being sent in each HTTP request sent to Elasticsearch,\nwhich may lead to higher indexing throughput,\nbut incurs a risk of overloading Elasticsearch,\ni.e. of overflowing its HTTP request buffers and tripping\nhttps://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[circuit breakers],\nleading to Elasticsearch giving up on some request and resulting in indexing failures.\n\nNote that raising this number above the queue size has no effect,\nas bulks cannot include more requests than are contained in the queue.","withinAMap":true,"defaultValue":"100","javaDocSiteLink":"","docMapKey":"max-bulk-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}}] \ No newline at end of file diff --git a/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.ElasticsearchVersionCheckConfig b/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.ElasticsearchVersionCheckConfig new file mode 100644 index 00000000000..e1968719619 --- /dev/null +++ b/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.ElasticsearchVersionCheckConfig @@ -0,0 +1 @@ +[{"configDocKey":{"type":"boolean","key":".enabled","additionalKeys":[],"configDoc":"Whether Hibernate Search should check the version of the Elasticsearch cluster on startup.\n\nSet to `false` if the Elasticsearch cluster may not be available on startup.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfig b/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfig index 8e865f670d9..dbec2d39756 100644 --- a/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfig +++ b/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.hibernate-search-orm.active","additionalKeys":["quarkus.hibernate-search-orm.\"persistence-unit-name\".active"],"configDoc":"Whether Hibernate Search should be active for this persistence unit at runtime.\n\nIf Hibernate Search is not active, it won't index Hibernate ORM entities,\nand accessing the SearchMapping/SearchSession of the relevant persistence unit\nfor search or other operation will not be possible.\n\nNote that if Hibernate Search is disabled (i.e. `quarkus.hibernate-search-orm.enabled` is set to `false`),\nit won't be active for any persistence unit, and setting this property to `true` will fail.","withinAMap":true,"defaultValue":"'true' if Hibernate Search is enabled; 'false' otherwise","javaDocSiteLink":"","docMapKey":"active","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocSection":{"name":"quarkus.hibernate-search-orm.backends","optional":false,"withinAMap":true,"sectionDetails":"== Configuration for backends","sectionDetailsTitle":"Configuration for backends","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.hibernate-search-orm","configGroupType":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.ElasticsearchBackendRuntimeConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"string","key":"quarkus.hibernate-search-orm.elasticsearch.hosts","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".hosts","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".hosts","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.hosts"],"configDoc":"The list of hosts of the Elasticsearch servers.","withinAMap":true,"defaultValue":"localhost:9200","javaDocSiteLink":"","docMapKey":"hosts","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.ElasticsearchClientProtocol","key":"quarkus.hibernate-search-orm.elasticsearch.protocol","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".protocol","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".protocol","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.protocol"],"configDoc":"The protocol to use when contacting Elasticsearch servers. Set to \"https\" to enable SSL/TLS.","withinAMap":true,"defaultValue":"http","javaDocSiteLink":"","docMapKey":"protocol","configPhase":"RUN_TIME","acceptedValues":["`http`","`https`"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.hibernate-search-orm.elasticsearch.username","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".username","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".username","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.username"],"configDoc":"The username used for authentication.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.hibernate-search-orm.elasticsearch.password","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".password","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".password","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.password"],"configDoc":"The password used for authentication.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.hibernate-search-orm.elasticsearch.connection-timeout","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".connection-timeout","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".connection-timeout","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.connection-timeout"],"configDoc":"The timeout when establishing a connection to an Elasticsearch server.","withinAMap":true,"defaultValue":"1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"connection-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.hibernate-search-orm.elasticsearch.read-timeout","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".read-timeout","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".read-timeout","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.read-timeout"],"configDoc":"The timeout when reading responses from an Elasticsearch server.","withinAMap":true,"defaultValue":"30S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"read-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.hibernate-search-orm.elasticsearch.request-timeout","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".request-timeout","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".request-timeout","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.request-timeout"],"configDoc":"The timeout when executing a request to an Elasticsearch server.\n\nThis includes the time needed to wait for a connection to be available,\nsend the request and read the response.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"request-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.hibernate-search-orm.elasticsearch.max-connections","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".max-connections","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".max-connections","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.max-connections"],"configDoc":"The maximum number of connections to all the Elasticsearch servers.","withinAMap":true,"defaultValue":"20","javaDocSiteLink":"","docMapKey":"max-connections","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.hibernate-search-orm.elasticsearch.max-connections-per-route","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".max-connections-per-route","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".max-connections-per-route","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.max-connections-per-route"],"configDoc":"The maximum number of connections per Elasticsearch server.","withinAMap":true,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"max-connections-per-route","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.hibernate-search-orm.elasticsearch.discovery.enabled","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".discovery.enabled","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".discovery.enabled","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.discovery.enabled"],"configDoc":"Defines if automatic discovery is enabled.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.hibernate-search-orm.elasticsearch.discovery.refresh-interval","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".discovery.refresh-interval","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".discovery.refresh-interval","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.discovery.refresh-interval"],"configDoc":"Refresh interval of the node list.","withinAMap":true,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"refresh-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.hibernate-search-orm.elasticsearch.thread-pool.size","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".thread-pool.size","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".thread-pool.size","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.thread-pool.size"],"configDoc":"The size of the thread pool assigned to the backend.\n\nNote that number is **per backend**, not per index.\nAdding more indexes will not add more threads.\n\nAs all operations happening in this thread-pool are non-blocking,\nraising its size above the number of processor cores available to the JVM will not bring noticeable performance\nbenefit.\nThe only reason to alter this setting would be to reduce the number of threads;\nfor example, in an application with a single index with a single indexing queue,\nrunning on a machine with 64 processor cores,\nyou might want to bring down the number of threads.\n\nDefaults to the number of processor cores available to the JVM on startup.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.hibernate-search-orm.elasticsearch.query.shard-failure.ignore","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".query.shard-failure.ignore","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".query.shard-failure.ignore","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.query.shard-failure.ignore"],"configDoc":"Whether partial shard failures are ignored (`true`) or lead to Hibernate Search throwing an exception (`false`).","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"ignore","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.hibernate-search-orm.elasticsearch.version-check.enabled","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".version-check.enabled","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".version-check.enabled","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.version-check.enabled"],"configDoc":"Whether Hibernate Search should check the version of the Elasticsearch cluster on startup.\n\nSet to `false` if the Elasticsearch cluster may not be available on startup.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"version-check","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"org.hibernate.search.backend.elasticsearch.index.IndexStatus","key":"quarkus.hibernate-search-orm.elasticsearch.schema-management.required-status","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".schema-management.required-status","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".schema-management.required-status","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.schema-management.required-status"],"configDoc":"The minimal https://www.elastic.co/guide/en/elasticsearch/reference/7.17/cluster-health.html[Elasticsearch cluster\nstatus] required on startup.","withinAMap":true,"defaultValue":"yellow","javaDocSiteLink":"","docMapKey":"required-status","configPhase":"RUN_TIME","acceptedValues":["`green`","`yellow`","`red`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":true}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.hibernate-search-orm.elasticsearch.schema-management.required-status-wait-timeout","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".schema-management.required-status-wait-timeout","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".schema-management.required-status-wait-timeout","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.schema-management.required-status-wait-timeout"],"configDoc":"How long we should wait for the status before failing the bootstrap.","withinAMap":true,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"required-status-wait-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.hibernate-search-orm.elasticsearch.indexing.queue-count","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".indexing.queue-count","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".indexing.queue-count","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.indexing.queue-count"],"configDoc":"The number of indexing queues assigned to each index.\n\nHigher values will lead to more connections being used in parallel,\nwhich may lead to higher indexing throughput,\nbut incurs a risk of overloading Elasticsearch,\ni.e. of overflowing its HTTP request buffers and tripping\nhttps://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[circuit breakers],\nleading to Elasticsearch giving up on some request and resulting in indexing failures.","withinAMap":true,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"queue-count","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.hibernate-search-orm.elasticsearch.indexing.queue-size","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".indexing.queue-size","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".indexing.queue-size","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.indexing.queue-size"],"configDoc":"The size of indexing queues.\n\nLower values may lead to lower memory usage, especially if there are many queues,\nbut values that are too low will reduce the likeliness of reaching the max bulk size\nand increase the likeliness of application threads blocking because the queue is full,\nwhich may lead to lower indexing throughput.","withinAMap":true,"defaultValue":"1000","javaDocSiteLink":"","docMapKey":"queue-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.hibernate-search-orm.elasticsearch.indexing.max-bulk-size","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".indexing.max-bulk-size","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".indexing.max-bulk-size","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.indexing.max-bulk-size"],"configDoc":"The maximum size of bulk requests created when processing indexing queues.\n\nHigher values will lead to more documents being sent in each HTTP request sent to Elasticsearch,\nwhich may lead to higher indexing throughput,\nbut incurs a risk of overloading Elasticsearch,\ni.e. of overflowing its HTTP request buffers and tripping\nhttps://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[circuit breakers],\nleading to Elasticsearch giving up on some request and resulting in indexing failures.\n\nNote that raising this number above the queue size has no effect,\nas bulks cannot include more requests than are contained in the queue.","withinAMap":true,"defaultValue":"100","javaDocSiteLink":"","docMapKey":"max-bulk-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocSection":{"name":"quarkus.hibernate-search-orm.elasticsearch.indexes","optional":false,"withinAMap":true,"sectionDetails":"== Per-index configuration overrides","sectionDetailsTitle":"Per-index configuration overrides","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.hibernate-search-orm","configGroupType":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.ElasticsearchIndexRuntimeConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"org.hibernate.search.backend.elasticsearch.index.IndexStatus","key":"quarkus.hibernate-search-orm.elasticsearch.indexes.\"index-name\".schema-management.required-status","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".indexes.\"index-name\".schema-management.required-status","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".indexes.\"index-name\".schema-management.required-status","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.indexes.\"index-name\".schema-management.required-status"],"configDoc":"The minimal https://www.elastic.co/guide/en/elasticsearch/reference/7.17/cluster-health.html[Elasticsearch cluster\nstatus] required on startup.","withinAMap":true,"defaultValue":"yellow","javaDocSiteLink":"","docMapKey":"required-status","configPhase":"RUN_TIME","acceptedValues":["`green`","`yellow`","`red`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":true}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.hibernate-search-orm.elasticsearch.indexes.\"index-name\".schema-management.required-status-wait-timeout","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".indexes.\"index-name\".schema-management.required-status-wait-timeout","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".indexes.\"index-name\".schema-management.required-status-wait-timeout","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.indexes.\"index-name\".schema-management.required-status-wait-timeout"],"configDoc":"How long we should wait for the status before failing the bootstrap.","withinAMap":true,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"required-status-wait-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.hibernate-search-orm.elasticsearch.indexes.\"index-name\".indexing.queue-count","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".indexes.\"index-name\".indexing.queue-count","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".indexes.\"index-name\".indexing.queue-count","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.indexes.\"index-name\".indexing.queue-count"],"configDoc":"The number of indexing queues assigned to each index.\n\nHigher values will lead to more connections being used in parallel,\nwhich may lead to higher indexing throughput,\nbut incurs a risk of overloading Elasticsearch,\ni.e. of overflowing its HTTP request buffers and tripping\nhttps://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[circuit breakers],\nleading to Elasticsearch giving up on some request and resulting in indexing failures.","withinAMap":true,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"queue-count","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.hibernate-search-orm.elasticsearch.indexes.\"index-name\".indexing.queue-size","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".indexes.\"index-name\".indexing.queue-size","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".indexes.\"index-name\".indexing.queue-size","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.indexes.\"index-name\".indexing.queue-size"],"configDoc":"The size of indexing queues.\n\nLower values may lead to lower memory usage, especially if there are many queues,\nbut values that are too low will reduce the likeliness of reaching the max bulk size\nand increase the likeliness of application threads blocking because the queue is full,\nwhich may lead to lower indexing throughput.","withinAMap":true,"defaultValue":"1000","javaDocSiteLink":"","docMapKey":"queue-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.hibernate-search-orm.elasticsearch.indexes.\"index-name\".indexing.max-bulk-size","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".indexes.\"index-name\".indexing.max-bulk-size","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".indexes.\"index-name\".indexing.max-bulk-size","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.indexes.\"index-name\".indexing.max-bulk-size"],"configDoc":"The maximum size of bulk requests created when processing indexing queues.\n\nHigher values will lead to more documents being sent in each HTTP request sent to Elasticsearch,\nwhich may lead to higher indexing throughput,\nbut incurs a risk of overloading Elasticsearch,\ni.e. of overflowing its HTTP request buffers and tripping\nhttps://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[circuit breakers],\nleading to Elasticsearch giving up on some request and resulting in indexing failures.\n\nNote that raising this number above the queue size has no effect,\nas bulks cannot include more requests than are contained in the queue.","withinAMap":true,"defaultValue":"100","javaDocSiteLink":"","docMapKey":"max-bulk-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}}],"anchorPrefix":null}}],"anchorPrefix":null}},{"configDocKey":{"type":"org.hibernate.search.mapper.orm.schema.management.SchemaManagementStrategyName","key":"quarkus.hibernate-search-orm.schema-management.strategy","additionalKeys":["quarkus.hibernate-search-orm.\"persistence-unit-name\".schema-management.strategy"],"configDoc":"The schema management strategy, controlling how indexes and their schema\nare created, updated, validated or dropped on startup and shutdown.\n\nAvailable values:\n\n[cols=2]\n!===\nh!Strategy\nh!Definition\n\n!none\n!Do nothing: assume that indexes already exist and that their schema matches Hibernate Search's expectations.\n\n!validate\n!Validate that indexes exist and that their schema matches Hibernate Search's expectations.\n\nIf it does not, throw an exception, but make no attempt to fix the problem.\n\n!create\n!For indexes that do not exist, create them along with their schema.\n\nFor indexes that already exist, do nothing: assume that their schema matches Hibernate Search's expectations.\n\n!create-or-validate (**default** unless using Dev Services)\n!For indexes that do not exist, create them along with their schema.\n\nFor indexes that already exist, validate that their schema matches Hibernate Search's expectations.\n\nIf it does not, throw an exception, but make no attempt to fix the problem.\n\n!create-or-update\n!For indexes that do not exist, create them along with their schema.\n\nFor indexes that already exist, validate that their schema matches Hibernate Search's expectations;\nif it does not match expectations, try to update it.\n\n**This strategy is unfit for production environments**,\ndue to several important limitations,\nbut can be useful when developing.\n\n!drop-and-create\n!For indexes that do not exist, create them along with their schema.\n\nFor indexes that already exist, drop them, then create them along with their schema.\n\n!drop-and-create-and-drop (**default** when using Dev Services)\n!For indexes that do not exist, create them along with their schema.\n\nFor indexes that already exist, drop them, then create them along with their schema.\n\nAlso, drop indexes and their schema on shutdown.\n!===\n\nSee https://docs.jboss.org/hibernate/stable/search/reference/en-US/html_single/#mapper-orm-schema-management-strategy[this section of the reference documentation]\nfor more information.","withinAMap":true,"defaultValue":"drop-and-create-and-drop when using Dev Services; create-or-validate otherwise","javaDocSiteLink":"","docMapKey":"strategy","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"org.hibernate.search.mapper.orm.search.loading.EntityLoadingCacheLookupStrategy","key":"quarkus.hibernate-search-orm.query.loading.cache-lookup.strategy","additionalKeys":["quarkus.hibernate-search-orm.\"persistence-unit-name\".query.loading.cache-lookup.strategy"],"configDoc":"The strategy to use when loading entities during the execution of a search query.","withinAMap":true,"defaultValue":"skip","javaDocSiteLink":"","docMapKey":"strategy","configPhase":"RUN_TIME","acceptedValues":["`skip`","`persistence-context`","`persistence-context-then-second-level-cache`"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":true}},{"configDocKey":{"type":"int","key":"quarkus.hibernate-search-orm.query.loading.fetch-size","additionalKeys":["quarkus.hibernate-search-orm.\"persistence-unit-name\".query.loading.fetch-size"],"configDoc":"The fetch size to use when loading entities during the execution of a search query.","withinAMap":true,"defaultValue":"100","javaDocSiteLink":"","docMapKey":"fetch-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.hibernate-search-orm.indexing.plan.synchronization.strategy","additionalKeys":["quarkus.hibernate-search-orm.\"persistence-unit-name\".indexing.plan.synchronization.strategy"],"configDoc":"How to synchronize between application threads and indexing,\nin particular when relying on (implicit) listener-triggered indexing on entity change,\nbut also when using a `SearchIndexingPlan` explicitly.\n\nDefines how complete indexing should be before resuming the application thread\nafter a database transaction is committed.\n\n[WARNING]\n====\nIndexing synchronization is only relevant when coordination is disabled (which is the default).\n\nWith the xref:hibernate-search-orm-elasticsearch.adoc#coordination[`outbox-polling` coordination strategy],\nindexing happens in background threads and is always asynchronous;\nthe behavior is equivalent to the `write-sync` synchronization strategy.\n====\n\nAvailable values:\n\n[cols=5]\n!===\n.2+h!Strategy\n.2+h!Throughput\n3+^h!Guarantees when the application thread resumes\n\nh!Changes applied\nh!Changes safe from crash/power loss\nh!Changes visible on search\n\n!async\n!Best\n^!icon:times[role=red]\n^!icon:times[role=red]\n^!icon:times[role=red]\n\n!write-sync (**default**)\n!Medium\n^!icon:check[role=lime]\n^!icon:check[role=lime]\n^!icon:times[role=red]\n\n!read-sync\n!Medium to worst\n^!icon:check[role=lime]\n^!icon:times[role=red]\n^!icon:check[role=lime]\n\n!sync\n!Worst\n^!icon:check[role=lime]\n^!icon:check[role=lime]\n^!icon:check[role=lime]\n!===\n\nThis property also accepts a xref:hibernate-search-orm-elasticsearch.adoc#bean-reference-note-anchor[bean reference]\nto a custom implementations of `IndexingPlanSynchronizationStrategy`.\n\nSee\nlink:{hibernate-search-docs-url}#indexing-plan-synchronization[this section of the reference documentation]\nfor more information.\n\n[NOTE]\n====\nInstead of setting this configuration property,\nyou can simply annotate your custom `IndexingPlanSynchronizationStrategy` implementation with `@SearchExtension`\nand leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.\nIf this configuration property is set, it takes precedence over any `@SearchExtension` annotation.\n====","withinAMap":true,"defaultValue":"write-sync","javaDocSiteLink":"","docMapKey":"strategy","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.hibernate-search-orm.multi-tenancy.tenant-ids","additionalKeys":["quarkus.hibernate-search-orm.\"persistence-unit-name\".multi-tenancy.tenant-ids"],"configDoc":"An exhaustive list of all tenant identifiers that may be used by the application when multi-tenancy is enabled.\n\nMainly useful when using the {@code outbox-polling} coordination strategy,\nsince it involves setting up one background processor per tenant.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tenant-ids","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.hibernate-search-orm.active","additionalKeys":["quarkus.hibernate-search-orm.\"persistence-unit-name\".active"],"configDoc":"Whether Hibernate Search should be active for this persistence unit at runtime.\n\nIf Hibernate Search is not active, it won't index Hibernate ORM entities,\nand accessing the SearchMapping/SearchSession of the relevant persistence unit\nfor search or other operation will not be possible.\n\nNote that if Hibernate Search is disabled (i.e. `quarkus.hibernate-search-orm.enabled` is set to `false`),\nit won't be active for any persistence unit, and setting this property to `true` will fail.","withinAMap":true,"defaultValue":"'true' if Hibernate Search is enabled; 'false' otherwise","javaDocSiteLink":"","docMapKey":"active","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocSection":{"name":"quarkus.hibernate-search-orm.backends","optional":false,"withinAMap":true,"sectionDetails":"== Configuration for backends","sectionDetailsTitle":"Configuration for backends","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.hibernate-search-orm","configGroupType":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.ElasticsearchBackendRuntimeConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"string","key":"quarkus.hibernate-search-orm.elasticsearch.hosts","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".hosts","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".hosts","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.hosts"],"configDoc":"The list of hosts of the Elasticsearch servers.","withinAMap":true,"defaultValue":"localhost:9200","javaDocSiteLink":"","docMapKey":"hosts","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.ElasticsearchClientProtocol","key":"quarkus.hibernate-search-orm.elasticsearch.protocol","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".protocol","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".protocol","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.protocol"],"configDoc":"The protocol to use when contacting Elasticsearch servers. Set to \"https\" to enable SSL/TLS.","withinAMap":true,"defaultValue":"http","javaDocSiteLink":"","docMapKey":"protocol","configPhase":"RUN_TIME","acceptedValues":["`http`","`https`"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.hibernate-search-orm.elasticsearch.username","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".username","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".username","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.username"],"configDoc":"The username used for authentication.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.hibernate-search-orm.elasticsearch.password","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".password","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".password","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.password"],"configDoc":"The password used for authentication.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.hibernate-search-orm.elasticsearch.connection-timeout","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".connection-timeout","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".connection-timeout","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.connection-timeout"],"configDoc":"The timeout when establishing a connection to an Elasticsearch server.","withinAMap":true,"defaultValue":"1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"connection-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.hibernate-search-orm.elasticsearch.read-timeout","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".read-timeout","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".read-timeout","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.read-timeout"],"configDoc":"The timeout when reading responses from an Elasticsearch server.","withinAMap":true,"defaultValue":"30S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"read-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.hibernate-search-orm.elasticsearch.request-timeout","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".request-timeout","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".request-timeout","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.request-timeout"],"configDoc":"The timeout when executing a request to an Elasticsearch server.\n\nThis includes the time needed to wait for a connection to be available,\nsend the request and read the response.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"request-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.hibernate-search-orm.elasticsearch.max-connections","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".max-connections","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".max-connections","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.max-connections"],"configDoc":"The maximum number of connections to all the Elasticsearch servers.","withinAMap":true,"defaultValue":"20","javaDocSiteLink":"","docMapKey":"max-connections","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.hibernate-search-orm.elasticsearch.max-connections-per-route","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".max-connections-per-route","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".max-connections-per-route","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.max-connections-per-route"],"configDoc":"The maximum number of connections per Elasticsearch server.","withinAMap":true,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"max-connections-per-route","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.hibernate-search-orm.elasticsearch.discovery.enabled","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".discovery.enabled","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".discovery.enabled","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.discovery.enabled"],"configDoc":"Defines if automatic discovery is enabled.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.hibernate-search-orm.elasticsearch.discovery.refresh-interval","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".discovery.refresh-interval","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".discovery.refresh-interval","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.discovery.refresh-interval"],"configDoc":"Refresh interval of the node list.","withinAMap":true,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"refresh-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.hibernate-search-orm.elasticsearch.thread-pool.size","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".thread-pool.size","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".thread-pool.size","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.thread-pool.size"],"configDoc":"The size of the thread pool assigned to the backend.\n\nNote that number is **per backend**, not per index.\nAdding more indexes will not add more threads.\n\nAs all operations happening in this thread-pool are non-blocking,\nraising its size above the number of processor cores available to the JVM will not bring noticeable performance\nbenefit.\nThe only reason to alter this setting would be to reduce the number of threads;\nfor example, in an application with a single index with a single indexing queue,\nrunning on a machine with 64 processor cores,\nyou might want to bring down the number of threads.\n\nDefaults to the number of processor cores available to the JVM on startup.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.hibernate-search-orm.elasticsearch.query.shard-failure.ignore","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".query.shard-failure.ignore","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".query.shard-failure.ignore","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.query.shard-failure.ignore"],"configDoc":"Whether partial shard failures are ignored (`true`) or lead to Hibernate Search throwing an exception (`false`).","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"ignore","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.hibernate-search-orm.elasticsearch.version-check.enabled","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".version-check.enabled","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".version-check.enabled","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.version-check.enabled"],"configDoc":"Whether Hibernate Search should check the version of the Elasticsearch cluster on startup.\n\nSet to `false` if the Elasticsearch cluster may not be available on startup.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"org.hibernate.search.backend.elasticsearch.index.IndexStatus","key":"quarkus.hibernate-search-orm.elasticsearch.schema-management.required-status","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".schema-management.required-status","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".schema-management.required-status","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.schema-management.required-status"],"configDoc":"The minimal https://www.elastic.co/guide/en/elasticsearch/reference/7.17/cluster-health.html[Elasticsearch cluster\nstatus] required on startup.","withinAMap":true,"defaultValue":"yellow","javaDocSiteLink":"","docMapKey":"required-status","configPhase":"RUN_TIME","acceptedValues":["`green`","`yellow`","`red`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":true}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.hibernate-search-orm.elasticsearch.schema-management.required-status-wait-timeout","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".schema-management.required-status-wait-timeout","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".schema-management.required-status-wait-timeout","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.schema-management.required-status-wait-timeout"],"configDoc":"How long we should wait for the status before failing the bootstrap.","withinAMap":true,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"required-status-wait-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.hibernate-search-orm.elasticsearch.indexing.queue-count","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".indexing.queue-count","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".indexing.queue-count","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.indexing.queue-count"],"configDoc":"The number of indexing queues assigned to each index.\n\nHigher values will lead to more connections being used in parallel,\nwhich may lead to higher indexing throughput,\nbut incurs a risk of overloading Elasticsearch,\ni.e. of overflowing its HTTP request buffers and tripping\nhttps://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[circuit breakers],\nleading to Elasticsearch giving up on some request and resulting in indexing failures.","withinAMap":true,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"queue-count","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.hibernate-search-orm.elasticsearch.indexing.queue-size","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".indexing.queue-size","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".indexing.queue-size","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.indexing.queue-size"],"configDoc":"The size of indexing queues.\n\nLower values may lead to lower memory usage, especially if there are many queues,\nbut values that are too low will reduce the likeliness of reaching the max bulk size\nand increase the likeliness of application threads blocking because the queue is full,\nwhich may lead to lower indexing throughput.","withinAMap":true,"defaultValue":"1000","javaDocSiteLink":"","docMapKey":"queue-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.hibernate-search-orm.elasticsearch.indexing.max-bulk-size","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".indexing.max-bulk-size","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".indexing.max-bulk-size","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.indexing.max-bulk-size"],"configDoc":"The maximum size of bulk requests created when processing indexing queues.\n\nHigher values will lead to more documents being sent in each HTTP request sent to Elasticsearch,\nwhich may lead to higher indexing throughput,\nbut incurs a risk of overloading Elasticsearch,\ni.e. of overflowing its HTTP request buffers and tripping\nhttps://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[circuit breakers],\nleading to Elasticsearch giving up on some request and resulting in indexing failures.\n\nNote that raising this number above the queue size has no effect,\nas bulks cannot include more requests than are contained in the queue.","withinAMap":true,"defaultValue":"100","javaDocSiteLink":"","docMapKey":"max-bulk-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocSection":{"name":"quarkus.hibernate-search-orm.elasticsearch.indexes","optional":false,"withinAMap":true,"sectionDetails":"== Per-index configuration overrides","sectionDetailsTitle":"Per-index configuration overrides","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.hibernate-search-orm","configGroupType":"io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.ElasticsearchIndexRuntimeConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"org.hibernate.search.backend.elasticsearch.index.IndexStatus","key":"quarkus.hibernate-search-orm.elasticsearch.indexes.\"index-name\".schema-management.required-status","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".indexes.\"index-name\".schema-management.required-status","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".indexes.\"index-name\".schema-management.required-status","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.indexes.\"index-name\".schema-management.required-status"],"configDoc":"The minimal https://www.elastic.co/guide/en/elasticsearch/reference/7.17/cluster-health.html[Elasticsearch cluster\nstatus] required on startup.","withinAMap":true,"defaultValue":"yellow","javaDocSiteLink":"","docMapKey":"required-status","configPhase":"RUN_TIME","acceptedValues":["`green`","`yellow`","`red`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":true}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.hibernate-search-orm.elasticsearch.indexes.\"index-name\".schema-management.required-status-wait-timeout","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".indexes.\"index-name\".schema-management.required-status-wait-timeout","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".indexes.\"index-name\".schema-management.required-status-wait-timeout","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.indexes.\"index-name\".schema-management.required-status-wait-timeout"],"configDoc":"How long we should wait for the status before failing the bootstrap.","withinAMap":true,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"required-status-wait-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.hibernate-search-orm.elasticsearch.indexes.\"index-name\".indexing.queue-count","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".indexes.\"index-name\".indexing.queue-count","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".indexes.\"index-name\".indexing.queue-count","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.indexes.\"index-name\".indexing.queue-count"],"configDoc":"The number of indexing queues assigned to each index.\n\nHigher values will lead to more connections being used in parallel,\nwhich may lead to higher indexing throughput,\nbut incurs a risk of overloading Elasticsearch,\ni.e. of overflowing its HTTP request buffers and tripping\nhttps://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[circuit breakers],\nleading to Elasticsearch giving up on some request and resulting in indexing failures.","withinAMap":true,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"queue-count","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.hibernate-search-orm.elasticsearch.indexes.\"index-name\".indexing.queue-size","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".indexes.\"index-name\".indexing.queue-size","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".indexes.\"index-name\".indexing.queue-size","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.indexes.\"index-name\".indexing.queue-size"],"configDoc":"The size of indexing queues.\n\nLower values may lead to lower memory usage, especially if there are many queues,\nbut values that are too low will reduce the likeliness of reaching the max bulk size\nand increase the likeliness of application threads blocking because the queue is full,\nwhich may lead to lower indexing throughput.","withinAMap":true,"defaultValue":"1000","javaDocSiteLink":"","docMapKey":"queue-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.hibernate-search-orm.elasticsearch.indexes.\"index-name\".indexing.max-bulk-size","additionalKeys":["quarkus.hibernate-search-orm.elasticsearch.\"backend-name\".indexes.\"index-name\".indexing.max-bulk-size","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.\"backend-name\".indexes.\"index-name\".indexing.max-bulk-size","quarkus.hibernate-search-orm.\"persistence-unit-name\".elasticsearch.indexes.\"index-name\".indexing.max-bulk-size"],"configDoc":"The maximum size of bulk requests created when processing indexing queues.\n\nHigher values will lead to more documents being sent in each HTTP request sent to Elasticsearch,\nwhich may lead to higher indexing throughput,\nbut incurs a risk of overloading Elasticsearch,\ni.e. of overflowing its HTTP request buffers and tripping\nhttps://www.elastic.co/guide/en/elasticsearch/reference/7.9/circuit-breaker.html[circuit breakers],\nleading to Elasticsearch giving up on some request and resulting in indexing failures.\n\nNote that raising this number above the queue size has no effect,\nas bulks cannot include more requests than are contained in the queue.","withinAMap":true,"defaultValue":"100","javaDocSiteLink":"","docMapKey":"max-bulk-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}}],"anchorPrefix":null}}],"anchorPrefix":null}},{"configDocKey":{"type":"org.hibernate.search.mapper.orm.schema.management.SchemaManagementStrategyName","key":"quarkus.hibernate-search-orm.schema-management.strategy","additionalKeys":["quarkus.hibernate-search-orm.\"persistence-unit-name\".schema-management.strategy"],"configDoc":"The schema management strategy, controlling how indexes and their schema\nare created, updated, validated or dropped on startup and shutdown.\n\nAvailable values:\n\n[cols=2]\n!===\nh!Strategy\nh!Definition\n\n!none\n!Do nothing: assume that indexes already exist and that their schema matches Hibernate Search's expectations.\n\n!validate\n!Validate that indexes exist and that their schema matches Hibernate Search's expectations.\n\nIf it does not, throw an exception, but make no attempt to fix the problem.\n\n!create\n!For indexes that do not exist, create them along with their schema.\n\nFor indexes that already exist, do nothing: assume that their schema matches Hibernate Search's expectations.\n\n!create-or-validate (**default** unless using Dev Services)\n!For indexes that do not exist, create them along with their schema.\n\nFor indexes that already exist, validate that their schema matches Hibernate Search's expectations.\n\nIf it does not, throw an exception, but make no attempt to fix the problem.\n\n!create-or-update\n!For indexes that do not exist, create them along with their schema.\n\nFor indexes that already exist, validate that their schema matches Hibernate Search's expectations;\nif it does not match expectations, try to update it.\n\n**This strategy is unfit for production environments**,\ndue to several important limitations,\nbut can be useful when developing.\n\n!drop-and-create\n!For indexes that do not exist, create them along with their schema.\n\nFor indexes that already exist, drop them, then create them along with their schema.\n\n!drop-and-create-and-drop (**default** when using Dev Services)\n!For indexes that do not exist, create them along with their schema.\n\nFor indexes that already exist, drop them, then create them along with their schema.\n\nAlso, drop indexes and their schema on shutdown.\n!===\n\nSee https://docs.jboss.org/hibernate/stable/search/reference/en-US/html_single/#mapper-orm-schema-management-strategy[this section of the reference documentation]\nfor more information.","withinAMap":true,"defaultValue":"drop-and-create-and-drop when using Dev Services; create-or-validate otherwise","javaDocSiteLink":"","docMapKey":"strategy","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"org.hibernate.search.mapper.orm.search.loading.EntityLoadingCacheLookupStrategy","key":"quarkus.hibernate-search-orm.query.loading.cache-lookup.strategy","additionalKeys":["quarkus.hibernate-search-orm.\"persistence-unit-name\".query.loading.cache-lookup.strategy"],"configDoc":"The strategy to use when loading entities during the execution of a search query.","withinAMap":true,"defaultValue":"skip","javaDocSiteLink":"","docMapKey":"strategy","configPhase":"RUN_TIME","acceptedValues":["`skip`","`persistence-context`","`persistence-context-then-second-level-cache`"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":true}},{"configDocKey":{"type":"int","key":"quarkus.hibernate-search-orm.query.loading.fetch-size","additionalKeys":["quarkus.hibernate-search-orm.\"persistence-unit-name\".query.loading.fetch-size"],"configDoc":"The fetch size to use when loading entities during the execution of a search query.","withinAMap":true,"defaultValue":"100","javaDocSiteLink":"","docMapKey":"fetch-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.hibernate-search-orm.indexing.plan.synchronization.strategy","additionalKeys":["quarkus.hibernate-search-orm.\"persistence-unit-name\".indexing.plan.synchronization.strategy"],"configDoc":"How to synchronize between application threads and indexing,\nin particular when relying on (implicit) listener-triggered indexing on entity change,\nbut also when using a `SearchIndexingPlan` explicitly.\n\nDefines how complete indexing should be before resuming the application thread\nafter a database transaction is committed.\n\n[WARNING]\n====\nIndexing synchronization is only relevant when coordination is disabled (which is the default).\n\nWith the xref:hibernate-search-orm-elasticsearch.adoc#coordination[`outbox-polling` coordination strategy],\nindexing happens in background threads and is always asynchronous;\nthe behavior is equivalent to the `write-sync` synchronization strategy.\n====\n\nAvailable values:\n\n[cols=5]\n!===\n.2+h!Strategy\n.2+h!Throughput\n3+^h!Guarantees when the application thread resumes\n\nh!Changes applied\nh!Changes safe from crash/power loss\nh!Changes visible on search\n\n!async\n!Best\n^!icon:times[role=red]\n^!icon:times[role=red]\n^!icon:times[role=red]\n\n!write-sync (**default**)\n!Medium\n^!icon:check[role=lime]\n^!icon:check[role=lime]\n^!icon:times[role=red]\n\n!read-sync\n!Medium to worst\n^!icon:check[role=lime]\n^!icon:times[role=red]\n^!icon:check[role=lime]\n\n!sync\n!Worst\n^!icon:check[role=lime]\n^!icon:check[role=lime]\n^!icon:check[role=lime]\n!===\n\nThis property also accepts a xref:hibernate-search-orm-elasticsearch.adoc#bean-reference-note-anchor[bean reference]\nto a custom implementations of `IndexingPlanSynchronizationStrategy`.\n\nSee\nlink:{hibernate-search-docs-url}#indexing-plan-synchronization[this section of the reference documentation]\nfor more information.\n\n[NOTE]\n====\nInstead of setting this configuration property,\nyou can simply annotate your custom `IndexingPlanSynchronizationStrategy` implementation with `@SearchExtension`\nand leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.\nIf this configuration property is set, it takes precedence over any `@SearchExtension` annotation.\n====","withinAMap":true,"defaultValue":"write-sync","javaDocSiteLink":"","docMapKey":"strategy","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.hibernate-search-orm.multi-tenancy.tenant-ids","additionalKeys":["quarkus.hibernate-search-orm.\"persistence-unit-name\".multi-tenancy.tenant-ids"],"configDoc":"An exhaustive list of all tenant identifiers that may be used by the application when multi-tenancy is enabled.\n\nMainly useful when using the {@code outbox-polling} coordination strategy,\nsince it involves setting up one background processor per tenant.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tenant-ids","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.hibernate-search-orm","enum":false}}] \ No newline at end of file