Component schema

CursorPagination

object3 direct references

Definition

Cursor pagination is a technique for paging through a result set using a cursor. It is similar to offset pagination except that the cursor is an opaque value that encodes the position within the result set. This allows for fetching the next page of results from the current position without having to skip over a potentially large number of rows.

It is also more resilient against late-arriving data which otherwise would cause issues with offset pagination. For example, if a row is inserted between two pages of results then the second page would contain a duplicate row and the third page would be missing.

Cursor

The cursor to another set of results. The value of this field is opaque to the client and may be used as a parameter to the next request to get the another set of results. Cursors do not implement any ordering.

integer

The maximum number of results to return. If not set, there is a default limit to the number of results returned.

Used by 3

These schemas and endpoints reference this type directly.

SchemaGetLogRecordsRequestSchemaGetSpansRequestSchemaGetTraceIdsRequest

json

OpenAPI source1234567891011121314
{
  "description": "Cursor pagination is a technique for paging through a result set using a cursor. It is\nsimilar to offset pagination except that the cursor is an opaque value that encodes the\nposition within the result set. This allows for fetching the next page of results from\nthe current position without having to skip over a potentially large number of rows.\n\nIt is also more resilient against late-arriving data which otherwise would cause issues\nwith offset pagination. For example, if a row is inserted between two pages of results\nthen the second page would contain a duplicate row and the third page would be missing.\n",
  "properties": {
    "cursor": {
      "$ref": "#/components/schemas/Cursor"
    },
    "limit": {
      "description": "The maximum number of results to return. If not set, there is a default limit to the number of results returned.\n",
      "type": "integer",
      "format": "int64",
      "example": 10
    }
  }
}