coldctl.
Get early access
ProductSecurityDocsBlogEarly accessSign inGet early access
Documentation CLI 0.1.1 · development llms.txt
COMMAND REFERENCE / LOCAL SCHEDULER

coldctl agent scheduler recurring create

Create a recurring archive and delete schedule.

ImplementedLocal schedule write

Syntax

USAGE
coldctl agent scheduler recurring create [OPTIONS] --every-seconds <EVERY_SECONDS> --source-stability <SOURCE_STABILITY> --confirm-original-source --delete-after-archive <POLICY>

Arguments & options

ArgumentDescription
<POLICY>Existing retention policy using PostgreSQL/MySQL/MongoDB and an S3 or Azure Blob destination
OptionDescription / default
--data-dir <PATH>Override the OS application data directory
--every-seconds <EVERY_SECONDS>Delay after completed deletion before the next cycle (60..31536000 seconds)
--source-stability <SOURCE_STABILITY>Assert source stability during every cycle, including downtime and retries [possible values: immutable-rows, quiescent-copy, live-values]
--confirm-original-sourceAuthorize automatic resumes against the original source for every cycle
--delete-after-archiveExplicitly authorize repeated verified source deletion (irreversible)
--max-retries <MAX_RETRIES>Consecutive transient retries before holding the schedule for recovery [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, --helpPrint 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 recurring create orders-archive --every-seconds 86400 --source-stability immutable-rows --confirm-original-source --delete-after-archive

Operational notes

PostgreSQL and MongoDB to S3 or Azure Blob. Each cycle requires stable eligible rows; MongoDB requires a quiescent source. Fresh cycles wait for completed verified deletion. Late arrivals between cycles are found by a full eligible-range rescan.

Run agent scheduler run under a service manager. Ctrl+C is restartable; recurring stop is terminal and an in-flight batch may commit. Failures retain the same job/cutoff. Policy/source/destination configuration is frozen.

Output, placeholders & global flags
View exact CLI help
HELP OUTPUT
Authorize repeated archive/verify/delete cycles until stopped

Usage: coldctl agent scheduler recurring create [OPTIONS] --every-seconds <EVERY_SECONDS> --source-stability <SOURCE_STABILITY> --confirm-original-source --delete-after-archive <POLICY>

Arguments:
  <POLICY>  Existing retention policy using PostgreSQL/MySQL/MongoDB and an S3 or Azure Blob destination

Options:
      --data-dir <PATH>
          Override the OS application data directory
      --every-seconds <EVERY_SECONDS>
          Delay after completed deletion before the next cycle (60..31536000 seconds)
      --source-stability <SOURCE_STABILITY>
          Assert source stability during every cycle, including downtime and retries [possible values: immutable-rows, quiescent-copy, live-values]
      --confirm-original-source
          Authorize automatic resumes against the original source for every cycle
      --delete-after-archive
          Explicitly authorize repeated verified source deletion (irreversible)
      --max-retries <MAX_RETRIES>
          Consecutive transient retries before holding the schedule for recovery [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
IN THIS COMMAND GROUPagent scheduler recurring list agent scheduler recurring show agent scheduler recurring stop agent scheduler recurring retry agent scheduler enqueue agent scheduler run agent scheduler list agent scheduler show agent scheduler cancel agent scheduler retry