This is an automated email from the ASF dual-hosted git repository.

vatamane pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/couchdb.git

commit e6af4924c69f31976c39bfb39d03a3ee5772c4f0
Author: Gabor Pali <[email protected]>
AuthorDate: Thu Mar 23 00:42:14 2023 +0100

    _find: mention the `covered` attribute in the `_explain` response
---
 src/docs/src/api/database/find.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/docs/src/api/database/find.rst 
b/src/docs/src/api/database/find.rst
index 3f4b9ca17..027ddf8ee 100644
--- a/src/docs/src/api/database/find.rst
+++ b/src/docs/src/api/database/find.rst
@@ -1317,6 +1317,9 @@ it easier to take advantage of future improvements to 
query planning
     :>header Content-Type: - :mimetype:`application/json`
     :>header Transfer-Encoding: ``chunked``
 
+    :>json boolean covered: Tell if the query could be answered only
+        by relying on the data stored in the index.  When ``true``, no
+        documents are fetched, which results in a faster response.
     :>json string dbname: Name of database.
     :>json object index: Index used to fulfill the query.
     :>json object selector: Query selector used.
@@ -1364,6 +1367,7 @@ it easier to take advantage of future improvements to 
query planning
         Transfer-Encoding: chunked
 
         {
+            "covered": false,
             "dbname": "movies",
             "index": {
                 "ddoc": "_design/0d61d9177426b1e2aa8d0fe732ec6e506f5d443c",

Reply via email to