Documentation CLI 0.1.1 · development llms.txt
DOCUMENTATION / CONCEPTS

Restore & value validation

Restore verified archives into a separate target using the matching database connector.

Same engine, separate target

Register a target with source add postgres, mysql or mongodb matching the archive engine, and confirm separation explicitly. The target database must exist; SQL target schemas must also exist. The command verifies the archive before writing, then creates an isolated target and recovery journal. It refuses unrelated existing targets.

CLI
coldctl archive restore JOB_ID --target restore-target --schema restore_database --table restored_orders --confirm-separate-target

Transactional recovery

Restore batches and their recovery checkpoints commit together using native engine transactions. Rerunning the identical command validates existing committed values and resumes. Preserve the companion SQL journal or MongoDB restore ledger. A --max-batches pause is successful but does not mean restore is complete.

What is not restored

Restore preserves supported archived values and key representations; it is not a complete application DDL backup. Defaults, sequences, secondary indexes, triggers, grants and application migrations need separate handling. MongoDB retains raw BSON but does not reconstruct collection-level application settings and indexes. Cross-engine restoration is unsupported.

Validate values

validate-restore compares committed values against the archive and can inspect partial restores. It does not establish equality with a source changed since export. Use the matching engine connector and its target privileges.

CLI
coldctl archive validate-restore JOB_ID --target restore-target --schema restore_database --table restored_orders --confirm-separate-target