Documentation CLI 0.1.1 · development llms.txt

coldctl archive restore

Restore verified data into a separate same-engine target.

ImplementedTarget database write

Syntax

USAGE

coldctl archive restore [OPTIONS] --target <TARGET> --schema <SCHEMA> --table <TABLE> --confirm-separate-target <ID>

Arguments & options

Argument	Description
`<ID>`	Job UUID from coldctl jobs list.

Option	Description / default
`--data-dir <PATH>`	Override the OS application data directory
`--output <OUTPUT>`	[default: table] [possible values: table, json]
`--target <TARGET>`	Name of a separately registered target using the archive's database engine.
`--schema <SCHEMA>`	Target SQL schema or MongoDB database; required for restore.
`--table <TABLE>`	Target SQL table or MongoDB collection name.
`--confirm-separate-target`	Required acknowledgement that the target is separate from the operational source.
`--max-batches <MAX_BATCHES>`	Optional committed-batch limit for this restore invocation. Stops at a safe boundary.
`-h, --help`	Print help

Examples

Replace configuration names, paths and JOB_ID with values from your installation. Examples are not executed by this page.

CLI

coldctl archive restore JOB_ID --target restore-target --schema public --table restored_orders --confirm-separate-target --max-batches 2 --output json

Operational notes

Register a separate target with the matching engine connector. The target database/schema must exist. Creates an isolated target and companion recovery journal, verifies before writing, and commits each batch with its checkpoint. Repeat the identical command to resume.

Output, placeholders & global flags

View exact CLI help

HELP OUTPUT

Restore into a new dedicated target table in the same database engine; rerun to resume

Usage: coldctl archive restore [OPTIONS] --target <TARGET> --schema <SCHEMA> --table <TABLE> --confirm-separate-target <ID>

Arguments:
  <ID>  

Options:
      --data-dir <PATH>            Override the OS application data directory
      --output <OUTPUT>            [default: table] [possible values: table, json]
      --target <TARGET>            
      --schema <SCHEMA>            
      --table <TABLE>              
      --confirm-separate-target    
      --max-batches <MAX_BATCHES>  
  -h, --help                       Print help