Documentation CLI 0.1.1 · development llms.txt

coldctl policy create

Save an explicit retention policy.

ImplementedLocal state write

Syntax

USAGE

coldctl policy create [OPTIONS] --name <NAME> --source <SOURCE> --destination <DESTINATION> --table <TABLE> --time-column <TIME_COLUMN> --older-than-days <OLDER_THAN_DAYS>

Arguments & options

Option	Description / default
`--data-dir <PATH>`	Override the OS application data directory
`--name <NAME>`	Unique local configuration name: 1â€“64 ASCII letters, digits, hyphens or underscores.
`--output <OUTPUT>`	[default: table] [possible values: table, json]
`--source <SOURCE>`	Name of a registered source.
`--destination <DESTINATION>`	Name of a registered local destination.
`--schema <SCHEMA>`	[default: public]
`--table <TABLE>`	SQL table or MongoDB collection name.
`--time-column <TIME_COLUMN>`	Date/timestamp column for the strict retention cutoff.
`--older-than-days <OLDER_THAN_DAYS>`	Retention age from 1 to 365000 days.
`--batch-size <BATCH_SIZE>`	[default: 500]
`--equals-column <EQUALS_COLUMN>`	Optional text equality-filter column. Requires --equals-value.
`--equals-value <EQUALS_VALUE>`	Literal filter value. Requires --equals-column. Stored locally, excluded from Cloud reports.
`-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 policy create --name orders-archive --source production --destination local-archive --schema public --table orders --time-column created_at --older-than-days 365 --equals-column status --equals-value completed --batch-size 500

Operational notes

Source and destination must exist. Retention is 1â€“365000 days. The parser accepts batch sizes 1â€“1000, but MySQL caps batches at 400 and MongoDB at 100. Equality column/value must be paired; MongoDB does not support equality filters. Create a new policy to change rules.

Output, placeholders & global flags

View exact CLI help

HELP OUTPUT

Save a retention policy. Validation against PostgreSQL is a separate read-only command

Usage: coldctl policy create [OPTIONS] --name <NAME> --source <SOURCE> --destination <DESTINATION> --table <TABLE> --time-column <TIME_COLUMN> --older-than-days <OLDER_THAN_DAYS>

Options:
      --data-dir <PATH>                    Override the OS application data directory
      --name <NAME>                        
      --output <OUTPUT>                    [default: table] [possible values: table, json]
      --source <SOURCE>                    
      --destination <DESTINATION>          
      --schema <SCHEMA>                    [default: public]
      --table <TABLE>                      
      --time-column <TIME_COLUMN>          
      --older-than-days <OLDER_THAN_DAYS>  
      --batch-size <BATCH_SIZE>            [default: 500]
      --equals-column <EQUALS_COLUMN>      
      --equals-value <EQUALS_VALUE>        
  -h, --help                               Print help