github-mirrors/elasticsearch
1
0
Fork 0
mirror of https://github.com/elastic/elasticsearch.git synced 2025-04-25 07:37:19 -04:00
Code Issues Projects Releases Packages Wiki Activity

Rename TopDocsCollectorContext to TopDocsCollectorFactory (#95435)

Browse source 
This is to complete the removal of the query collector context
abstraction implemented with #95383. The remaining
TopDocsCollectorContext is more of a factory than a context object.
This commit renames the class and all of its subclasses. It also adds
javadocs to its methods to clarify the contract around them.
This commit is contained in:
Luca Cavanna 2023-04-21 10:00:27 +02:00 • committed by GitHub
parent 02cbdb263e
commit 8e15a1a7ad
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 34 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

4
server/src/main/java/org/elasticsearch/search/query/QueryPhase.java
View file

@ -53,7 +53,7 @@ import static org.elasticsearch.search.profile.query.CollectorResult.REASON_SEAR
import static org.elasticsearch.search.profile.query.CollectorResult.REASON_SEARCH_MULTI; import static org.elasticsearch.search.profile.query.CollectorResult.REASON_SEARCH_MULTI;
import static org.elasticsearch.search.profile.query.CollectorResult.REASON_SEARCH_POST_FILTER; import static org.elasticsearch.search.profile.query.CollectorResult.REASON_SEARCH_POST_FILTER;
import static org.elasticsearch.search.profile.query.CollectorResult.REASON_SEARCH_TERMINATE_AFTER_COUNT; import static org.elasticsearch.search.profile.query.CollectorResult.REASON_SEARCH_TERMINATE_AFTER_COUNT;
import static org.elasticsearch.search.query.TopDocsCollectorContext.createTopDocsCollectorContext; import static org.elasticsearch.search.query.TopDocsCollectorFactory.createTopDocsCollectorFactory;
/** /**
* Query phase of a search request, used to run the query and get back from each shard information about the matching documents * Query phase of a search request, used to run the query and get back from each shard information about the matching documents
@ -132,7 +132,7 @@ public class QueryPhase {
} }
// create the top docs collector last when the other collectors are known // create the top docs collector last when the other collectors are known
final TopDocsCollectorContext topDocsFactory = createTopDocsCollectorContext( final TopDocsCollectorFactory topDocsFactory = createTopDocsCollectorFactory(
searchContext, searchContext,
searchContext.parsedPostFilter() != null || searchContext.minimumScore() != null searchContext.parsedPostFilter() != null || searchContext.minimumScore() != null
); );

42
server/src/main/java/org/elasticsearch/search/query/TopDocsCollectorContext.java → server/src/main/java/org/elasticsearch/search/query/TopDocsCollectorFactory.java
View file

@ -65,21 +65,29 @@ import static org.elasticsearch.search.profile.query.CollectorResult.REASON_SEAR
/** /**
* Creates and holds the main {@link Collector} that will be used to search and collect top hits. * Creates and holds the main {@link Collector} that will be used to search and collect top hits.
* Once the returned collector has been used to collect hits, allows to enrich the collected top docs to be set to the search context.
*/ */
abstract class TopDocsCollectorContext { abstract class TopDocsCollectorFactory {
final String profilerName; final String profilerName;
final DocValueFormat[] sortValueFormats; final DocValueFormat[] sortValueFormats;
TopDocsCollectorContext(String profilerName, DocValueFormat[] sortValueFormats) { TopDocsCollectorFactory(String profilerName, DocValueFormat[] sortValueFormats) {
this.profilerName = profilerName; this.profilerName = profilerName;
this.sortValueFormats = sortValueFormats; this.sortValueFormats = sortValueFormats;
} }
/**
* Returns the collector used to collect top hits, created depending on the incoming request options
*/
abstract Collector collector(); abstract Collector collector();
/**
* Returns the collected top docs to be set to the {@link QuerySearchResult} within the search context.
* To be called after collection, to enrich the top docs and wrap them with our {@link TopDocsAndMaxScore}.
*/
abstract TopDocsAndMaxScore topDocsAndMaxScore() throws IOException; abstract TopDocsAndMaxScore topDocsAndMaxScore() throws IOException;
static class EmptyTopDocsCollectorContext extends TopDocsCollectorContext { static class EmptyTopDocsCollectorFactory extends TopDocsCollectorFactory {
private final Sort sort; private final Sort sort;
private final Collector collector; private final Collector collector;
private final Supplier<TotalHits> hitCountSupplier; private final Supplier<TotalHits> hitCountSupplier;
@ -89,7 +97,7 @@ abstract class TopDocsCollectorContext {
* @param sortAndFormats The sort clause if provided * @param sortAndFormats The sort clause if provided
* @param trackTotalHitsUpTo The threshold up to which total hit count needs to be tracked * @param trackTotalHitsUpTo The threshold up to which total hit count needs to be tracked
*/ */
private EmptyTopDocsCollectorContext(@Nullable SortAndFormats sortAndFormats, int trackTotalHitsUpTo) { private EmptyTopDocsCollectorFactory(@Nullable SortAndFormats sortAndFormats, int trackTotalHitsUpTo) {
super(REASON_SEARCH_COUNT, null); super(REASON_SEARCH_COUNT, null);
this.sort = sortAndFormats == null ? null : sortAndFormats.sort; this.sort = sortAndFormats == null ? null : sortAndFormats.sort;
if (trackTotalHitsUpTo == SearchContext.TRACK_TOTAL_HITS_DISABLED) { if (trackTotalHitsUpTo == SearchContext.TRACK_TOTAL_HITS_DISABLED) {
@ -130,7 +138,7 @@ abstract class TopDocsCollectorContext {
} }
} }
static class CollapsingTopDocsCollectorContext extends TopDocsCollectorContext { static class CollapsingTopDocsCollectorFactory extends TopDocsCollectorFactory {
private final SinglePassGroupingCollector<?> topDocsCollector; private final SinglePassGroupingCollector<?> topDocsCollector;
private final Supplier<Float> maxScoreSupplier; private final Supplier<Float> maxScoreSupplier;
@ -141,7 +149,7 @@ abstract class TopDocsCollectorContext {
* @param numHits The number of collapsed top hits to retrieve. * @param numHits The number of collapsed top hits to retrieve.
* @param trackMaxScore True if max score should be tracked * @param trackMaxScore True if max score should be tracked
*/ */
private CollapsingTopDocsCollectorContext( private CollapsingTopDocsCollectorFactory(
CollapseContext collapseContext, CollapseContext collapseContext,
@Nullable SortAndFormats sortAndFormats, @Nullable SortAndFormats sortAndFormats,
int numHits, int numHits,
@ -175,7 +183,7 @@ abstract class TopDocsCollectorContext {
} }
} }
static class SimpleTopDocsCollectorContext extends TopDocsCollectorContext { static class SimpleTopDocsCollectorFactory extends TopDocsCollectorFactory {
private static TopDocsCollector<?> createCollector( private static TopDocsCollector<?> createCollector(
@Nullable SortAndFormats sortAndFormats, @Nullable SortAndFormats sortAndFormats,
@ -207,7 +215,7 @@ abstract class TopDocsCollectorContext {
* @param trackTotalHitsUpTo Threshold up to which total hit count should be tracked * @param trackTotalHitsUpTo Threshold up to which total hit count should be tracked
* @param hasFilterCollector True if the collector chain contains at least one collector that can filter documents out * @param hasFilterCollector True if the collector chain contains at least one collector that can filter documents out
*/ */
private SimpleTopDocsCollectorContext( private SimpleTopDocsCollectorFactory(
IndexReader reader, IndexReader reader,
Query query, Query query,
@Nullable SortAndFormats sortAndFormats, @Nullable SortAndFormats sortAndFormats,
@ -289,11 +297,11 @@ abstract class TopDocsCollectorContext {
} }
} }
static class ScrollingTopDocsCollectorContext extends SimpleTopDocsCollectorContext { static class ScrollingTopDocsCollectorFactory extends SimpleTopDocsCollectorFactory {
private final ScrollContext scrollContext; private final ScrollContext scrollContext;
private final int numberOfShards; private final int numberOfShards;
private ScrollingTopDocsCollectorContext( private ScrollingTopDocsCollectorFactory(
IndexReader reader, IndexReader reader,
Query query, Query query,
ScrollContext scrollContext, ScrollContext scrollContext,
@ -403,10 +411,10 @@ abstract class TopDocsCollectorContext {
} }
/** /**
* Creates a {@link TopDocsCollectorContext} from the provided <code>searchContext</code>. * Creates a {@link TopDocsCollectorFactory} from the provided <code>searchContext</code>.
* @param hasFilterCollector True if the collector chain contains at least one collector that can filters document. * @param hasFilterCollector True if the collector chain contains at least one collector that can filters document.
*/ */
static TopDocsCollectorContext createTopDocsCollectorContext(SearchContext searchContext, boolean hasFilterCollector) static TopDocsCollectorFactory createTopDocsCollectorFactory(SearchContext searchContext, boolean hasFilterCollector)
throws IOException { throws IOException {
final IndexReader reader = searchContext.searcher().getIndexReader(); final IndexReader reader = searchContext.searcher().getIndexReader();
final Query query = searchContext.rewrittenQuery(); final Query query = searchContext.rewrittenQuery();
@ -414,7 +422,7 @@ abstract class TopDocsCollectorContext {
final int totalNumDocs = Math.max(1, reader.numDocs()); final int totalNumDocs = Math.max(1, reader.numDocs());
if (searchContext.size() == 0) { if (searchContext.size() == 0) {
// no matter what the value of from is // no matter what the value of from is
return new EmptyTopDocsCollectorContext(searchContext.sort(), searchContext.trackTotalHitsUpTo()); return new EmptyTopDocsCollectorFactory(searchContext.sort(), searchContext.trackTotalHitsUpTo());
} else if (searchContext.scrollContext() != null) { } else if (searchContext.scrollContext() != null) {
// we can disable the tracking of total hits after the initial scroll query // we can disable the tracking of total hits after the initial scroll query
// since the total hits is preserved in the scroll context. // since the total hits is preserved in the scroll context.
@ -423,7 +431,7 @@ abstract class TopDocsCollectorContext {
: SearchContext.TRACK_TOTAL_HITS_ACCURATE; : SearchContext.TRACK_TOTAL_HITS_ACCURATE;
// no matter what the value of from is // no matter what the value of from is
int numDocs = Math.min(searchContext.size(), totalNumDocs); int numDocs = Math.min(searchContext.size(), totalNumDocs);
return new ScrollingTopDocsCollectorContext( return new ScrollingTopDocsCollectorFactory(
reader, reader,
query, query,
searchContext.scrollContext(), searchContext.scrollContext(),
@ -435,9 +443,9 @@ abstract class TopDocsCollectorContext {
hasFilterCollector hasFilterCollector
); );
} else if (searchContext.collapse() != null) { } else if (searchContext.collapse() != null) {
boolean trackScores = searchContext.sort() == null ? true : searchContext.trackScores(); boolean trackScores = searchContext.sort() == null || searchContext.trackScores();
int numDocs = Math.min(searchContext.from() + searchContext.size(), totalNumDocs); int numDocs = Math.min(searchContext.from() + searchContext.size(), totalNumDocs);
return new CollapsingTopDocsCollectorContext( return new CollapsingTopDocsCollectorFactory(
searchContext.collapse(), searchContext.collapse(),
searchContext.sort(), searchContext.sort(),
numDocs, numDocs,
@ -453,7 +461,7 @@ abstract class TopDocsCollectorContext {
numDocs = Math.max(numDocs, rescoreContext.getWindowSize()); numDocs = Math.max(numDocs, rescoreContext.getWindowSize());
} }
} }
return new SimpleTopDocsCollectorContext( return new SimpleTopDocsCollectorFactory(
reader, reader,
query, query,
searchContext.sort(), searchContext.sort(),

6
server/src/test/java/org/elasticsearch/search/query/QueryPhaseTests.java
View file

@ -83,7 +83,7 @@ import java.util.Collections;
import java.util.List; import java.util.List;
import java.util.function.IntUnaryOperator; import java.util.function.IntUnaryOperator;
import static org.elasticsearch.search.query.TopDocsCollectorContext.hasInfMaxScore; import static org.elasticsearch.search.query.TopDocsCollectorFactory.hasInfMaxScore;
import static org.hamcrest.Matchers.anyOf; import static org.hamcrest.Matchers.anyOf;
import static org.hamcrest.Matchers.arrayWithSize; import static org.hamcrest.Matchers.arrayWithSize;
import static org.hamcrest.Matchers.equalTo; import static org.hamcrest.Matchers.equalTo;
@ -679,7 +679,7 @@ public class QueryPhaseTests extends IndexShardTestCase {
context.parsedQuery(new ParsedQuery(q)); context.parsedQuery(new ParsedQuery(q));
context.setSize(3); context.setSize(3);
context.trackTotalHitsUpTo(3); context.trackTotalHitsUpTo(3);
TopDocsCollectorContext topDocsContext = TopDocsCollectorContext.createTopDocsCollectorContext(context, false); TopDocsCollectorFactory topDocsContext = TopDocsCollectorFactory.createTopDocsCollectorFactory(context, false);
assertEquals(topDocsContext.collector().scoreMode(), org.apache.lucene.search.ScoreMode.COMPLETE); assertEquals(topDocsContext.collector().scoreMode(), org.apache.lucene.search.ScoreMode.COMPLETE);
QueryPhase.executeInternal(context); QueryPhase.executeInternal(context);
assertEquals(5, context.queryResult().topDocs().topDocs.totalHits.value); assertEquals(5, context.queryResult().topDocs().topDocs.totalHits.value);
@ -687,7 +687,7 @@ public class QueryPhaseTests extends IndexShardTestCase {
assertThat(context.queryResult().topDocs().topDocs.scoreDocs.length, equalTo(3)); assertThat(context.queryResult().topDocs().topDocs.scoreDocs.length, equalTo(3));
context.sort(new SortAndFormats(new Sort(new SortField("other", SortField.Type.INT)), new DocValueFormat[] { DocValueFormat.RAW })); context.sort(new SortAndFormats(new Sort(new SortField("other", SortField.Type.INT)), new DocValueFormat[] { DocValueFormat.RAW }));
topDocsContext = TopDocsCollectorContext.createTopDocsCollectorContext(context, false); topDocsContext = TopDocsCollectorFactory.createTopDocsCollectorFactory(context, false);
assertEquals(topDocsContext.collector().scoreMode(), org.apache.lucene.search.ScoreMode.TOP_DOCS); assertEquals(topDocsContext.collector().scoreMode(), org.apache.lucene.search.ScoreMode.TOP_DOCS);
QueryPhase.executeInternal(context); QueryPhase.executeInternal(context);
assertEquals(5, context.queryResult().topDocs().topDocs.totalHits.value); assertEquals(5, context.queryResult().topDocs().topDocs.totalHits.value);

8
server/src/test/java/org/elasticsearch/search/query/TopDocsCollectorContextTests.java → server/src/test/java/org/elasticsearch/search/query/TopDocsCollectorFactoryTests.java
View file

@ -25,7 +25,7 @@ import org.elasticsearch.test.ESTestCase;
import java.io.IOException; import java.io.IOException;
public class TopDocsCollectorContextTests extends ESTestCase { public class TopDocsCollectorFactoryTests extends ESTestCase {
public void testShortcutTotalHitCountTextField() throws IOException { public void testShortcutTotalHitCountTextField() throws IOException {
try (Directory dir = newDirectory(); RandomIndexWriter iw = new RandomIndexWriter(random(), dir)) { try (Directory dir = newDirectory(); RandomIndexWriter iw = new RandomIndexWriter(random(), dir)) {
@ -39,7 +39,7 @@ public class TopDocsCollectorContextTests extends ESTestCase {
iw.commit(); iw.commit();
try (IndexReader reader = iw.getReader()) { try (IndexReader reader = iw.getReader()) {
final Query testQuery = new FieldExistsQuery("text"); final Query testQuery = new FieldExistsQuery("text");
int hitCount = TopDocsCollectorContext.shortcutTotalHitCount(reader, testQuery); int hitCount = TopDocsCollectorFactory.shortcutTotalHitCount(reader, testQuery);
assertEquals(-1, hitCount); assertEquals(-1, hitCount);
} }
} }
@ -59,7 +59,7 @@ public class TopDocsCollectorContextTests extends ESTestCase {
iw.commit(); iw.commit();
try (IndexReader reader = iw.getReader()) { try (IndexReader reader = iw.getReader()) {
final Query testQuery = new FieldExistsQuery("string"); final Query testQuery = new FieldExistsQuery("string");
int hitCount = TopDocsCollectorContext.shortcutTotalHitCount(reader, testQuery); int hitCount = TopDocsCollectorFactory.shortcutTotalHitCount(reader, testQuery);
assertEquals(2, hitCount); assertEquals(2, hitCount);
} }
} }
@ -75,7 +75,7 @@ public class TopDocsCollectorContextTests extends ESTestCase {
iw.commit(); iw.commit();
try (IndexReader reader = iw.getReader()) { try (IndexReader reader = iw.getReader()) {
final Query testQuery = new FieldExistsQuery("int"); final Query testQuery = new FieldExistsQuery("int");
int hitCount = TopDocsCollectorContext.shortcutTotalHitCount(reader, testQuery); int hitCount = TopDocsCollectorFactory.shortcutTotalHitCount(reader, testQuery);
assertEquals(1, hitCount); assertEquals(1, hitCount);
} }
} }