Skip to content

Commit abd20eb

Browse files
Merge pull request #46 from ianf-mongodb/DOCSP-27700
DOCSP-27700 Manage the Relation Model Refactor
2 parents 5e87eda + 73a7f8a commit abd20eb

File tree

2 files changed

+31
-26
lines changed

2 files changed

+31
-26
lines changed

snooty.toml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,5 +31,6 @@ toc_landing_pages = [
3131
"code-generation/code-generation"
3232
]
3333

34-
# [constants]
35-
# constant = "value"
34+
[constants]
35+
ddl = ":abbr:`DDL (Data Definition Language)`"
36+

source/projects/manage-relational-connection.txt

Lines changed: 28 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ Manage the Relational Model
99
.. contents:: On this page
1010
:local:
1111
:backlinks: none
12-
:depth: 1
12+
:depth: 2
1313
:class: singlecol
1414

15-
You can use the :guilabel:`Manage` button on the :guilabel:`Schema model` pane to
16-
make changes to the schemas or tables you want to include in
15+
You can use the :guilabel:`Manage` button on the :guilabel:`Schema model`
16+
pane to make changes to the schemas or tables you want to include in
1717
your migration project. You can also connect to the source database
18-
or use a DDL file to refresh the list of available tables.
18+
or use a {+ddl+} file to refresh the list of available tables.
1919

2020
Add or Remove Tables from a Project
2121
-----------------------------------
@@ -28,40 +28,44 @@ the :guilabel:`Manage` button.
2828

2929
#. Click the check box next to the schema or schemas you are migrating.
3030

31-
#. To expand the tables in a schema, click ``>``.
31+
#. To expand the tables in a schema, click the :icon-fa5:`chevron-right`
32+
button.
3233

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

3536
#. Click :guilabel:`Save`.
3637

3738
Changes from your relational database are reflected in the main
38-
Relational Migrator diagram and included in future migration jobs.
39+
Relational Migrator diagram and included in future sync jobs.
3940

4041
Refresh Schema Changes
4142
----------------------
4243

43-
If your relational database table structure changes, use the :guilabel:`Refresh Schema` button to let Relational Migrator know.
44+
If your relational database table structure changes, use the
45+
:guilabel:`Refresh Schema` button to let Relational Migrator know.
4446

45-
1. From the :guilabel:`Mapping` screen, click the :guilabel:`Manage` button on the
46-
:guilabel:`Schema model` pane.
47+
1. From the :guilabel:`Mapping` screen, click the :guilabel:`Manage`
48+
button on the :guilabel:`Schema model` pane.
4749

48-
#. Click the :guilabel:`Refresh schema` button on the Manage relational model modal.
50+
#. Click the :guilabel:`Refresh schema` button on the Manage
51+
relational model modal.
4952

50-
#. Select either :ref:`Connect DB <connect-db>` or :ref:`Import DDL File <import-ddl-file>`.
53+
#. Select either :ref:`Connect to database <connect-to-db>` or
54+
:ref:`Import DDL File <import-ddl-file>`.
5155

52-
.. _connect-db:
56+
.. _connect-to-db:
5357

54-
Connect DB
55-
~~~~~~~~~~~
58+
Connect to database
59+
~~~~~~~~~~~~~~~~~~~
5660

57-
:guilabel:`Connect DB` rescans the schema. Changes in foreign key relations or data
58-
types for the underlying tables are read into Migrator.
61+
:guilabel:`Connect to database` rescans the schema. Changes in foreign key
62+
relations or data types for the underlying tables are read into Migrator.
5963

60-
1. Input the :guilabel:`JDBC URI`, :guilabel:`Username` and :guilabel:`Password`
61-
for the database instance you are connecting to.
64+
1. Input the :guilabel:`JDBC URI`, :guilabel:`Username` and
65+
:guilabel:`Password` for the database instance you are connecting to.
6266

63-
The account used can be different from the credentials you used when creating
64-
the project.
67+
The account used can be different from the credentials you used when
68+
creating the project.
6569

6670
.. note::
6771

@@ -74,14 +78,14 @@ types for the underlying tables are read into Migrator.
7478

7579
Any changes from your relational database are reflected in
7680
the main Relational Migrator diagram and included in future
77-
migration jobs.
81+
sync jobs.
7882

7983
.. _import-ddl-file:
8084

8185
Import DDL File
8286
~~~~~~~~~~~~~~~
8387

84-
:guilabel:`Import DDL File` opens a file prompt that accepts a DDL file of the
88+
:guilabel:`Import DDL File` opens a file prompt that accepts a {+ddl+} file of the
8589
relational schema you are migrating. Any changes in the foreign key relations or
8690
data types for the underlying tables are read into Migrator.
8791

@@ -95,11 +99,11 @@ data types for the underlying tables are read into Migrator.
9599
- PostgreSQL
96100
- SQL Server
97101

98-
#. Choose a file or drag and drop a DDL statement file.
102+
#. Choose a file or drag and drop a {+ddl+} statement file.
99103

100104
#. Click :guilabel:`Import`.
101105

102106
#. Click :guilabel:`Save`.
103107

104108
Any changes from your relational database are reflected in the main
105-
Relational Migrator diagram and included in future migration jobs.
109+
Relational Migrator diagram and included in future sync jobs.

0 commit comments

Comments
 (0)