Skip to content

Commit dd3bbfb

Browse files
thefourtheyenik9000
authored andcommitted
doc: highlight that doc counts come from lucene (#23522)
The docs don't clearly explain that the deleted doc count also comes from lucene. IMHO, it is worth highlighting this information separately, as a Note. Apart from that, there should be an official recommended alternative as well.
1 parent f4f6ce4 commit dd3bbfb

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

docs/reference/cat/indices.asciidoc

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,17 @@ green open twitter2 nYFWZEO7TUiOjLQXBaYJpA 5 0 0 0
2424
// TESTRESPONSE[s/u8FNjxh8Rfy_awN11oDKYQ|nYFWZEO7TUiOjLQXBaYJpA/.+/ _cat]
2525

2626
We can tell quickly how many shards make up an index, the number of
27-
docs at the Lucene level, including hidden docs (e.g., from nested types),
28-
deleted docs, primary store size, and total store size (all shards including replicas).
27+
docs, deleted docs, primary store size, and total store size (all shards including replicas).
2928
All these exposed metrics come directly from Lucene APIs.
3029

30+
*Notes:*
31+
32+
1. As the number of documents and deleted documents shown in this are at the lucene level,
33+
it includes all the hidden documents (e.g. from nested documents) as well.
34+
35+
2. To get actual count of documents at the elasticsearch level, the recommended way
36+
is to use either the <<cat-count>> or the <<search-count>>
37+
3138
[float]
3239
[[pri-flag]]
3340
=== Primaries

0 commit comments

Comments
 (0)