Skip to content

yugabyte/yb-voyager

Repository files navigation

YugabyteDB Voyager

License Documentation Status Ask in forum Slack chat Analytics

YugabyteDB Voyager is a powerful open-source data migration engine that accelerates cloud native adoption by removing barriers to moving applications to the public or private cloud. It helps you migrate databases to YugabyteDB quickly and securely.

YugabyteDB Voyager manages the entire lifecycle of a database migration, including cluster preparation for data import, schema-migration, and data-migration, using the yb-voyager command line utility.

YugabyteDB Voyager Architecture

You can migrate data to any one of the three YugabyteDB products (2.16.0.0 and later). The following cluster types are supported: Local YugabyteDB clusters, YugabyteDB Anywhere, YugabyteDB Managed

Highlights

  • Free and completely open source
  • Identical steps and unified experience for all sources and destinations
  • Optimized for distributed databases
    • Chunks the source files
    • Scales and auto tunes based on cluster size
    • Number of connections based on target configuration
    • Parallelism across tables and within tables
  • Idempotent
  • Data import is resumable in case of disruption
  • Visual progress for data export and import
  • Scales with nodes and cpu
  • Packaged for easy installation, one-click installer
  • Safe defaults
  • Direct data import from CSV and text files

Prerequisites and Install

For prerequisites like supported operating system, machine requirements, please refer to the Prerequisites section

Once the prerequisites are satisifed, you can install yb-voyager on a machine with operating systems like RHEL, Ubuntu, macOS, or even in Airgapped, or Docker environment or build using source. For detailed instructions, refer Install section

Migration Steps

The workflow to carry out a migration using yb-voyager is as follows:

YugabyteDB Voyager Architecture

More details regarding the entire migration workflow, starting from setting up your source and target databases, up until verifying the migration can be found in the Migration Steps on the YugabyteDB Voyager Docs.

Current Product State and Roadmap

YugabyteDB Voyager Architecture

Need Help?

Contribute

As an an open-source project with a strong focus on the user community, we welcome contributions as GitHub pull requests. See our Contributor Guides to get going. Discussions and RFCs for features happen on the design discussions section of our Forum.

License

Source code in this repository is variously licensed under the Apache License 2.0 and the Polyform Free Trial License 1.0.0. A copy of each license can be found in the licenses directory.