Learn the concepts

The learning guides explain the SDK's domain model independently of a particular source format or destination system. Begin with the definition, follow an item through execution, then examine the state and contracts needed for recovery.

Define the work

• Migration definitions: compose capabilities and choose a Process Pipeline or Process Batch Pipeline.
• Schemas and mapping: decode source-native values and validate process-facing contracts.
• Sources: emit items, discover changes, and look up current data by identity.
• Source items: distinguish payload, stable identity, observed version, and discovery position.
• Destinations: perform destination-owned operations and record typed evidence.

Understand durable state

• States and completion: separate Migration Item State, Migration Run State, and Migration Definition Completion.
• Migration stores: persist progress and enforce compatibility and ownership.
• Tracking: distinguish the Tracking Record Contract, Tracking Record, and Destination Journal.
• Registries and dependencies: select definitions, order execution, and resolve tracked references.

Execute and recover

• Execution and observation: plan a Migration Run, select an Execution Adapter, and follow progress through a client observation.
• Errors: understand typed failures, durable error records, and intentional skips.
• Retries: choose the operation to repeat and apply a bounded backoff strategy.
• Rollback: compensate destination work from durable Migration Item State.

Use the cookbook to see these primitives assembled into complete implementations, and the operating guides to control them through the CLI or TUI.