For AI agents: a documentation index is available at https://www.mongodb.com/docs/llms.txt — markdown versions of all pages are available by appending .md to any URL path.
Docs Menu

Manage the Relational Model

You can change the schemas or tables you want to include in your migration project by connecting to the source database or using a DDL file to refresh the list of available tables.

You can also change the relational and MongoDB database connections to migrate from or to a different database, such as switching from a staging environment to production.

Relational Migrator automatically saves your project changes as you work. However, you must manually save changes that you make in a dialog, such as selecting tables or importing a DDL file, to your project by using the Save button.

To change the tables you're migrating from your relational database, use the Manage button.

  1. From the Mapping screen, click the Manage button on the Schema model pane.

  2. Click the check box next to the schema or schemas you are migrating.

  3. To expand the tables in a schema, click the button.

    Select the tables you want to add or remove from your migration.

  4. Click Save to apply your table selections to the project.

    The main Relational Migrator diagram reflects changes from your relational database. Future migration jobs include these changes.

If your relational database table structure changes, use the Refresh Schema button to let Relational Migrator know.

  1. From the Mapping screen, click the Manage button on the Schema model pane.

  2. To refresh the schema for the active Relational DB connection, click the Refresh schema button on the Manage relational model modal.

  3. To refresh the schema for a file, click Import DDL File

You can change the active Relational DB in the Database Connections bar, such as switching the connection from a staging database to one in production. This re-scans the schema. Migrator reads in any changes in foreign key relations or data types for underlying tables.

Note

You can only use saved connections or create new connections of the same database type originally used in the project.

  1. Click the Relational DB drop-down.

    To use a saved relational database connection, click Use a saved connection and select it from the drop-down, then enter credentials if required.

    To create a new connection, click + Add Connection:

    1. In the Database type drop-down, select the database type.

    2. To enter a connection string directly, enable the Enter URI manually toggle and paste your connection string into the JDBC URI.

    3. To create a connection string by entering database information, enter the following:

      Field
      Value

      Host

      The host IP or DNS name.

      Port

      The port number.

      Database

      The database name. Required.

      Identifier

      One of Service Name or SID.

      Username and Password

      The credentials to use for authentication.

      Checking Save password saves the password securely on your machine, so you don't have to enter the Username and Password again when using the saved connection.

    4. Enter a Connection name and optional Environment tag.

    5. Click Connect.

      The saved connection is available for use in all jobs and projects.

Any changes from your relational database are reflected in the main Relational Migrator diagram and included in future migration jobs.

Import DDL File opens a file prompt that accepts a DDL file of the relational schema you are migrating. Any changes in the foreign key relations or data types for the underlying tables are read into Migrator.

  1. Select your Database type.

    Relational Migrator currently supports the following database types:

    • MySQL

    • Oracle

    • PostgreSQL

    • SQL Server

  2. Choose a file or drag and drop a DDL statement file.

  3. Click Import.

  4. Click Save to apply the imported schema to the project.

Any changes from your relational database are reflected in the main Relational Migrator diagram and included in future migration jobs.