Skip to content

Commit ad01f07

Browse files
committed
Standardize naming of fetch subphases. (#52171)
This commit makes the names of fetch subphases more consistent: * Now the names end in just 'Phase', whereas before some ended in 'FetchSubPhase'. This matches the query subphases like AggregationPhase. * Some names include 'fetch' like FetchScorePhase to avoid ambiguity about what they do.
1 parent 4e28d40 commit ad01f07

File tree

29 files changed

+88
-88
lines changed

29 files changed

+88
-88
lines changed

server/src/main/java/org/elasticsearch/index/query/InnerHitBuilder.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
import org.elasticsearch.search.builder.SearchSourceBuilder.ScriptField;
3535
import org.elasticsearch.search.collapse.CollapseBuilder;
3636
import org.elasticsearch.search.fetch.StoredFieldsContext;
37-
import org.elasticsearch.search.fetch.subphase.DocValueFieldsContext.FieldAndFormat;
37+
import org.elasticsearch.search.fetch.subphase.FetchDocValuesContext.FieldAndFormat;
3838
import org.elasticsearch.search.fetch.subphase.FetchSourceContext;
3939
import org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder;
4040
import org.elasticsearch.search.sort.SortBuilder;

server/src/main/java/org/elasticsearch/index/query/InnerHitContextBuilder.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
import org.elasticsearch.index.IndexSettings;
2323
import org.elasticsearch.script.FieldScript;
2424
import org.elasticsearch.search.builder.SearchSourceBuilder;
25-
import org.elasticsearch.search.fetch.subphase.DocValueFieldsContext;
25+
import org.elasticsearch.search.fetch.subphase.FetchDocValuesContext;
2626
import org.elasticsearch.search.fetch.subphase.InnerHitsContext;
2727
import org.elasticsearch.search.internal.SearchContext;
2828
import org.elasticsearch.search.sort.SortAndFormats;
@@ -88,7 +88,7 @@ protected void setupInnerHitsContext(QueryShardContext queryShardContext,
8888
innerHitsContext.storedFieldsContext(innerHitBuilder.getStoredFieldsContext());
8989
}
9090
if (innerHitBuilder.getDocValueFields() != null) {
91-
innerHitsContext.docValueFieldsContext(new DocValueFieldsContext(innerHitBuilder.getDocValueFields()));
91+
innerHitsContext.docValuesContext(new FetchDocValuesContext(innerHitBuilder.getDocValueFields()));
9292
}
9393
if (innerHitBuilder.getScriptFields() != null) {
9494
for (SearchSourceBuilder.ScriptField field : innerHitBuilder.getScriptFields()) {

server/src/main/java/org/elasticsearch/search/DefaultSearchContext.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@
5757
import org.elasticsearch.search.fetch.FetchPhase;
5858
import org.elasticsearch.search.fetch.FetchSearchResult;
5959
import org.elasticsearch.search.fetch.StoredFieldsContext;
60-
import org.elasticsearch.search.fetch.subphase.DocValueFieldsContext;
60+
import org.elasticsearch.search.fetch.subphase.FetchDocValuesContext;
6161
import org.elasticsearch.search.fetch.subphase.FetchSourceContext;
6262
import org.elasticsearch.search.fetch.subphase.ScriptFieldsContext;
6363
import org.elasticsearch.search.fetch.subphase.highlight.SearchContextHighlight;
@@ -111,7 +111,7 @@ final class DefaultSearchContext extends SearchContext {
111111
private StoredFieldsContext storedFields;
112112
private ScriptFieldsContext scriptFields;
113113
private FetchSourceContext fetchSourceContext;
114-
private DocValueFieldsContext docValueFieldsContext;
114+
private FetchDocValuesContext docValuesContext;
115115
private int from = -1;
116116
private int size = -1;
117117
private SortAndFormats sort;
@@ -459,13 +459,13 @@ public SearchContext fetchSourceContext(FetchSourceContext fetchSourceContext) {
459459
}
460460

461461
@Override
462-
public DocValueFieldsContext docValueFieldsContext() {
463-
return docValueFieldsContext;
462+
public FetchDocValuesContext docValuesContext() {
463+
return docValuesContext;
464464
}
465465

466466
@Override
467-
public SearchContext docValueFieldsContext(DocValueFieldsContext docValueFieldsContext) {
468-
this.docValueFieldsContext = docValueFieldsContext;
467+
public SearchContext docValuesContext(FetchDocValuesContext docValuesContext) {
468+
this.docValuesContext = docValuesContext;
469469
return this;
470470
}
471471

server/src/main/java/org/elasticsearch/search/SearchModule.java

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -243,14 +243,14 @@
243243
import org.elasticsearch.search.aggregations.pipeline.SumBucketPipelineAggregator;
244244
import org.elasticsearch.search.fetch.FetchPhase;
245245
import org.elasticsearch.search.fetch.FetchSubPhase;
246-
import org.elasticsearch.search.fetch.subphase.DocValueFieldsFetchSubPhase;
247-
import org.elasticsearch.search.fetch.subphase.ExplainFetchSubPhase;
248-
import org.elasticsearch.search.fetch.subphase.FetchSourceSubPhase;
249-
import org.elasticsearch.search.fetch.subphase.MatchedQueriesFetchSubPhase;
250-
import org.elasticsearch.search.fetch.subphase.ScoreFetchSubPhase;
251-
import org.elasticsearch.search.fetch.subphase.ScriptFieldsFetchSubPhase;
252-
import org.elasticsearch.search.fetch.subphase.SeqNoPrimaryTermFetchSubPhase;
253-
import org.elasticsearch.search.fetch.subphase.VersionFetchSubPhase;
246+
import org.elasticsearch.search.fetch.subphase.FetchDocValuesPhase;
247+
import org.elasticsearch.search.fetch.subphase.ExplainPhase;
248+
import org.elasticsearch.search.fetch.subphase.FetchSourcePhase;
249+
import org.elasticsearch.search.fetch.subphase.MatchedQueriesPhase;
250+
import org.elasticsearch.search.fetch.subphase.FetchScorePhase;
251+
import org.elasticsearch.search.fetch.subphase.ScriptFieldsPhase;
252+
import org.elasticsearch.search.fetch.subphase.SeqNoPrimaryTermPhase;
253+
import org.elasticsearch.search.fetch.subphase.FetchVersionPhase;
254254
import org.elasticsearch.search.fetch.subphase.highlight.FastVectorHighlighter;
255255
import org.elasticsearch.search.fetch.subphase.highlight.HighlightPhase;
256256
import org.elasticsearch.search.fetch.subphase.highlight.Highlighter;
@@ -745,15 +745,15 @@ private void registerMovingAverageModel(SearchExtensionSpec<MovAvgModel, MovAvgM
745745
}
746746

747747
private void registerFetchSubPhases(List<SearchPlugin> plugins) {
748-
registerFetchSubPhase(new ExplainFetchSubPhase());
749-
registerFetchSubPhase(new DocValueFieldsFetchSubPhase());
750-
registerFetchSubPhase(new ScriptFieldsFetchSubPhase());
751-
registerFetchSubPhase(new FetchSourceSubPhase());
752-
registerFetchSubPhase(new VersionFetchSubPhase());
753-
registerFetchSubPhase(new SeqNoPrimaryTermFetchSubPhase());
754-
registerFetchSubPhase(new MatchedQueriesFetchSubPhase());
748+
registerFetchSubPhase(new ExplainPhase());
749+
registerFetchSubPhase(new FetchDocValuesPhase());
750+
registerFetchSubPhase(new ScriptFieldsPhase());
751+
registerFetchSubPhase(new FetchSourcePhase());
752+
registerFetchSubPhase(new FetchVersionPhase());
753+
registerFetchSubPhase(new SeqNoPrimaryTermPhase());
754+
registerFetchSubPhase(new MatchedQueriesPhase());
755755
registerFetchSubPhase(new HighlightPhase(highlighters));
756-
registerFetchSubPhase(new ScoreFetchSubPhase());
756+
registerFetchSubPhase(new FetchScorePhase());
757757

758758
FetchPhaseConstructionContext context = new FetchPhaseConstructionContext(highlighters);
759759
registerFromPlugin(plugins, p -> p.getFetchSubPhases(context), this::registerFetchSubPhase);

server/src/main/java/org/elasticsearch/search/SearchService.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@
7777
import org.elasticsearch.search.fetch.QueryFetchSearchResult;
7878
import org.elasticsearch.search.fetch.ScrollQueryFetchSearchResult;
7979
import org.elasticsearch.search.fetch.ShardFetchRequest;
80-
import org.elasticsearch.search.fetch.subphase.DocValueFieldsContext;
80+
import org.elasticsearch.search.fetch.subphase.FetchDocValuesContext;
8181
import org.elasticsearch.search.fetch.subphase.ScriptFieldsContext.ScriptField;
8282
import org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder;
8383
import org.elasticsearch.search.internal.AliasFilter;
@@ -822,11 +822,11 @@ private void parseSource(DefaultSearchContext context, SearchSourceBuilder sourc
822822
context.fetchSourceContext(source.fetchSource());
823823
}
824824
if (source.docValueFields() != null) {
825-
List<DocValueFieldsContext.FieldAndFormat> docValueFields = new ArrayList<>();
826-
for (DocValueFieldsContext.FieldAndFormat format : source.docValueFields()) {
825+
List<FetchDocValuesContext.FieldAndFormat> docValueFields = new ArrayList<>();
826+
for (FetchDocValuesContext.FieldAndFormat format : source.docValueFields()) {
827827
Collection<String> fieldNames = context.mapperService().simpleMatchToFullName(format.field);
828828
for (String fieldName: fieldNames) {
829-
docValueFields.add(new DocValueFieldsContext.FieldAndFormat(fieldName, format.format));
829+
docValueFields.add(new FetchDocValuesContext.FieldAndFormat(fieldName, format.format));
830830
}
831831
}
832832
int maxAllowedDocvalueFields = context.mapperService().getIndexSettings().getMaxDocvalueFields();
@@ -836,7 +836,7 @@ private void parseSource(DefaultSearchContext context, SearchSourceBuilder sourc
836836
+ "] but was [" + docValueFields.size() + "]. This limit can be set by changing the ["
837837
+ IndexSettings.MAX_DOCVALUE_FIELDS_SEARCH_SETTING.getKey() + "] index level setting.");
838838
}
839-
context.docValueFieldsContext(new DocValueFieldsContext(docValueFields));
839+
context.docValuesContext(new FetchDocValuesContext(docValueFields));
840840
}
841841
if (source.highlighter() != null) {
842842
HighlightBuilder highlightBuilder = source.highlighter();

server/src/main/java/org/elasticsearch/search/aggregations/metrics/TopHitsAggregationBuilder.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
import org.elasticsearch.search.builder.SearchSourceBuilder;
4040
import org.elasticsearch.search.builder.SearchSourceBuilder.ScriptField;
4141
import org.elasticsearch.search.fetch.StoredFieldsContext;
42-
import org.elasticsearch.search.fetch.subphase.DocValueFieldsContext.FieldAndFormat;
42+
import org.elasticsearch.search.fetch.subphase.FetchDocValuesContext.FieldAndFormat;
4343
import org.elasticsearch.search.fetch.subphase.FetchSourceContext;
4444
import org.elasticsearch.search.fetch.subphase.ScriptFieldsContext;
4545
import org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder;

server/src/main/java/org/elasticsearch/search/aggregations/metrics/TopHitsAggregatorFactory.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@
2525
import org.elasticsearch.search.aggregations.AggregatorFactory;
2626
import org.elasticsearch.search.aggregations.pipeline.PipelineAggregator;
2727
import org.elasticsearch.search.fetch.StoredFieldsContext;
28-
import org.elasticsearch.search.fetch.subphase.DocValueFieldsContext;
29-
import org.elasticsearch.search.fetch.subphase.DocValueFieldsContext.FieldAndFormat;
28+
import org.elasticsearch.search.fetch.subphase.FetchDocValuesContext;
29+
import org.elasticsearch.search.fetch.subphase.FetchDocValuesContext.FieldAndFormat;
3030
import org.elasticsearch.search.fetch.subphase.FetchSourceContext;
3131
import org.elasticsearch.search.fetch.subphase.ScriptFieldsContext;
3232
import org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder;
@@ -107,7 +107,7 @@ public Aggregator createInternal(SearchContext searchContext,
107107
subSearchContext.storedFieldsContext(storedFieldsContext);
108108
}
109109
if (docValueFields != null) {
110-
subSearchContext.docValueFieldsContext(new DocValueFieldsContext(docValueFields));
110+
subSearchContext.docValuesContext(new FetchDocValuesContext(docValueFields));
111111
}
112112
for (ScriptFieldsContext.ScriptField field : scriptFields) {
113113
subSearchContext.scriptFields().add(field);

server/src/main/java/org/elasticsearch/search/builder/SearchSourceBuilder.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
import org.elasticsearch.search.aggregations.PipelineAggregationBuilder;
4949
import org.elasticsearch.search.collapse.CollapseBuilder;
5050
import org.elasticsearch.search.fetch.StoredFieldsContext;
51-
import org.elasticsearch.search.fetch.subphase.DocValueFieldsContext.FieldAndFormat;
51+
import org.elasticsearch.search.fetch.subphase.FetchDocValuesContext.FieldAndFormat;
5252
import org.elasticsearch.search.fetch.subphase.FetchSourceContext;
5353
import org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder;
5454
import org.elasticsearch.search.internal.SearchContext;

server/src/main/java/org/elasticsearch/search/fetch/FetchPhase.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
import org.elasticsearch.search.SearchShardTarget;
5656
import org.elasticsearch.search.fetch.subphase.FetchSourceContext;
5757
import org.elasticsearch.search.fetch.subphase.InnerHitsContext;
58-
import org.elasticsearch.search.fetch.subphase.InnerHitsFetchSubPhase;
58+
import org.elasticsearch.search.fetch.subphase.InnerHitsPhase;
5959
import org.elasticsearch.search.internal.SearchContext;
6060
import org.elasticsearch.search.lookup.SourceLookup;
6161
import org.elasticsearch.tasks.TaskCancelledException;
@@ -81,7 +81,7 @@ public class FetchPhase implements SearchPhase {
8181

8282
public FetchPhase(List<FetchSubPhase> fetchSubPhases) {
8383
this.fetchSubPhases = fetchSubPhases.toArray(new FetchSubPhase[fetchSubPhases.size() + 1]);
84-
this.fetchSubPhases[fetchSubPhases.size()] = new InnerHitsFetchSubPhase(this);
84+
this.fetchSubPhases[fetchSubPhases.size()] = new InnerHitsPhase(this);
8585
}
8686

8787
@Override
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
/**
3030
* Explains the scoring calculations for the top hits.
3131
*/
32-
public final class ExplainFetchSubPhase implements FetchSubPhase {
32+
public final class ExplainPhase implements FetchSubPhase {
3333

3434
@Override
3535
public void hitExecute(SearchContext context, HitContext hitContext) {

0 commit comments

Comments
 (0)