Add comment explaining slice <-> shard assignment

Signed-off-by: Michael Froh <[email protected]>
opensearch-project · Dec 17, 2024 · c7abf62 · c7abf62
1 parent eadaabd
commit c7abf62
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/server/src/main/java/org/opensearch/cluster/routing/OperationRouting.java b/server/src/main/java/org/opensearch/cluster/routing/OperationRouting.java
@@ -289,6 +289,12 @@ public GroupShardsIterator<ShardIterator> searchShards(
             if (slice != null) {
                 // Filter the returned shards for the given slice
                 CollectionUtil.timSort(indexIterators);
+                // We use the ordinal of the iterator in the group (after sorting) rather than the shard id, because
+                // computeTargetedShards may return a subset of shards for an index, if a routing parameter was
+                // specified. In that case, the set of routable shards is considered the full universe of available
+                // shards for each index, when mapping shards to slices. If no routing parameter was specified,
+                // then ordinals and shard IDs are the same. This mimics the logic in
+                // org.opensearch.search.slice.SliceBuilder.toFilter.
                 for (int i = 0; i < indexIterators.size(); i++) {
                     if (slice.shardMatches(i, indexIterators.size())) {
                         allShardIterators.add(indexIterators.get(i));