MongoDB

Prev Next

Overview

Replicate Preview enables efficient data movement between MongoDB environments, supporting both source and target configurations. Users can quickly define replication pipelines by selecting source tables and configuring target destinations, allowing data to be replicated with minimal setup and operational overhead. The platform simplifies pipeline creation while ensuring consistent and reliable data delivery across MongoDB instances.

Note

MongoDB is currently supported as both a source and target endpoint in Replicate Preview, limited to Snapshot (full load) replication mode, with Change Data Capture (CDC) and streaming replication not yet supported.

Prerequisites

  • Ensure that you create a MongoDB datastore connection and assign Metadata Scanning and Cloud Replication usage types. Refer to Create a Connection and Connecting to MongoDB for more information.

  • If you are using this connection as a source, run a scan to ingest metadata from this connection's objects into the SKP.

Connection Considerations

Replica Set

  • Leave blank for standalone MongoDB installations.

  • Required when connecting to MongoDB replica set deployments.

  • The value must exactly match the replica set name configured on the MongoDB cluster.

Verify in MongoDB using the following command: rs.status() .

Authentication Type

MongoDB connections support multiple authentication methods depending on the security requirements of your environment.

By default, the SKP uses Username and Password Authentication, where a MongoDB user account is validated against the specified Authentication Source database. This is the most common authentication method for standalone MongoDB servers and replica set deployments.

For enhanced security, organizations may also enable TLS (Transport Layer Security). When TLS is enabled, all communication between the SKP and MongoDB is encrypted, helping protect credentials and data transmitted across the network. TLS can be used in conjunction with Username and Password Authentication and is recommended for production environments.

Available authentication options include:

  • Username and Password (standard MongoDB authentication)

  • TLS with certificate validation

  • TLS with self-signed or non-trusted certificates (using the Allow Invalid TLS Certificates option, typically for testing purposes)

User Permissions

When setting up replications that use MongoDB as either a source or target database, you need to ensure that the User ID used for establishing connections to the database has sufficient read and write privileges to complete all the operations required for Replicate Preview to perform a replication.

At minimum, the MongoDB user should have read permissions:

db.grantRolesToUser(
  "skpuser",               //your_username
  [
    { role: "readAnyDatabase", db: "admin" }
  ]
)

For both Read and Write permissions:

db.grantRolesToUser(
  "skp_user",               //your_username
  [
    { role: "readWrite", db: "your_database_name" }
  ]
)

Next Steps

In Replicate Preview, configure your workspace using this system datastore and start replicating data. Refer to Configure Workspace: Datastores for more information.