OpenSearch/docs/java-api
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
..
admin Make sure to use the type _doc in the REST documentation. (#34662) 2018-10-22 11:54:04 -07:00
aggregations [7.x Backport] Force selection of calendar or fixed intervals (#41906) 2019-05-20 12:07:29 -04:00
docs Docs: Drop inline callouts from the java API (#39932) (#40693) 2019-04-01 13:02:23 -04:00
query-dsl [DOCS] Fix deprecation notification (#40980) 2019-04-08 11:38:55 -07:00
aggs.asciidoc [7.x Backport] Force selection of calendar or fixed intervals (#41906) 2019-05-20 12:07:29 -04:00
client.asciidoc Deprecate the transport client in favour of the high-level REST client (#27085) 2017-12-01 12:24:16 +01:00
docs.asciidoc Added minimal docs for reindex api in java-api docs 2018-03-16 07:42:48 +01:00
index.asciidoc Provide names for all artifact repositories (#41857) 2019-05-07 06:35:28 -04:00
query-dsl.asciidoc Build that java api docs from a test (#24354) 2017-05-02 13:00:56 -04:00
search.asciidoc [7.x Backport] Force selection of calendar or fixed intervals (#41906) 2019-05-20 12:07:29 -04:00