Skip to content

Commit 06b228e

Browse files
authored
DOCSP-30123 Project with a Recommended Schema Details (#28)
* DOCSP-30123 Recommended Schema
1 parent d53f0b6 commit 06b228e

6 files changed

+37
-32
lines changed
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Before finalizing the creation of your project, you have the choice to
2+
select the initial mappings. These options include starting with a
3+
recommended MongoDB schema, which is automatically suggested by
4+
Relational Migrator based on your relational database.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
Choose an :guilabel:`Initial mappings` option for your MongoDB schema.
2+
3+
- :guilabel:`Start with a MongoDB schema that matches your relational schema`
4+
Creates your initial project with a new document mapping rule for each table.
5+
6+
- :guilabel:`Start with a recommended MongoDB schema`
7+
Relational Migrator creates mapping rules for a suggested MongoDB schema.
8+
When you choose this option, a table appears showing the imported relational tables.
9+
Relational Migrator suggests which tables should be represented as
10+
:guilabel:`top-level` or :guilabel:`embedded` collections.
11+
You can use the checkboxes to modify which tables are mapped into
12+
collections or embedded.
13+
14+
- :guilabel:`Start with an empty MongoDB schema`
15+
Creates your initial project with no mapping rules.
16+
17+
.. note::
18+
19+
Regardless of the option you choose when starting your project,
20+
you have the flexibility to manually add, remove, or modify mapping
21+
rules at any time. This allows you to customize the MongoDB schema
22+
according to the specific requirements of your workload.

source/index.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Bring Your Relational Workloads to MongoDB With Confidence
7676

7777
.. procedure::
7878

79-
.. step:: Replicate From Supported Relation Systems
79+
.. step:: Replicate From Supported Relational Systems
8080

8181
Replicate data from Oracle, MySQL, SQL Server, or PostgreSQL
8282
to MongoDB Atlas or on-premises.

source/projects/create-project-live-connection.txt

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,9 @@ When creating a project with a live connection you:
2525
About this Task
2626
---------------
2727

28-
Creating a project with live a live connection is the recommended process for starting a new Relational Migrator project.
28+
Creating a project with a live connection is the recommended process for starting a new Relational Migrator project.
29+
30+
.. include:: /includes/project-initial-mappings-att.rst
2931

3032
Steps
3133
-----
@@ -133,16 +135,7 @@ Steps
133135
- ``snake_case``
134136
- ``UPPER_SNAKE_CASE``
135137

136-
#. Choose an :guilabel:`Initial mappings` option for your MongoDB schema.
137-
138-
- :guilabel:`Start with a MongoDB schema that matches your relational schema`: Creates your
139-
initial project with a new document mapping rule for each table.
140-
141-
- :guilabel:`Start with a recommended MongoDB schema`: Relational Migrator chooses
142-
mapping rules for you.
143-
144-
- :guilabel:`Start with an empty MongoDB schema`: Creates your initial project
145-
with no mapping rules.
138+
#. .. include:: /includes/project-initial-mappings.rst
146139

147140
#. Enter a name for your project.
148141

source/projects/create-project-loading-schema-files.txt

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ to your relational database are a consideration.
4141
Although you can create a project and map schemas from a DDL file, Relational Migrator
4242
still connects to the relational database to run sync jobs.
4343

44+
.. include:: /includes/project-initial-mappings-att.rst
45+
4446
Before you Begin
4547
----------------
4648

@@ -160,16 +162,7 @@ Steps
160162
- ``snake_case``
161163
- ``UPPER_SNAKE_CASE``
162164

163-
#. Choose an :guilabel:`Initial mappings` option for your MongoDB schema.
164-
165-
- :guilabel:`Start with a MongoDB schema that matches your relational schema`: Creates your
166-
initial project with a new document mapping rule for each table.
167-
168-
- :guilabel:`Start with a recommended MongoDB schema`: Relational Migrator chooses
169-
mapping rules for you.
170-
171-
- :guilabel:`Start with an empty MongoDB schema`: Creates your initial project
172-
with no mapping rules.
165+
#. .. include:: /includes/project-initial-mappings.rst
173166

174167
#. Enter a name for your project.
175168

source/projects/create-project-sample-schema.txt

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ About this Task
2929
Creating a project with a sample schema is the quickest and easiest way
3030
to test drive Relational Migrator.
3131

32+
.. include:: /includes/project-initial-mappings-att.rst
33+
3234
Before you Begin
3335
----------------
3436

@@ -117,16 +119,7 @@ skip step one.
117119
- ``snake_case``
118120
- ``UPPER_SNAKE_CASE``
119121

120-
#. Choose an :guilabel:`Initial mappings` option for your MongoDB schema.
121-
122-
- :guilabel:`Start with a MongoDB schema that matches your relational schema`: Creates your
123-
initial project with a new document mapping rule for each table.
124-
125-
- :guilabel:`Start with a recommended MongoDB schema`: Relational Migrator chooses
126-
mapping rules for you.
127-
128-
- :guilabel:`Start with an empty MongoDB schema`: Creates your initial project
129-
with no mapping rules.
122+
#. .. include:: /includes/project-initial-mappings.rst
130123

131124
#. Enter a name for your project.
132125

0 commit comments

Comments
 (0)