Skip to content

Commit 1261b3c

Browse files
authored
DOCSP-34023 Rename WiredTiger Parameters (#5400)
* DOCSP-34023 Rename WiredTiger Parameters * KD feedback * * * JO feedback
1 parent 2fe53cc commit 1261b3c

File tree

4 files changed

+88
-117
lines changed

4 files changed

+88
-117
lines changed

source/reference/command/serverStatus.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6759,8 +6759,8 @@ wiredTiger
67596759

67606760
These settings are MongoDB-specific. To change the settings for
67616761
concurrent reads and write transactions (read and write tickets), see
6762-
:parameter:`wiredTigerConcurrentReadTransactions` and
6763-
:parameter:`wiredTigerConcurrentWriteTransactions`.
6762+
:parameter:`storageEngineConcurrentReadTransactions` and
6763+
:parameter:`storageEngineConcurrentWriteTransactions`.
67646764

67656765
.. important::
67666766

source/reference/parameters.txt

Lines changed: 72 additions & 113 deletions
Original file line numberDiff line numberDiff line change
@@ -5140,6 +5140,78 @@ Storage Parameters
51405140

51415141
:parameter:`processUmask` is not available on Windows systems.
51425142

5143+
.. parameter:: storageEngineConcurrentReadTransactions
5144+
5145+
.. versionchanged:: 7.0
5146+
5147+
|mongod-only|
5148+
5149+
*Type*: integer
5150+
5151+
*Default*: 128
5152+
5153+
Starting in MongoDB 7.0, this parameter is available for all storage
5154+
engines. In earlier versions, this parameter is available for the
5155+
WiredTiger storage engine only.
5156+
5157+
Specify the maximum number of concurrent read transactions (read tickets)
5158+
allowed into the storage engine.
5159+
5160+
.. |wtparam| replace:: ``storageEngineConcurrentReadTransactions``
5161+
5162+
.. include:: /includes/fact-concurrent-read-write-dynamic-behavior.rst
5163+
5164+
.. code-block:: javascript
5165+
5166+
db.adminCommand( { setParameter: 1, storageEngineConcurrentReadTransactions: <int> } )
5167+
5168+
.. versionchanged:: 6.0
5169+
5170+
The ``wiredTigerConcurrentReadTransactions`` parameter was renamed to
5171+
``storageEngineConcurrentReadTransactions``.
5172+
5173+
.. seealso::
5174+
5175+
:serverstatus:`wiredTiger.concurrentTransactions`
5176+
5177+
.. parameter:: storageEngineConcurrentWriteTransactions
5178+
5179+
.. versionchanged:: 7.0
5180+
5181+
|mongod-only|
5182+
5183+
*Type*: integer
5184+
5185+
Starting in MongoDB 7.0, this parameter is available for all storage
5186+
engines. In earlier versions, this parameter is available for the
5187+
WiredTiger storage engine only.
5188+
5189+
Specify the maximum number of concurrent write transactions allowed
5190+
into the WiredTiger storage engine.
5191+
5192+
By default, MongoDB sets ``storageEngineConcurrentWriteTransactions`` to
5193+
whichever value is higher:
5194+
5195+
- Number of cores on the machine running MongoDB
5196+
- 4
5197+
5198+
.. |wtparam| replace:: ``storageEngineConcurrentWriteTransactions``
5199+
5200+
.. include:: /includes/fact-concurrent-read-write-dynamic-behavior.rst
5201+
5202+
.. code-block:: javascript
5203+
5204+
db.adminCommand( { setParameter: 1, storageEngineConcurrentWriteTransactions: <int> } )
5205+
5206+
.. versionchanged:: 6.0
5207+
5208+
The ``wiredTigerConcurrentWriteTransactions`` parameter was renamed to
5209+
``storageEngineConcurrentWriteTransactions``.
5210+
5211+
.. seealso::
5212+
5213+
:serverstatus:`wiredTiger.concurrentTransactions`
5214+
51435215
.. parameter:: syncdelay
51445216

51455217
|mongod-only|
@@ -5235,119 +5307,6 @@ Storage Parameters
52355307
WiredTiger Parameters
52365308
~~~~~~~~~~~~~~~~~~~~~
52375309

5238-
.. parameter:: wiredTigerMaxCacheOverflowSizeGB
5239-
5240-
.. note:: Deprecated in MongoDB 4.4
5241-
5242-
5243-
MongoDB deprecates the ``wiredTigerMaxCacheOverflowSizeGB``
5244-
parameter. The parameter has no effect starting in MongoDB 4.4.
5245-
5246-
|mongod-only|
5247-
5248-
*Default*: 0 (No specified maximum)
5249-
5250-
Specify the maximum size (in GB) for the "lookaside (or cache
5251-
overflow) table" file :file:`WiredTigerLAS.wt` for MongoDB
5252-
4.2.1-4.2.x. The file no longer exists starting in
5253-
version 4.4.
5254-
5255-
The parameter can accept the following values:
5256-
5257-
.. list-table::
5258-
:header-rows: 1
5259-
:widths: 20 80
5260-
5261-
* - Value
5262-
- Description
5263-
5264-
* - ``0``
5265-
5266-
- The default value. If set to ``0``, the file size is
5267-
unbounded.
5268-
5269-
* - number >= 0.1
5270-
5271-
- The maximum size (in GB). If the :file:`WiredTigerLAS.wt`
5272-
file exceeds this size, :binary:`~bin.mongod` exits with a
5273-
fatal assertion. You can clear the :file:`WiredTigerLAS.wt`
5274-
file and restart :binary:`~bin.mongod`.
5275-
5276-
You can only set this parameter during run time using the
5277-
:dbcommand:`setParameter` database command:
5278-
5279-
.. code-block:: javascript
5280-
5281-
db.adminCommand( { setParameter: 1, wiredTigerMaxCacheOverflowSizeGB: 100 } )
5282-
5283-
To set the maximum size during start up, use the
5284-
:setting:`storage.wiredTiger.engineConfig.maxCacheOverflowFileSizeGB`
5285-
instead.
5286-
5287-
.. versionadded:: 4.2.1
5288-
5289-
.. parameter:: wiredTigerConcurrentReadTransactions
5290-
5291-
.. versionchanged:: 7.0
5292-
5293-
|mongod-only|
5294-
5295-
*Type*: integer
5296-
5297-
*Default*: 128
5298-
5299-
Starting in MongoDB 7.0, this parameter is available for all storage
5300-
engines. In earlier versions, this parameter is available for the
5301-
WiredTiger storage engine only.
5302-
5303-
Specify the maximum number of concurrent read transactions (read tickets)
5304-
allowed into the storage engine.
5305-
5306-
.. |wtparam| replace:: ``wiredTigerConcurrentReadTransactions``
5307-
5308-
.. include:: /includes/fact-concurrent-read-write-dynamic-behavior.rst
5309-
5310-
.. code-block:: javascript
5311-
5312-
db.adminCommand( { setParameter: 1, wiredTigerConcurrentReadTransactions: <int> } )
5313-
5314-
.. seealso::
5315-
5316-
:serverstatus:`wiredTiger.concurrentTransactions`
5317-
5318-
.. parameter:: wiredTigerConcurrentWriteTransactions
5319-
5320-
.. versionchanged:: 7.0
5321-
5322-
|mongod-only|
5323-
5324-
*Type*: integer
5325-
5326-
Starting in MongoDB 7.0, this parameter is available for all storage
5327-
engines. In earlier versions, this parameter is available for the
5328-
WiredTiger storage engine only.
5329-
5330-
Specify the maximum number of concurrent write transactions allowed
5331-
into the WiredTiger storage engine.
5332-
5333-
By default, MongoDB sets ``wiredTigerConcurrentWriteTransactions`` to
5334-
whichever value is higher:
5335-
5336-
- Number of cores on the machine running MongoDB
5337-
- 4
5338-
5339-
.. |wtparam| replace:: ``wiredTigerConcurrentWriteTransactions``
5340-
5341-
.. include:: /includes/fact-concurrent-read-write-dynamic-behavior.rst
5342-
5343-
.. code-block:: javascript
5344-
5345-
db.adminCommand( { setParameter: 1, wiredTigerConcurrentWriteTransactions: <int> } )
5346-
5347-
.. seealso::
5348-
5349-
:serverstatus:`wiredTiger.concurrentTransactions`
5350-
53515310
.. parameter:: wiredTigerEngineRuntimeConfig
53525311

