diff --git a/docs/reference/index-modules.asciidoc b/docs/reference/index-modules.asciidoc index 4f31b7f7c3d1f..5c721311afeb5 100644 --- a/docs/reference/index-modules.asciidoc +++ b/docs/reference/index-modules.asciidoc @@ -334,7 +334,8 @@ pipeline attempts to change the `_index` field, the indexing request will fail. For internal use by Elastic only. Maximum number of time series dimensions for the index. Defaults to `16`. + -You can mark a field as a dimension using the `dimension` mapping parameter. +You can mark a field as a dimension using the `time_series_dimension` mapping +parameter. [[index-hidden]] `index.hidden`:: diff --git a/docs/reference/mapping/types/aggregate-metric-double.asciidoc b/docs/reference/mapping/types/aggregate-metric-double.asciidoc index cc359fddbbc03..3cbd140afee19 100644 --- a/docs/reference/mapping/types/aggregate-metric-double.asciidoc +++ b/docs/reference/mapping/types/aggregate-metric-double.asciidoc @@ -57,6 +57,11 @@ specify at least one value. Default metric sub-field to use for queries, scripts, and aggregations that don't use a sub-field. Must be a value from the `metrics` array. +include::numeric.asciidoc[tag=time_series_metric] ++ +For `aggregate_metric_double` fields, this parameter accepts `counter`, `gauge`, +and `summary`. You can't update this parameter for existing fields. + [[aggregate-metric-double-uses]] ==== Uses diff --git a/docs/reference/mapping/types/histogram.asciidoc b/docs/reference/mapping/types/histogram.asciidoc index 0e4b56df53e01..8d76a864fd33b 100644 --- a/docs/reference/mapping/types/histogram.asciidoc +++ b/docs/reference/mapping/types/histogram.asciidoc @@ -24,6 +24,14 @@ per document. Nested arrays are not supported. * `histogram` fields do not support sorting. ======== +[[histogram-params]] +==== Parameters + +include::numeric.asciidoc[tag=time_series_metric] ++ +For `histogram` fields, this parameter accepts `histogram`. You can't update +this parameter for existing fields. + [[histogram-uses]] ==== Uses diff --git a/docs/reference/mapping/types/ip.asciidoc b/docs/reference/mapping/types/ip.asciidoc index 173f27df08ce5..9981da4318773 100644 --- a/docs/reference/mapping/types/ip.asciidoc +++ b/docs/reference/mapping/types/ip.asciidoc @@ -43,10 +43,6 @@ NOTE: You can also store ip ranges in a single field using an <>:: Should the field be stored on disk in a column-stride fashion, so that it @@ -95,6 +91,8 @@ include::keyword.asciidoc[tag=dimension] the <> field. Accepts `true` or `false` (default). +include::keyword.asciidoc[tag=dimension] + [[query-ip-fields]] ==== Querying `ip` fields diff --git a/docs/reference/mapping/types/keyword.asciidoc b/docs/reference/mapping/types/keyword.asciidoc index 15852f8a7daff..e25de411891ce 100644 --- a/docs/reference/mapping/types/keyword.asciidoc +++ b/docs/reference/mapping/types/keyword.asciidoc @@ -54,24 +54,6 @@ include::numeric.asciidoc[tag=map-ids-as-keyword] The following parameters are accepted by `keyword` fields: -[horizontal] - -// tag::dimension[] -`dimension`:: -For internal use by Elastic only. Marks the field as a time series dimension. -Accepts `true` or `false` (default). -+ -The <> -index setting limits the number of dimensions in an index. -+ -Dimension fields have the following constraints: -+ -* The `doc_values` and `index` mapping parameters must be `true`. -* Field values cannot be an <>. -// end::dimension[] -* Field values cannot be larger than 1024 bytes. -* The field cannot use a <>. - <>:: Should the field be stored on disk in a column-stride fashion, so that it @@ -107,6 +89,10 @@ Dimension fields have the following constraints: Defaults to `docs` but can also be set to `freqs` to take term frequency into account when computing scores. +<>:: + + Metadata about the field. + <>:: Whether field-length should be taken into account when scoring queries. @@ -161,9 +147,21 @@ Dimension fields have the following constraints: when building a query for this field. Accepts `true` or `false` (default). -<>:: - - Metadata about the field. +// tag::dimension[] +`time_series_dimension`:: +(Optional, Boolean) For internal use by Elastic only. Marks the field as a time +series dimension. Defaults to `false`. ++ +The <> +index setting limits the number of dimensions in an index. ++ +Dimension fields have the following constraints: ++ +* The `doc_values` and `index` mapping parameters must be `true`. +* Field values cannot be an <>. +// end::dimension[] +* Field values cannot be larger than 1024 bytes. +* The field cannot use a <>. include::constant-keyword.asciidoc[] diff --git a/docs/reference/mapping/types/numeric.asciidoc b/docs/reference/mapping/types/numeric.asciidoc index 4b4be55a4947a..2beeca1079744 100644 --- a/docs/reference/mapping/types/numeric.asciidoc +++ b/docs/reference/mapping/types/numeric.asciidoc @@ -111,19 +111,12 @@ the data as both a `keyword` _and_ a numeric data type. The following parameters are accepted by numeric types: -[horizontal] - <>:: Try to convert strings to numbers and truncate fractions for integers. Accepts `true` (default) and `false`. Not applicable for `unsigned_long`. Note that this cannot be set if the `script` parameter is used. -include::keyword.asciidoc[tag=dimension] -+ -Of the numeric field types, only `byte`, `short`, `integer`, and `long` fields -support this parameter. - <>:: Should the field be stored on disk in a column-stride fashion, so that it @@ -140,6 +133,10 @@ support this parameter. Should the field be searchable? Accepts `true` (default) and `false`. +<>:: + + Metadata about the field. + <>:: Accepts a numeric value of the same `type` as the field which is @@ -173,9 +170,25 @@ support this parameter. the <> field. Accepts `true` or `false` (default). -<>:: - - Metadata about the field. +include::keyword.asciidoc[tag=dimension] ++ +Of the numeric field types, only `byte`, `short`, `integer`, `long`, and +`unsigned_long` fields support this parameter. ++ +A numeric field can't be both a time series dimension and a time series metric. + +// tag::time_series_metric[] +`time_series_metric`:: +(Optional, string) For internal use by Elastic only. Marks the field as a time +series metric. The value is the metric type. Defaults to `null` (Not a time +series metric). +// end::time_series_metric[] ++ +For numeric fields, this parameter accepts `gauge` and `counter`. You can't +update this parameter for existing fields. ++ +For a numeric time series metric, the `doc_values` parameter must be `true`. A +numeric field can't be both a time series dimension and a time series metric. [[scaled-float-params]] ==== Parameters for `scaled_float`