Skip to content

Commit a684e10

Browse files
authored
Improve listing of index mode options in docs (#127155)
1 parent db04c20 commit a684e10

File tree

1 file changed

+21
-33
lines changed

1 file changed

+21
-33
lines changed

docs/reference/elasticsearch/index-settings/index-modules.md

Lines changed: 21 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -49,39 +49,27 @@ $$$index-codec$$$ `index.codec`
4949

5050
$$$index-mode-setting$$$ `index.mode`
5151
: The `index.mode` setting is used to control settings applied in specific domains like ingestion of time series data or logs. Different mutually exclusive modes exist, which are used to apply settings or default values controlling indexing of documents, sorting and other parameters whose value affects indexing or query performance.
52-
53-
```console
54-
PUT my-index-000001
55-
{
56-
"settings": {
57-
"index":{
58-
"mode":"standard" <1>
59-
}
60-
}
61-
}
62-
```
63-
64-
1. This index uses the `standard` index mode
65-
66-
67-
Index mode supports the following values:
68-
69-
`null`
70-
: Default value (same as `standard`).
71-
72-
`standard`
73-
: Standard indexing with default settings.
74-
75-
`lookup`
76-
: Index that can be used for lookup joins in ES|QL. Limited to 1 shard.
77-
78-
79-
`time_series`
80-
: *(data streams only)* Index mode optimized for storage of metrics. For more information, see [Time series index settings](time-series.md).
81-
82-
`logsdb`
83-
: *(data streams only)* Index mode optimized for [logs](docs-content://manage-data/data-store/data-streams/logs-data-stream.md).
84-
52+
53+
**Example**
54+
55+
```console
56+
PUT my-index-000001
57+
{
58+
"settings": {
59+
"index":{
60+
"mode":"standard" # This index uses the `standard` index mode
61+
}
62+
}
63+
}
64+
```
65+
**Supported values**
66+
67+
The `index.mode` setting supports the following values:
68+
- `null`: Default value (same as `standard`).
69+
- `standard`: Standard indexing with default settings.
70+
- `lookup`: Index that can be used for [LOOKUP JOIN](/reference/query-languages/esql/esql-lookup-join.md) in ES|QL. Limited to 1 shard.
71+
- `time_series`: *(data streams only)* Index mode optimized for storage of metrics. For more information, see [Time series index settings](time-series.md).
72+
- `logsdb`: *(data streams only)* Index mode optimized for [logs](docs-content://manage-data/data-store/data-streams/logs-data-stream.md).
8573

8674
$$$routing-partition-size$$$ `index.routing_partition_size`
8775
: The number of shards a custom routing value can go to. Defaults to 1 and can only be set at index creation time. This value must be less than the `index.number_of_routing_shards` unless the `index.number_of_routing_shards` value is also 1. for more details about how this setting is used, refer to [](/reference/elasticsearch/mapping-reference/mapping-routing-field.md#routing-index-partition).

0 commit comments

Comments
 (0)