Documentation CLI 0.1.1 · development llms.txt

coldctl agent scheduler enqueue

Queue a long-running archive.

ImplementedLocal queue write

Syntax

USAGE

coldctl agent scheduler enqueue [OPTIONS] --source-stability <SOURCE_STABILITY> --confirm-original-source <POLICY>

Arguments & options

Argument	Description
`<POLICY>`	Existing local retention policy name.

Option	Description / default
`--data-dir <PATH>`	Override the OS application data directory
`--job <JOB>`	Adopt this incomplete job instead of creating a new archive
`--source-stability <SOURCE_STABILITY>`	[possible values: immutable-rows, quiescent-copy, live-values]
`--confirm-original-source`	Authorize automatic resumes against the original, continuously stable source
`--allow-repeat`	Acknowledge possible overlap with prior exports when creating a new archive job.
`--delete-after-archive`	Delete unchanged source records after archive verification (irreversible)
`--delay-seconds <DELAY_SECONDS>`	Delay initial execution by this many seconds (maximum one year) [default: 0]
`--max-retries <MAX_RETRIES>`	Consecutive transient retries, with exponential backoff (maximum 100) [default: 5]
`--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 archive batches, 0â€“3,600,000 milliseconds; default 0.
`--min-free-bytes <MIN_FREE_BYTES>`	Keep this many bytes free before each destination write
`--query-timeout-ms <QUERY_TIMEOUT_MS>`	Archive query timeout, 1â€“300,000 milliseconds; default 10,000.
`--lock-timeout-ms <LOCK_TIMEOUT_MS>`	Archive lock timeout, 1â€“300,000 milliseconds; default 2,000, no greater than query timeout.
`-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 agent scheduler enqueue orders-archive --source-stability immutable-rows --confirm-original-source

Operational notes

One active queue entry per policy. Default slice: 60 seconds; positive duration required. --max-rows is per slice. --job adopts an incomplete original job. --delete-after-archive explicitly authorizes verified deletion; MongoDB requires quiescent-copy.

Output, placeholders & global flags

View exact CLI help

HELP OUTPUT

Queue one archive; automatically resume checkpoints until it completes

Usage: coldctl agent scheduler enqueue [OPTIONS] --source-stability <SOURCE_STABILITY> --confirm-original-source <POLICY>

Arguments:
  <POLICY>  

Options:
      --data-dir <PATH>
          Override the OS application data directory
      --job <JOB>
          Adopt this incomplete job instead of creating a new archive
      --source-stability <SOURCE_STABILITY>
          [possible values: immutable-rows, quiescent-copy, live-values]
      --confirm-original-source
          Authorize automatic resumes against the original, continuously stable source
      --allow-repeat
          
      --delete-after-archive
          Delete unchanged source records after archive verification (irreversible)
      --delay-seconds <DELAY_SECONDS>
          Delay initial execution by this many seconds (maximum one year) [default: 0]
      --max-retries <MAX_RETRIES>
          Consecutive transient retries, with exponential backoff (maximum 100) [default: 5]
      --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