Browse Source

Add some clarification regarding docs.count

* Add some clarification regarding docs.count

* Some improvements as suggested by @jasontedor
Herbert Fischer 9 years ago
parent
commit
c0ebce0ba0
2 changed files with 5 additions and 2 deletions
  1. 3 2
      docs/reference/cat/indices.asciidoc
  2. 2 0
      docs/reference/cat/segments.asciidoc

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

@@ -13,8 +13,9 @@ green  open   twitter2   2   0       2030            0      5.8mb          5.8mb
 --------------------------------------------------
 
 We can tell quickly how many shards make up an index, the number of
-docs, deleted docs, primary store size, and total store size (all
-shards including replicas).
+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). 
+All these exposed metrics come directly from Lucene APIs.
 
 [float]
 [[pri-flag]]

+ 2 - 0
docs/reference/cat/segments.asciidoc

@@ -44,6 +44,8 @@ generation::    The generation number is incremented with each segment that is w
                 The name of the segment is derived from this generation number.
 
 docs.count::    The number of non-deleted documents that are stored in this segment.
+                Note that these are Lucene documents, so the count will include hidden
+				documents (e.g. from nested types).
 
 docs.deleted::  The number of deleted documents that are stored in this segment.
                 It is perfectly fine if this number is greater than 0, space is