Document _cat/indices behavior when encountering source only indices (#114884)

Closes https://github.com/elastic/elasticsearch/issues/114546
This commit is contained in:
Pooya Salehi 2024-10-16 11:08:17 +02:00 committed by GitHub
parent 64f2c42a76
commit ae452becc7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 9 additions and 2 deletions

View file

@ -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 <<indices-get-index,get index API>>.
====
@ -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 <<cat-count,cat count>> or
<<search-count,count>> APIs.
Note that information such as document count, deleted document count and store size are not shown for
indices restored from <<snapshots-source-only-repository,source-only snapshots>> since these indices
do not contain the relevant data structures to retrieve this information from.
[[cat-indices-api-path-params]]
==== {api-path-parms-title}

View file

@ -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.
* 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 <<cat-indices,cat indices API>>.
==================================================
Before registering a source-only repository, use {kib} or the