Documentation CLI 0.1.1 · development llms.txt

coldctl archive run

Export a new job in bounded Parquet batches.

ImplementedDatabase read + local write

Syntax

USAGE

coldctl archive run [OPTIONS] --source-stability <SOURCE_STABILITY> <POLICY>

Arguments & options

Argument	Description
`<POLICY>`	Name of a saved policy.

Option	Description / default
`--data-dir <PATH>`	Override the OS application data directory
`--output <OUTPUT>`	[default: table] [possible values: table, json]
`--source-stability <SOURCE_STABILITY>`	Assert stable rows AND eligibility (including no backdated inserts) [possible values: immutable-rows, quiescent-copy, live-values]
`--allow-repeat`	Acknowledge that a new run can duplicate previous exports
`--max-rows <MAX_ROWS>`	Rows per invocation; 0 removes a saved limit
`--max-duration-seconds <MAX_DURATION_SECONDS>`	Seconds per invocation, checked at safe boundaries; 0 removes a saved limit
`--batch-delay-ms <BATCH_DELAY_MS>`	Delay between batches in ms, 0â€“3,600,000. Default: 0.
`--min-free-bytes <MIN_FREE_BYTES>`	Keep this many bytes free before each destination write
`--query-timeout-ms <QUERY_TIMEOUT_MS>`	Statement timeout in ms, 1â€“300,000. Default: 10,000.
`--lock-timeout-ms <LOCK_TIMEOUT_MS>`	Lock timeout in ms, 1â€“300,000 and no larger than query timeout. Default: 2,000.
`-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 run orders-archive --source-stability immutable-rows --max-rows 10000 --batch-delay-ms 100 --output json

Operational notes

Requires an explicit stable-source assertion. Use immutable-rows only if values and eligibility stay unchanged, including no backdated inserts; use quiescent-copy for a frozen copy. A replica alone is not frozen. A prior job requires --allow-repeat, acknowledging possible duplication. Does not delete source records.

Output, placeholders & global flags

View exact CLI help

HELP OUTPUT

Export eligible rows to a NEW local Parquet job directory. Never deletes source rows

Usage: coldctl archive run [OPTIONS] --source-stability <SOURCE_STABILITY> <POLICY>

Arguments:
  <POLICY>  

Options:
      --data-dir <PATH>
          Override the OS application data directory
      --output <OUTPUT>
          [default: table] [possible values: table, json]
      --source-stability <SOURCE_STABILITY>
          Assert stable rows AND eligibility (including no backdated inserts) [possible values: immutable-rows, quiescent-copy, live-values]
      --allow-repeat
          Acknowledge that a new run can duplicate previous exports
      --max-rows <MAX_ROWS>
          Rows per invocation; 0 removes a saved limit
      --max-duration-seconds <MAX_DURATION_SECONDS>
          Seconds per invocation, checked at safe boundaries; 0 removes a saved limit
      --batch-delay-ms <BATCH_DELAY_MS>
          
      --min-free-bytes <MIN_FREE_BYTES>
          Keep this many bytes free before each destination write
      --query-timeout-ms <QUERY_TIMEOUT_MS>
          
      --lock-timeout-ms <LOCK_TIMEOUT_MS>
          
  -h, --help
          Print help