honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Docs: Remove the 'Factor' paragraph to reflect #6490 

The current implementation of 'date_histogram' does not understand
the `factor` parameter. Since the docs shouldn't raise false hopes,
I removed the section.

Closes #7277
This commit is contained in:
Konrad Feldmeier 2014-08-14 11:58:36 +02:00 committed by Clinton Gormley
parent bf8c4f1155
commit 3b3e2ed5e9
1 changed files with 1 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/reference/search/aggregations/bucket/datehistogram-aggregation.asciidoc
View File

@ -69,14 +69,6 @@ set `pre_zone_adjust_large_interval` to `true`, which will apply the same conver
example, to day and above intervals (it can be set regardless of the interval, but only kick in when using day and
higher intervals).
==== Factor
The date histogram works on numeric values (since time is stored in milliseconds since the epoch in UTC). But,
sometimes, systems will store a different resolution (like seconds since UTC) in a numeric field. The `factor`
parameter can be used to change the value in the field to milliseconds to actual do the relevant rounding, and then
be applied again to get to the original unit. For example, when storing in a numeric field seconds resolution, the
factor can be set to 1000.
==== Pre/Post Offset
Specific offsets can be provided for pre rounding and post rounding. The `pre_offset` for pre rounding, and
@ -135,4 +127,4 @@ value level scripts are supported. It is also possible to control the order of t
settings and filter the returned buckets based on a `min_doc_count` setting (by defaults to all buckets with
`min_doc_count > 0` will be returned). This histogram also supports the `extended_bounds` settings, that enables extending
the bounds of the histogram beyond the data itself (to read more on why you'd want to do that please refer to the
explanation <<search-aggregations-bucket-histogram-aggregation-extended-bounds,here>>.
explanation <<search-aggregations-bucket-histogram-aggregation-extended-bounds,here>>.