honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Rename FieldValueRetriever -> FieldFetcher. (#62795) (#62836) 

The name `FieldFetcher` fits better with the 'fetch' terminology we use
elsewhere, for example `FetchFieldsPhase` and `ValueFetcher`.

This PR also moves the construction of the fetcher off the context and onto
`FetchFieldsPhase`, which feels like a more natural place for it, and fixes a
TODO in javadocs.
This commit is contained in:
Julie Tibshirani 2020-09-23 10:12:23 -07:00 committed by GitHub
parent 38c8a55df8
commit f971146de4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 49 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
server/src/main/java/org/elasticsearch/action/search/SearchRequestBuilder.java
View File

@ -329,7 +329,7 @@ public class SearchRequestBuilder extends ActionRequestBuilder<SearchRequest, Se
* Adds a field to load and return. The field must be present in the document _source.
*
* @param name The field to load
* @param format TODO(jtibs): fill this in
* @param format an optional format string used when formatting values, for example a date format.
*/
public SearchRequestBuilder addFetchField(String name, String format) {
sourceBuilder().fetchField(name, format);

12
server/src/main/java/org/elasticsearch/search/fetch/subphase/FetchFieldsContext.java
View File

@ -18,9 +18,6 @@
*/
package org.elasticsearch.search.fetch.subphase;
import org.elasticsearch.index.mapper.MapperService;
import org.elasticsearch.search.lookup.SearchLookup;
import java.util.List;
/**
@ -33,12 +30,7 @@ public class FetchFieldsContext {
this.fields = fields;
}
public FieldValueRetriever fieldValueRetriever(String indexName, MapperService mapperService, SearchLookup searchLookup) {
if (mapperService.documentMapper().sourceMapper().enabled() == false) {
throw new IllegalArgumentException(
"Unable to retrieve the requested [fields] since _source is disabled in the mappings for index [" + indexName + "]"
);
}
return FieldValueRetriever.create(mapperService, searchLookup, fields);
public List<FieldAndFormat> fields() {
return fields;
}
}

20
server/src/main/java/org/elasticsearch/search/fetch/subphase/FetchFieldsPhase.java
View File

@ -22,10 +22,12 @@ package org.elasticsearch.search.fetch.subphase;
import org.apache.lucene.index.LeafReaderContext;
import org.elasticsearch.common.document.DocumentField;
import org.elasticsearch.index.mapper.IgnoredFieldMapper;
import org.elasticsearch.index.mapper.MapperService;
import org.elasticsearch.search.SearchHit;
import org.elasticsearch.search.fetch.FetchContext;
import org.elasticsearch.search.fetch.FetchSubPhase;
import org.elasticsearch.search.fetch.FetchSubPhaseProcessor;
import org.elasticsearch.search.lookup.SearchLookup;
import org.elasticsearch.search.lookup.SourceLookup;
import java.io.IOException;
@ -45,15 +47,19 @@ public final class FetchFieldsPhase implements FetchSubPhase {
if (fetchFieldsContext == null) {
return null;
}
FieldValueRetriever retriever = fetchFieldsContext.fieldValueRetriever(
fetchContext.getIndexName(),
fetchContext.mapperService(),
fetchContext.searchLookup()
);
MapperService mapperService = fetchContext.mapperService();
SearchLookup searchLookup = fetchContext.searchLookup();
if (fetchContext.mapperService().documentMapper().sourceMapper().enabled() == false) {
throw new IllegalArgumentException("Unable to retrieve the requested [fields] since _source is disabled " +
"in the mappings for index [" + fetchContext.getIndexName() + "]");
}
FieldFetcher fieldFetcher = FieldFetcher.create(mapperService, searchLookup, fetchFieldsContext.fields());
return new FetchSubPhaseProcessor() {
@Override
public void setNextReader(LeafReaderContext readerContext) {
retriever.setNextReader(readerContext);
fieldFetcher.setNextReader(readerContext);
}
@Override
@ -62,7 +68,7 @@ public final class FetchFieldsPhase implements FetchSubPhase {
SourceLookup sourceLookup = hitContext.sourceLookup();
Set<String> ignoredFields = getIgnoredFields(hit);
Map<String, DocumentField> documentFields = retriever.retrieve(sourceLookup, ignoredFields);
Map<String, DocumentField> documentFields = fieldFetcher.fetch(sourceLookup, ignoredFields);
for (Map.Entry<String, DocumentField> entry : documentFields.entrySet()) {
hit.setDocumentField(entry.getKey(), entry.getValue());
}

16
server/src/main/java/org/elasticsearch/search/fetch/subphase/FieldValueRetriever.java → server/src/main/java/org/elasticsearch/search/fetch/subphase/FieldFetcher.java
View File

@ -42,12 +42,10 @@ import java.util.Set;
* A helper class to {@link FetchFieldsPhase} that's initialized with a list of field patterns to fetch.
* Then given a specific document, it can retrieve the corresponding fields from the document's source.
*/
public class FieldValueRetriever {
public static FieldValueRetriever create(
MapperService mapperService,
SearchLookup searchLookup,
Collection<FieldAndFormat> fieldAndFormats
) {
public class FieldFetcher {
public static FieldFetcher create(MapperService mapperService,
SearchLookup searchLookup,
Collection<FieldAndFormat> fieldAndFormats) {
MappingLookup fieldMappers = mapperService.documentMapper().mappers();
List<FieldContext> fieldContexts = new ArrayList<>();
@ -74,16 +72,16 @@ public class FieldValueRetriever {
}
}
return new FieldValueRetriever(fieldContexts);
return new FieldFetcher(fieldContexts);
}
private final List<FieldContext> fieldContexts;
private FieldValueRetriever(List<FieldContext> fieldContexts) {
private FieldFetcher(List<FieldContext> fieldContexts) {
this.fieldContexts = fieldContexts;
}
public Map<String, DocumentField> retrieve(SourceLookup sourceLookup, Set<String> ignoredFields) throws IOException {
public Map<String, DocumentField> fetch(SourceLookup sourceLookup, Set<String> ignoredFields) throws IOException {
Map<String, DocumentField> documentFields = new HashMap<>();
for (FieldContext context : fieldContexts) {
String field = context.fieldName;

52
server/src/test/java/org/elasticsearch/search/fetch/subphase/FieldValueRetrieverTests.java → server/src/test/java/org/elasticsearch/search/fetch/subphase/FieldFetcherTests.java
View File

@ -36,7 +36,7 @@ import java.util.Map;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.hasItems;
public class FieldValueRetrieverTests extends ESSingleNodeTestCase {
public class FieldFetcherTests extends ESSingleNodeTestCase {
public void testLeafValues() throws IOException {
MapperService mapperService = createMapperService();
@ -50,7 +50,7 @@ public class FieldValueRetrieverTests extends ESSingleNodeTestCase {
List<FieldAndFormat> fieldAndFormats = org.elasticsearch.common.collect.List.of(
new FieldAndFormat("field", null),
new FieldAndFormat("object.field", null));
Map<String, DocumentField> fields = retrieveFields(mapperService, source, fieldAndFormats);
Map<String, DocumentField> fields = fetchFields(mapperService, source, fieldAndFormats);
assertThat(fields.size(), equalTo(2));
DocumentField field = fields.get("field");
@ -73,7 +73,7 @@ public class FieldValueRetrieverTests extends ESSingleNodeTestCase {
.endObject()
.endObject();
Map<String, DocumentField> fields = retrieveFields(mapperService, source, "float_range");
Map<String, DocumentField> fields = fetchFields(mapperService, source, "float_range");
assertThat(fields.size(), equalTo(1));
DocumentField rangeField = fields.get("float_range");
@ -88,7 +88,7 @@ public class FieldValueRetrieverTests extends ESSingleNodeTestCase {
.field("field", "value")
.endObject();
Map<String, DocumentField> fields = retrieveFields(mapperService, source, "non-existent");
Map<String, DocumentField> fields = fetchFields(mapperService, source, "non-existent");
assertThat(fields.size(), equalTo(0));
}
@ -98,11 +98,11 @@ public class FieldValueRetrieverTests extends ESSingleNodeTestCase {
.field("field", "value")
.endObject();
Map<String, DocumentField> fields = retrieveFields(mapperService, source, "_routing");
Map<String, DocumentField> fields = fetchFields(mapperService, source, "_routing");
assertTrue(fields.isEmpty());
}
public void testRetrieveAllFields() throws IOException {
public void testFetchAllFields() throws IOException {
MapperService mapperService = createMapperService();
XContentBuilder source = XContentFactory.jsonBuilder().startObject()
.field("field", "value")
@ -111,7 +111,7 @@ public class FieldValueRetrieverTests extends ESSingleNodeTestCase {
.endObject()
.endObject();
Map<String, DocumentField> fields = retrieveFields(mapperService, source, "*");
Map<String, DocumentField> fields = fetchFields(mapperService, source, "*");
assertThat(fields.size(), equalTo(2));
}
@ -123,7 +123,7 @@ public class FieldValueRetrieverTests extends ESSingleNodeTestCase {
.endArray()
.endObject();
Map<String, DocumentField> fields = retrieveFields(mapperService, source, "field");
Map<String, DocumentField> fields = fetchFields(mapperService, source, "field");
DocumentField field = fields.get("field");
assertNotNull(field);
assertThat(field.getValues().size(), equalTo(2));
@ -137,7 +137,7 @@ public class FieldValueRetrieverTests extends ESSingleNodeTestCase {
.endArray()
.endObject();
fields = retrieveFields(mapperService, source, "object.field");
fields = fetchFields(mapperService, source, "object.field");
field = fields.get("object.field");
assertNotNull(field);
assertThat(field.getValues().size(), equalTo(4));
@ -151,7 +151,7 @@ public class FieldValueRetrieverTests extends ESSingleNodeTestCase {
.array("geo_point", 27.1, 42.0)
.endObject();
Map<String, DocumentField> fields = retrieveFields(mapperService, source, "geo_point");
Map<String, DocumentField> fields = fetchFields(mapperService, source, "geo_point");
assertThat(fields.size(), equalTo(1));
DocumentField field = fields.get("geo_point");
@ -166,7 +166,7 @@ public class FieldValueRetrieverTests extends ESSingleNodeTestCase {
.endArray()
.endObject();
fields = retrieveFields(mapperService, source, "geo_point");
fields = fetchFields(mapperService, source, "geo_point");
assertThat(fields.size(), equalTo(1));
field = fields.get("geo_point");
@ -184,7 +184,7 @@ public class FieldValueRetrieverTests extends ESSingleNodeTestCase {
.endObject()
.endObject();
Map<String, DocumentField> fields = retrieveFields(mapperService, source, "*field");
Map<String, DocumentField> fields = fetchFields(mapperService, source, "*field");
assertThat(fields.size(), equalTo(3));
DocumentField field = fields.get("field");
@ -210,7 +210,7 @@ public class FieldValueRetrieverTests extends ESSingleNodeTestCase {
.field("date_field", "1990-12-29T00:00:00.000Z")
.endObject();
Map<String, DocumentField> fields = retrieveFields(mapperService, source, org.elasticsearch.common.collect.List.of(
Map<String, DocumentField> fields = fetchFields(mapperService, source, org.elasticsearch.common.collect.List.of(
new FieldAndFormat("field", null),
new FieldAndFormat("date_field", "yyyy/MM/dd")));
assertThat(fields.size(), equalTo(2));
@ -240,14 +240,14 @@ public class FieldValueRetrieverTests extends ESSingleNodeTestCase {
XContentBuilder source = XContentFactory.jsonBuilder().startObject()
.array("field", "value", "other_value", "really_really_long_value")
.endObject();
Map<String, DocumentField> fields = retrieveFields(mapperService, source, "field");
Map<String, DocumentField> fields = fetchFields(mapperService, source, "field");
DocumentField field = fields.get("field");
assertThat(field.getValues().size(), equalTo(2));
source = XContentFactory.jsonBuilder().startObject()
.array("field", "really_really_long_value")
.endObject();
fields = retrieveFields(mapperService, source, "field");
fields = fetchFields(mapperService, source, "field");
assertFalse(fields.containsKey("field"));
}
@ -269,7 +269,7 @@ public class FieldValueRetrieverTests extends ESSingleNodeTestCase {
.field("field", "value")
.endObject();
Map<String, DocumentField> fields = retrieveFields(mapperService, source, "alias_field");
Map<String, DocumentField> fields = fetchFields(mapperService, source, "alias_field");
assertThat(fields.size(), equalTo(1));
DocumentField field = fields.get("alias_field");
@ -277,7 +277,7 @@ public class FieldValueRetrieverTests extends ESSingleNodeTestCase {
assertThat(field.getValues().size(), equalTo(1));
assertThat(field.getValues(), hasItems("value"));
fields = retrieveFields(mapperService, source, "*field");
fields = fetchFields(mapperService, source, "*field");
assertThat(fields.size(), equalTo(2));
assertTrue(fields.containsKey("alias_field"));
assertTrue(fields.containsKey("field"));
@ -302,7 +302,7 @@ public class FieldValueRetrieverTests extends ESSingleNodeTestCase {
.field("field", 42)
.endObject();
Map<String, DocumentField> fields = retrieveFields(mapperService, source, "field.keyword");
Map<String, DocumentField> fields = fetchFields(mapperService, source, "field.keyword");
assertThat(fields.size(), equalTo(1));
DocumentField field = fields.get("field.keyword");
@ -310,7 +310,7 @@ public class FieldValueRetrieverTests extends ESSingleNodeTestCase {
assertThat(field.getValues().size(), equalTo(1));
assertThat(field.getValues(), hasItems("42"));
fields = retrieveFields(mapperService, source, "field*");
fields = fetchFields(mapperService, source, "field*");
assertThat(fields.size(), equalTo(2));
assertTrue(fields.containsKey("field"));
assertTrue(fields.containsKey("field.keyword"));
@ -337,7 +337,7 @@ public class FieldValueRetrieverTests extends ESSingleNodeTestCase {
.array("other_field", 1, 2, 3)
.endObject();
Map<String, DocumentField> fields = retrieveFields(mapperService, source, "field");
Map<String, DocumentField> fields = fetchFields(mapperService, source, "field");
assertThat(fields.size(), equalTo(1));
DocumentField field = fields.get("field");
@ -355,25 +355,25 @@ public class FieldValueRetrieverTests extends ESSingleNodeTestCase {
.endObject()
.endObject();
Map<String, DocumentField> fields = retrieveFields(mapperService, source, "object");
Map<String, DocumentField> fields = fetchFields(mapperService, source, "object");
assertFalse(fields.containsKey("object"));
}
private Map<String, DocumentField> retrieveFields(MapperService mapperService, XContentBuilder source, String fieldPattern)
private Map<String, DocumentField> fetchFields(MapperService mapperService, XContentBuilder source, String fieldPattern)
throws IOException {
List<FieldAndFormat> fields = org.elasticsearch.common.collect.List.of(new FieldAndFormat(fieldPattern, null));
return retrieveFields(mapperService, source, fields);
return fetchFields(mapperService, source, fields);
}
private Map<String, DocumentField> retrieveFields(MapperService mapperService, XContentBuilder source, List<FieldAndFormat> fields)
private Map<String, DocumentField> fetchFields(MapperService mapperService, XContentBuilder source, List<FieldAndFormat> fields)
throws IOException {
SourceLookup sourceLookup = new SourceLookup();
sourceLookup.setSource(BytesReference.bytes(source));
FieldValueRetriever fetchFieldsLookup = FieldValueRetriever.create(mapperService, null, fields);
return fetchFieldsLookup.retrieve(sourceLookup, org.elasticsearch.common.collect.Set.of());
FieldFetcher fieldFetcher = FieldFetcher.create(mapperService, null, fields);
return fieldFetcher.fetch(sourceLookup, org.elasticsearch.common.collect.Set.of());
}
public MapperService createMapperService() throws IOException {