Skip to content

Commit 1220278

Browse files
authored
Document index setting around source metadata field. (#127000) (#133063)
1 parent d8478f0 commit 1220278

File tree

2 files changed

+26
-1
lines changed

2 files changed

+26
-1
lines changed
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
mapped_pages:
3+
- https://www.elastic.co/guide/en/elasticsearch/reference/current/source-index-settings.html
4+
navigation_title: Source settings
5+
---
6+
7+
# Source index settings [source-index-settings]
8+
9+
All settings around the _source metadata field.
10+
11+
$$$source-mode$$$
12+
13+
`index.source.mode`
14+
: (Static, string) The source mode for the index. Valid values are [`synthetic`](/reference/elasticsearch/mapping-reference/mapping-source-field.md#synthetic-source), [`disabled`](/reference/elasticsearch/mapping-reference/mapping-source-field.md#disable-source-field) or `stored`. Defaults to `stored`. The `stored` source mode always stores the source metadata field on disk.
15+
16+
$$$recovery-use_synthetic_source$$$
17+
18+
`index.recovery.use_synthetic_source`
19+
: (Static, boolean) If synthetic source mode is used, whether the recovery source should also be synthesized instead of stored to disk. Defaults to `true`. This setting can only be configured if synthetic source mode is enabled.
20+
21+
$$$synthetic-source-keep$$$
22+
23+
`index.mapping.synthetic_source_keep`
24+
: (Static, string) Controls how to retain accuracy of fields at the index level. Valid values are `none` or `arrays`.This is a subset of [synthetic source keep mapping attribute](/reference/elasticsearch/mapping-reference/mapping-source-field.md#synthetic-source-keep). Defaults to `arrays` if `index.mode` is `logsdb` or otherwise `none`.

docs/reference/elasticsearch/toc.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ toc:
5757
children:
5858
- file: index-settings/preloading-data-into-file-system-cache.md
5959
- file: index-settings/time-series.md
60+
- file: index-settings/source.md
6061
- file: index-settings/translog.md
6162
- file: index-lifecycle-actions/index.md
6263
children:
@@ -203,4 +204,4 @@ toc:
203204
- file: command-line-tools/setup-passwords.md
204205
- file: command-line-tools/shard-tool.md
205206
- file: command-line-tools/syskeygen.md
206-
- file: command-line-tools/users-command.md
207+
- file: command-line-tools/users-command.md

0 commit comments

Comments
 (0)