Documentation CLI 0.1.1 · development llms.txt

coldctl agent scheduler group create

Schedule parent-child archival.

ImplementedLocal group lifecycle

Syntax

USAGE

coldctl agent scheduler group create [OPTIONS] --every-seconds <EVERY_SECONDS> --confirm-quiescent-source --confirm-original-source --delete-after-archive

Arguments & options

Option	Description / default
`--data-dir <PATH>`	Override the OS application data directory
`--policies <POLICIES> <POLICIES>...`	Two to 32 explicit table policies on one source.
`--every-seconds <EVERY_SECONDS>`	Delay after a completed cycle, at least 60 seconds.
`--confirm-quiescent-source`	Assert all member tables remain quiescent through the full cycle and retries.
`--confirm-original-source`	Authorize deletion against the original source.
`--delete-after-archive`	Authorize repeated verified source deletion.
`--max-retries <MAX_RETRIES>`	[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 batches in milliseconds.
`--min-free-bytes <MIN_FREE_BYTES>`	Keep this many bytes free before each destination write
`--query-timeout-ms <QUERY_TIMEOUT_MS>`	Source query timeout in milliseconds.
`--lock-timeout-ms <LOCK_TIMEOUT_MS>`	Source lock timeout in milliseconds.
`-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 group create --policies orders items --every-seconds 3600 --confirm-quiescent-source --confirm-original-source --delete-after-archive

Operational notes

Requires matching CLI and connector builds. Groups require quiescent tables and are resumable, not atomic across tables. Configure automatic shadow validation for every member before scheduled deletion.

Output, placeholders & global flags

View exact CLI help

HELP OUTPUT

Usage: coldctl agent scheduler group create [OPTIONS] --every-seconds <EVERY_SECONDS> --confirm-quiescent-source --confirm-original-source --delete-after-archive

Options:
      --data-dir <PATH>
          Override the OS application data directory
      --policies <POLICIES> <POLICIES>...
          
      --every-seconds <EVERY_SECONDS>
          
      --confirm-quiescent-source
          
      --confirm-original-source
          
      --delete-after-archive
          
      --max-retries <MAX_RETRIES>
          [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