OpenSearch/docs/java-api/aggregations/bucket
Zachary Tong 6ae6f57d39
[7.x Backport] Force selection of calendar or fixed intervals (#41906)
The date_histogram accepts an interval which can be either a calendar
interval (DST-aware, leap seconds, arbitrary length of months, etc) or
fixed interval (strict multiples of SI units). Unfortunately this is inferred
by first trying to parse as a calendar interval, then falling back to fixed
if that fails.

This leads to confusing arrangement where `1d` == calendar, but
`2d` == fixed.  And if you want a day of fixed time, you have to
specify `24h` (e.g. the next smallest unit).  This arrangement is very
error-prone for users.

This PR adds `calendar_interval` and `fixed_interval` parameters to any
code that uses intervals (date_histogram, rollup, composite, datafeed, etc).
Calendar only accepts calendar intervals, fixed accepts any combination of
units (meaning `1d` can be used to specify `24h` in fixed time), and both
are mutually exclusive.

The old interval behavior is deprecated and will throw a deprecation warning.
It is also mutually exclusive with the two new parameters. In the future the
old dual-purpose interval will be removed.

The change applies to both REST and java clients.
2019-05-20 12:07:29 -04:00
..
children-aggregation.asciidoc Add parent-join module (#24638) 2017-05-12 15:58:06 +02:00
datehistogram-aggregation.asciidoc [7.x Backport] Force selection of calendar or fixed intervals (#41906) 2019-05-20 12:07:29 -04:00
daterange-aggregation.asciidoc [doc] fix outdated java api examples 2015-06-16 09:45:07 +02:00
filter-aggregation.asciidoc updated Java API docs with the changes due to aggregator refactoring 2016-02-15 10:34:29 +00:00
filters-aggregation.asciidoc Update Java documentation for 5.0 2016-11-28 17:33:40 +01:00
geodistance-aggregation.asciidoc updated Java API docs with the changes due to aggregator refactoring 2016-02-15 10:34:29 +00:00
geohashgrid-aggregation.asciidoc [doc] fix outdated java api examples 2015-06-16 09:45:07 +02:00
global-aggregation.asciidoc
histogram-aggregation.asciidoc Compound order for histogram aggregations. (#22343) 2017-05-11 18:06:26 +01:00
iprange-aggregation.asciidoc Modifies the JavaAPI docs related to AggregationBuilder 2018-01-11 12:59:30 +01:00
missing-aggregation.asciidoc
nested-aggregation.asciidoc updated Java API docs with the changes due to aggregator refactoring 2016-02-15 10:34:29 +00:00
range-aggregation.asciidoc [doc] fix outdated java api examples 2015-06-16 09:45:07 +02:00
reverse-nested-aggregation.asciidoc Update Java documentation for 5.0 2016-11-28 17:33:40 +01:00
significantterms-aggregation.asciidoc
terms-aggregation.asciidoc Compound order for histogram aggregations. (#22343) 2017-05-11 18:06:26 +01:00