import data reference

The following page describes the usage of the following import commands:

• import data (and import data to target)
• import data status
• get data-migration-report
• import data to source
• import data to source-replica

import data

For offline migration, Import the data to the YugabyteDB database.

For live migration (with fall-forward and fall-back), the import data command is an alias of import data to target which imports the data from the data directory to the target database, and starts ingesting the new changes captured by export data to the target database.

Syntax

Syntax for import data is as follows:

Usage: yb-voyager import data [ <arguments> ... ]

Syntax for import data to target is as follows:

Usage: yb-voyager import data to target [ <arguments> ... ]

Arguments

The valid arguments for import data are described in the following table:

Example

Offline migration

An example for offline migration is as follows:

yb-voyager import data --export-dir /dir/export-dir \
        --target-db-host 127.0.0.1 \
        --target-db-user ybvoyager \
        --target-db-password 'password' \
        --target-db-name target_db \
        --target-db-schema target_schema \
        --parallel-jobs 12

Live migration

An example for all live migration scenarios is as follows:

yb-voyager import data to target --export-dir /dir/export-dir \
        --target-db-host 127.0.0.1 \
        --target-db-user ybvoyager \
        --target-db-password 'password' \
        --target-db-name target_db \
        --target-db-schema target_schema \
        --parallel-jobs 12

import data status

For offline migration, get the status report of an ongoing or completed data import operation. The report contains migration status of tables, number of rows or bytes imported, and percentage completion.

Syntax

Usage: yb-voyager import data status [ <arguments> ... ]

Arguments

The valid arguments for import data status are described in the following table:

Example

yb-voyager import data status --export-dir /dir/export-dir

get data-migration-report

Note that this command is applicable for Live migrations only.

Provides a consolidated report of data migration per table among all the databases involved in the live migration. The report includes the number of rows exported, the number of rows imported, change events exported and imported (INSERTS, UPDATES, and DELETES), and the final row count on the database.

Syntax

Usage: yb-voyager get data-migration-report [ <arguments> ... ]

Arguments

The valid arguments for get data-migration-report are described in the following table:

Example

yb-voyager get data-migration-report --export-dir /dir/export-dir

import data to source

Note that this command is applicable for Live migrations only.

Imports data to the source database, and streams new changes from the YugabyteDB database to the source database.

Syntax

Usage: yb-voyager import data to source [ <arguments> ... ]

Arguments

The valid arguments for import data to source are described in the following table:

Example

yb-voyager import data to source --export-dir /dir/export-dir \
        --source-db-password 'password'

import data to source-replica

Note that this command is applicable for Live migrations only.

Imports data to the source-replica database, and streams new changes from the YugabyteDB database to the source-replica database.

Syntax

Usage: yb-voyager import data to source-replica [ <arguments> ... ]

Arguments

The valid arguments for import data to source-replica are described in the following table:

Example

yb-voyager import data to source-replica --export-dir /dir/export-dir \
        --source-replica-db-host 127.0.0.1 \
        --source-replica-db-user ybvoyager \
        --source-replica-db-password 'password' \
        --source-replica-db-name source_replica_db \
        --source-replica-db-schema source_replica_schema \
        --parallel-jobs 12