HSEARCH-3879 Add pointers to the reference documentation for thread/i…

…ndexing settings constants
hibernate · Apr 3, 2020 · 49efc18 · 49efc18
1 parent 33365e0
commit 49efc18
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 0 deletions.
diff --git a/...ain/java/org/hibernate/search/backend/elasticsearch/cfg/ElasticsearchBackendSettings.java b/...ain/java/org/hibernate/search/backend/elasticsearch/cfg/ElasticsearchBackendSettings.java
@@ -233,6 +233,9 @@ private ElasticsearchBackendSettings() {
 	 * or a string that can be parsed to such integer value.
 	 * <p>
 	 * Defaults to the number of processor cores available to the JVM on startup.
+	 * <p>
+	 * See the reference documentation, section "Elasticsearch backend - Threads",
+	 * for more information about this setting and its implications.
 	 */
 	public static final String THREAD_POOL_SIZE = "thread_pool.size";
 

diff --git a/.../main/java/org/hibernate/search/backend/elasticsearch/cfg/ElasticsearchIndexSettings.java b/.../main/java/org/hibernate/search/backend/elasticsearch/cfg/ElasticsearchIndexSettings.java
@@ -50,6 +50,9 @@ private ElasticsearchIndexSettings() {
 	 * or a string that can be parsed to such integer value.
 	 * <p>
 	 * Defaults to {@link Defaults#INDEXING_QUEUE_COUNT}.
+	 * <p>
+	 * See the reference documentation, section "Elasticsearch backend - Indexing",
+	 * for more information about this setting and its implications.
 	 */
 	public static final String INDEXING_QUEUE_COUNT = INDEXING_PREFIX + IndexingRadicals.QUEUE_COUNT;
 
@@ -60,6 +63,9 @@ private ElasticsearchIndexSettings() {
 	 * or a string that can be parsed to such integer value.
 	 * <p>
 	 * Defaults to {@link Defaults#INDEXING_QUEUE_SIZE}.
+	 * <p>
+	 * See the reference documentation, section "Elasticsearch backend - Indexing",
+	 * for more information about this setting and its implications.
 	 */
 	public static final String INDEXING_QUEUE_SIZE = INDEXING_PREFIX + IndexingRadicals.QUEUE_SIZE;
 
@@ -70,6 +76,9 @@ private ElasticsearchIndexSettings() {
 	 * or a string that can be parsed to such integer value.
 	 * <p>
 	 * Defaults to {@link Defaults#INDEXING_MAX_BULK_SIZE}.
+	 * <p>
+	 * See the reference documentation, section "Elasticsearch backend - Indexing",
+	 * for more information about this setting and its implications.
 	 */
 	public static final String INDEXING_MAX_BULK_SIZE = INDEXING_PREFIX + IndexingRadicals.MAX_BULK_SIZE;
 

diff --git a/...d/lucene/src/main/java/org/hibernate/search/backend/lucene/cfg/LuceneBackendSettings.java b/...d/lucene/src/main/java/org/hibernate/search/backend/lucene/cfg/LuceneBackendSettings.java
@@ -121,6 +121,9 @@ private LuceneBackendSettings() {
 	 * or a string that can be parsed to such integer value.
 	 * <p>
 	 * Defaults to the number of processor cores available to the JVM on startup.
+	 * <p>
+	 * See the reference documentation, section "Lucene backend - Threads",
+	 * for more information about this setting and its implications.
 	 */
 	public static final String THREAD_POOL_SIZE = "thread_pool.size";
 

diff --git a/...end/lucene/src/main/java/org/hibernate/search/backend/lucene/cfg/LuceneIndexSettings.java b/...end/lucene/src/main/java/org/hibernate/search/backend/lucene/cfg/LuceneIndexSettings.java
@@ -139,6 +139,9 @@ private LuceneIndexSettings() {
 	 * or a string that can be parsed to such integer value.
 	 * <p>
 	 * Defaults to {@link Defaults#INDEXING_QUEUE_COUNT}.
+	 * <p>
+	 * See the reference documentation, section "Lucene backend - Indexing",
+	 * for more information about this setting and its implications.
 	 */
 	public static final String INDEXING_QUEUE_COUNT = INDEXING_PREFIX + IndexingRadicals.QUEUE_COUNT;
 
@@ -149,6 +152,9 @@ private LuceneIndexSettings() {
 	 * or a string that can be parsed to such integer value.
 	 * <p>
 	 * Defaults to {@link Defaults#INDEXING_QUEUE_SIZE}.
+	 * <p>
+	 * See the reference documentation, section "Lucene backend - Indexing",
+	 * for more information about this setting and its implications.
 	 */
 	public static final String INDEXING_QUEUE_SIZE = INDEXING_PREFIX + IndexingRadicals.QUEUE_SIZE;