For AI agents: a documentation index is available at https://www.mongodb.com/docs/llms.txt — markdown versions of all pages are available by appending .md to any URL path.
Docs Menu

Compress Network Traffic

MongoDB drivers can compress the messages sent to and received from MongoDB Server. This reduces the amount of data transferred for each operation. Compression can improve performance over constrained networks and lower the data transfer costs associated with running MongoDB Atlas.

Compression operates at the wire protocol level, so it applies to every operation that your application performs. If you specify more than one algorithm, the driver uses the first algorithm in your list that MongoDB Server also supports.

MongoDB drivers support the following compression algorithms:

MongoDB Atlas charges for data transferred across cloud regions, cloud providers, and between your infrastructure and MongoDB Atlas. Network compression reduces the amount of data that your application sends and receives, which can lower these data transfer costs. To learn more about pricing, see Data Transfer Costs.

Network compression also has productivity benefits. Compressed messages take less time to transfer across the network, which can improve your application's response times. Compression also reduces the bandwidth that your MongoDB traffic uses, which leaves more bandwidth available for other applications on the same network.

When you choose a compression algorithm, consider the following guidelines:

  • Use Zstandard for a balance of compression efficiency and resource usage. Zstandard is a good default choice for most applications.

  • Use Snappy for latency-sensitive applications that require minimal computational overhead.

  • Use Zlib for broad compatibility across MongoDB drivers and environments.

Tip

Monitor CPU Usage

Compression trades network bandwidth for CPU usage. After you enable network compression, monitor your application's CPU utilization to confirm that the trade-off benefits your workload. To learn more about these trade-offs, see the CPU Utilization and Network Compression in MongoDB blog post.

The following table lists the minimum supported driver and MongoDB Server version for each compression algorithm:

Compression Algorithm
Minimum Driver Version
Minimum Server Version

3.0

4.2

3.0

4.2

4.7

4.2

To enable network compression for your MongoDB connection, install the required dependencies and specify the compression algorithms you want to use.

The following table lists each algorithm and the required dependencies, if any:

Compression Algorithm
Dependencies

Snappy

Add the snappy package to your application. To install, run the npm install --save snappy command.

Zlib

None

Zstandard

Add the @mongodb-js/zstd package to your application. To install, run the npm install --save @mongodb-js/zstd command.

You can enable compression for the connection to your MongoDB instance by specifying the algorithms in one of two ways:

  1. Adding the parameter to your connection string.

  2. Specifying the compressors option in your MongoClientOptions.

To enable compression using the connection string, add the compressors parameter in the connection string. You can specify one or more compression algorithms, separating them with commas:

const uri =
"mongodb+srv://<user>:<password>@<cluster-url>/?compressors=snappy,zlib";
const client = new MongoClient(uri);

To enable compression using the MongoClientOptions, pass the compressors option and the compression algorithm you want to use. You can specify one or more compression algorithms, separating them with commas:

const uri =
"mongodb+srv://<user>:<password>@<cluster-url>";
const client = new MongoClient(uri,
{
compressors: ["snappy"]
});

Specify compression algorithms using the following strings: