Browse Source

[DOCS] Add note that terms enum API may return terms from deleted docs (#89654)

Abdon Pijpelink 3 years ago
parent
commit
772784f3c9
1 changed files with 6 additions and 1 deletions
  1. 6 1
      docs/reference/search/terms-enum.asciidoc

+ 6 - 1
docs/reference/search/terms-enum.asciidoc

@@ -41,6 +41,11 @@ If the `complete` flag is `false`, the returned `terms` set may be incomplete
 and should be treated as approximate. This can occur due to a few reasons, such
 as a request timeout or a node error.
 
+NOTE: The terms enum API may return terms from deleted documents. Deleted
+documents are initially only marked as deleted. It is not until their segments
+are <<index-modules-merge,merged>> that documents are actually deleted. Until
+that happens, the terms enum API will return terms from these documents.
+
 [[search-terms-enum-api-request]]
 ==== {api-request-title}
 
@@ -104,4 +109,4 @@ query rewrites to `match_none`.
 (Optional, string)
 The string after which terms in the index should be returned. Allows for a form of
 pagination if the last result from one request is passed as the `search_after`
-parameter for a subsequent request.
+parameter for a subsequent request.