Skip to content

Commit 6852a4d

Browse files
committed
DOCSP-1907, DOCSP-1908: wiredTigerEngineRuntimeConfig
1 parent ce1eb50 commit 6852a4d

File tree

2 files changed

+36
-51
lines changed

2 files changed

+36
-51
lines changed

source/reference/command/setParameter.txt

Lines changed: 3 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -19,51 +19,8 @@ setParameter
1919

2020
.. code-block:: javascript
2121

22-
{ setParameter: 1, <option>: <value> }
22+
db.adminCommand( { setParameter: 1, <parameter>: <value> } )
2323

24-
Replace the ``<option>`` with one of the supported
25-
:dbcommand:`setParameter` options:
24+
For the available parameters, including examples, see
25+
:doc:`/reference/parameters`.
2626

27-
**Indexing**
28-
29-
- :parameter:`failIndexKeyTooLong`
30-
- :parameter:`notablescan`
31-
32-
**Logging**
33-
34-
- :parameter:`logComponentVerbosity`
35-
- :parameter:`logLevel`
36-
- :parameter:`logUserIds`
37-
- :parameter:`maxLogSizeKB`
38-
- :parameter:`quiet`
39-
- :parameter:`traceExceptions`
40-
41-
**Replication**
42-
43-
- :parameter:`replApplyBatchSize`
44-
- :parameter:`replIndexPrefetch`
45-
- :parameter:`oplogInitialFindMaxSeconds`
46-
47-
**Security**
48-
49-
- :parameter:`auditAuthorizationSuccess`
50-
- :parameter:`clusterAuthMode`
51-
- :parameter:`scramIterationCount`
52-
- :parameter:`sslMode`
53-
54-
**Sharding**
55-
56-
- :parameter:`userCacheInvalidationIntervalSecs`
57-
58-
**Storage**
59-
60-
- :parameter:`journalCommitInterval`
61-
- :parameter:`syncdelay`
62-
- :parameter:`wiredTigerEngineRuntimeConfigSetting`
63-
64-
**JavaScript**
65-
66-
- :parameter:`disableJavaScriptJIT`
67-
68-
.. slave-ok, admin-only
69-
.. textSearchEnabled, deprecated v2.6

source/reference/parameters.txt

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,34 @@ MongoDB Server Parameters
1313
Synopsis
1414
--------
1515

16-
MongoDB provides a number of configuration options that are accessible
17-
via the :dbcommand:`setParameter` command or the
18-
``--setParameter`` option.
16+
MongoDB provides a number of configuration options that you can set
17+
using:
18+
19+
- the :dbcommand:`setParameter` command:
20+
21+
.. code-block:: javascript
22+
23+
db.adminCommand( { setParameter: 1, <parameter>: <value> } )
24+
25+
- the :setting:`setParameter` configuration setting:
26+
27+
.. code-block:: yaml
28+
29+
setParameter:
30+
<parameter1>: <value1>
31+
...
32+
33+
- the ``--setParameter`` command-line option for :option:`mongod <mongod --setParameter>`
34+
and :option:`mongos <mongos --setParameter>`:
35+
36+
.. code-block:: sh
37+
38+
mongod --setParameter <parameter>=<value>
39+
mongos --setParameter <parameter>=<value>
1940

2041
For additional configuration options, see
21-
:doc:`/reference/configuration-options` and :doc:`Manual Page for
22-
mongod </reference/program/mongod>`.
42+
:doc:`/reference/configuration-options`, :binary:`~bin.mongod` and
43+
:binary:`~bin.mongos`.
2344

2445
Parameters
2546
----------
@@ -1614,11 +1635,18 @@ WiredTiger Parameters
16141635

16151636
|mongod-only|
16161637

1638+
16171639
Specify ``wiredTiger`` storage engine configuration options for a
16181640
running :binary:`~bin.mongod` instance. You can *only* set this
16191641
parameter using the :dbcommand:`setParameter` command and *not*
16201642
using the command line or configuration file option.
16211643

1644+
.. warning::
1645+
1646+
Avoid modifying the :parameter:`wiredTigerEngineRuntimeConfig`
1647+
unless under the direction from MongoDB engineers as this setting has
1648+
major implication across both WiredTiger and MongoDB.
1649+
16221650
Consider the following operation prototype:
16231651

16241652
.. code-block:: javascript

0 commit comments

Comments
 (0)