Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 16, 2024
Merged

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

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f6d315
Document _cat/indices behavior when encountering source only indices
pxsalehi Oct 16, 2024
49325ea
review comments
pxsalehi Oct 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/reference/cat/indices.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>>.
====

Expand Down Expand Up @@ -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
<<snapshots-source-only-repository, source-only indices>> since these indices do not contain the relevant
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The term source-only indices is not used elsewhere and may be confusing. Could we call them "indices restored from a source-only snapshot" instead just to avoid any ambiguity?

data structures to retrieve this information from.


[[cat-indices-api-path-params]]
==== {api-path-parms-title}
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/snapshot-restore/repository-source-only.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similarly here re. the phrase source-only indices. Also could this just be another bullet point in the list of constraints on indices restored from source-only snapshots?

Therefore, this information is not available for such indices in APIs such as the <<cat-indices,cat indices API>>.
==================================================

Before registering a source-only repository, use {kib} or the
Expand Down
Loading