Merge pull request #191 from nvillahermosa-mdb/DOCSP-38140-jdbc-snapshots

DOCSP-38140 JDBC snapshots

Author: nvillahermosa-mdb

snooty.toml

@@ -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. 
         """

source/database-connections/save-relational-connection.txt

@@ -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`.

source/getting-started/supported-databases.txt

@@ -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
@@ -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
 ----------

source/includes/fact-user-properties-location.rst

@@ -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``

source/includes/steps-create-relational-connection-short.rst

@@ -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`.

source/jobs/creating-jobs.txt

@@ -20,10 +20,12 @@ About this Task
 ---------------
 
 - 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.
 
-- 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
 
@@ -34,10 +36,15 @@ Before you Begin
 
 - :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
 -----
 
@@ -79,13 +86,20 @@ Steps
         * - 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 verifies migrated data 
             against the source database. Only supported for snapshot mode.

source/jobs/prerequisites.txt

@@ -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`
      - 
 
@@ -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>