cutover reference
This page documents the preview (v2.21) version. Preview includes features under active development and is for development and testing only. For production, use the stable (v2024.1) version.
The following page describes the following cutover commands:
cutover to target
Initiate cutover to the target YugabyteDB database.
Syntax
Usage: yb-voyager initiate cutover to target [ <arguments> ... ]
Arguments
The valid arguments for initiate cutover to target are described in the following table:
| Argument | Description/valid options |
|---|---|
| -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. |
| -h, --help | Command line help for initiate cutover to target. |
| ‑‑prepare‑for‑fall‑back | Prepare for fall-back by streaming changes from the target YugabyteDB database to the source database. Not applicable to the fall-forward workflow. Accepted parameters: true, false, yes, no, 0, 1 |
Example
yb-voyager initiate cutover to target --export-dir /dir/export-dir --prepare-for-fall-back false
cutover to source
Initiate a cutover to the source database.
Syntax
Usage: yb-voyager initiate cutover to source [ <arguments> ... ]
Arguments
The valid arguments for initiate cutover to source are described in the following table:
| Argument | Description/valid options |
|---|---|
| -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. |
| -h, --help | Command line help for cutover. |
Example
yb-voyager initiate cutover to source --export-dir /path/to/yb/export/dir
cutover to source-replica
Initiate a cutover to the source-replica database.
Syntax
Usage: yb-voyager initiate cutover to source-replica [ <arguments> ... ]
Arguments
The valid arguments for initiate cutover to source-replica are described in the following table:
| Argument | Description/valid options |
|---|---|
| -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. |
| -h, --help | Command line help for cutover. |
Example
yb-voyager initiate cutover to source-replica --export-dir /path/to/yb/export/dir
cutover status
Shows the status of the cutover process, whether it is cutover to target, cutover to source-replica, or cutover to source. Status can be INITIATED, NOT INITIATED, or COMPLETED.
Syntax
Usage: yb-voyager cutover status [ <arguments> ... ]
Arguments
The valid arguments for cutover status are described in the following table:
| Argument | Description/valid options |
|---|---|
| -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. |
| -h, --help | Command line help for cutover status. |
Example
yb-voyager cutover status --export-dir /dir/export-dir