org.elasticsearch.search.sort.FieldSortBuilder Maven / Gradle / Ivy
Show all versions of elasticsearch Show documentation
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/
package org.elasticsearch.search.sort;
import org.apache.lucene.document.LongPoint;
import org.apache.lucene.index.IndexReader;
import org.apache.lucene.index.MultiTerms;
import org.apache.lucene.index.PointValues;
import org.apache.lucene.index.Terms;
import org.apache.lucene.search.SortField;
import org.elasticsearch.ElasticsearchParseException;
import org.elasticsearch.Version;
import org.elasticsearch.common.ParsingException;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput;
import org.elasticsearch.common.time.DateMathParser;
import org.elasticsearch.common.time.DateUtils;
import org.elasticsearch.common.util.BigArrays;
import org.elasticsearch.index.IndexSortConfig;
import org.elasticsearch.index.fielddata.IndexFieldData;
import org.elasticsearch.index.fielddata.IndexFieldData.XFieldComparatorSource.Nested;
import org.elasticsearch.index.fielddata.IndexNumericFieldData;
import org.elasticsearch.index.fielddata.IndexNumericFieldData.NumericType;
import org.elasticsearch.index.mapper.DateFieldMapper.DateFieldType;
import org.elasticsearch.index.mapper.KeywordFieldMapper;
import org.elasticsearch.index.mapper.MappedFieldType;
import org.elasticsearch.index.mapper.NestedLookup;
import org.elasticsearch.index.mapper.NestedObjectMapper;
import org.elasticsearch.index.mapper.NumberFieldMapper.NumberFieldType;
import org.elasticsearch.index.query.QueryBuilder;
import org.elasticsearch.index.query.QueryRewriteContext;
import org.elasticsearch.index.query.QueryShardException;
import org.elasticsearch.index.query.SearchExecutionContext;
import org.elasticsearch.search.DocValueFormat;
import org.elasticsearch.search.MultiValueMode;
import org.elasticsearch.search.SearchSortValuesAndFormats;
import org.elasticsearch.search.builder.SearchSourceBuilder;
import org.elasticsearch.xcontent.ObjectParser;
import org.elasticsearch.xcontent.ObjectParser.ValueType;
import org.elasticsearch.xcontent.ParseField;
import org.elasticsearch.xcontent.XContentBuilder;
import org.elasticsearch.xcontent.XContentParser;
import java.io.IOException;
import java.util.Collections;
import java.util.Locale;
import java.util.Objects;
import java.util.function.Function;
import static org.elasticsearch.index.mapper.DateFieldMapper.Resolution.MILLISECONDS;
import static org.elasticsearch.index.mapper.DateFieldMapper.Resolution.NANOSECONDS;
import static org.elasticsearch.search.sort.NestedSortBuilder.NESTED_FIELD;
/**
* A sort builder to sort based on a document field.
*/
public class FieldSortBuilder extends SortBuilder {
public static final String NAME = "field_sort";
public static final ParseField MISSING = new ParseField("missing");
public static final ParseField SORT_MODE = new ParseField("mode");
public static final ParseField UNMAPPED_TYPE = new ParseField("unmapped_type");
public static final ParseField NUMERIC_TYPE = new ParseField("numeric_type");
public static final ParseField FORMAT = new ParseField("format");
/**
* special field name to sort by index order
*/
public static final String DOC_FIELD_NAME = "_doc";
/**
* special field name to sort by index order
*/
public static final String SHARD_DOC_FIELD_NAME = ShardDocSortField.NAME;
private static final SortFieldAndFormat SORT_DOC = new SortFieldAndFormat(new SortField(null, SortField.Type.DOC), DocValueFormat.RAW);
private static final SortFieldAndFormat SORT_DOC_REVERSE = new SortFieldAndFormat(
new SortField(null, SortField.Type.DOC, true),
DocValueFormat.RAW
);
private final String fieldName;
private Object missing;
private String unmappedType;
private String numericType;
private SortMode sortMode;
private NestedSortBuilder nestedSort;
private String format;
/** Copy constructor. */
public FieldSortBuilder(FieldSortBuilder template) {
this(template.fieldName);
this.order(template.order());
this.missing(template.missing());
this.unmappedType(template.unmappedType());
if (template.sortMode != null) {
this.sortMode(template.sortMode());
}
if (template.getNestedSort() != null) {
this.setNestedSort(template.getNestedSort());
}
this.numericType = template.numericType;
}
/**
* Constructs a new sort based on a document field.
*
* @param fieldName
* The field name.
*/
public FieldSortBuilder(String fieldName) {
if (fieldName == null) {
throw new IllegalArgumentException("fieldName must not be null");
}
this.fieldName = fieldName;
}
/**
* Read from a stream.
*/
public FieldSortBuilder(StreamInput in) throws IOException {
fieldName = in.readString();
if (in.getVersion().before(Version.V_8_0_0)) {
if (in.readOptionalNamedWriteable(QueryBuilder.class) != null || in.readOptionalString() != null) {
throw new IOException(
"the [sort] options [nested_path] and [nested_filter] are removed in 8.x, " + "please use [nested] instead"
);
}
}
missing = in.readGenericValue();
order = in.readOptionalWriteable(SortOrder::readFromStream);
sortMode = in.readOptionalWriteable(SortMode::readFromStream);
unmappedType = in.readOptionalString();
nestedSort = in.readOptionalWriteable(NestedSortBuilder::new);
if (in.getVersion().onOrAfter(Version.V_7_2_0)) {
numericType = in.readOptionalString();
}
if (in.getVersion().onOrAfter(Version.V_7_13_0)) {
format = in.readOptionalString();
}
}
@Override
public void writeTo(StreamOutput out) throws IOException {
out.writeString(fieldName);
if (out.getVersion().before(Version.V_8_0_0)) {
out.writeOptionalNamedWriteable(null);
out.writeOptionalString(null);
}
out.writeGenericValue(missing);
out.writeOptionalWriteable(order);
out.writeOptionalWriteable(sortMode);
out.writeOptionalString(unmappedType);
out.writeOptionalWriteable(nestedSort);
if (out.getVersion().onOrAfter(Version.V_7_2_0)) {
out.writeOptionalString(numericType);
}
if (out.getVersion().onOrAfter(Version.V_7_13_0)) {
out.writeOptionalString(format);
} else {
if (format != null) {
throw new IllegalArgumentException("Custom format for output of sort fields requires all nodes on 8.0 or later");
}
}
}
/** Returns the document field this sort should be based on. */
public String getFieldName() {
return this.fieldName;
}
/**
* Sets the value when a field is missing in a doc. Can also be set to {@code _last} or
* {@code _first} to sort missing last or first respectively.
*/
public FieldSortBuilder missing(Object missing) {
this.missing = missing;
return this;
}
/** Returns the value used when a field is missing in a doc. */
public Object missing() {
return missing;
}
/**
* Set the type to use in case the current field is not mapped in an index.
* Specifying a type tells Elasticsearch what type the sort values should
* have, which is important for cross-index search, if there are sort fields
* that exist on some indices only. If the unmapped type is {@code null}
* then query execution will fail if one or more indices don't have a
* mapping for the current field.
*/
public FieldSortBuilder unmappedType(String type) {
this.unmappedType = type;
return this;
}
/**
* Returns the type to use in case the current field is not mapped in an
* index.
*/
public String unmappedType() {
return this.unmappedType;
}
/**
* Defines what values to pick in the case a document contains multiple
* values for the targeted sort field. Possible values: min, max, sum and
* avg
*
*
* The last two values are only applicable for number based fields.
*/
public FieldSortBuilder sortMode(SortMode sortMode) {
Objects.requireNonNull(sortMode, "sort mode cannot be null");
this.sortMode = sortMode;
return this;
}
/**
* Returns what values to pick in the case a document contains multiple
* values for the targeted sort field.
*/
public SortMode sortMode() {
return this.sortMode;
}
/**
* Returns the {@link NestedSortBuilder}
*/
public NestedSortBuilder getNestedSort() {
return this.nestedSort;
}
/**
* Sets the {@link NestedSortBuilder} to be used for fields that are inside a nested
* object. The {@link NestedSortBuilder} takes a `path` argument and an optional
* nested filter that the nested objects should match with in
* order to be taken into account for sorting.
*/
public FieldSortBuilder setNestedSort(final NestedSortBuilder nestedSort) {
this.nestedSort = nestedSort;
return this;
}
/**
* Returns the numeric type that values should translated to or null
* if the original numeric type should be preserved.
*/
public String getNumericType() {
return numericType;
}
/**
* Forces the numeric type to use for the field. The query will fail if this option
* is set on a field that is not mapped as a numeric in some indices.
* Specifying a numeric type tells Elasticsearch what type the sort values should
* have, which is important for cross-index search, if a field does not have
* the same type on all indices.
* Allowed values are long, double, date and date_nanos.
*/
public FieldSortBuilder setNumericType(String numericType) {
String lowerCase = numericType.toLowerCase(Locale.ENGLISH);
switch (lowerCase) {
case "long":
case "double":
case "date":
case "date_nanos":
break;
default:
throw new IllegalArgumentException(
"invalid value for [numeric_type], " + "must be [long, double, date, date_nanos], got " + lowerCase
);
}
this.numericType = lowerCase;
return this;
}
/**
* Returns the external format that is specified via {@link #setFormat(String)}
*/
public String getFormat() {
return format;
}
/**
* Specifies a format specification that will be used to format the output value of this sort field.
* Currently, only "date" and "data_nanos" date types support this external format (i.e., date format).
*/
public FieldSortBuilder setFormat(String format) {
this.format = format;
return this;
}
@Override
public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
builder.startObject();
builder.startObject(fieldName);
builder.field(ORDER_FIELD.getPreferredName(), order);
if (missing != null) {
builder.field(MISSING.getPreferredName(), missing);
}
if (unmappedType != null) {
builder.field(UNMAPPED_TYPE.getPreferredName(), unmappedType);
}
if (sortMode != null) {
builder.field(SORT_MODE.getPreferredName(), sortMode);
}
if (nestedSort != null) {
builder.field(NESTED_FIELD.getPreferredName(), nestedSort);
}
if (numericType != null) {
builder.field(NUMERIC_TYPE.getPreferredName(), numericType);
}
if (format != null) {
builder.field(FORMAT.getPreferredName(), format);
}
builder.endObject();
builder.endObject();
return builder;
}
private static NumericType resolveNumericType(String value) {
return switch (value) {
case "long" -> NumericType.LONG;
case "double" -> NumericType.DOUBLE;
case "date" -> NumericType.DATE;
case "date_nanos" -> NumericType.DATE_NANOSECONDS;
default -> throw new IllegalArgumentException(
"invalid value for [numeric_type], " + "must be [long, double, date, date_nanos], got " + value
);
};
}
@Override
public SortFieldAndFormat build(SearchExecutionContext context) throws IOException {
final boolean reverse = order == SortOrder.DESC;
if (DOC_FIELD_NAME.equals(fieldName)) {
return reverse ? SORT_DOC_REVERSE : SORT_DOC;
} else if (SHARD_DOC_FIELD_NAME.equals(fieldName)) {
return new SortFieldAndFormat(new ShardDocSortField(context.getShardRequestIndex(), reverse), DocValueFormat.RAW);
}
MappedFieldType fieldType = context.getFieldType(fieldName);
Nested nested = nested(context, fieldType);
if (fieldType == null) {
fieldType = resolveUnmappedType(context);
}
IndexFieldData fieldData = context.getForField(fieldType, MappedFieldType.FielddataOperation.SEARCH);
if (fieldData instanceof IndexNumericFieldData == false
&& (sortMode == SortMode.SUM || sortMode == SortMode.AVG || sortMode == SortMode.MEDIAN)) {
throw new QueryShardException(context, "we only support AVG, MEDIAN and SUM on number based fields");
}
final SortField field;
boolean isNanosecond = false;
if (numericType != null) {
if (fieldData instanceof IndexNumericFieldData == false) {
throw new QueryShardException(
context,
"[numeric_type] option cannot be set on a non-numeric field, got " + fieldType.typeName()
);
}
IndexNumericFieldData numericFieldData = (IndexNumericFieldData) fieldData;
NumericType resolvedType = resolveNumericType(numericType);
field = numericFieldData.sortField(resolvedType, missing, localSortMode(), nested, reverse);
isNanosecond = resolvedType == NumericType.DATE_NANOSECONDS;
} else {
field = fieldData.sortField(missing, localSortMode(), nested, reverse);
if (fieldData instanceof IndexNumericFieldData) {
isNanosecond = ((IndexNumericFieldData) fieldData).getNumericType() == NumericType.DATE_NANOSECONDS;
}
}
DocValueFormat formatter = fieldType.docValueFormat(format, null);
if (format != null) {
formatter = DocValueFormat.enableFormatSortValues(formatter);
}
if (isNanosecond) {
formatter = DocValueFormat.withNanosecondResolution(formatter);
}
return new SortFieldAndFormat(field, formatter);
}
public boolean canRewriteToMatchNone() {
return nestedSort == null && (missing == null || "_last".equals(missing));
}
/**
* Returns whether some values of the given {@link SearchExecutionContext#getIndexReader()} are within the
* primary sort value provided in the bottomSortValues.
*/
public boolean isBottomSortShardDisjoint(SearchExecutionContext context, SearchSortValuesAndFormats bottomSortValues)
throws IOException {
if (bottomSortValues == null || bottomSortValues.getRawSortValues().length == 0) {
return false;
}
if (canRewriteToMatchNone() == false) {
return false;
}
MappedFieldType fieldType = context.getFieldType(fieldName);
if (fieldType == null) {
// unmapped
return false;
}
if (fieldType.isIndexed() == false) {
return false;
}
DocValueFormat docValueFormat = bottomSortValues.getSortValueFormats()[0];
final DateMathParser dateMathParser;
if (docValueFormat instanceof DocValueFormat.DateTime) {
dateMathParser = ((DocValueFormat.DateTime) docValueFormat).getDateMathParser();
} else {
dateMathParser = null;
}
Object bottomSortValue = bottomSortValues.getFormattedSortValues()[0];
Object minValue = order() == SortOrder.DESC ? bottomSortValue : null;
Object maxValue = order() == SortOrder.DESC ? null : bottomSortValue;
try {
MappedFieldType.Relation relation = fieldType.isFieldWithinQuery(
context.getIndexReader(),
minValue,
maxValue,
true,
true,
null,
dateMathParser,
context
);
return relation == MappedFieldType.Relation.DISJOINT;
} catch (ElasticsearchParseException exc) {
// can happen if the sort field is mapped differently in another search index
return false;
}
}
@Override
public BucketedSort buildBucketedSort(SearchExecutionContext context, BigArrays bigArrays, int bucketSize, BucketedSort.ExtraData extra)
throws IOException {
if (DOC_FIELD_NAME.equals(fieldName)) {
throw new IllegalArgumentException("sorting by _doc is not supported");
}
MappedFieldType fieldType = context.getFieldType(fieldName);
Nested nested = nested(context, fieldType);
if (fieldType == null) {
fieldType = resolveUnmappedType(context);
}
IndexFieldData fieldData = context.getForField(fieldType, MappedFieldType.FielddataOperation.SEARCH);
if (fieldData instanceof IndexNumericFieldData == false
&& (sortMode == SortMode.SUM || sortMode == SortMode.AVG || sortMode == SortMode.MEDIAN)) {
throw new QueryShardException(context, "we only support AVG, MEDIAN and SUM on number based fields");
}
if (numericType != null) {
if (fieldData instanceof IndexNumericFieldData == false) {
throw new QueryShardException(
context,
"[numeric_type] option cannot be set on a non-numeric field, got " + fieldType.typeName()
);
}
IndexNumericFieldData numericFieldData = (IndexNumericFieldData) fieldData;
NumericType resolvedType = resolveNumericType(numericType);
return numericFieldData.newBucketedSort(
resolvedType,
bigArrays,
missing,
localSortMode(),
nested,
order,
fieldType.docValueFormat(null, null),
bucketSize,
extra
);
}
try {
return fieldData.newBucketedSort(
bigArrays,
missing,
localSortMode(),
nested,
order,
fieldType.docValueFormat(null, null),
bucketSize,
extra
);
} catch (IllegalArgumentException e) {
throw new IllegalArgumentException(
"error building sort for field ["
+ fieldName
+ "] of type ["
+ fieldType.typeName()
+ "] in index ["
+ context.index().getName()
+ "]: "
+ e.getMessage(),
e
);
}
}
private MappedFieldType resolveUnmappedType(SearchExecutionContext context) {
if (unmappedType == null) {
throw new QueryShardException(context, "No mapping found for [" + fieldName + "] in order to sort on");
}
return context.buildAnonymousFieldType(unmappedType);
}
private MultiValueMode localSortMode() {
if (sortMode != null) {
return MultiValueMode.fromString(sortMode.toString());
}
return order == SortOrder.DESC ? MultiValueMode.MAX : MultiValueMode.MIN;
}
private Nested nested(SearchExecutionContext context, MappedFieldType fieldType) throws IOException {
if (fieldType == null) {
return null;
}
if (nestedSort == null) {
validateMissingNestedPath(context, fieldName);
return null;
}
validateMaxChildrenExistOnlyInTopLevelNestedSort(context, nestedSort);
return resolveNested(context, nestedSort);
}
/**
* Return true if the primary sort in the provided source
* is an instance of {@link FieldSortBuilder}.
*/
public static boolean hasPrimaryFieldSort(SearchSourceBuilder source) {
return getPrimaryFieldSortOrNull(source) != null;
}
/**
* Return the {@link FieldSortBuilder} if the primary sort in the provided source
* is an instance of this class, null otherwise.
*/
public static FieldSortBuilder getPrimaryFieldSortOrNull(SearchSourceBuilder source) {
if (source == null || source.sorts() == null || source.sorts().isEmpty()) {
return null;
}
return source.sorts().get(0) instanceof FieldSortBuilder ? (FieldSortBuilder) source.sorts().get(0) : null;
}
/**
* Return the {@link MinAndMax} indexed value from the provided {@link FieldSortBuilder} or null if unknown.
* The value can be extracted on non-nested indexed mapped fields of type keyword, numeric or date, other fields
* and configurations return null.
*/
public static MinAndMax getMinMaxOrNull(SearchExecutionContext context, FieldSortBuilder sortBuilder) throws IOException {
SortAndFormats sort = SortBuilder.buildSort(Collections.singletonList(sortBuilder), context).get();
SortField sortField = sort.sort.getSort()[0];
if (sortField.getField() == null) {
return null;
}
IndexReader reader = context.getIndexReader();
MappedFieldType fieldType = context.getFieldType(sortField.getField());
if (reader == null || (fieldType == null || fieldType.isIndexed() == false)) {
return null;
}
switch (IndexSortConfig.getSortFieldType(sortField)) {
case LONG:
case INT:
case DOUBLE:
case FLOAT:
return extractNumericMinAndMax(reader, sortField, fieldType, sortBuilder);
case STRING:
case STRING_VAL:
if (fieldType instanceof KeywordFieldMapper.KeywordFieldType) {
Terms terms = MultiTerms.getTerms(reader, fieldType.name());
if (terms == null) {
return null;
}
return terms.getMin() != null ? new MinAndMax<>(terms.getMin(), terms.getMax()) : null;
}
break;
}
return null;
}
private static MinAndMax extractNumericMinAndMax(
IndexReader reader,
SortField sortField,
MappedFieldType fieldType,
FieldSortBuilder sortBuilder
) throws IOException {
String fieldName = fieldType.name();
byte[] minPackedValue = PointValues.getMinPackedValue(reader, fieldName);
if (minPackedValue == null) {
return null;
}
if (fieldType instanceof NumberFieldType numberFieldType) {
Number minPoint = numberFieldType.parsePoint(minPackedValue);
Number maxPoint = numberFieldType.parsePoint(PointValues.getMaxPackedValue(reader, fieldName));
return switch (IndexSortConfig.getSortFieldType(sortField)) {
case LONG -> new MinAndMax<>(minPoint.longValue(), maxPoint.longValue());
case INT -> new MinAndMax<>(minPoint.intValue(), maxPoint.intValue());
case DOUBLE -> new MinAndMax<>(minPoint.doubleValue(), maxPoint.doubleValue());
case FLOAT -> new MinAndMax<>(minPoint.floatValue(), maxPoint.floatValue());
default -> null;
};
} else if (fieldType instanceof DateFieldType dateFieldType) {
Function dateConverter = createDateConverter(sortBuilder, dateFieldType);
Long min = dateConverter.apply(minPackedValue);
Long max = dateConverter.apply(PointValues.getMaxPackedValue(reader, fieldName));
return new MinAndMax<>(min, max);
}
return null;
}
private static Function createDateConverter(FieldSortBuilder sortBuilder, DateFieldType dateFieldType) {
String numericTypeStr = sortBuilder.getNumericType();
if (numericTypeStr != null) {
NumericType numericType = resolveNumericType(numericTypeStr);
if (dateFieldType.resolution() == MILLISECONDS && numericType == NumericType.DATE_NANOSECONDS) {
return v -> DateUtils.toNanoSeconds(LongPoint.decodeDimension(v, 0));
} else if (dateFieldType.resolution() == NANOSECONDS && numericType == NumericType.DATE) {
return v -> DateUtils.toMilliSeconds(LongPoint.decodeDimension(v, 0));
}
}
return v -> LongPoint.decodeDimension(v, 0);
}
/**
* Throws an exception if max children is not located at top level nested sort.
*/
static void validateMaxChildrenExistOnlyInTopLevelNestedSort(SearchExecutionContext context, NestedSortBuilder nestedSort) {
for (NestedSortBuilder child = nestedSort.getNestedSort(); child != null; child = child.getNestedSort()) {
if (child.getMaxChildren() != Integer.MAX_VALUE) {
throw new QueryShardException(context, "max_children is only supported on top level of nested sort");
}
}
}
/**
* Throws an exception if the provided field requires a nested context.
*/
static void validateMissingNestedPath(SearchExecutionContext context, String field) {
NestedObjectMapper contextMapper = context.nestedScope().getObjectMapper();
if (contextMapper != null) {
// already in nested context
return;
}
NestedLookup nestedLookup = context.nestedLookup();
String nestedParent = nestedLookup.getNestedParent(field);
if (nestedParent != null && nestedLookup.getNestedMappers().get(nestedParent).isIncludeInRoot() == false) {
throw new QueryShardException(
context,
"it is mandatory to set the [nested] context on the nested sort field: [" + field + "]."
);
}
}
@Override
public boolean equals(Object other) {
if (this == other) {
return true;
}
if (other == null || getClass() != other.getClass()) {
return false;
}
FieldSortBuilder builder = (FieldSortBuilder) other;
return (Objects.equals(this.fieldName, builder.fieldName)
&& Objects.equals(this.missing, builder.missing)
&& Objects.equals(this.order, builder.order)
&& Objects.equals(this.sortMode, builder.sortMode)
&& Objects.equals(this.unmappedType, builder.unmappedType)
&& Objects.equals(this.nestedSort, builder.nestedSort))
&& Objects.equals(this.numericType, builder.numericType)
&& Objects.equals(this.format, builder.format);
}
@Override
public int hashCode() {
return Objects.hash(
this.fieldName,
this.nestedSort,
this.missing,
this.order,
this.sortMode,
this.unmappedType,
this.numericType,
this.format
);
}
@Override
public String getWriteableName() {
return NAME;
}
@Override
public Version getMinimalSupportedVersion() {
return Version.V_EMPTY;
}
/**
* Creates a new {@link FieldSortBuilder} from the query held by the {@link XContentParser} in
* {@link org.elasticsearch.xcontent.XContent} format.
*
* @param parser the input parser. The state on the parser contained in this context will be changed as a side effect of this
* method call
* @param fieldName in some sort syntax variations the field name precedes the xContent object that specifies further parameters, e.g.
* in '{ "foo": { "order" : "asc"} }'. When parsing the inner object, the field name can be passed in via this argument
*/
public static FieldSortBuilder fromXContent(XContentParser parser, String fieldName) throws IOException {
return PARSER.parse(parser, new FieldSortBuilder(fieldName), null);
}
private static final ObjectParser PARSER = new ObjectParser<>(NAME);
static {
PARSER.declareField(FieldSortBuilder::missing, XContentParser::objectText, MISSING, ValueType.VALUE);
PARSER.declareString(FieldSortBuilder::unmappedType, UNMAPPED_TYPE);
PARSER.declareString((b, v) -> b.order(SortOrder.fromString(v)), ORDER_FIELD);
PARSER.declareString((b, v) -> b.sortMode(SortMode.fromString(v)), SORT_MODE);
PARSER.declareObject(FieldSortBuilder::setNestedSort, (p, c) -> NestedSortBuilder.fromXContent(p), NESTED_FIELD);
PARSER.declareString(FieldSortBuilder::setNumericType, NUMERIC_TYPE);
PARSER.declareString(FieldSortBuilder::setFormat, FORMAT);
PARSER.declareField(
(b, v) -> {},
(p, c) -> {
throw new ParsingException(p.getTokenLocation(), "[nested_path] has been removed in favour of the [nested] parameter", c);
},
NESTED_PATH_FIELD,
ValueType.STRING
);
PARSER.declareObject(
(b, v) -> {},
(p, c) -> {
throw new ParsingException(p.getTokenLocation(), "[nested_filter] has been removed in favour of the [nested] parameter", c);
},
NESTED_FILTER_FIELD
);
}
@Override
public FieldSortBuilder rewrite(QueryRewriteContext ctx) throws IOException {
if (nestedSort == null) {
return this;
}
NestedSortBuilder rewrite = nestedSort.rewrite(ctx);
if (nestedSort == rewrite) {
return this;
}
return new FieldSortBuilder(this).setNestedSort(rewrite);
}
}