Skip to content

Commit 803322b

Browse files
authored
DOCSP-34023 Rename WiredTiger Parameters (#5400) (#5469)
* DOCSP-34023 Rename WiredTiger Parameters (#5400) * DOCSP-34023 Rename WiredTiger Parameters * KD feedback * * * JO feedback * *
1 parent 2ef152c commit 803322b

File tree

4 files changed

+88
-66
lines changed

4 files changed

+88
-66
lines changed

source/reference/command/serverStatus.txt

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

68236823
These settings are MongoDB-specific. To change the settings for
68246824
concurrent reads and write transactions (read and write tickets), see
6825-
:parameter:`wiredTigerConcurrentReadTransactions` and
6826-
:parameter:`wiredTigerConcurrentWriteTransactions`.
6825+
:parameter:`storageEngineConcurrentReadTransactions` and
6826+
:parameter:`storageEngineConcurrentWriteTransactions`.
68276827

68286828
.. important::
68296829

source/reference/parameters.txt

Lines changed: 72 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -5100,6 +5100,78 @@ Storage Parameters
51005100

51015101
:parameter:`processUmask` is not available on Windows systems.
51025102

5103+
.. parameter:: storageEngineConcurrentReadTransactions
5104+
5105+
.. versionchanged:: 7.0
5106+
5107+
|mongod-only|
5108+
5109+
*Type*: integer
5110+
5111+
*Default*: 128
5112+
5113+
Starting in MongoDB 7.0, this parameter is available for all storage
5114+
engines. In earlier versions, this parameter is available for the
5115+
WiredTiger storage engine only.
5116+
5117+
Specify the maximum number of concurrent read transactions (read tickets)
5118+
allowed into the storage engine.
5119+
5120+
.. |wtparam| replace:: ``storageEngineConcurrentReadTransactions``
5121+
5122+
.. include:: /includes/fact-concurrent-read-write-dynamic-behavior.rst
5123+
5124+
.. code-block:: javascript
5125+
5126+
db.adminCommand( { setParameter: 1, storageEngineConcurrentReadTransactions: <int> } )
5127+
5128+
.. versionchanged:: 6.0
5129+
5130+
The ``wiredTigerConcurrentReadTransactions`` parameter was renamed to
5131+
``storageEngineConcurrentReadTransactions``.
5132+
5133+
.. seealso::
5134+
5135+
:serverstatus:`wiredTiger.concurrentTransactions`
5136+
5137+
.. parameter:: storageEngineConcurrentWriteTransactions
5138+
5139+
.. versionchanged:: 7.0
5140+
5141+
|mongod-only|
5142+
5143+
*Type*: integer
5144+
5145+
Starting in MongoDB 7.0, this parameter is available for all storage
5146+
engines. In earlier versions, this parameter is available for the
5147+
WiredTiger storage engine only.
5148+
5149+
Specify the maximum number of concurrent write transactions allowed
5150+
into the WiredTiger storage engine.
5151+
5152+
By default, MongoDB sets ``storageEngineConcurrentWriteTransactions`` to
5153+
whichever value is higher:
5154+
5155+
- Number of cores on the machine running MongoDB
5156+
- 4
5157+
5158+
.. |wtparam| replace:: ``storageEngineConcurrentWriteTransactions``
5159+
5160+
.. include:: /includes/fact-concurrent-read-write-dynamic-behavior.rst
5161+
5162+
.. code-block:: javascript
5163+
5164+
db.adminCommand( { setParameter: 1, storageEngineConcurrentWriteTransactions: <int> } )
5165+
5166+
.. versionchanged:: 6.0
5167+
5168+
The ``wiredTigerConcurrentWriteTransactions`` parameter was renamed to
5169+
``storageEngineConcurrentWriteTransactions``.
5170+
5171+
.. seealso::
5172+
5173+
:serverstatus:`wiredTiger.concurrentTransactions`
5174+
51035175
.. parameter:: syncdelay
51045176

51055177
|mongod-only|
@@ -5246,68 +5318,6 @@ WiredTiger Parameters
52465318

52475319
.. versionadded:: 4.2.1
52485320

5249-
.. parameter:: wiredTigerConcurrentReadTransactions
5250-
5251-
.. versionchanged:: 7.0
5252-
5253-
|mongod-only|
5254-
5255-
*Type*: integer
5256-
5257-
*Default*: 128
5258-
5259-
Starting in MongoDB 7.0, this parameter is available for all storage
5260-
engines. In earlier versions, this parameter is available for the
5261-
WiredTiger storage engine only.
5262-
5263-
Specify the maximum number of concurrent read transactions (read tickets)
5264-
allowed into the storage engine.
5265-
5266-
.. |wtparam| replace:: ``wiredTigerConcurrentReadTransactions``
5267-
5268-
.. include:: /includes/fact-concurrent-read-write-dynamic-behavior.rst
5269-
5270-
.. code-block:: javascript
5271-
5272-
db.adminCommand( { setParameter: 1, wiredTigerConcurrentReadTransactions: <int> } )
5273-
5274-
.. seealso::
5275-
5276-
:serverstatus:`wiredTiger.concurrentTransactions`
5277-
5278-
.. parameter:: wiredTigerConcurrentWriteTransactions
5279-
5280-
.. versionchanged:: 7.0
5281-
5282-
|mongod-only|
5283-
5284-
*Type*: integer
5285-
5286-
Starting in MongoDB 7.0, this parameter is available for all storage
5287-
engines. In earlier versions, this parameter is available for the
5288-
WiredTiger storage engine only.
5289-
5290-
Specify the maximum number of concurrent write transactions allowed
5291-
into the WiredTiger storage engine.
5292-
5293-
By default, MongoDB sets ``wiredTigerConcurrentWriteTransactions`` to
5294-
whichever value is higher:
5295-
5296-
- Number of cores on the machine running MongoDB
5297-
- 4
5298-
5299-
.. |wtparam| replace:: ``wiredTigerConcurrentWriteTransactions``
5300-
5301-
.. include:: /includes/fact-concurrent-read-write-dynamic-behavior.rst
5302-
5303-
.. code-block:: javascript
5304-
5305-
db.adminCommand( { setParameter: 1, wiredTigerConcurrentWriteTransactions: <int> } )
5306-
5307-
.. seealso::
5308-
5309-
:serverstatus:`wiredTiger.concurrentTransactions`
5310-
53115321
.. parameter:: wiredTigerEngineRuntimeConfig
53125322

53135323
|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)