Skip to content

Commit 1f04319

Browse files
authored
[DOCS] Document time series dimension mapping parameters (#75414)
Changes: * Documents the `dimension` mapping parameter for `ip`, `keyword`, and `numeric` fields. * Documents the `index.mapping.dimension_fields.limit` index setting.
1 parent cee83f7 commit 1f04319

File tree

4 files changed

+30
-0
lines changed

4 files changed

+30
-0
lines changed

docs/reference/index-modules.asciidoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -329,6 +329,13 @@ Defaults to `*`, which matches all fields eligible for
329329
the default pipeline (if it exists). The special pipeline name `_none`
330330
indicates no ingest pipeline will run.
331331

332+
[[index-mapping-dimension-fields-limit]]
333+
`index.mapping.dimension_fields.limit`::
334+
For internal use by {kib} only. Maximum number of time series dimensions for the
335+
index. Defaults to `16`.
336+
+
337+
You can mark a field as a dimension using the `dimension` mapping parameter.
338+
332339
[discrete]
333340
=== Settings in other index modules
334341

docs/reference/mapping/types/ip.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ The following parameters are accepted by `ip` fields:
4545

4646
[horizontal]
4747

48+
include::keyword.asciidoc[tag=dimension]
49+
4850
<<doc-values,`doc_values`>>::
4951

5052
Should the field be stored on disk in a column-stride fashion, so that it

docs/reference/mapping/types/keyword.asciidoc

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,22 @@ The following parameters are accepted by `keyword` fields:
5656

5757
[horizontal]
5858

59+
// tag::dimension[]
60+
`dimension`::
61+
For internal use by {kib} only. Marks the field as a time series dimension.
62+
Accepts `true` or `false` (default).
63+
+
64+
The <<index-mapping-dimension-fields-limit,`index.mapping.dimension_fields.limit`>>
65+
index setting limits the number of dimensions in an index.
66+
+
67+
Dimension fields have the following constraints:
68+
+
69+
* The `doc_values` and `index` mapping parameters must be `true`.
70+
* Field values cannot be an <<array,array or multi-value>>.
71+
// end::dimension[]
72+
* Field values cannot be larger than 1024 bytes.
73+
* The field cannot use a <<normalizer,`normalizer`>>.
74+
5975
<<doc-values,`doc_values`>>::
6076

6177
Should the field be stored on disk in a column-stride fashion, so that it

docs/reference/mapping/types/numeric.asciidoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,11 @@ The following parameters are accepted by numeric types:
119119
Accepts `true` (default) and `false`. Not applicable for `unsigned_long`.
120120
Note that this cannot be set if the `script` parameter is used.
121121

122+
include::keyword.asciidoc[tag=dimension]
123+
+
124+
Of the numeric field types, only `byte`, `short`, `integer`, and `long` fields
125+
support this parameter.
126+
122127
<<doc-values,`doc_values`>>::
123128

124129
Should the field be stored on disk in a column-stride fashion, so that it

0 commit comments

Comments
 (0)