archive changes reference
yb-voyager archive changes
The archive changes command limits the disk space used by the locally queued CDC events. After the changes from the local queue are applied on the target YugabyteDB database (and source-replica database), they are eligible for deletion.
You can either choose to delete the segments or archive them to a separate location.
Syntax
Usage: yb-voyager archive changes [ <arguments> ... ]
Arguments
The following table lists the valid CLI flags and parameters for archive changes command.
When run at the same time, flags take precedence over configuration flag settings.
CLI flag |
Config file parameter | Description |
|---|---|---|
| --fs-utilization-threshold | |
Disk use threshold (in percent) for the export directory. Used only with --policy delete. Default: 70 |
| --policy | |
Specifies how to handle processed segments: delete or archive. |
| --archive-dir | |
Path to an existing directory to copy processed segments into before they are removed from the export directory. Required when policy is archive. |
| -e, --export-dir | |
Path to the export directory. This directory is a workspace used to store exported schema DDL files, export data files, migration state, and a log file. |
| --send-diagnostics | |
Enable or disable sending diagnostics information to Yugabyte. Default: true Accepted parameters: true, false, yes, no, 0, 1 |
| -l, --log-level | |
Log level for yb-voyager. Accepted values: trace, debug, info, warn, error, fatal, panic Default: info |
| -h, --help | — | Command line help for archive changes. |
| -y, --yes | — | Answer yes to all prompts during migration. Default: false |
| -c, --config-file | — | Path to a configuration file. |
Examples
Configuration file:
yb-voyager archive changes --config-file <path-to-config-file>
CLI:
Example to delete changes without archiving them to another destination is as follows:
yb-voyager archive changes --export-dir /dir/export-dir --policy delete
Example to archive changes from the export directory to another destination is as follows:
yb-voyager archive changes --export-dir /dir/export-dir --policy archive --archive-dir /dir/archive-dir