Documentation CLI 0.1.1 · development llms.txt

coldctl archive reclaim

Reclaim PostgreSQL space in a bounded window.

ImplementedSource maintenance

Syntax

USAGE

coldctl archive reclaim [OPTIONS] --confirm-original-source --window-start-unix-ms <WINDOW_START_UNIX_MS> --window-end-unix-ms <WINDOW_END_UNIX_MS> <ID>

Arguments & options

Argument	Description
`<ID>`	Original archive job ID.

Option	Description / default
`--confirm-original-source`	Confirm maintenance targets the original source database.
`--data-dir <PATH>`	Override the OS application data directory
`--output <OUTPUT>`	[default: table] [possible values: table, json]
`--window-start-unix-ms <WINDOW_START_UNIX_MS>`	Customer window start as UTC Unix milliseconds.
`--window-end-unix-ms <WINDOW_END_UNIX_MS>`	Customer window end as UTC Unix milliseconds, at most 24 hours after start.
`--wait-timeout-seconds <WAIT_TIMEOUT_SECONDS>`	[default: 5]
`--max-duration-seconds <MAX_DURATION_SECONDS>`	Bound this attempt (1-290 seconds), also limited by the window end [default: 240]
`-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 reclaim JOB --confirm-original-source --window-start-unix-ms START --window-end-unix-ms END

Operational notes

Requires completed verified deletion. START/END are UTC Unix milliseconds. Default attempt limit 240 seconds; maximum 290. Verified server filesystem access and 2x free space are required for pg_repack. Always uses wait-timeout and no-kill-backend. Missing pg_repack falls back to VACUUM without truncation.

Output, placeholders & global flags

View exact CLI help

HELP OUTPUT

Reclaim within an active customer window (UTC Unix milliseconds, at most 24h)

Usage: coldctl archive reclaim [OPTIONS] --confirm-original-source --window-start-unix-ms <WINDOW_START_UNIX_MS> --window-end-unix-ms <WINDOW_END_UNIX_MS> <ID>

Arguments:
  <ID>  

Options:
      --confirm-original-source
          
      --data-dir <PATH>
          Override the OS application data directory
      --output <OUTPUT>
          [default: table] [possible values: table, json]
      --window-start-unix-ms <WINDOW_START_UNIX_MS>
          
      --window-end-unix-ms <WINDOW_END_UNIX_MS>
          
      --wait-timeout-seconds <WAIT_TIMEOUT_SECONDS>
          [default: 5]
      --max-duration-seconds <MAX_DURATION_SECONDS>
          Bound this attempt (1-290 seconds), also limited by the window end [default: 240]
  -h, --help
          Print help