Docs Menu
Docs Home
/
MongoDB Cluster-to-Cluster Sync
/
Reference

mongosync

On this page

  • Definition
  • Compatibility
  • Syntax
  • Command Line Options
  • Global Options
  • Behavior
  • Learn More

Definition

The mongosync binary is the primary process used in Cluster-to-Cluster Sync. mongosync migrates data from one cluster to another and can keep the clusters in continuous sync.

You can use mongosync to create dedicated analytics, development, or testing clusters that mirror your production environment. Synchronized clusters can also support locality requirements for audit and data residency compliance.

In addition to continuous data synchronization, mongosync can also facilitate a one time data migration between clusters.

For an overview of the mongosync process, see About mongosync.

To get started with mongosync, refer to the Quick Start Guide.

Compatibility

  • The minimum supported server versions of MongoDB are 6.0.13 and 7.0.6.

    You can migrate data on clusters (source) with versions of MongoDB lower than 6.0 to an Atlas cluster (destination). Migration from clusters with lower version requires additional preparation and configuration in the clusters with the lower version. Contact your account team to inquire about Professional Services.

  • mongosync supports replica sets and sharded clusters.

  • Standalone MongoDB instances are not supported. Convert the standalone instance to a replica set before using Cluster-to-Cluster Sync.

  • mongosync does not support Atlas shared clusters or serverless instances.

  • For a full list of limitations, see Cluster-to-Cluster Sync Limitations.

Syntax

The mongosync command layout below is modified for display. To connect cluster0 to cluster1 with mongosync, enter the following command on one line:

mongosync \
      --cluster0 "<cluster0_connection_string>" \
      --cluster1 "<cluster1_connection_string>"

For more information on how to format your connection strings, see Connecting mongosync.

Command Line Options

Global Options

--cluster0 <URI>

Sets the connection URI for the first cluster. The first cluster can serve as either the source or the destination in the sync process. Designate the source and destination clusters in the call to the start API endpoint.

For more information on connecting mongosync, see Connections.

To set the --cluster0 option from a configuration file, see the cluster0 setting.

Warning

On some systems, providing a password in a connection string with the --cluster0 or --cluster1 options may make the password visible to system status programs, such as ps, that may be invoked by other users.

Consider using the --config option to specify a configuration file containing the password instead.

--cluster1 <URI>

Sets the connection URI for the second cluster. The second cluster can serve as either the source or the destination in the sync process. Designate the source and destination clusters in the call to the start API endpoint.

For more information on connecting mongosync, see Connections.

To set the --cluster1 option from a configuration file, see the cluster1 setting.

Warning

On some systems, providing a password in a connection string with the --cluster0 or --cluster1 options may make the password visible to system status programs, such as ps, that may be invoked by other users.

Consider using the --config option to specify a configuration file containing the password instead.

--config <filename>

Sets the path to the configuration file.

For more information, see Configuration File.

--disableTelemetry

New in version 1.4.0.

Disables the collection of telemetry data for mongosync.

By default, mongosync collects anonymous, aggregated usage data to improve MongoDB products. When you run mongosync you can disable collection of this telemetry data.

To set the --disableTelemetry option from a configuration file, see the disableTelemetry setting.

For more information, see User Data Collection.

--help, -h

Prints usage information to stdout.

--id <ID>

Sets an identifier for the mongosync instance.

Use this option when running multiple instances of mongosync on a sharded cluster, to synchronize the shards individually.

The identifier value for this option must correspond to the shard ID of the shard it syncs. To find the shard ID, use the listShards command.

To set the --id option from a configuration file, see the id setting.

--loadLevel <level>

Type: integer

Default: 3

Sets the cluster workload level for syncing data between the source and destination clusters:

  • 4, the highest setting, maximizes cluster workload and syncs data the fastest.

  • 1, the lowest setting, minimizes cluster workload and syncs data the slowest.

To set the --loadLevel option from a configuration file, see the loadLevel setting.

Warning

Setting loadLevel higher than the default of 3 may negatively impact the destination cluster performance.

If read bottlenecks exist on the source cluster or if write bottlenecks exist on the destination cluster, decreasing loadLevel might improve performance.

--logPath <DIR>

Sets the path to the log directory. Cluster-to-Cluster Sync writes logs to files in this directory.

For more information, see Logging.

To set the --logPath option from a configuration file, see the logPath setting.

--port

Default: 27182

Sets the port used by the HTTP server for the Cluster-to-Cluster Sync HTTP API.

To set the --port option from a configuration file, see the port setting.

--verbosity <level>

Default: DEBUG

Sets the verbosity level to use in log messages. Cluster-to-Cluster Sync logs all messages at the specified level and any messages at lower levels.

The --verbosity option supports the following values:

  • TRACE

  • DEBUG

  • INFO

  • WARN

  • ERROR

  • FATAL

  • PANIC

To set the --verbosity option from a configuration file, see the verbosity setting.

--version, -v

Prints mongosync version information to stdout.

Behavior

For more information, see mongosync Behavior.

Learn More

Back

Reference

Next

Behavior