docsp-32850 - network compression (#113)

Author: mongoKart

source/fundamentals/connection.txt

@@ -11,6 +11,7 @@ Connection
    /fundamentals/connection/connect
    /fundamentals/connection/connection-options
    /fundamentals/connection/tls
+   /fundamentals/connection/network-compression
    Connect to MongoDB Atlas from AWS Lambda <https://www.mongodb.com/docs/atlas/manage-connections-aws-lambda/>
 
 .. contents:: On this page

source/fundamentals/connection/network-compression.txt

@@ -0,0 +1,76 @@
+.. _csharp-network-compression:
+
+===================
+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-short+} supports the following compression algorithms:
+
+1. `Snappy <https://google.github.io/snappy/>`__: available in MongoDB 3.6 and later.
+
+2. `Zlib <https://zlib.net/>`__: available in MongoDB 3.6 and later.
+
+3. `Zstandard <https://github.com/facebook/zstd/>`__: available in MongoDB 4.2 and later.
+
+If you specify multiple compression algorithms, the driver selects the
+first one in the list supported by your MongoDB instance.
+
+.. _enable-compression:
+
+Specify Compression Algorithms
+------------------------------
+
+To enable compression for the connection to your MongoDB instance,
+specify the algorithms you want to use in one of the following ways: 
+
+1. Add the algorithms to your connection string as a parameter 
+2. Specify the algorithms in the ``Compressors`` property of your ``MongoClientSettings``
+   object
+
+.. tabs::
+
+   .. tab:: Connection String
+      :tabid: connection-string
+
+      To enable compression by using the connection string, add the
+      ``compressors`` parameter to the connection string. You can
+      specify one or more compression algorithms, separating them with
+      commas:
+
+      .. code-block:: csharp
+         :emphasize-lines: 2
+
+         const string connectionUri =
+           "mongodb+srv://<user>:<password>@<cluster-url>/?compressors=snappy,zlib,zstd";
+
+         var client = new MongoClient(connectionUri);
+
+   .. tab:: MongoClientSettings
+      :tabid: mongoclientsettings
+
+      To enable compression by using
+      `MongoClientSettings <{+api-root+}/T_MongoDB_Driver_MongoClientSettings.htm>`__,
+      set the ``Compressors`` property of your ``MongoClientSettings`` object to a
+      ``List`` of one or more ``CompressorConfiguration`` objects. Each
+      ``CompressorConfiguration`` object in the ``List`` represents an algorithm you
+      want to use:
+
+      .. code-block:: csharp
+         :emphasize-lines: 5-10
+
+         var settings = new MongoClientSettings()
+         {  
+            Scheme = ConnectionStringScheme.MongoDB,
+            Server = new MongoServerAddress("<cluster-url>"),
+            Compressors = new List<CompressorConfiguration>()
+            {  
+               new CompressorConfiguration(CompressorType.Snappy),
+               new CompressorConfiguration(CompressorType.Zlib),
+               new CompressorConfiguration(CompressorType.Zstandard)
+            }
+         };
+
+         var client = new MongoClient(settings);