Skip to content

Commit f08b2b4

Browse files
authored
DOCSP-45120-change-sync-to-migration (#180)
* DOCSP-45120-change-sync-to-migration * DOCSP-45120 removing constants * DOCSP-45120 tech edit * DOCSP-45120 fixing build
1 parent 2f5b3d3 commit f08b2b4

File tree

54 files changed

+205
-207
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+205
-207
lines changed

snooty.toml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,6 @@ toc_landing_pages = [
4646
[constants]
4747
connector-version = "2.7.0"
4848
ddl = ":abbr:`DDL (Data Definition Language)`"
49-
job = "sync job" #this will be updated to migration job in the near future.
50-
job_plural = "sync jobs" #this will be updated to migration jobs in the near future.
5149
migrator-api = "REST API Documentation"
5250
migrator-api-endpoints = "Endpoints"
5351

source/api-docs.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Relational Migrator REST API
2121
The Relational Migrator REST API provides you with programmatic access
2222
to Relation Migrator with HTTPS endpoints. The REST API is a
2323
Relational Migrator service between your application and your source and
24-
destination databases that you can send requests to manage your sync jobs.
24+
destination databases that you can send requests to manage your migration jobs.
2525

2626
You don't need to install any additional extensions or packages to use
2727
the Relational Migrator REST API. The functionality is part of the
@@ -59,7 +59,7 @@ Use the Relational Migrator REST API when:
5959
``WHERE DATEDIFF(CURDATE(), last_modified) <= 1`` to batch migrate
6060
data on a cadence from your relational database to MongoDB.
6161

62-
- You want to programmatically create Relational Migrator sync jobs
62+
- You want to programmatically create Relational Migrator migration jobs
6363
dynamically. For example, using connection strings from
6464
multiple databases without manually configuring them in the GUI.
6565

source/code-generation/query-converter/test-converted-queries/compare-converted-queries.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ You can use the :guilabel:`Test Queries` pane to compare source
1414
and destination queries, views, and stored procedure results
1515
in Relational Migrator. The :guilabel:`Test Queries` can
1616
help you verify the accuracy of converted code and
17-
show the source and destination data after you run a sync job.
17+
show the source and destination data after you run a migration job.
1818

1919
About this Task
2020
---------------

source/connection-strings/connection-strings.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Relational Migrator uses connection strings to connect to both
1414
the relational and MongoDB databases. You can create connection strings:
1515

1616
- Using the UI when you create a project.
17-
- Using the UI when you create a sync job.
17+
- Using the UI when you create a migration job.
1818
- By manually providing the Uniform Resource Identifier (URI).
1919

2020
Get Started

source/connection-strings/mongodb-database-connection-strings.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,4 +137,4 @@ Results
137137
-------
138138

139139
The MongoDB connection URI is optionally specified as part of the process for
140-
creating a Relational Migrator project or when creating a sync job.
140+
creating a Relational Migrator project or when creating a migration job.

source/getting-started.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Get Started with Relational Migrator
2020

2121
Relational Migrator is a tool to help you migrate your relational
2222
data to MongoDB. This page guides you through installing the tool
23-
and running your first sync job.
23+
and running your first migration job.
2424

2525
To get familiar with Relational Migrator capabilities,
2626
features, and use cases, review the following resources:
@@ -64,16 +64,16 @@ Steps
6464
the destination data model that best matches your
6565
application needs.
6666

67-
.. step:: Create a sync job
67+
.. step:: Create a migration job
6868

69-
:ref:`Sync jobs <rm-sync-jobs>` move the data from relational
70-
tables to MongoDB collections. Sync jobs have two types:
69+
:ref:`Migration jobs <rm-sync-jobs>` move the data from relational
70+
tables to MongoDB collections. Migration jobs have two types:
7171

7272
- **Snapshot** for point in time migrations.
7373
- **Continuous** for ongoing change data capture zero-downtime migrations.
7474

7575
To start your migration to MongoDB,
76-
:ref:`create a sync job <rm-create-jobs>`.
76+
:ref:`create a migration job <rm-create-jobs>`.
7777

7878
.. toctree::
7979
:titlesonly:

source/getting-started/atlas-log-in.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Log In with Atlas
1313
You can optionally sign in to your Atlas account inside Relational
1414
Migrator. If you log in, you can access the
1515
:ref:`Query Converter <rm-query-converter>` feature and you can choose
16-
destination clusters from a list when creating sync jobs.
16+
destination clusters from a list when creating migration jobs.
1717

1818
Before you Begin
1919
----------------

source/getting-started/migration-scenarios.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ destination databases remain in sync.
4949
After the continuous sync migration completes, you can transfer users to
5050
the new application and shut down the legacy application.
5151

52-
To learn more about sync jobs, see :ref:`rm-sync-jobs`.
52+
To learn more about migration jobs, see :ref:`rm-sync-jobs`.
5353

5454
Currently Unsupported Migration Scenarios
5555
-----------------------------------------
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
When defining :ref:`rm-calculated-fields` and :ref:`rm-id-field-customizations`,
22
Relational Migrator shows an initial data type of :guilabel:`default`.
3-
When you run a sync job, Relational Migrator updates this data type.
3+
When you run a migration job, Relational Migrator updates this data type.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
You can recover a continuous sync job within 24 hours of failure.
1+
You can recover a continuous migration job within 24 hours of failure.
22
For details, see :ref:`rm-sync-jobs-recoverability`.

source/includes/fact-data-prep-oracle-step1.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ a. Create a service account:
1414
#. Grant select permissions to the service account:
1515

1616
The required permission for the service account depend on whether
17-
the tables are owned by the service account used to run the sync job.
17+
the tables are owned by the service account used to run the migration job.
1818
To check table ownership run the following query:
1919

2020
.. code-block:: sql
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
- Continuous sync jobs using Confluent Cloud Kafka may take additional
1+
- Continuous migration jobs using Confluent Cloud Kafka may take additional
22
time due to the provisioning of backend resources on Confluent Cloud.
33
This process typically takes an additional two to five
4-
minutes the first time a CDC sync job runs.
4+
minutes the first time a CDC migration job runs.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
This task also applies to Apache Kafka supported
2-
continuous sync jobs. There is no procedural difference introduced when
2+
continuous migration jobs. There is no procedural difference introduced when
33
using Kafka. For more details, see :ref:`kafka-intro`.

source/includes/fact-mapping-options-configure-fields.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,5 @@ a. Define the options for the new mapping rule. When defining the
1515

1616
- Change field names.
1717

18-
- Include or exclude a field from your sync job by clicking the
18+
- Include or exclude a field from your migration job by clicking the
1919
:icon-fa5:`check-square` icon next to the field name.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
- Snapshot sync jobs migrate all the data and then stops.
2-
- Continuous sync job run a snapshot and then enter a CDC stage to
1+
- Snapshot migration jobs migrate all the data and then stops.
2+
- Continuous migration job run a snapshot and then enter a CDC stage to
33
continuously replicate data changes.

source/index.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ Explore libraries and tools for MongoDB.
150150
Mapping Rules </mapping-rules/mapping-rules>
151151
Table Filters </table-filters/table-filters>
152152
Diagrams </diagrams/diagrams>
153-
Sync Jobs </jobs/sync-jobs>
153+
Migration Jobs </jobs/sync-jobs>
154154
Connection Strings </connection-strings/connection-strings>
155155
Code Generation </code-generation>
156156
{+migrator-api+} <api-docs>

source/installation.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ For instructions on installing Relational Migrator, see the following pages:
4444
* - Kafka
4545

4646
- The Kafka deployment method is suitable for long-running Change Data
47-
Capture (CDC) sync jobs and large data migrations that exceed 4 weeks in
47+
Capture (CDC) migration jobs and large data migrations that exceed 4 weeks in
4848
duration or involve databases larger than 20GB. `Apache Kafka
4949
<https://kafka.apache.org/>`__ is an open-source platform for distributed
5050
workloads that offers high availability and automatic recovery. This is the

source/installation/deployment-considerations.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ the most:
5858
.. tip::
5959

6060
Check the sleep timeout setting for your operating system. If your
61-
machine goes to sleep during a migration, the sync job fails.
61+
machine goes to sleep during a migration, the migration job fails.
6262

6363
Network Considerations
6464
----------------------

source/installation/kafka-deployments/migrator-with-kafka.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Use Cases
2626
---------
2727

2828
Relational Migrator with Kafka is intended for large and long running jobs.
29-
Kafka's built-in resilience ensures the sync job can recover and continue
29+
Kafka's built-in resilience ensures the migration job can recover and continue
3030
running if any component becomes temporarily unavailable.
3131

3232
Behavior

source/installation/system-requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ web browsers:
7575
Kafka Deployments
7676
-----------------
7777

78-
You can optionally use Kafka for long-running sync jobs. For details.
78+
You can optionally use Kafka for long-running migration jobs. For details.
7979
see :ref:`kafka-intro`.
8080

8181
Supported Databases

source/jobs/creating-jobs.txt

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
.. _rm-create-jobs:
22

3-
=================
4-
Create a Sync Job
5-
=================
3+
======================
4+
Create a Migration Job
5+
======================
66

77
.. contents:: On this page
88
:local:
99
:backlinks: none
1010
:depth: 1
1111
:class: singlecol
1212

13-
Sync jobs are the worker processes responsible for transferring your
13+
Migration jobs are the worker processes responsible for transferring your
1414
data and schemas from a relational database to MongoDB. Create a new
15-
sync job from the :guilabel:`Data Migration` tab.
15+
migration job from the :guilabel:`Data Migration` tab.
1616

1717
.. include:: /includes/fact-kafka-supported-task.rst
1818

1919
About this Task
2020
---------------
2121

22-
- The URI credentials you provide when creating a sync job do not
22+
- The URI credentials you provide when creating a migration job do not
2323
need to be the same as the credentials used when creating your project.
2424

2525
.. include:: /includes/fact-kafka-additional-time.rst
@@ -39,10 +39,10 @@ Steps
3939

4040
.. procedure::
4141

42-
.. step:: Click the :guilabel:`Create Sync Job` button
42+
.. step:: Click the :guilabel:`Create Migration Job` button
4343

44-
On the :guilabel:`Data Migration` tab, click :guilabel:`Create Sync Job`.
45-
Relational Migrator only runs one sync job at a time. If a sync job is in
44+
On the :guilabel:`Data Migration` tab, click :guilabel:`Create Migration Job`.
45+
Relational Migrator only runs one migration job at a time. If a migration job is in
4646
progress, this button is disabled.
4747

4848
.. step:: Enter the relational database connection details
@@ -148,13 +148,13 @@ Steps
148148
* - Migration Option
149149
- Description
150150
* - Mode
151-
- Defines the type of sync job.
151+
- Defines the type of migration job.
152152
* - Drop destination collections before migration
153153
- Boolean. Indicates whether Relational Migrator drops a
154154
destination collection before transferring data.
155155
* - Stop after errors
156156
- Integer. Indicates the number of errors after which Relational
157-
Migrator stops the sync job.
157+
Migrator stops the migration job.
158158
* - Verify migrated data
159159
- Boolean. If true, the sync engine checks the migrated data
160160
against the source database. Only supported for snapshot mode.
@@ -171,23 +171,23 @@ Steps
171171

172172
.. warning::
173173

174-
Before proceeding with starting a sync job:
174+
Before proceeding with starting a migration job:
175175

176176
1. Download the script.
177177
2. Carefully review its contents.
178178
3. Execute the statements.
179179
4. Follow any commented manual steps.
180180

181-
.. step:: Review and start your sync job
181+
.. step:: Review and start your migration job
182182

183183
On the :guilabel:`Review Summary` form, you can see details about
184-
your sync job. These details include the type, the number of
184+
your migration job. These details include the type, the number of
185185
tables and rows affected, and the estimated data size of the
186-
sync job. To start your sync job, click :guilabel:`Start`.
186+
migration job. To start your migration job, click :guilabel:`Start`.
187187

188188
.. note ::
189189

190-
For Kafka sync jobs, view deployment details by selecting the
190+
For Kafka migration jobs, view deployment details by selecting the
191191
job in the :guilabel:`History` pane on the
192192
:guilabel:`Data Migration` screen and hovering
193193
over the icon next to the :guilabel:`Create Migration Job`

source/jobs/data-verification/data-verification.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ Data Verification
1212

1313
Data verification is a process that is built into the sync engine.
1414
The data verification process uses the source and destination
15-
connection strings to validate that a sync job was successful.
15+
connection strings to validate that a migration job was successful.
1616

17-
- Data verification is supported for one-time sync jobs.
18-
- By default, data verification is not performed when running a sync job.
17+
- Data verification is supported for one-time migration jobs.
18+
- By default, data verification is not performed when running a migration job.
1919
You must explicitly opt-in to verification in :guilabel:`Migration Options`
2020
before the job is started.
21-
- Enabling data verification can add significant compute time to a sync
21+
- Enabling data verification can add significant compute time to a migration
2222
job.
2323

2424
When data verification is successful, source and destination states match.

source/jobs/data-verification/use-data-verification.txt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,26 +11,26 @@ Use Data Verification
1111
:class: singlecol
1212

1313
Data verification optionally runs as a separate process that is tightly
14-
coupled to a sync job. Data verification can be enabled for one-time
15-
sync jobs. This page details how to enable and debug the
14+
coupled to a migration job. Data verification can be enabled for one-time
15+
migration jobs. This page details how to enable and debug the
1616
data verification process.
1717

1818
Enable Data Verification
1919
------------------------
2020

2121
You can optionally enable data verification when
22-
:ref:`creating a sync job <rm-create-jobs>` on the :guilabel:`Data Migration` tab.
22+
:ref:`creating a migration job <rm-create-jobs>` on the :guilabel:`Data Migration` tab.
2323

2424
On the :guilabel:`Migration Options` module, click the
25-
:guilabel:`Verify migrated data` check box for your sync job.
25+
:guilabel:`Verify migrated data` check box for your migration job.
2626

2727
.. note::
2828

29-
The Data Verification process can take as long or longer than the data sync job.
29+
The Data Verification process can take as long or longer than the data migration job.
3030
You can click :guilabel:`Terminate` to cancel a Data Verification process.
3131

3232
To view status and metadata information about the data verification process
33-
for a sync job, click the :guilabel:`Data Verification` drop-down menu:
33+
for a migration job, click the :guilabel:`Data Verification` drop-down menu:
3434

3535
.. image:: /img/jobs/data-verification/data-verification-click-dropdown.png
3636
:alt: Click Data Verification Drop-Down
@@ -39,7 +39,7 @@ Data Verification Overview
3939
--------------------------
4040

4141
On the :guilabel:`Data Verification` pane, you can view the metadata
42-
about a sync jobs verification process.
42+
about a migration jobs verification process.
4343

4444
.. list-table::
4545
:header-rows: 1
@@ -87,7 +87,7 @@ A data verification process can be any of the following statuses:
8787
Successful Data Verification
8888
----------------------------
8989

90-
When a sync job is successful the status updates to :guilabel:`Verified`
90+
When a migration job is successful the status updates to :guilabel:`Verified`
9191
and a double checkmark is displayed in the :guilabel:`History` pane:
9292

9393
.. image:: /img/jobs/data-verification/data-verification-double-checkmark.png

0 commit comments

Comments
 (0)