Watermark

interface Watermark

Progress marker for a query scan. Carried on every response frame, whether or not the frame delivers a matching item. Watermarks never regress in the requested ordering, but consecutive frames may carry the same watermark when additional work does not advance the safe resume frontier.

Properties

Link copied to clipboard
abstract val checkpoint: <Error class: unknown class>?

The inclusive boundary checkpoint that the scan has fully covered within the request's effective interval, in the request's ordering direction: an ascending scan has emitted every matching item in the interval at checkpoints <= checkpoint (strictly greater ones may still hold matches); a descending scan has emitted every matching item in the interval at checkpoints >= checkpoint. This boundary never regresses in the scan direction, but it may repeat while the cursor advances.

Link copied to clipboard
abstract val cursor: <Error class: unknown class>?

Opaque cursor at this scan position. Set on every watermark. Use as options.after (ascending) or options.before (descending) on the next request to resume from here. The most recently received cursor is always the safe resume point.

Link copied to clipboard

Returns the field-presence view for this Watermark instance.

Functions

Link copied to clipboard
Link copied to clipboard
fun Watermark.copy(body: <Error class: unknown class>.() -> Unit = {}): Watermark

Copies the original message, including unknown fields.