Skip to content

Improve listing of index mode options in docs #127155

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 24, 2025
Merged

Improve listing of index mode options in docs #127155

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5ee8fee
List index mode options in docs
ioanatia Apr 22, 2025
c88c65a
fix indentation, add formatting, link etc.
leemthompo Apr 23, 2025
90864a1
fix link syntax
leemthompo Apr 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 21 additions & 33 deletions docs/reference/elasticsearch/index-settings/index-modules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,39 +49,27 @@ $$$index-codec$$$ `index.codec`

$$$index-mode-setting$$$ `index.mode`
: 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.

```console
PUT my-index-000001
{
"settings": {
"index":{
"mode":"standard" <1>
}
}
}
```

1. This index uses the `standard` index mode


Index mode supports the following values:

`null`
: Default value (same as `standard`).

`standard`
: Standard indexing with default settings.

`lookup`
: Index that can be used for lookup joins in ES|QL. Limited to 1 shard.


`time_series`
: *(data streams only)* Index mode optimized for storage of metrics. For more information, see [Time series index settings](time-series.md).

`logsdb`
: *(data streams only)* Index mode optimized for [logs](docs-content://manage-data/data-store/data-streams/logs-data-stream.md).


**Example**

```console
PUT my-index-000001
{
"settings": {
"index":{
"mode":"standard" # This index uses the `standard` index mode
}
}
}
```
**Supported values**

The `index.mode` setting supports the following values:
- `null`: Default value (same as `standard`).
- `standard`: Standard indexing with default settings.
- `lookup`: Index that can be used for [LOOKUP JOIN](/reference/query-languages/esql/esql-lookup-join.md) in ES|QL. Limited to 1 shard.
- `time_series`: *(data streams only)* Index mode optimized for storage of metrics. For more information, see [Time series index settings](time-series.md).
- `logsdb`: *(data streams only)* Index mode optimized for [logs](docs-content://manage-data/data-store/data-streams/logs-data-stream.md).

$$$routing-partition-size$$$ `index.routing_partition_size`
: 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).
Expand Down
Loading