Docs Menu

Docs HomeNode.js

Network Compression

You can enable a driver option to compress messages, which reduces the amount of data passed over the network between MongoDB and your application.

The driver supports the following compression algorithms:

  1. Snappy: available in MongoDB 3.6 and later.

  2. Zlib: available in MongoDB 3.6 and later.

If you specify multiple compression algorithms, the driver selects the first one in the list supported by your MongoDB instance.

Note

When using the Snappy or Zstandard compression algorithm, you must add explicit dependencies.

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.

Specify compression algorithms using the following strings:

  • "snappy" for Snappy compression

  • "zlib" for Zlib compression

To add the Snappy compression algorithm to your application, run the following code:

npm install --save snappy

To add the Zstandard compression algorithm to your application, run the following code:

npm install --save @mongodb-js/zstd
←  Connection OptionsStable API →
Give Feedback
© 2022 MongoDB, Inc.

About

  • Careers
  • Investor Relations
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2022 MongoDB, Inc.