cutover reference

yb-voyager cutover

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

YugabyteDB gRPC vs YugabyteDB Connector

During the export data from target phase, after cutover to target in the fall-forward/fall-back workflows, YugabyteDB Voyager exports changes from YugabyteDB. YugabyteDB provides two types of CDC (Change Data Capture) connectors:

  • YugabyteDB gRPC Connector: Requires direct access to the cluster's internal ports-specifically, YB-TServer (9100) and YB-Master (7100). This connector is suitable for deployments where these ports are accessible.

  • YugabyteDB Connector: Does not require access to internal ports and is recommended for deployments where the gRPC connector cannot be used, for example, YugabyteDB Aeon. Supported in YugabyteDB versions 2024.1.1 or later. Note that currently there are is a known limitation with this connector. Refer to GitHub issue 27248 for more details.

Use the argument --use-yb-grpc-connector to select the YugabyteDB gRPC connector for the migration as described in the following table.

Arguments

The following table lists the valid CLI flags and parameters for cutover to target command.

When run at the same time, flags take precedence over configuration flag settings.

CLI flag
 Config file parameter Description
--prepare-for-fall-back 
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
--use-yb-grpc-connector 
cutover-to-target:
  use-yb-grpc-connector:
Applicable to fall-forward or fall-back workflows where you export changes from YugabyteDB during export data from target. If set to true, YugabyteDB gRPC Connector is used. Otherwise, YugabyteDB Connector is used.
.
Accepted parameters: true, false, yes, no, 0, 1.
-e, --export-dir 
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.

Example

Configuration file:

yb-voyager initiate cutover to target --config-file <path-to-config-file>

CLI:

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 following table lists the valid CLI flags and parameters for cutover to source command.

When run at the same time, flags take precedence over configuration flag settings.

CLI flag
 Config file parameter Description
-e, --export-dir 
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

Configuration file:

yb-voyager initiate cutover to source --config-file <path-to-config-file>

CLI:

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 following table lists the valid CLI flags and parameters for cutover to source-replica command.

When run at the same time, flags take precedence over configuration flag settings.

CLI flag
 Config file parameter Description
-e, --export-dir 
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

Configuration file:

yb-voyager initiate cutover to source-replica --config-file <path-to-config-file>

CLI:

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 following table lists the valid CLI flags and parameters for cutover status command.

When run at the same time, flags take precedence over configuration flag settings.

CLI flag
 Config file parameter Description
-e, --export-dir 
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

Configuration file:

yb-voyager cutover status --config-file <path-to-config-file>

CLI:

yb-voyager cutover status --export-dir /dir/export-dir