From 3757d8fb1dfd1ff9b80aed2376070b5c4888aaba Mon Sep 17 00:00:00 2001
From: Igor Ribeiro Sucupira <igorrs@gmail.com>
Date: Sun, 10 Jan 2010 03:37:34 -0200
Subject: Add option to compress data when copying tables between Mnesia nodes

Optionally using data compression for copying Mnesia tables allows
the system to be tuned to eliminate network bottlenecks from
deployments where enough CPU is available to use zlib.

With this patch, running erl -mnesia send_compressed <level>
will enable compression for sending tables between nodes. The
compression level can be any integer in [0, 9], with 0 (the
default) meaning no compression (exactly the previous behaviour)
and 9 being the highest compression level.

To set any non-zero compression level at the sender, both nodes
must have the updated Mnesia modules (the receiver will work
according to the sender's configuration).
---
 lib/mnesia/doc/src/mnesia.xml | 11 +++++++++++
 1 file changed, 11 insertions(+)

(limited to 'lib/mnesia/doc')

diff --git a/lib/mnesia/doc/src/mnesia.xml b/lib/mnesia/doc/src/mnesia.xml
index 3484cd104a..33387a88f4 100644
--- a/lib/mnesia/doc/src/mnesia.xml
+++ b/lib/mnesia/doc/src/mnesia.xml
@@ -3044,6 +3044,17 @@ raise(Name, Amount) ->
           The default value is <c>2</c>.
           </p>
       </item>
+      <item>
+        <p><c>-mnesia send_compressed Level</c> specifies the level of
+          compression to be used when copying a table from the local node to
+          another one. The default level is 0.
+          </p>
+        <p><c>Level</c> must be an integer in the interval [0, 9], with 0
+          representing no compression and 9 representing maximum compression.
+          Before setting it to a non-zero value, make sure the remote nodes
+          understand this configuration.
+          </p>
+      </item>
       <item>
         <p><c>-mnesia schema_location Loc</c> controls where
           Mnesia will look for its schema. The parameter
-- 
cgit v1.2.3