Skip to content

Commit 9b9cc49

Browse files
committed
Document setting options to box.cfg directly (#3451)
1 parent 864ca12 commit 9b9cc49

File tree

1 file changed

+38
-6
lines changed

1 file changed

+38
-6
lines changed

doc/reference/configuration/index.rst

Lines changed: 38 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -292,15 +292,47 @@ Configuration parameters have the form:
292292
Since ``box.cfg`` may contain many configuration parameters and since some of the
293293
parameters (such as directory addresses) are semi-permanent, it's best to keep
294294
``box.cfg`` in a Lua file. Typically this Lua file is the initialization file
295-
which is specified on the tarantool command line.
295+
which is specified on the Tarantool command line.
296296

297297
Most configuration parameters are for allocating resources, opening ports, and
298-
specifying database behavior. All parameters are optional. A few parameters are
299-
dynamic, that is, they can be changed at runtime by calling ``box.cfg{}``
300-
a second time.
298+
specifying database behavior. All parameters are optional.
299+
A few parameters are dynamic, that is, they can be changed at runtime by calling ``box.cfg{}`` a second time.
300+
For example, the command below sets the :ref:`listen port <cfg_basic-listen>` to ``3301``.
301+
302+
.. code-block:: tarantoolsession
303+
304+
tarantool> box.cfg{ listen = 3301 }
305+
2023-05-10 13:28:54.667 [31326] main/103/interactive I> tx_binary: stopped
306+
2023-05-10 13:28:54.667 [31326] main/103/interactive I> tx_binary: bound to [::]:3301
307+
2023-05-10 13:28:54.667 [31326] main/103/interactive/box.load_cfg I> set 'listen' configuration option to 3301
308+
---
309+
...
310+
311+
312+
To see all the non-null parameters, execute ``box.cfg`` (no parentheses).
313+
314+
.. code-block:: tarantoolsession
315+
316+
tarantool> box.cfg
317+
---
318+
- replication_skip_conflict: false
319+
wal_queue_max_size: 16777216
320+
feedback_host: https://feedback.tarantool.io
321+
memtx_dir: .
322+
memtx_min_tuple_size: 16
323+
-- other parameters --
324+
...
325+
326+
To see a particular parameter value, call a corresponding ``box.cfg`` option.
327+
For example, ``box.cfg.listen`` shows the specified :ref:`listen address <cfg_basic-listen>.
328+
329+
.. code-block:: tarantoolsession
330+
331+
tarantool> box.cfg.listen
332+
---
333+
- 3301
334+
...
301335

302-
To see all the non-null parameters, say ``box.cfg`` (no parentheses). To see a
303-
particular parameter, for example, the listen address, say ``box.cfg.listen``.
304336

305337
.. _box-cfg-params-prior:
306338

0 commit comments

Comments
 (0)