Cursor

The cursor parameter allows for efficient batch retrieval of large amounts of documents. It can be used to get all documents. The state of the result set will be preserved.

1. By default the cursor is not enabled.
2. To enable it, select cursor to the GQL query to get the cursor in combination with a query in where.
3. The response will have a cursor value, and then get the next batches using that cursor value in the GQL query.
4. The results for the first query will be preserved in the current state (stateful), 10 minutes per request, and after that time, the cursor will expire and no longer be valid.
5. Continue till there are no more results.
6. The number of results per batch depend on the number set in limit for the first query with cursor, the skip is ignored. The client can implement this by ignoring the first batches of results.
7. It is recommended to sort by DOC for fastest retrieval.

Example request, where we get the batches per 1 document:

{
  StandardPage(
    cursor: "FGluY2x1ZGVfY29udGV4dF91dWlkDXF1ZXJ5QW5kRmV0Y2gBFnh3Qmszbmh0UkxPeWVGVHBLcUtQVWcAAAAAAAAATRZJVkJ4eFZBdVM5dTI4R1UzVUFSOEpn"
    limit: 1
    orderBy: {_ranking: DOC}
  ) {
    items {
      Name
      Url
      RouteSegment
      Changed
    }
    cursor
  }
}

Last updated: Sep 10, 2021