Skip to main content
Skip table of contents

MongoDB installation and upgrade

Downloading the connector

The connector is provided as a zip file on the Delphix download site. Perform these steps to download the connector:

  1. Launch a web browser and navigate to the Delphix download portal.

  2. Login to the portal using customer support credentials.

  3. Navigate to Delphix Product Releases -> Select Connectors  ->  MongoDB_Linux v0.X.X (applicable version number) → click the sc_mongo_0.X.X.json file available to initiate the download.

Installing the connector

  1. Login to the Delphix Management application.

  2. Click Manage -> Plugins.

  3. To upload a plugin, click the + icon.

  4. This step displays the Upload or Upgrade a Plugin dialog. Upload the sc_mongo_0.X.X.json file.


For more information, refer to the Continuous Data Engine connector management page.

Upgrading the connector

Uploading a higher version connector is the same as installing the MongoDB connector. 

Perform the following steps to upgrade a connector version:

  1. Upload the higher version connector file at step 4 above.

  2. Refresh all corresponding environments.

  3. Ensure connector discovery is completed successfully.

  4. Take a new snapshot of the staging database and VDB.

Datasets do not require a disable and re-enabled as part of the upgrade process. Only refresh of environments is required.

To verify the new version of the connector, view the snapshot metadata on the new snapshot.

To upgrade to newer versions of the MongoDB connector, you must follow the upgrade path as given below.

Currently Installed Version

Recommended upgrade path

1.0.x, 1.1.x, 1.2.x, 1.3.x

Upgrade to 1.4.0 using the standard upgrade directions

Things to consider during upgrade

  • $MONGO_REPO_CFGFILE file update with connector upgrade

    • After uploading the 1.1.0 MongoDB connector version, specify the MongoDB database tools path in $MONGO_REPO_CFGFILE.

    • After uploading the 1.2.0 or later MongoDB connector version, specify all relevant paths for mongosh, mongod, mongorestore, mongodump, and mongosync in $MONGO_REPO_CFGFILE.

    • After uploading the 1.2.1 or later MongoDB connector version, replace the Legacy mongo shell with the mongosh shell on the staging and target environments, to make benefit of more shell features like MongoDB node.js driver support.

    • Once complete, refresh the environment. Steps can be found in the Refresh an environment section in the Environment operations page before executing any other operation.

Upgrade to MongoDB connector version v1.2.1 or later

If the dSource type is onlinemongodump.

  1. Make sure that the Source MongoDB Host Connect String contains replica set to PRIMARY as a first node in the connection string.

    1. For example, if Source MongoDB Host Connect String is set to,,, the must refers to the PRIMARY node of replica set.

  2. If the source database is SSL/TLS enabled, modify the Source MongoDB Host Connect String using the following rules:

    1. --ssl should be replaced with --tls

    2. --sslPEMKeyFile should be replaced with --tlsCertificateKeyFile

    3. --sslCAFile should be replaced with --tlsCAFile

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.