Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
cbfae0b
Draft
nvillahermosa-mdb Jan 9, 2025
c1d3b82
Pushing draft content for build
nvillahermosa-mdb Jan 14, 2025
f45302d
Rendering check
nvillahermosa-mdb Jan 16, 2025
b5728f8
Removed unnecessary new file
nvillahermosa-mdb Jan 16, 2025
d723a17
Removed DB2 and Sybase ASE from main relational connection workflow s…
nvillahermosa-mdb Jan 16, 2025
2c96c22
Feedback
nvillahermosa-mdb Jan 17, 2025
9513a7b
Typo
nvillahermosa-mdb Jan 17, 2025
c8baf3d
Typo
nvillahermosa-mdb Jan 17, 2025
c878753
Typo
nvillahermosa-mdb Jan 17, 2025
d6ee883
Draft content
nvillahermosa-mdb Jan 27, 2025
3265c50
Removed JDBC procedure
nvillahermosa-mdb Feb 3, 2025
6afaaed
Trimmed JDBC coverage in migration job doc
nvillahermosa-mdb Feb 3, 2025
5270ca9
Removed JDBC driver column
nvillahermosa-mdb Feb 3, 2025
a2e5956
DB support cleanup
nvillahermosa-mdb Feb 3, 2025
358d23d
Added public preview content back
nvillahermosa-mdb Feb 3, 2025
9cdbf73
Added public preview content back
nvillahermosa-mdb Feb 3, 2025
3ff905f
Rendering
nvillahermosa-mdb Feb 3, 2025
dc8bbea
Rendering
nvillahermosa-mdb Feb 3, 2025
3023bc2
Copy edits
nvillahermosa-mdb Feb 3, 2025
e2419ca
Columns
nvillahermosa-mdb Feb 3, 2025
83e05e7
Added supported versions
nvillahermosa-mdb Feb 3, 2025
fe8d220
Errant punctuation
nvillahermosa-mdb Feb 4, 2025
b17da57
Moved DB2, Sybase back out of main support table
nvillahermosa-mdb Feb 25, 2025
176c809
Removed extraneous sybase prereqs page
nvillahermosa-mdb Feb 25, 2025
f31ab6e
Removed an additional extra link
nvillahermosa-mdb Feb 25, 2025
a65d55a
Wording fix
nvillahermosa-mdb Feb 25, 2025
bb4d3c1
Alphabetization
nvillahermosa-mdb Feb 25, 2025
7d7d8d6
Rebuild
nvillahermosa-mdb Feb 28, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions snooty.toml
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,8 @@ migrator-api-endpoints = "Endpoints"
[[banners]]
targets = [
"jobs/prerequisites/db2.txt",
"jobs/prerequisites/sybase.txt"
]
variant = "warning"
value = """\
DB2 and Sybase database support is currently in public preview. Users looking for production-grade migration assistance, please contact your account representative to engage in a guided evaluation.
DB2 database support is currently in public preview. Users looking for production-grade migration assistance, please contact your account representative to engage in a guided evaluation.
"""
10 changes: 0 additions & 10 deletions source/database-connections/save-relational-connection.txt
Original file line number Diff line number Diff line change
Expand Up @@ -68,16 +68,6 @@ To save a new connection from the :guilabel:`Connections` page:

.. include:: /includes/table-postgresql-connection-fields.rst

.. tab:: DB2
:tabid: db-db2

.. include:: /includes/table-db2-connection-fields.rst

.. tab:: Sybase ASE
:tabid: db-sybase

.. include:: /includes/table-sybase-connection-fields.rst

.. step: Identify the connection

Enter a :guilabel:`Connection name` and optional :guilabel:`Environment tag`.
Expand Down
88 changes: 64 additions & 24 deletions source/getting-started/supported-databases.txt
Original file line number Diff line number Diff line change
Expand Up @@ -23,30 +23,35 @@ versions for both source and MongoDB databases.

.. warning::

You might be able to use other versions or deployments, but they have not been tested
with Relational Migrator.
You might be able to use other versions or deployments, but they have not
been tested with Relational Migrator.

Source Databases and Versions
-----------------------------
Supported Source Databases
--------------------------

Relational Migrator supports the following source databases:
Relational Migrator supports the following source databases:

.. list-table::
:header-rows: 1
:widths: 25 40 35

* - Database
- Supported Versions
- Deployments

* - :ref:`Oracle <rm-prereq-oracle>`
- 11g and higher
- Self hosted, AWS RDS

* - :ref:`Microsoft SQL Server <rm-prereq-sqlserver>`
- 2012 and higher (Enterprise or Developer edition required for
versions before 2016)
- Self hosted, AWS RDS, Azure SQL Database

* - :ref:`MySQL <rm-prereq-mysql>`
- 5.7 and higher
- Self hosted, AWS RDS/Aurora, Azure Database

* - :ref:`Oracle <rm-prereq-oracle>`
- 11g and higher
- Self hosted, AWS RDS

* - :ref:`PostgreSQL <rm-prereq-postgres>`
- 10 and higher
- Self hosted, AWS RDS/Aurora, Azure Database
Expand All @@ -55,33 +60,68 @@ Relational Migrator supports the following source databases:
- 10 and higher
- Self hosted, AWS RDS/Aurora, Azure Database

* - :ref:`MySQL <rm-prereq-mysql>`
- 5.7 and higher
- Self hosted, AWS RDS/Aurora, Azure Database

* - :ref:`Sybase ASE <rm-prereq-sybase>` (Public Preview)
- 15 and higher (Sybase IQ not supported)
.. _jdbc-databases:

