Compress Network Traffic

Version Compatibility

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

Compression Algorithm	Minimum Driver Version	Minimum Server Version
Snappy	3.0	4.2
Zlib	3.0	4.2
Zstandard	4.7	4.2

Enable Network Compression

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

Install Dependencies

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.

Specify Compression Algorithms

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

Adding the parameter to your connection string.
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:

"snappy" for Snappy compression
"zlib" for Zlib compression
"zstd" for Zstandard compression

Back

Connection Options

Stable API