Skip to main content

Below is a detailed property description table for the provided state.json structure:

KeyData TypeDescriptionSample Value
typestringIdentifies the type of state stored. In this file, "GLOBAL" indicates that the state applies globally to the replication process."GLOBAL"
globalobjectContains global state information including overall replication progress and a list of globally tracked streams.{ "state": { "lsn": "0/198C935" }, "streams": ["public.sample_data"] }
global.stateobjectHolds the global state details required to resume replication, such as log sequence markers.{ "lsn": "0/198C935" }
global.state.lsnstringThe Log Sequence Number (LSN) indicating the last processed position in the transaction log."0/198C935"
global.streamsarrayAn array listing fully-qualified stream identifiers tracked at the global level.[ "public.sample_data" ]
streamsarrayAn 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[].streamstringThe identifier (typically a table name) of the stream whose state is being tracked."sample_data"
streams[].namespacestringIndicates the namespace or schema to which the stream belongs."public"
streams[].sync_modestringSpecifies the synchronization mode for the stream. It may be left empty if no specific mode is applied."" (empty string)
streams[].stateobjectContains state details specific to the stream, such as information on data segmentation or chunks.{ "chunks": [] }
streams[].state.chunksarrayAn 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.


Need Assistance?

If you have any questions or uncertainties about setting up OLake, contributing to the project, or troubleshooting any issues, we’re here to help. You can:

  • Email Support: Reach out to our team at hello@olake.io for prompt assistance.
  • Join our Slack Community: where we discuss future roadmaps, discuss bugs, help folks to debug issues they are facing and more.
  • Schedule a Call: If you prefer a one-on-one conversation, schedule a call with our CTO and team.

Your success with OLake is our priority. Don’t hesitate to contact us if you need any help or further clarification!