MAmacrometa
Query

Read next batch from cursor

If the cursor has not been deleted, fetch an object with the following attributes:

  • id: the cursor-identifier
  • result: a list of documents for the current batch
  • hasMore: false if this was the last batch
  • count: if present the total number of elements

If hasMore returns true, the next call might still return no documents. If hasMore is false, the cursor is exhausted. Once the hasMore attribute has a value of false, the client can stop.

put/_fabric/{fabric}/_api/cursor/{cursor-identifier}

Request

Path parameters

fabricstring string required

The name of the fabric.

cursor-identifierstring string required

The name of the cursor.

Response

Successfully fetched JSON object.

codeinteger

HTTP response code.

errorboolean required

Flag if there is an error in response. False for this response.

countinteger

Total number of result documents available if the count attribute was used.

extraobject

(Optional) A JSON object with extra information about the query result contained in the stats sub-attribute. For data-modification queries, the extra.stats sub-attribute contains the number of modified documents. If the ignoreErrors query option was specified, extra.stats also includes the number of documents that could not be modified due to an error.

hasMoreboolean

True indicates there are more results available for the cursor on the server. False indicates there are no more results available.

idstring

(Optional) ID of temporary cursor created on the server.

cachedboolean

True indicates results are cached. False indicates results are not cached.

Example response

{
  "code": 200,
  "count": 1,
  "extra": {
    "stats": {
      "writesExecuted": 0,
      "writesIgnored": 0,
      "scannedFull": 7,
      "scannedIndex": 0,
      "filtered": 0,
      "httpRequests": 0,
      "executionTime": 0.0006868839263916016,
      "peakMemoryUsage": 18396
    },
    "warnings": []
  },
  "id": "11176313",
  "result": [
    {
      "_id": "xxx/8753330",
      "_key": "8753330",
      "_rev": "_dpDmoaa--_",
      "item1": "data2"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.