diff options
| author | Gabor Pali <gabor.pali@ibm.com> | 2023-03-23 00:42:14 +0100 |
|---|---|---|
| committer | Nick Vatamaniuc <nickva@users.noreply.github.com> | 2023-04-18 23:51:32 -0400 |
| commit | e6af4924c69f31976c39bfb39d03a3ee5772c4f0 (patch) | |
| tree | a36ea069d530574df79b409c493db669895ba929 | |
| parent | 313b74e92161a80293de273e88661dd28ce1417e (diff) | |
| download | couchdb-e6af4924c69f31976c39bfb39d03a3ee5772c4f0.tar.gz | |
_find: mention the `covered` attribute in the `_explain` response
| -rw-r--r-- | src/docs/src/api/database/find.rst | 4 |
1 files changed, 4 insertions, 0 deletions
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", |