Skip to main content

DeltaStreamState

connector_namestring
stream_namestring
cursor_typestringnullable

Null if no row exists yet (a getState before any begin).

Possible values: [timestamp_utc, numeric_id, opaque_token, null]

committed_cursor_valuestringnullable

High-water mark of the last successful complete_run. Null until the first complete.

committed_at_utcdate-timenullable
statusstring

idle when no row exists or after a reset. Caller decides what to do with running.

Possible values: [idle, running, succeeded, failed]

started_at_utcdate-timenullable
completed_at_utcdate-timenullable
records_processedintegernullable
error_summarystringnullable

Set by fail_run, cleared by the next begin.

metadata objectnullable

Free-form jsonb stored by complete_run.

property name*anynullable

Free-form jsonb stored by complete_run.

updated_at_utcdate-timenullable
updated_bystringnullable
DeltaStreamState
{
"connector_name": "string",
"stream_name": "string",
"cursor_type": "timestamp_utc",
"committed_cursor_value": "string",
"committed_at_utc": "2024-07-29T15:51:28.071Z",
"status": "idle",
"started_at_utc": "2024-07-29T15:51:28.071Z",
"completed_at_utc": "2024-07-29T15:51:28.071Z",
"records_processed": 0,
"error_summary": "string",
"metadata": {},
"updated_at_utc": "2024-07-29T15:51:28.071Z",
"updated_by": "string"
}