Skip to content

Commit d8898d3

Browse files
committed
DOCS-4559: adds new glossary terms for 2.8
1 parent 5bb6226 commit d8898d3

File tree

4 files changed

+51
-20
lines changed

4 files changed

+51
-20
lines changed

source/core/storage.txt

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ collections. Each database has a distinct set of data files and can
2929
contain a large number of collections. A single MongoDB deployment may
3030
have many databases.
3131

32+
.. _storage-wiredtiger:
33+
3234
WiredTiger Storage Engine
3335
-------------------------
3436

@@ -61,7 +63,7 @@ the data files are *always* valid.
6163
The WiredTiger journal persists all data modifications between
6264
checkpoints. If MongoDB exits between checkpoints, it uses the journal
6365
to replay all data modified since the last checkpoint. By default the
64-
WiredTiger journal is compressed using the ``snappy`` algorithm.
66+
WiredTiger journal is compressed using the :term:`snappy` algorithm.
6567

6668
You can disable journaling by setting :setting:`storage.journal.enabled`
6769
to ``false``, which can reduce the overhead of maintaining the
@@ -71,27 +73,31 @@ unexpectedly between
7173
checkpoints. For members of :term:`replica sets <replica set>`, the replication
7274
process may provide sufficient durability guarantees.
7375

76+
.. _storage-wiredtiger-compression:
77+
7478
Compression
7579
~~~~~~~~~~~
7680

7781
MongoDB supports compression for all collections and indexes using
78-
both block and prefix compression. Compression minimize storage use at the
79-
expense of additional computational requirements.
82+
both block and :term:`prefix compression`. Compression minimizes storage use at the
83+
expense of additional CPU.
8084

81-
By default all indexes with the WiredTiger engine use prefix compression
82-
enabled. Also, by default all collections with WiredTiger use block
83-
compression with the ``snappy`` algorithm. Compression with ``zlib``
84-
compression is also available.
85+
By default, all indexes with the WiredTiger engine use :term:`prefix compression`.
86+
Also, by default all collections with WiredTiger use block
87+
compression with the :term:`snappy` algorithm. Compression with :term:`zlib`
88+
is also available.
8589

8690
You can modify the default compression settings for all collections
8791
and indexes. Compression is also configurable on a per-collection and
8892
per-index basis during collection and index creation.
8993

90-
For most workloads the default compression settings balance storage
94+
For most workloads, the default compression settings balance storage
9195
efficiency and processing requirements.
9296

9397
.. TODO add link to wiredTiger configuration
9498

99+
.. _storage-mmapv1:
100+
95101
MMAPv1 Storage Engine
96102
---------------------
97103

source/includes/options-mongod.yaml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1614,31 +1614,31 @@ description: |
16141614
16151615
- ``none``
16161616
1617-
- ``snappy``
1617+
- :term:`snappy`
16181618
1619-
- ``zlib``
1619+
- :term:`zlib`
16201620
---
16211621
program: mongod
1622-
name: wiredTigerCollectionBlockCompressor
1622+
name: wiredTigerIndexBlockCompressor
16231623
directive: option
16241624
optional: true
1625-
default: "snappy"
1625+
default: "none"
16261626
args: "<compressor>"
16271627
description: |
16281628
16291629
.. versionadded:: 2.8.0
16301630
1631-
Specifies the default type of compression to use to compress collection
1632-
data. You can override this on a per-collection basis when creating
1633-
collections.
1631+
Specifies the default type of compression to use to compress index
1632+
data. You can override this on a per-index basis when creating
1633+
indexes.
16341634
16351635
Available compressors are:
16361636
16371637
- ``none``
16381638
1639-
- ``snappy``
1639+
- :term:`snappy`
16401640
1641-
- ``zlib``
1641+
- :term:`zlib`
16421642
---
16431643
program: mongod
16441644
name: wiredTigerIndexPrefixCompression
@@ -1650,6 +1650,6 @@ description: |
16501650
16511651
.. versionadded:: 2.8.0
16521652
1653-
Specify ``true`` for {{role}} to enable prefix compression for
1653+
Specify ``true`` for {{role}} to enable :term:`prefix compression` for
16541654
index data.
16551655
...

source/reference/glossary.txt

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -615,6 +615,12 @@ Glossary
615615
:doc:`/reference/command/collMod` and
616616
:collflag:`usePowerOf2Sizes`.
617617

618+
prefix compression
619+
Reduces memory and disk consumption by storing any identical index
620+
key prefixes only once, per page of memory. See:
621+
:ref:`storage-wiredtiger-compression` for more about WiredTiger's
622+
compression behavior.
623+
618624
pre-splitting
619625
An operation performed before inserting data that divides the
620626
range of possible shard key values into chunks to facilitate easy
@@ -817,6 +823,16 @@ Glossary
817823
information on master/slave replication, see
818824
:doc:`/core/master-slave`.
819825

826+
snappy
827+
A compression/decompression library designed to balance
828+
efficient computation requirements with reasonable compression rates.
829+
Snappy is the default compression
830+
library for MongoDB's use of ':ref:`WiredTiger
831+
<storage-wiredtiger>`. See: `Snappy
832+
<https://code.google.com/p/snappy/>`_ and the `WiredTiger compression
833+
documentation <http://source.wiredtiger.com/2.4.1/compression.html>`_
834+
for more information.
835+
820836
split
821837
The division between :term:`chunks <chunk>` in a :term:`sharded
822838
cluster`. See :doc:`/core/sharding-chunk-splitting`.
@@ -961,3 +977,12 @@ Glossary
961977
relevant chunk get applied to the proper shard. For related
962978
information, see :ref:`faq-writebacklisten` and
963979
:ref:`server-status-writebacksqueued`.
980+
981+
zlib
982+
A data compression library that provides higher compression rates
983+
at the cost of more CPU, compared to MongoDB's use of
984+
:term:`snappy`. You can configure :ref:`WiredTiger
985+
<storage-wiredtiger>` to use zlib as its compression library. See:
986+
http://www.zlib.net and the `WiredTiger compression documentation
987+
<http://source.wiredtiger.com/2.4.1/compression.html>`_ for more
988+
information.

source/release-notes/2.8.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,9 @@ options. You can set :ref:`WiredTiger options on the command line
6161
All existing server, database, and collection reporting exposes
6262
statistics from WiredTiger.
6363

64-
WiredTiger compresses collection data by default using ``snappy``.
64+
WiredTiger compresses collection data by default using :term:`snappy`.
6565

66-
WiredTiger uses prefix compression on all indexes by default.
66+
WiredTiger uses :term:`prefix compression` on all indexes by default.
6767

6868
Increased Number of Replica Set Members
6969
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)