Create a Project by Using a Sample Schema

About this Task

Creating a project with a sample schema is the quickest and easiest way to test drive Relational Migrator.

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.

Before you Begin

Before you can run sync jobs from the sample schema you must either:

1. Download Docker to pull and host a provided PostgreSQL database container. This container comes preloaded with the sample schema presented in Relational Migrator.

2. Download and execute the Northwind.sql database setup script on an existing PostgreSQL instance. This script loads the sample schema.

Steps

The following steps guide you through the process of connecting to a Docker container with the intent of migrating data with sync jobs. This is not a requirement, you can create a project without running sync jobs. If you do not plan on running sync jobs, skip step one.

1. (Optional) From a terminal window, run the following Docker command to launch a PostgreSQL relational database instance:

   docker run -p 5432:5432 public.ecr.aws/v4d7k6c9/relational-migrator-sample-database

   The connection credentials for this database instance are:

   • Username: postgres

   • Password: postgres

   • Port: 5432

   Warning

   The PostgreSQL database is for demo uses only and should not be used for production purposes.

2. In Relational Migrator, click New Project at the top-right of the Relational Migrator home screen.

3. Click the Create sample button.

4. From the Select tables screen, indicate the tables you want to migrate, and click Next.

   The following table explains the different ways you can select tables to migrate:

   Target	Action
   All tables within a database	Click the check mark for the target database.
   All tables within a schema	Expand the target database and click the check mark for the target schema.
   Specific tables within a schema	Expand the target database and schema. Select the target tables individually.
   Specific table names	Use the Filter bar above the Relational Schema list.

5. Choose a Global casing option for collection names.

   This option affects the names of your collections created from the tables in your relational database:

   • Keep Original: Keep the original casing used in your relational database table name.

   • Override with Global Casing: Override the original table name with a global casing convention.

     • camelCase

     • TitleCase

     • kebab-case

     • snake_case

     • UPPER_SNAKE_CASE

6. Choose an Initial mappings option for your MongoDB schema.

   • Start with a MongoDB schema that matches your relational schema

     Creates your initial project with a new document mapping rule for each table.

   • Start with a recommended MongoDB schema

     Relational Migrator creates mapping rules for a suggested MongoDB schema. When you choose this option, a table appears showing the imported relational tables. Relational Migrator suggests which tables should be represented as top-level or embedded collections. You can use the checkboxes to modify which tables are mapped into collections or embedded.

   • Start with an empty MongoDB schema

     Creates your initial project with no mapping rules.

   Note

   Regardless of the option you choose when starting your project, you have the flexibility to manually add, remove, or modify mapping rules at any time. This allows you to customize the MongoDB schema according to the specific requirements of your workload.

7. Enter a name for your project.

8. Click Done.

Next Steps

• Create Mapping Rules From Relational

• Create Mapping Rules To MongoDB