mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-08 22:14:59 +00:00
e7d352b489
This commit adds support for histogram and date_histogram agg compound order by refactoring and reusing terms agg order code. The major change is that the Terms.Order and Histogram.Order classes have been replaced/refactored into a new class BucketOrder. This is a breaking change for the Java Transport API. For backward compatibility with previous ES versions the (date)histogram compound order will use the first order. Also the _term and _time aggregation order keys have been deprecated; replaced by _key. Relates to #20003: now that all these aggregations use the same order code, it should be easier to move validation to parse time (as a follow up PR). Relates to #14771: histogram and date_histogram aggregation order will now be validated at reduce time. Closes #23613: if a single BucketOrder that is not a tie-breaker is added with the Java Transport API, it will be converted into a CompoundOrder with a tie-breaker.
74 lines
2.4 KiB
Plaintext
74 lines
2.4 KiB
Plaintext
[[java-aggs-bucket-datehistogram]]
|
|
==== Date Histogram Aggregation
|
|
|
|
Here is how you can use
|
|
{ref}/search-aggregations-bucket-datehistogram-aggregation.html[Date Histogram Aggregation]
|
|
with Java API.
|
|
|
|
|
|
===== Prepare aggregation request
|
|
|
|
Here is an example on how to create the aggregation request:
|
|
|
|
[source,java]
|
|
--------------------------------------------------
|
|
AggregationBuilder aggregation =
|
|
AggregationBuilders
|
|
.dateHistogram("agg")
|
|
.field("dateOfBirth")
|
|
.dateHistogramInterval(DateHistogramInterval.YEAR);
|
|
--------------------------------------------------
|
|
|
|
Or if you want to set an interval of 10 days:
|
|
|
|
[source,java]
|
|
--------------------------------------------------
|
|
AggregationBuilder aggregation =
|
|
AggregationBuilders
|
|
.dateHistogram("agg")
|
|
.field("dateOfBirth")
|
|
.dateHistogramInterval(DateHistogramInterval.days(10));
|
|
--------------------------------------------------
|
|
|
|
|
|
===== Use aggregation response
|
|
|
|
Import Aggregation definition classes:
|
|
|
|
[source,java]
|
|
--------------------------------------------------
|
|
import org.elasticsearch.search.aggregations.bucket.histogram.Histogram;
|
|
--------------------------------------------------
|
|
|
|
[source,java]
|
|
--------------------------------------------------
|
|
// sr is here your SearchResponse object
|
|
Histogram agg = sr.getAggregations().get("agg");
|
|
|
|
// For each entry
|
|
for (Histogram.Bucket entry : agg.getBuckets()) {
|
|
DateTime key = (DateTime) entry.getKey(); // Key
|
|
String keyAsString = entry.getKeyAsString(); // Key as String
|
|
long docCount = entry.getDocCount(); // Doc count
|
|
|
|
logger.info("key [{}], date [{}], doc_count [{}]", keyAsString, key.getYear(), docCount);
|
|
}
|
|
--------------------------------------------------
|
|
|
|
This will basically produce for the first example:
|
|
|
|
[source,text]
|
|
--------------------------------------------------
|
|
key [1942-01-01T00:00:00.000Z], date [1942], doc_count [1]
|
|
key [1945-01-01T00:00:00.000Z], date [1945], doc_count [1]
|
|
key [1946-01-01T00:00:00.000Z], date [1946], doc_count [1]
|
|
...
|
|
key [2005-01-01T00:00:00.000Z], date [2005], doc_count [1]
|
|
key [2007-01-01T00:00:00.000Z], date [2007], doc_count [2]
|
|
key [2008-01-01T00:00:00.000Z], date [2008], doc_count [3]
|
|
--------------------------------------------------
|
|
|
|
===== Order
|
|
|
|
Supports the same order functionality as the <<java-aggs-bucket-terms,`Terms Aggregation`>>.
|