LogPageResult

Experimental

log/page result: a contiguous, gap-free run of the stored rows in sequence order, each as written to disk: envelopes and stored omitted_live_only markers alike. Clients that read record contents must skip markers.

Fields and variants

• nextCursor — Experimental
• records — Experimental

Source

schema/msp/experimental/msp.schema.json#/types/LogPageResult

{
  "description": "`log/page` result: a contiguous, gap-free run of the stored\nrows in sequence order, each as written to disk: envelopes and\nstored `omitted_live_only` markers alike. Clients that read record\ncontents must skip markers.",
  "properties": {
    "nextCursor": {
      "anyOf": [
        {
          "$ref": "#/$defs/RawLogCursor"
        },
        {
          "type": "null"
        }
      ],
      "description": "The cursor after the last returned row (a marker's cursor is its\n`position`), or null when `records` is empty. Page to the tail by\nlooping `from = nextCursor.after`."
    },
    "records": {
      "description": "The served rows, in sequence order: a [`RawLogRecordEnvelope`], or at\na position stored as a marker line the retained-gap marker. A member carrying `retained_marker` is the marker,\nany other member is the envelope; free-form for the same reason as\n`LogRecordParams::record`. A marker counts toward `limit`.",
      "items": {
        "properties": {},
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "nextCursor",
    "records"
  ],
  "type": "object",
  "x-msp-descriptor": "log/page",
  "x-msp-stability": "experimental"
}