Compress Network Traffic

Overview

The Scala driver provides a connection option to compress messages, which reduces the amount of data passed over the network between MongoDB and your application.

The driver supports the following algorithms:

• Snappy

• Zlib

• Zstandard

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

Specify Compression Algorithms

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

• In the compressors parameter of your connection string

• In the compressorList method chained to the MongoClientSettings.builder() method

The following example shows how to specify all compression algorithms. Select the Connection String or MongoClientSettings tab to see the corresponding syntax:

val mongoClient = MongoClient(
  "mongodb://<hostname>:<port>/?compressors=snappy,zlib,zstd"
)

val settings = MongoClientSettings.builder()
  .applyConnectionString(ConnectionString("<connection string>"))
  .compressorList(List(
    MongoCompressor.createSnappyCompressor(),
    MongoCompressor.createZlibCompressor(),
    MongoCompressor.createZstdCompressor()
  ).asJava)
  .build()
val mongoClient = MongoClient(settings)

API Documentation

To learn more about any of the methods or types discussed in this guide, see the following API documentation:

• MongoClientSettings

• MongoClientSettings.Builder.compressorList()

• MongoCompressor

• MongoCompressor.createSnappyCompressor()

• MongoCompressor.createZlibCompressor()

• MongoCompressor.createZstdCompressor()