Back to Yugabyte Db

archive changes reference

docs/content/stable/yugabyte-voyager/reference/cutover-archive/archive-changes.md

2026.1.0.0-b292.6 KB
Original Source

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

text
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.

{{<table>}}

<div style="width:150px">CLI flag</div>Config file parameterDescription

| --fs-utilization-threshold |

yaml{.nocopy}
archive-changes:
  fs-utilization-threshold:

|Disk use threshold (in percent) for the export directory. Used only with --policy delete. Default: 70 | | --policy |

yaml
archive-changes:
  policy:

| Specifies how to handle processed segments: delete or archive. | | --archive-dir |

yaml
archive-changes:
  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 |

yaml{.nocopy}
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 |

yaml{.nocopy}
send-diagnostics:

|Enable or disable sending diagnostics information to Yugabyte. Default: true Accepted parameters: true, false, yes, no, 0, 1 |

| -l, --log-level |

yaml
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. |

{{</table>}}

Examples

Configuration file:

sh
yb-voyager archive changes --config-file <path-to-config-file>

CLI:

Example to delete changes without archiving them to another destination is as follows:

sh
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:

sh
yb-voyager archive changes --export-dir /dir/export-dir --policy archive --archive-dir /dir/archive-dir