Databases Supported with a JDBC Driver
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. important::

This feature is in public preview.

Some databases are supported for snapshot data migration through a JDBC
connection. You can run snapshot migration jobs against these databases, but
not continuous CDC sync jobs.

.. list-table::
:header-rows: 1

* - Database
- Supported Versions
- Deployments

* - CockroachDB
- 24.3.0 and higher
- Self hosted

* - :ref:`DB2 <rm-prereq-db2>` (Public Preview)
* - :ref:`DB2 <rm-prereq-db2>`
- 11.5 and higher
- Self hosted, AWS RDS
- Self hosted, AWS RDS

MongoDB Databases and Versions
------------------------------
* - SQL Anywhere
- 16.0 and higher
- Self hosted

Relational Migrator supports the following MongoDB databases:
* - Sybase ASE
- 15 and higher
- Self hosted

* - Sybase IQ
- 16.0 and higher
- Self hosted

* - Yugabyte
- 2.20 and higher
- Self hosted


MongoDB Support
---------------

Relational Migrator supports the following MongoDB versions and deployments:

.. list-table::
:header-rows: 1

* - Database
* - Deployment Type
- Supported Versions
- Deployments

* - MongoDB
- 4.4 and higher
- Self hosted, MongoDB Atlas
* - MongoDB Server (Self-Managed)
- 5.0 and higher

* - MongoDB Atlas
- 5.0 and higher

Learn More
----------
Expand Down
3 changes: 3 additions & 0 deletions source/includes/fact-user-properties-location.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- **MacOS:** ``~/Library/Application Support/MongoDB/Relational Migrator/user.properties``
- **Windows:** ``C:\Users\%USERNAME%\AppData\Local\MongoDB\Relational Migrator\Data\user.properties``
- **Linux:** ``~/Migrator/user.properties``
10 changes: 0 additions & 10 deletions source/includes/steps-create-relational-connection-short.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,6 @@ a. In the :guilabel:`Database type` drop-down, select the database type.

.. include:: /includes/table-postgresql-connection-fields.rst

.. tab:: DB2
:tabid: db-db2

.. include:: /includes/table-db2-connection-fields.rst

.. tab:: Sybase ASE
:tabid: db-sybase

.. include:: /includes/table-sybase-connection-fields.rst

#. Enter a :guilabel:`Connection name` and optional :guilabel:`Environment tag`.

#. Click :guilabel:`Connect`.
Expand Down
22 changes: 18 additions & 4 deletions source/jobs/creating-jobs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,12 @@
---------------

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

Check failure on line 23 in source/jobs/creating-jobs.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules

[vale] reported by reviewdog 🐶 [MongoDB.ConciseTerms] 'must' is preferred over 'need to'. Raw Output: {"message": "[MongoDB.ConciseTerms] 'must' is preferred over 'need to'.", "location": {"path": "source/jobs/creating-jobs.txt", "range": {"start": {"line": 23, "column": 3}}}, "severity": "ERROR"}

- You use an existing :ref:`Relational Database Connection
<rm-save-relational-connection>`, or create one when you create the migration job.
- If you're migrating from a :ref:`supported database <supported-databases>`,
you can use a saved :ref:`Relational Database Connection
<rm-save-relational-connection>`, or create one when you create the migration
job.

.. include:: /includes/fact-kafka-additional-time.rst

Expand All @@ -34,10 +36,15 @@

- :ref:`Create one or more mapping rules <create-rule-relational>` in your
Relational Migrator project.

- For both Atlas and on-premises deployments, create a separate
:ref:`MongoDB user <rm-mongodb-service-user>` for Relational Migrator with
:authrole:`readWrite` access to your MongoDB database.

- If you're using a :ref:`JDBC driver <jdbc-databases>` to perform a snapshot
migration, contact your MongoDB representative for configuration information.


Steps
-----

Expand Down Expand Up @@ -79,13 +86,20 @@
* - Migration Option
- Description
* - Mode
- Defines the type of migration job.
- :guilabel:`Snapshot` or :guilabel:`Continuous` migration.

For databases connected through a :ref:`JDBC driver <jdbc-databases>`,
Relational Migrator only supports snapshot migration. The
:guilabel:`Continuous` option is disabled for these databases.

* - Drop destination collections before migration
- Boolean. Indicates whether Relational Migrator drops a
destination collection before transferring data.

* - Stop after errors
- Integer. Indicates the number of errors after which Relational
Migrator stops the migration job.

* - Verify migrated data
- Boolean. If true, the sync engine checks the migrated data
against the source database. Only supported for snapshot mode.
Expand Down
7 changes: 1 addition & 6 deletions source/jobs/prerequisites.txt
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,7 @@ create your first migration job.
- :icon-lg:`Checkmark`
- :icon-lg:`Checkmark`

* - :ref:`Sybase ASE <rm-prereq-sybase>`
- :icon-lg:`Checkmark`
-

* - :ref:`DB2 <rm-prereq-db2>`
* - Databases supported with a :ref:`JDBC driver <jdbc-databases>`
- :icon-lg:`Checkmark`
-

Expand All @@ -69,5 +65,4 @@ create your first migration job.
Oracle </jobs/prerequisites/oracle>
PostgreSQL </jobs/prerequisites/postgres>
SQL Server </jobs/prerequisites/sql-server>
Sybase </jobs/prerequisites/sybase>
DB2 </jobs/prerequisites/db2>
14 changes: 0 additions & 14 deletions source/jobs/prerequisites/sybase.txt

This file was deleted.

Loading