Last updated:|... min read
Below is a detailed property description table for the provided state.json
structure:
Key | Data Type | Description | Sample Value |
---|---|---|---|
type | string | Identifies the type of state stored. In this file, "GLOBAL" indicates that the state applies globally to the replication process. | "GLOBAL" |
global | object | Contains global state information including overall replication progress and a list of globally tracked streams. | { "state": { "lsn": "0/198C935" }, "streams": ["public.sample_data"] } |
global.state | object | Holds the global state details required to resume replication, such as log sequence markers. | { "lsn": "0/198C935" } |
global.state.lsn | string | The Log Sequence Number (LSN) indicating the last processed position in the transaction log. | "0/198C935" |
global.streams | array | An array listing fully-qualified stream identifiers tracked at the global level. | [ "public.sample_data" ] |
streams | array | An array of objects, each representing the state of an individual stream. These objects contain details needed to resume replication for that stream. | [ { "stream": "sample_data", "namespace": "public", "sync_mode": "", "state": { "chunks": [] } } ] |
streams[].stream | string | The identifier (typically a table name) of the stream whose state is being tracked. | "sample_data" |
streams[].namespace | string | Indicates the namespace or schema to which the stream belongs. | "public" |
streams[].sync_mode | string | Specifies the synchronization mode for the stream. It may be left empty if no specific mode is applied. | "" (empty string) |
streams[].state | object | Contains state details specific to the stream, such as information on data segmentation or chunks. | { "chunks": [] } |
streams[].state.chunks | array | An array used to store chunk information, useful for managing segmented or large datasets during replication. | [] |
This table provides a clear and concise reference for each configuration property in the state.json
file, making it easier for developers to understand and work with the replication state details.
Refer here for more about sync modes.