From 671110e680a649a67888498eb0b02b3ea3ed26c2 Mon Sep 17 00:00:00 2001 From: Martijn van Groningen Date: Thu, 17 Apr 2025 15:34:52 +0200 Subject: [PATCH 1/2] Document index setting around source metadata field. --- .../elasticsearch/index-settings/source.md | 24 +++++++++++++++++++ docs/reference/elasticsearch/toc.yml | 3 ++- 2 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 docs/reference/elasticsearch/index-settings/source.md diff --git a/docs/reference/elasticsearch/index-settings/source.md b/docs/reference/elasticsearch/index-settings/source.md new file mode 100644 index 0000000000000..df62dc3013dad --- /dev/null +++ b/docs/reference/elasticsearch/index-settings/source.md @@ -0,0 +1,24 @@ +--- +mapped_pages: + - https://www.elastic.co/guide/en/elasticsearch/reference/current/source-index-settings.html +navigation_title: Source settings +--- + +# Source index settings [source-index-settings] + +All settings around the _source metadata field. + +$$$source-mode$$$ + +`index.source.mode` +: (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. + +$$$recovery-use_synthetic_source$$$ + +`index.recovery.use_synthetic_source` +: (Static, boolean) If synthetic source mode is used, whether the recovery source should also be synthesized instead of stored to disk. Defaults to `true` if source mode is `synthetic`. + +$$$synthetic-source-keep$$$ + +`index.mapping.synthetic_source_keep` +: (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`. diff --git a/docs/reference/elasticsearch/toc.yml b/docs/reference/elasticsearch/toc.yml index 625ec7069a024..e8e006390bf3a 100644 --- a/docs/reference/elasticsearch/toc.yml +++ b/docs/reference/elasticsearch/toc.yml @@ -57,6 +57,7 @@ toc: children: - file: index-settings/preloading-data-into-file-system-cache.md - file: index-settings/time-series.md + - file: index-settings/source.md - file: index-settings/translog.md - file: index-lifecycle-actions/index.md children: @@ -194,4 +195,4 @@ toc: - file: command-line-tools/setup-passwords.md - file: command-line-tools/shard-tool.md - file: command-line-tools/syskeygen.md - - file: command-line-tools/users-command.md \ No newline at end of file + - file: command-line-tools/users-command.md From 328847e6631bb8ff5f7965d07adf912245928811 Mon Sep 17 00:00:00 2001 From: Martijn van Groningen Date: Thu, 17 Apr 2025 15:46:44 +0200 Subject: [PATCH 2/2] iter --- docs/reference/elasticsearch/index-settings/source.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/elasticsearch/index-settings/source.md b/docs/reference/elasticsearch/index-settings/source.md index df62dc3013dad..53c2d10795e74 100644 --- a/docs/reference/elasticsearch/index-settings/source.md +++ b/docs/reference/elasticsearch/index-settings/source.md @@ -16,7 +16,7 @@ $$$source-mode$$$ $$$recovery-use_synthetic_source$$$ `index.recovery.use_synthetic_source` -: (Static, boolean) If synthetic source mode is used, whether the recovery source should also be synthesized instead of stored to disk. Defaults to `true` if source mode is `synthetic`. +: (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. $$$synthetic-source-keep$$$