Docs Menu
Docs Home
/
Relational Migrator
/

Create a Project By Connecting to a Live Database

On this page

  • About this Task
  • Steps
  • Next Steps

You can create a project using a live database connection. Creating a project is the first step in the migration process. When creating a project with a live connection you:

  • Provide the connection details for your source relational database.

  • Provide the connection details for your destination MongoDB deployment.

  • Select the database, schema, and tables that are part of the migration.

Creating a project with a live connection is the recommended process for starting a new Relational Migrator project.

Before finalizing the creation of your project, you have the choice to select the initial mappings. These options include starting with a recommended MongoDB schema, which is automatically suggested by Relational Migrator based on your relational database.

1
2

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 a new 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.

    Field
    Value

    Host

    The host IP or DNS name.

    Port

    The port number.

    Database

    The database name. If blank, you only see objects in the default dbo schema in all databases.

    Authentication

    By default, this is set to SQL Server. Set to Windows to enable Windows Integrated Authentication, using the credentials of the user who launched the Relational Migrator executable. This disables the Username and Password fields.

    Username and Password

    The credentials to use for authentication. Disabled if Authentication is set to Windows.

    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.

    General / SSL toggle

    View SSL settings for the connection.

    To use SSL, you must first uncomment and update the server.ssl configuration properties in your user.properties file.

    SSL: Use SSL

    Enable or disable SSL.

    SSL: Trust server certificate

    With SSL enabled, check this to trust the stored certificate. Leave unchecked to verify the server certificate against a trusted Certificate Authority.

    Field
    Value

    Host

    The host IP or DNS name.

    Port

    The port number.

    Database

    The database name. Leave blank to load all databases.

    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.

    General / SSL toggle

    View SSL settings for the connection.

    To use SSL, you must first uncomment and update the server.ssl configuration properties in your user.properties file.

    SSL: Use SSL

    Enable or disable SSL.

    SSL: SSL mode

    With SSL enabled, choose from:

    • Preferred (default): Make an encrypted connection if possible, otherwise fall back to an unencrypted connection.

    • Required: Require an encrypted connection.

    • Verify CA: Verify the server certificate against a trusted Certificate Authority.

    • Verify identity: Verify the database connection information against the certificate contents.

    Field
    Value

    Host

    The host IP or DNS name.

    Port

    The port number.

    Database

    The database name. Leave blank to connect to the default database.

    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.

    General / SSL toggle

    View SSL settings for the connection.

    To use SSL, you must first uncomment and update the server.ssl configuration properties in your user.properties file.

    SSL: Use SSL

    Enable or disable SSL.

    SSL: SSL mode

    With SSL enabled, choose from:

    • Prefer (default): Make an encrypted connection if possible, otherwise fall back to an unencrypted connection.

    • Require: Require an encrypted connection.

    • Verify CA: Verify the server certificate against a trusted Certificate Authority.

    • Verify full: Verify the database connection information against the certificate contents.

    Field
    Value

    Host

    The host IP or DNS name.

    Port

    The port number.

    Database

    The database name. Required.

    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.

    Field
    Value

    Host

    The host IP or DNS name.

    Port

    The port number.

    Database

    The database name. Leave blank to connect to the default database.

    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.

Back

Settings