From 5f6d315b6d4cb1fb337c01dffd805095c488de29 Mon Sep 17 00:00:00 2001 From: Pooya Salehi Date: Wed, 16 Oct 2024 10:24:29 +0200 Subject: [PATCH 1/2] Document _cat/indices behavior when encountering source only indices --- docs/reference/cat/indices.asciidoc | 8 ++++++-- .../snapshot-restore/repository-source-only.asciidoc | 3 +++ 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/reference/cat/indices.asciidoc b/docs/reference/cat/indices.asciidoc index cf1cc9f825cb2..ec358197c87ef 100644 --- a/docs/reference/cat/indices.asciidoc +++ b/docs/reference/cat/indices.asciidoc @@ -6,8 +6,8 @@ [IMPORTANT] ==== -cat APIs are only intended for human consumption using the command line or {kib} -console. They are _not_ intended for use by applications. For application +cat APIs are only intended for human consumption using the command line or {kib} +console. They are _not_ intended for use by applications. For application consumption, use the <>. ==== @@ -50,6 +50,10 @@ indexing and search. As a result, all document counts include hidden To get an accurate count of {es} documents, use the <> or <> APIs. +Note that information such as document count, deleted document count and store size are not shown for +<> since these indices do not contain the relevant +data structures to retrieve this information from. + [[cat-indices-api-path-params]] ==== {api-path-parms-title} diff --git a/docs/reference/snapshot-restore/repository-source-only.asciidoc b/docs/reference/snapshot-restore/repository-source-only.asciidoc index 04e53c42aff9d..fe745385c9ca1 100644 --- a/docs/reference/snapshot-restore/repository-source-only.asciidoc +++ b/docs/reference/snapshot-restore/repository-source-only.asciidoc @@ -27,6 +27,9 @@ As a result, indices adopting synthetic source cannot be restored. When you rest * The mapping of the restored index is empty, but the original mapping is available from the types top level `meta` element. +Note that information such as document count, deleted document count and store size are not available for +source-only indices since these indices do not contain the relevant data structures to retrieve this information from. +Therefore, this information is not available for such indices in APIs such as the <>. ================================================== Before registering a source-only repository, use {kib} or the From 49325ea31db9bfff39b0314a4402b3ddbf4e3b6b Mon Sep 17 00:00:00 2001 From: Pooya Salehi Date: Wed, 16 Oct 2024 10:44:38 +0200 Subject: [PATCH 2/2] review comments --- docs/reference/cat/indices.asciidoc | 4 ++-- .../snapshot-restore/repository-source-only.asciidoc | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/reference/cat/indices.asciidoc b/docs/reference/cat/indices.asciidoc index ec358197c87ef..b8dda01c2eae0 100644 --- a/docs/reference/cat/indices.asciidoc +++ b/docs/reference/cat/indices.asciidoc @@ -51,8 +51,8 @@ To get an accurate count of {es} documents, use the <> or <> APIs. Note that information such as document count, deleted document count and store size are not shown for -<> since these indices do not contain the relevant -data structures to retrieve this information from. +indices restored from <> since these indices +do not contain the relevant data structures to retrieve this information from. [[cat-indices-api-path-params]] diff --git a/docs/reference/snapshot-restore/repository-source-only.asciidoc b/docs/reference/snapshot-restore/repository-source-only.asciidoc index fe745385c9ca1..3c11d6ca6e59c 100644 --- a/docs/reference/snapshot-restore/repository-source-only.asciidoc +++ b/docs/reference/snapshot-restore/repository-source-only.asciidoc @@ -27,9 +27,9 @@ As a result, indices adopting synthetic source cannot be restored. When you rest * The mapping of the restored index is empty, but the original mapping is available from the types top level `meta` element. -Note that information such as document count, deleted document count and store size are not available for -source-only indices since these indices do not contain the relevant data structures to retrieve this information from. -Therefore, this information is not available for such indices in APIs such as the <>. + * Information such as document count, deleted document count and store size are not available for such indices + since these indices do not contain the relevant data structures to retrieve this information from. Therefore, + this information is not shown for such indices in APIs such as the <>. ================================================== Before registering a source-only repository, use {kib} or the