import schema reference

yb-voyager import schema

Import the schema to the YugabyteDB database.

During migration, run the import schema command twice, first without the --post-snapshot-import argument and then with the argument. The second invocation creates indexes and triggers in the target schema, and must be done after import data is complete.

For Oracle migrations

For Oracle migrations using YugabyteDB Voyager v1.1 or later, the Orafce extension is installed on the target database by default. This enables you to use a subset of predefined functions, operators, and packages from Oracle. The extension is installed in the public schema, and when listing functions or views, extra objects will be visible on the target database which may confuse you. You can remove the extension using the DROP EXTENSION command.

Syntax

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

Arguments

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

Argument	Description/valid options
--continue‑on‑error	Continue to import all the exported schema even if there are errors, and output all the erroneous DDLs to the `failed.sql` file in the `export-dir/schema` directory. Default: false Example: `yb-voyager import schema ... --continue-on-error true` Accepted parameters: true, false, yes, no, 0, 1
--enable-orafce	Enables Orafce extension on target (if source database type is Oracle). Default: true Accepted parameters: true, false, yes, no, 0, 1
--exclude‑object‑type‑list	Comma-separated list of schema object types (object types are case-insensitive) to exclude while importing schema (ignored if --object-type-list is used). Example: `--exclude-object-type-list 'FUNCTION,PROCEDURE'`
-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.
--ignore-exist	Ignore if an object already exists on the target database. Default: false Example: `yb-voyager import schema ... --ignore-exist true` Accepted parameters: true, false, yes, no, 0, 1
--object-type-list, ‑‑exclude‑object‑type‑list	Comma-separated list of objects to import (--object-type-list) or not (--exclude-object-type-list). You can provide only one of the arguments at a time. Example: `yb-voyager import schema …. –object-type-list "TABLE,FUNCTION,VIEW"` Accepted parameters: Oracle: TYPE, SEQUENCE, TABLE, PARTITION, INDEX, PACKAGE, TRIGGER, FUNCTION, PROCEDURE, MVIEW, SYNONYM PostgreSQL: SCHEMA, COLLATION, EXTENSION, TYPE, DOMAIN, SEQUENCE, TABLE, INDEX, FUNCTION, AGGREGATE, PROCEDURE, VIEW, TRIGGER, MVIEW, RULE, COMMENT MySQL: TABLE, PARTITION, INDEX, VIEW, TRIGGER, FUNCTION, PROCEDURE
--post-snapshot-import	Perform schema related tasks on the target YugabyteDB after data import is complete. Use --refresh-mviews along with this flag to refresh materialized views. Default: false Accepted parameters: true, false, yes, no, 0, 1
--refresh-mviews	Refreshes the materialized views on target during the post-import-data phase. Default: false Accepted parameters: true, false, yes, no, 0, 1
--send-diagnostics	Enable or disable sending diagnostics information to Yugabyte. Default: true Accepted parameters: true, false, yes, no, 0, 1
--start-clean	Starts a fresh schema import on the target YugabyteDB database for the schema present in the `schema` directory. Default: false Accepted parameters: true, false, yes, no, 0, 1
--straight-order	Imports the schema objects in the order specified via the `--object-type-list` flag. Default: false Example: `yb-voyager import schema ... --object-type-list 'TYPE,TABLE,VIEW...' --straight-order true` Accepted parameters: true, false, yes, no, 0, 1
--target-db-host	Domain name or IP address of the machine on which target database server is running. Default: 127.0.0.1
--target-db-name	Target database name. Default: yugabyte
--target-db-password	Target database password. Alternatively, you can also specify the password by setting the environment variable `TARGET_DB_PASSWORD`. If you don't provide a password via the CLI or environment variable during any migration phase, yb-voyager will prompt you at runtime for a password. If the password contains special characters that are interpreted by the shell (for example, # and $), enclose the password in single quotes.
--target-db-port	Port number of the target database server. Default: 5433
--target-db-schema	Schema name of the target YugabyteDB database. MySQL and Oracle migrations only.
--target-db-user	Username of the target YugabyteDB database.
--target-ssl-cert	Path to a file containing the certificate which is part of the SSL `<cert,key>` pair.
--target-ssl-key	Path to a file containing the key which is part of the SSL `<cert,key>` pair.
--target-ssl-crl	Path to a file containing the SSL certificate revocation list (CRL).
--target-ssl-mode	Specify the SSL mode for the target database as one of `disable`, `allow`, `prefer` (default), `require`, `verify-ca`, or `verify-full`.
--target-ssl-root-cert	Path to a file containing SSL certificate authority (CA) certificate(s).
-y, --yes	Answer yes to all prompts during the export schema operation. Default: false

Examples

yb-voyager import schema --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

Example of post-import data phase is as follows:


yb-voyager import schema --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 \
        --post-snapshot-import true \
        --refresh-mviews true