53535312
|mongod-only|

source/release-notes/6.0-compatibility.txt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,18 @@ MongoDB 6.0 removes the following server parameters:
186186
:doc:`reconfigure your TLS/SSL connections </tutorial/configure-ssl>`
187187
before upgrading.
188188

189+
Renamed Parameters
190+
------------------
191+
192+
Starting in MongoDB 6.0, the following parameters have been renamed:
193+
194+
- ``wiredTigerConcurrentReadTransactions`` is now
195+
:parameter:`storageEngineConcurrentReadTransactions`
196+
197+
- ``wiredTigerConcurrentWriteTransactions`` is now
198+
:parameter:`storageEngineConcurrentWriteTransactions`
199+
200+
189201
TTL ``expireAfterSeconds`` Behavior When Set to ``NaN``
190202
-------------------------------------------------------
191203

source/release-notes/7.0.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -191,8 +191,8 @@ Concurrent Storage Engine Transactions (Read and Write Tickets)
191191
To learn more, see:
192192

193193
- :serverstatus:`wiredTiger.concurrentTransactions`
194-
- :parameter:`wiredTigerConcurrentReadTransactions`
195-
- :parameter:`wiredTigerConcurrentWriteTransactions`
194+
- :parameter:`storageEngineConcurrentReadTransactions`
195+
- :parameter:`storageEngineConcurrentWriteTransactions`
196196

197197
``currentOp`` Metrics
198198
~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)