Skip to content

Commit 172696d

Browse files
committed
Document _cat/indices behavior when encountering source only indices (elastic#114884)
Closes elastic#114546
1 parent bae09a8 commit 172696d

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

docs/reference/cat/indices.asciidoc

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66

77
[IMPORTANT]
88
====
9-
cat APIs are only intended for human consumption using the command line or {kib}
10-
console. They are _not_ intended for use by applications. For application
9+
cat APIs are only intended for human consumption using the command line or {kib}
10+
console. They are _not_ intended for use by applications. For application
1111
consumption, use the <<indices-get-index,get index API>>.
1212
====
1313

@@ -50,6 +50,10 @@ indexing and search. As a result, all document counts include hidden
5050
To get an accurate count of {es} documents, use the <<cat-count,cat count>> or
5151
<<search-count,count>> APIs.
5252

53+
Note that information such as document count, deleted document count and store size are not shown for
54+
indices restored from <<snapshots-source-only-repository,source-only snapshots>> since these indices
55+
do not contain the relevant data structures to retrieve this information from.
56+
5357

5458
[[cat-indices-api-path-params]]
5559
==== {api-path-parms-title}

docs/reference/snapshot-restore/repository-source-only.asciidoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ As a result, indices adopting synthetic source cannot be restored. When you rest
2727
* The mapping of the restored index is empty, but the original mapping is available from the types top
2828
level `meta` element.
2929
30+
* Information such as document count, deleted document count and store size are not available for such indices
31+
since these indices do not contain the relevant data structures to retrieve this information from. Therefore,
32+
this information is not shown for such indices in APIs such as the <<cat-indices,cat indices API>>.
3033
==================================================
3134

3235
Before registering a source-only repository, use {kib} or the

0 commit comments

Comments
 (0)