Skip to content

Commit 067eecb

Browse files
authored
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 f78d4b3 commit 067eecb

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
@@ -33,7 +33,7 @@
3333
import org.elasticsearch.search.builder.SearchSourceBuilder.ScriptField;
3434
import org.elasticsearch.search.collapse.CollapseBuilder;
3535
import org.elasticsearch.search.fetch.StoredFieldsContext;
36-
import org.elasticsearch.search.fetch.subphase.DocValueFieldsContext.FieldAndFormat;
36+
import org.elasticsearch.search.fetch.subphase.FetchDocValuesContext.FieldAndFormat;
3737
import org.elasticsearch.search.fetch.subphase.FetchSourceContext;
3838
import org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder;
3939
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
@@ -56,7 +56,7 @@
5656
import org.elasticsearch.search.fetch.FetchPhase;
5757
import org.elasticsearch.search.fetch.FetchSearchResult;
5858
import org.elasticsearch.search.fetch.StoredFieldsContext;
59-
import org.elasticsearch.search.fetch.subphase.DocValueFieldsContext;
59+
import org.elasticsearch.search.fetch.subphase.FetchDocValuesContext;
6060
import org.elasticsearch.search.fetch.subphase.FetchSourceContext;
6161
import org.elasticsearch.search.fetch.subphase.ScriptFieldsContext;
6262
import org.elasticsearch.search.fetch.subphase.highlight.SearchContextHighlight;
@@ -109,7 +109,7 @@ final class DefaultSearchContext extends SearchContext {
109109
private StoredFieldsContext storedFields;
110110
private ScriptFieldsContext scriptFields;
111111
private FetchSourceContext fetchSourceContext;
112-
private DocValueFieldsContext docValueFieldsContext;
112+
private FetchDocValuesContext docValuesContext;
113113
private int from = -1;
114114
private int size = -1;
115115
private SortAndFormats sort;
@@ -443,13 +443,13 @@ public SearchContext fetchSourceContext(FetchSourceContext fetchSourceContext) {
443443
}
444444

445445
@Override
446-
public DocValueFieldsContext docValueFieldsContext() {
447-
return docValueFieldsContext;
446+
public FetchDocValuesContext docValuesContext() {
447+
return docValuesContext;
448448
}
449449

450450
@Override
451-
public SearchContext docValueFieldsContext(DocValueFieldsContext docValueFieldsContext) {
452-
this.docValueFieldsContext = docValueFieldsContext;
451+
public SearchContext docValuesContext(FetchDocValuesContext docValuesContext) {
452+
this.docValuesContext = docValuesContext;
453453
return this;
454454
}
455455

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

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -230,14 +230,14 @@
230230
import org.elasticsearch.search.aggregations.pipeline.SumBucketPipelineAggregator;
231231
import org.elasticsearch.search.fetch.FetchPhase;
232232
import org.elasticsearch.search.fetch.FetchSubPhase;
233-
import org.elasticsearch.search.fetch.subphase.DocValueFieldsFetchSubPhase;
234-
import org.elasticsearch.search.fetch.subphase.ExplainFetchSubPhase;
235-
import org.elasticsearch.search.fetch.subphase.FetchSourceSubPhase;
236-
import org.elasticsearch.search.fetch.subphase.MatchedQueriesFetchSubPhase;
237-
import org.elasticsearch.search.fetch.subphase.ScoreFetchSubPhase;
238-
import org.elasticsearch.search.fetch.subphase.ScriptFieldsFetchSubPhase;
239-
import org.elasticsearch.search.fetch.subphase.SeqNoPrimaryTermFetchSubPhase;
240-
import org.elasticsearch.search.fetch.subphase.VersionFetchSubPhase;
233+
import org.elasticsearch.search.fetch.subphase.FetchDocValuesPhase;
234+
import org.elasticsearch.search.fetch.subphase.ExplainPhase;
235+
import org.elasticsearch.search.fetch.subphase.FetchSourcePhase;
236+
import org.elasticsearch.search.fetch.subphase.MatchedQueriesPhase;
237+
import org.elasticsearch.search.fetch.subphase.FetchScorePhase;
238+
import org.elasticsearch.search.fetch.subphase.ScriptFieldsPhase;
239+
import org.elasticsearch.search.fetch.subphase.SeqNoPrimaryTermPhase;
240+
import org.elasticsearch.search.fetch.subphase.FetchVersionPhase;
241241
import org.elasticsearch.search.fetch.subphase.highlight.FastVectorHighlighter;
242242
import org.elasticsearch.search.fetch.subphase.highlight.HighlightPhase;
243243
import org.elasticsearch.search.fetch.subphase.highlight.Highlighter;
@@ -687,15 +687,15 @@ private <T extends SignificanceHeuristic> void registerSignificanceHeuristic(Sig
687687
}
688688

689689
private void registerFetchSubPhases(List<SearchPlugin> plugins) {
690-
registerFetchSubPhase(new ExplainFetchSubPhase());
691-
registerFetchSubPhase(new DocValueFieldsFetchSubPhase());
692-
registerFetchSubPhase(new ScriptFieldsFetchSubPhase());
693-
registerFetchSubPhase(new FetchSourceSubPhase());
694-
registerFetchSubPhase(new VersionFetchSubPhase());
695-
registerFetchSubPhase(new SeqNoPrimaryTermFetchSubPhase());
696-
registerFetchSubPhase(new MatchedQueriesFetchSubPhase());
690+
registerFetchSubPhase(new ExplainPhase());
691+
registerFetchSubPhase(new FetchDocValuesPhase());
692+
registerFetchSubPhase(new ScriptFieldsPhase());
693+
registerFetchSubPhase(new FetchSourcePhase());
694+
registerFetchSubPhase(new FetchVersionPhase());
695+
registerFetchSubPhase(new SeqNoPrimaryTermPhase());
696+
registerFetchSubPhase(new MatchedQueriesPhase());
697697
registerFetchSubPhase(new HighlightPhase(highlighters));
698-
registerFetchSubPhase(new ScoreFetchSubPhase());
698+
registerFetchSubPhase(new FetchScorePhase());
699699

700700
FetchPhaseConstructionContext context = new FetchPhaseConstructionContext(highlighters);
701701
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
@@ -79,7 +79,7 @@
7979
import org.elasticsearch.search.fetch.QueryFetchSearchResult;
8080
import org.elasticsearch.search.fetch.ScrollQueryFetchSearchResult;
8181
import org.elasticsearch.search.fetch.ShardFetchRequest;
82-
import org.elasticsearch.search.fetch.subphase.DocValueFieldsContext;
82+
import org.elasticsearch.search.fetch.subphase.FetchDocValuesContext;
8383
import org.elasticsearch.search.fetch.subphase.ScriptFieldsContext.ScriptField;
8484
import org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder;
8585
import org.elasticsearch.search.internal.AliasFilter;
@@ -883,11 +883,11 @@ private void parseSource(DefaultSearchContext context, SearchSourceBuilder sourc
883883
context.fetchSourceContext(source.fetchSource());
884884
}
885885
if (source.docValueFields() != null) {
886-
List<DocValueFieldsContext.FieldAndFormat> docValueFields = new ArrayList<>();
887-
for (DocValueFieldsContext.FieldAndFormat format : source.docValueFields()) {
886+
List<FetchDocValuesContext.FieldAndFormat> docValueFields = new ArrayList<>();
887+
for (FetchDocValuesContext.FieldAndFormat format : source.docValueFields()) {
888888
Collection<String> fieldNames = context.mapperService().simpleMatchToFullName(format.field);
889889
for (String fieldName: fieldNames) {
890-
docValueFields.add(new DocValueFieldsContext.FieldAndFormat(fieldName, format.format));
890+
docValueFields.add(new FetchDocValuesContext.FieldAndFormat(fieldName, format.format));
891891
}
892892
}
893893
int maxAllowedDocvalueFields = context.mapperService().getIndexSettings().getMaxDocvalueFields();
@@ -897,7 +897,7 @@ private void parseSource(DefaultSearchContext context, SearchSourceBuilder sourc
897897
+ "] but was [" + docValueFields.size() + "]. This limit can be set by changing the ["
898898
+ IndexSettings.MAX_DOCVALUE_FIELDS_SEARCH_SETTING.getKey() + "] index level setting.");
899899
}
900-
context.docValueFieldsContext(new DocValueFieldsContext(docValueFields));
900+
context.docValuesContext(new FetchDocValuesContext(docValueFields));
901901
}
902902
if (source.highlighter() != null) {
903903
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
@@ -38,7 +38,7 @@
3838
import org.elasticsearch.search.builder.SearchSourceBuilder;
3939
import org.elasticsearch.search.builder.SearchSourceBuilder.ScriptField;
4040
import org.elasticsearch.search.fetch.StoredFieldsContext;
41-
import org.elasticsearch.search.fetch.subphase.DocValueFieldsContext.FieldAndFormat;
41+
import org.elasticsearch.search.fetch.subphase.FetchDocValuesContext.FieldAndFormat;
4242
import org.elasticsearch.search.fetch.subphase.FetchSourceContext;
4343
import org.elasticsearch.search.fetch.subphase.ScriptFieldsContext;
4444
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
@@ -47,7 +47,7 @@
4747
import org.elasticsearch.search.aggregations.PipelineAggregationBuilder;
4848
import org.elasticsearch.search.collapse.CollapseBuilder;
4949
import org.elasticsearch.search.fetch.StoredFieldsContext;
50-
import org.elasticsearch.search.fetch.subphase.DocValueFieldsContext.FieldAndFormat;
50+
import org.elasticsearch.search.fetch.subphase.FetchDocValuesContext.FieldAndFormat;
5151
import org.elasticsearch.search.fetch.subphase.FetchSourceContext;
5252
import org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder;
5353
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
@@ -52,7 +52,7 @@
5252
import org.elasticsearch.search.SearchShardTarget;
5353
import org.elasticsearch.search.fetch.subphase.FetchSourceContext;
5454
import org.elasticsearch.search.fetch.subphase.InnerHitsContext;
55-
import org.elasticsearch.search.fetch.subphase.InnerHitsFetchSubPhase;
55+
import org.elasticsearch.search.fetch.subphase.InnerHitsPhase;
5656
import org.elasticsearch.search.internal.SearchContext;
5757
import org.elasticsearch.search.lookup.SourceLookup;
5858
import org.elasticsearch.tasks.TaskCancelledException;
@@ -78,7 +78,7 @@ public class FetchPhase implements SearchPhase {
7878

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

8484
@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)