Skip to content

Commit 9b2108f

Browse files
(DOCSP-20183): Updates to snapshot history (#223)
* (DOCSP-20183): Updates to snapshot history * Updates per copy review
1 parent 553658e commit 9b2108f

File tree

2 files changed

+25
-8
lines changed

2 files changed

+25
-8
lines changed

source/core/wiredtiger.txt

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,6 @@ metadata table is atomically updated to reference the new checkpoint.
5757
Once the new checkpoint is accessible, WiredTiger frees pages from the
5858
old checkpoints.
5959

60-
Starting in MongoDB 5.0, you can use the
61-
:parameter:`minSnapshotHistoryWindowInSeconds` parameter to control how
62-
long WiredTiger keeps the snapshot history.
63-
6460
Using WiredTiger, even without :ref:`journaling
6561
<storage-wiredtiger-journal>`, MongoDB can recover from the last
6662
checkpoint; however, to recover changes made after the last checkpoint,
@@ -70,6 +66,24 @@ run with :ref:`journaling <storage-wiredtiger-journal>`.
7066

7167
.. include:: /includes/wiredtiger-node-nojournal.rst
7268

69+
.. _storage-snapshot-history:
70+
71+
Snapshot History Retention
72+
~~~~~~~~~~~~~~~~~~~~~~~~~~
73+
74+
Starting in MongoDB 5.0, you can use the
75+
:parameter:`minSnapshotHistoryWindowInSeconds` parameter to specify how
76+
long WiredTiger keeps the snapshot history.
77+
78+
Increasing the value of :parameter:`minSnapshotHistoryWindowInSeconds`
79+
increases disk usage, because the server must maintain the history of
80+
older modified values within the specified time window. The amount of
81+
disk space used depends on your workload, with higher volume workloads
82+
requiring more disk space.
83+
84+
MongoDB maintains the snapshot history in the ``WiredTigerHS.wt`` file,
85+
located in your specified :setting:`~storage.dbPath`.
86+
7387
.. _storage-wiredtiger-journal:
7488

7589
Journal

source/reference/parameters.txt

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3986,12 +3986,15 @@ Storage Parameters
39863986
.. code-block:: javascript
39873987

39883988
db.adminCommand( { setParameter: 1, minSnapshotHistoryWindowInSeconds: 600 } )
3989+
3990+
.. note::
39893991

3990-
.. seealso::
3992+
Increasing the value of
3993+
:parameter:`minSnapshotHistoryWindowInSeconds` increases disk
3994+
usage. For more information, see :ref:`storage-snapshot-history`.
39913995

3992-
- Read concern :readconcern:`"snapshot"`
3993-
- :ref:`Snapshots and Checkpoints
3994-
<storage-wiredtiger-checkpoints>`
3996+
To modify this value for a :atlas:`MongoDB Atlas </>` cluster, you
3997+
must contact :atlas:`Atlas Support </support>`.
39953998

39963999
.. parameter:: processUmask
39974000

0 commit comments

Comments
 (0)