HSEARCH-4389 Remove mentions of "shards.static" in the documentation …

…of the outbox-polling coordination strategy
hibernate · Jan 3, 2022 · 8b6a1fc · 8b6a1fc
1 parent 3272e7b
commit 8b6a1fc
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 11 deletions.
diff --git a/documentation/src/main/asciidoc/reference/coordination.asciidoc b/documentation/src/main/asciidoc/reference/coordination.asciidoc
@@ -425,21 +425,20 @@ by setting the following configuration properties:
 
 [source]
 ----
-hibernate.search.coordination.event_processor.shards.static = true
 hibernate.search.coordination.event_processor.shards.total_count = 4
 hibernate.search.coordination.event_processor.shards.assigned = 0
 ----
 
-* `shards.static` defines sharding as static.
-It defaults to `false` and must be set to `true` explicitly in order for
-the other configuration properties to be taken into account.
 * `shards.total_count` defines the total number of shards
 as an <<configuration-property-types,integer value>>.
-This property has no default and must be set explicitly when static sharding is enabled.
+This property has no default and must be set explicitly if you want static sharding.
 It must be set to the same value on all application nodes with assigned shards.
+When this property is set, `shards.assigned` must also be set
 * `shards.assigned` defines the shards assigned to the application node
 as an <<configuration-property-types,integer value>>, or multiple comma-separated integer values.
-This property has no default and must be set explicitly when static sharding is enabled.
+This property has no default and must be set explicitly if you want static sharding.
+When this property is set, `shards.total_count` must also be set.
++
 Shards are referred to by an index in the range `[0, total_count - 1]` (see above for `total_count`).
 A given application node must be assigned at least one shard
 but may be assigned multiple shards by setting `shards.assigned` to a comma-separated list,
@@ -462,7 +461,6 @@ and no shard at all to application nodes #2 and #3:
 ----
 # Node #0
 hibernate.search.coordination.strategy = outbox-polling
-hibernate.search.coordination.event_processor.shards.static = true
 hibernate.search.coordination.event_processor.shards.total_count = 2
 hibernate.search.coordination.event_processor.shards.assigned = 0
 ----
@@ -471,7 +469,6 @@ hibernate.search.coordination.event_processor.shards.assigned = 0
 ----
 # Node #1
 hibernate.search.coordination.strategy = outbox-polling
-hibernate.search.coordination.event_processor.shards.static = true
 hibernate.search.coordination.event_processor.shards.total_count = 2
 hibernate.search.coordination.event_processor.shards.assigned = 1
 ----

diff --git a/...ch/mapper/orm/coordination/outboxpolling/cfg/HibernateOrmMapperOutboxPollingSettings.java b/...ch/mapper/orm/coordination/outboxpolling/cfg/HibernateOrmMapperOutboxPollingSettings.java
@@ -78,7 +78,7 @@ private HibernateOrmMapperOutboxPollingSettings() {
 	 * Expects an Integer value of at least {@code 2},
 	 * or a String that can be parsed into such Integer value.
 	 * <p>
-	 * No default: must be provided when static sharding is enabled.
+	 * No default: must be provided explicitly if you want static sharding.
 	 */
 	public static final String COORDINATION_EVENT_PROCESSOR_SHARDS_TOTAL_COUNT = PREFIX + Radicals.COORDINATION_EVENT_PROCESSOR_SHARDS_TOTAL_COUNT;
 
@@ -89,7 +89,7 @@ private HibernateOrmMapperOutboxPollingSettings() {
 	 * Failing that, some events may not be processed or may be processed twice or in the wrong order,
 	 * resulting in errors and/or out-of-sync indexes.
 	 * <p>
-	 * Only available when {@link HibernateOrmMapperSettings#AUTOMATIC_INDEXING_STRATEGY} is
+	 * Only available when {@link HibernateOrmMapperSettings#COORDINATION_STRATEGY} is
 	 * {@value #COORDINATION_STRATEGY_NAME}.
 	 * <p>
 	 * When this property is set, {@value #COORDINATION_EVENT_PROCESSOR_SHARDS_TOTAL_COUNT} must also be set.
@@ -100,7 +100,7 @@ private HibernateOrmMapperOutboxPollingSettings() {
 	 * or a String containing multiple such shard index strings separated by commas,
 	 * or a {@code Collection<Integer>} containing such shard indices.
 	 * <p>
-	 * No default: must be provided when static sharding is enabled.
+	 * No default: must be provided explicitly if you want static sharding.
 	 */
 	public static final String COORDINATION_EVENT_PROCESSOR_SHARDS_ASSIGNED = PREFIX + Radicals.COORDINATION_EVENT_PROCESSOR_SHARDS_ASSIGNED;