-
Notifications
You must be signed in to change notification settings - Fork 25.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Aggregations: bucket_sort pipeline aggregation (#27152)
This commit adds a parent pipeline aggregation that allows sorting the buckets of a parent multi-bucket aggregation. The aggregation also offers [from] and [size] parameters in order to truncate the result as desired. Closes #14928
- Loading branch information
1 parent
d22fd4e
commit 66bef26
Showing
9 changed files
with
1,112 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
195 changes: 195 additions & 0 deletions
195
...csearch/search/aggregations/pipeline/bucketsort/BucketSortPipelineAggregationBuilder.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,195 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package org.elasticsearch.search.aggregations.pipeline.bucketsort; | ||
|
|
||
| import org.elasticsearch.common.ParseField; | ||
| import org.elasticsearch.common.io.stream.StreamInput; | ||
| import org.elasticsearch.common.io.stream.StreamOutput; | ||
| import org.elasticsearch.common.xcontent.ConstructingObjectParser; | ||
| import org.elasticsearch.common.xcontent.ObjectParser; | ||
| import org.elasticsearch.common.xcontent.XContentBuilder; | ||
| import org.elasticsearch.common.xcontent.XContentParser; | ||
| import org.elasticsearch.search.aggregations.AggregationBuilder; | ||
| import org.elasticsearch.search.aggregations.AggregatorFactory; | ||
| import org.elasticsearch.search.aggregations.PipelineAggregationBuilder; | ||
| import org.elasticsearch.search.aggregations.pipeline.AbstractPipelineAggregationBuilder; | ||
| import org.elasticsearch.search.aggregations.pipeline.BucketHelpers.GapPolicy; | ||
| import org.elasticsearch.search.aggregations.pipeline.PipelineAggregator; | ||
| import org.elasticsearch.search.builder.SearchSourceBuilder; | ||
| import org.elasticsearch.search.sort.FieldSortBuilder; | ||
| import org.elasticsearch.search.sort.SortBuilder; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.ArrayList; | ||
| import java.util.Arrays; | ||
| import java.util.Collections; | ||
| import java.util.List; | ||
| import java.util.Locale; | ||
| import java.util.Map; | ||
| import java.util.Objects; | ||
|
|
||
| import static org.elasticsearch.common.xcontent.ConstructingObjectParser.optionalConstructorArg; | ||
| import static org.elasticsearch.search.aggregations.pipeline.PipelineAggregator.Parser.GAP_POLICY; | ||
|
|
||
| /** | ||
| * Builds a pipeline aggregation that allows sorting the buckets of its parent | ||
| * aggregation. The bucket {@code _key}, {@code _count} or sub-aggregations may be used as sort | ||
| * keys. Parameters {@code from} and {@code size} may also be set in order to truncate the | ||
| * result bucket list. | ||
| */ | ||
| public class BucketSortPipelineAggregationBuilder extends AbstractPipelineAggregationBuilder<BucketSortPipelineAggregationBuilder> { | ||
| public static final String NAME = "bucket_sort"; | ||
|
|
||
| private static final ParseField FROM = new ParseField("from"); | ||
| private static final ParseField SIZE = new ParseField("size"); | ||
|
|
||
| public static final ConstructingObjectParser<BucketSortPipelineAggregationBuilder, String> PARSER = new ConstructingObjectParser<>(NAME, | ||
| false, (a, context) -> new BucketSortPipelineAggregationBuilder(context, (List<FieldSortBuilder>) a[0])); | ||
|
|
||
| static { | ||
| PARSER.declareField(optionalConstructorArg(), (p, c) -> { | ||
| List<SortBuilder<?>> sorts = SortBuilder.fromXContent(p); | ||
| List<FieldSortBuilder> fieldSorts = new ArrayList<>(sorts.size()); | ||
| for (SortBuilder<?> sort : sorts) { | ||
| if (sort instanceof FieldSortBuilder == false) { | ||
| throw new IllegalArgumentException("[" + NAME + "] only supports field based sorting; incompatible sort: [" | ||
| + sort + "]"); | ||
| } | ||
| fieldSorts.add((FieldSortBuilder) sort); | ||
| } | ||
| return fieldSorts; | ||
| }, SearchSourceBuilder.SORT_FIELD, | ||
| ObjectParser.ValueType.OBJECT_ARRAY); | ||
| PARSER.declareInt(BucketSortPipelineAggregationBuilder::from, FROM); | ||
| PARSER.declareInt(BucketSortPipelineAggregationBuilder::size, SIZE); | ||
| PARSER.declareField(BucketSortPipelineAggregationBuilder::gapPolicy, p -> { | ||
| if (p.currentToken() == XContentParser.Token.VALUE_STRING) { | ||
| return GapPolicy.parse(p.text().toLowerCase(Locale.ROOT), p.getTokenLocation()); | ||
| } | ||
| throw new IllegalArgumentException("Unsupported token [" + p.currentToken() + "]"); | ||
| }, GAP_POLICY, ObjectParser.ValueType.STRING); | ||
| } | ||
|
|
||
| private List<FieldSortBuilder> sorts = Collections.emptyList(); | ||
| private int from = 0; | ||
| private Integer size; | ||
| private GapPolicy gapPolicy = GapPolicy.SKIP; | ||
|
|
||
| public BucketSortPipelineAggregationBuilder(String name, List<FieldSortBuilder> sorts) { | ||
| super(name, NAME, sorts == null ? new String[0] : sorts.stream().map(s -> s.getFieldName()).toArray(String[]::new)); | ||
| this.sorts = sorts == null ? Collections.emptyList() : sorts; | ||
| } | ||
|
|
||
| /** | ||
| * Read from a stream. | ||
| */ | ||
| public BucketSortPipelineAggregationBuilder(StreamInput in) throws IOException { | ||
| super(in, NAME); | ||
| sorts = in.readList(FieldSortBuilder::new); | ||
| from = in.readVInt(); | ||
| size = in.readOptionalVInt(); | ||
| gapPolicy = GapPolicy.readFrom(in); | ||
| } | ||
|
|
||
| @Override | ||
| protected void doWriteTo(StreamOutput out) throws IOException { | ||
| out.writeList(sorts); | ||
| out.writeVInt(from); | ||
| out.writeOptionalVInt(size); | ||
| gapPolicy.writeTo(out); | ||
| } | ||
|
|
||
| public BucketSortPipelineAggregationBuilder from(int from) { | ||
| if (from < 0) { | ||
| throw new IllegalArgumentException("[" + FROM.getPreferredName() + "] must be a non-negative integer: [" + from + "]"); | ||
| } | ||
| this.from = from; | ||
| return this; | ||
| } | ||
|
|
||
| public BucketSortPipelineAggregationBuilder size(Integer size) { | ||
| if (size != null && size <= 0) { | ||
| throw new IllegalArgumentException("[" + SIZE.getPreferredName() + "] must be a positive integer: [" + size + "]"); | ||
| } | ||
| this.size = size; | ||
| return this; | ||
| } | ||
|
|
||
| public BucketSortPipelineAggregationBuilder gapPolicy(GapPolicy gapPolicy) { | ||
| if (gapPolicy == null) { | ||
| throw new IllegalArgumentException("[" + GAP_POLICY.getPreferredName() + "] must not be null: [" + name + "]"); | ||
| } | ||
| this.gapPolicy = gapPolicy; | ||
| return this; | ||
| } | ||
|
|
||
| @Override | ||
| protected PipelineAggregator createInternal(Map<String, Object> metaData) throws IOException { | ||
| return new BucketSortPipelineAggregator(name, sorts, from, size, gapPolicy, metaData); | ||
| } | ||
|
|
||
| @Override | ||
| public void doValidate(AggregatorFactory<?> parent, List<AggregationBuilder> aggFactories, | ||
| List<PipelineAggregationBuilder> pipelineAggregatoractories) { | ||
| if (sorts.isEmpty() && size == null && from == 0) { | ||
| throw new IllegalStateException("[" + name + "] is configured to perform nothing. Please set either of " | ||
| + Arrays.asList(SearchSourceBuilder.SORT_FIELD.getPreferredName(), SIZE.getPreferredName(), FROM.getPreferredName()) | ||
| + " to use " + NAME); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| protected XContentBuilder internalXContent(XContentBuilder builder, Params params) throws IOException { | ||
| builder.field(SearchSourceBuilder.SORT_FIELD.getPreferredName(), sorts); | ||
| builder.field(FROM.getPreferredName(), from); | ||
| if (size != null) { | ||
| builder.field(SIZE.getPreferredName(), size); | ||
| } | ||
| builder.field(GAP_POLICY.getPreferredName(), gapPolicy); | ||
| return builder; | ||
| } | ||
|
|
||
| public static BucketSortPipelineAggregationBuilder parse(String reducerName, XContentParser parser) throws IOException { | ||
| return PARSER.parse(parser, reducerName); | ||
| } | ||
|
|
||
| @Override | ||
| protected boolean overrideBucketsPath() { | ||
| return true; | ||
| } | ||
|
|
||
| @Override | ||
| protected int doHashCode() { | ||
| return Objects.hash(sorts, from, size, gapPolicy); | ||
| } | ||
|
|
||
| @Override | ||
| protected boolean doEquals(Object obj) { | ||
| BucketSortPipelineAggregationBuilder other = (BucketSortPipelineAggregationBuilder) obj; | ||
| return Objects.equals(sorts, other.sorts) | ||
| && Objects.equals(from, other.from) | ||
| && Objects.equals(size, other.size) | ||
| && Objects.equals(gapPolicy, other.gapPolicy); | ||
| } | ||
|
|
||
| @Override | ||
| public String getWriteableName() { | ||
| return NAME; | ||
| } | ||
| } |
Oops, something went wrong.