Browse Source

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.
Sakthipriyan Vairamani 8 years ago
parent
commit
dd3bbfb153
1 changed files with 9 additions and 2 deletions
  1. 9 2
      docs/reference/cat/indices.asciidoc

+ 9 - 2
docs/reference/cat/indices.asciidoc

@@ -24,10 +24,17 @@ green  open   twitter2 nYFWZEO7TUiOjLQXBaYJpA   5   0          0            0
 // TESTRESPONSE[s/u8FNjxh8Rfy_awN11oDKYQ|nYFWZEO7TUiOjLQXBaYJpA/.+/ _cat]
 
 We can tell quickly how many shards make up an index, the number of
-docs at the Lucene level, including hidden docs (e.g., from nested types),
-deleted docs, primary store size, and total store size (all shards including replicas).
+docs, deleted docs, primary store size, and total store size (all shards including replicas).
 All these exposed metrics come directly from Lucene APIs.
 
+*Notes:*
+
+1. As the number of documents and deleted documents shown in this are at the lucene level,
+it includes all the hidden documents (e.g. from nested documents) as well.
+
+2. To get actual count of documents at the elasticsearch level, the recommended way
+is to use either the <<cat-count>> or the <<search-count>>
+
 [float]
 [[pri-flag]]
 === Primaries