Skip to content

Commit 310bc71

Browse files
committed
DOCS-331 add setParameter examples
1 parent 6924114 commit 310bc71

File tree

1 file changed

+58
-30
lines changed

1 file changed

+58
-30
lines changed

source/reference/command/setParameter.txt

Lines changed: 58 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -18,98 +18,126 @@ setParameter
1818
Replace the ``<option>`` with one of the following options
1919
supported by this command:
2020

21-
:option integer journalCommitInterval:
22-
21+
:option integer journalCommitInterval:
22+
2323
Specify an integer between ``1`` and ``500`` signifying the number
2424
of milliseconds (ms) between journal commits.
2525

2626
Consider the following example which sets the
27-
:option:`journalCommitInterval` to ``200`` ms:
28-
27+
``journalCommitInterval`` to ``200`` ms:
28+
2929
.. code-block:: javascript
30-
30+
3131
use admin
3232
db.runCommand( { setParameter: 1, journalCommitInterval: 200 } )
33-
34-
:option integer logLevel:
35-
33+
34+
.. seealso::
35+
36+
:setting:`journalCommitInterval`.
37+
38+
:option integer logLevel:
39+
3640
Specify an integer between ``0`` and ``5`` signifying the
3741
verbosity of the logging, where ``5`` is the most verbose.
3842

3943
Consider the following example which sets the
40-
:option:`logLevel` to ``2``:
41-
44+
``logLevel`` to ``2``:
45+
4246
.. code-block:: javascript
43-
47+
4448
use admin
4549
db.runCommand( { setParameter: 1, logLevel: 2 } )
46-
50+
51+
.. seealso::
52+
53+
:setting:`verbose`.
54+
4755
:option boolean notablescan:
48-
56+
4957
Specify whether queries must use indexes. If ``true``,
5058
queries that perform a table scan instead of using an index
5159
will fail.
5260

5361
Consider the following example which sets the
54-
:option:`notablescan` to true:
55-
62+
``notablescan`` to true:
63+
5664
.. code-block:: javascript
57-
65+
5866
use admin
5967
db.runCommand( { setParameter: 1, notablescan: true } )
6068

69+
.. seealso::
70+
71+
:setting:`notablescan`.
72+
73+
6174
:option boolean traceExceptions:
62-
75+
6376
.. versionadded:: 2.1
64-
77+
6578
Specify whether to log full stack traces on assertions or
6679
errors. If ``true``, :program:`mongod` will log full stack
6780
traces on assertions or errors.
6881

6982
Consider the following example which sets the
70-
:option:`traceExceptions` to true:
71-
83+
``traceExceptions`` to true:
84+
7285
.. code-block:: javascript
73-
86+
7487
use admin
7588
db.runCommand( { setParameter: 1, traceExceptions: true } )
7689

77-
:option boolean quiet:
78-
90+
.. seealso::
91+
92+
:setting:`traceExceptions`.
93+
94+
:option boolean quiet:
95+
7996
Specify whether to go into a quiet logging mode. If
8097
``true``, :program:`mongod` will go into a quiet logging
8198
mode which will not log the following events/activities:
82-
99+
83100
- connection events;
101+
84102
- the :dbcommand:`drop` command, the
85103
:dbcommand:`dropIndexes` command, the
86104
:dbcommand:`diagLogging` command, the
87105
:dbcommand:`validate` command, and the
88106
:dbcommand:`clean` command; and
107+
89108
- replication synchronization activities.
90109

91110
Consider the following example which sets the
92-
:option:`quiet` to true:
111+
``quiet`` to true:
93112

94113
.. code-block:: javascript
95-
114+
96115
use admin
97116
db.runCommand( { setParameter: 1, quiet: true } )
98117

118+
.. seealso::
119+
120+
:setting:`quiet`.
121+
99122
:option integer syncdelay:
100-
101-
Specify the interval, in seconds, between :term:`fsyncs
123+
124+
Specify the interval in seconds between :term:`fsyncs
102125
<fsync>` (i.e., flushes of memory to disk). By default,
103126
:program:`mongod` will flush memory to disk every 60
104127
seconds. Do not change this value unless you see a
105128
background flush average greater than 60 seconds.
106129

107130
Consider the following example which sets the
108-
:option:`syncdelay` to 60:
131+
``syncdelay`` to ``60`` seconds:
109132

110133
.. code-block:: javascript
111-
134+
112135
use admin
113136
db.runCommand( { setParameter: 1, syncdelay: 60 } )
114137

138+
.. seealso::
139+
140+
:setting:`syncdelay`.
141+
142+
115143
.. slave-ok, admin-only

0 commit comments

Comments
 (0)