Skip to content

Commit 5984f94

Browse files
committed
Update text after review
1 parent 99acfe3 commit 5984f94

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

doc/reference/reference_lua/box_info/synchro.rst

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -11,46 +11,46 @@ box.info.synchro
1111
Since version :doc:`2.8.1 </release/2.8.1>`.
1212
Show the current state of synchronous replication.
1313

14-
In :ref:`synchronous replication <repl_sync>`, a transaction is considered committed only after achieving
14+
In :ref:`synchronous replication <repl_sync>`, transaction is considered committed only after achieving
1515
the required quorum number.
16-
While the transactions are collecting confirmations from remote nodes, these transactions are waiting in the queue.
16+
While transactions are collecting confirmations from remote nodes, these transactions are waiting in the queue.
1717

1818
The following information is provided:
1919

2020
* ``queue``:
2121

22-
- ``owner`` -- ID of the replica that owns the synchronous transaction queue.
23-
Once an owner instance appears, all other instances become read-only.
24-
If the ``owner`` field is ``0``, then every instance is writeable,
22+
- ``owner`` (since version :doc:`2.10.0 </release/2.10.0>`) -- ID of the replica that owns the synchronous
23+
transaction queue. Once an owner instance appears, all other instances become read-only.
24+
If the ``owner`` field is ``0``, then every instance may be writable,
2525
but they can't create any synchronous transactions.
2626
To claim or reclaim the queue, use :ref:`box.ctl.promote() <box_ctl-promote>` on the instance that you want
2727
to promote.
28-
With elections enabled, the instance runs ``box.ctl.promote()`` automatically after winning the elections.
29-
Since version :doc:`2.10.0 </release/2.10.0>`.
28+
With elections enabled, an instance runs ``box.ctl.promote()`` command automatically after winning the elections.
3029

31-
- ``term`` -- current queue term.
32-
It contains the term of the last ``PROMOTE``.
33-
Usually it is equal to :ref:`box.info.election.term <box_info_election>`.
30+
- ``term`` (since version :doc:`2.10.0 </release/2.10.0>`) -- current queue term.
31+
It contains the term of the last ``PROMOTE`` request.
32+
Usually, it is equal to :ref:`box.info.election.term <box_info_election>`.
3433
However, the queue term value may be less than the corresponding one in the election term.
35-
It can happen when a new round of elections started, but no one has promoted yet.
36-
Since version :doc:`2.10.0 </release/2.10.0>`.
34+
It can happen when a new round of elections started, but no instance has been promoted yet.
3735

3836
- ``len`` -- current number of entries that are waiting in the queue.
3937

40-
- ``busy`` -- the boolean value is set to ``true`` if there is a synchronous transaction in progress.
41-
Until the active transaction is complete, any other incoming synchronous transactions will be delayed.
42-
Since version :doc:`2.10.0 </release/2.10.0>`.
38+
- ``busy`` (since version :doc:`2.10.0 </release/2.10.0>`) -- the boolean value is ``true``
39+
when the instance is processing or writing some system request that modifies the queue
40+
(for example, ``PROMOTE``, ``CONFIRM``, or ``ROLLBACK``).
41+
Until the request is complete, any other incoming synchronous transactions and system requests
42+
will be delayed.
4343

4444
* ``quorum`` -- evaluated value of the
4545
:ref:`replication_synchro_quorum <cfg_replication-replication_synchro_quorum>` configuration option.
4646
Since version :doc:`2.5.3 </release/2.5.3>`, the option can be set as a dynamic formula.
47-
In this case, the value in the ``quorum`` member depends on the current number of replicas.
47+
In this case, the value of the ``quorum`` member depends on the current number of replicas.
4848

4949
**Example 1:**
5050

5151
In this example, the ``quorum`` field is equal to ``1``.
52-
This means that the synchronous transactions work like asynchronous.
53-
`1` means that successful WAL write to the master is enough to commit.
52+
That is, synchronous transactions work like asynchronous ones.
53+
`1` means that a successful WAL writing to the master is enough to commit.
5454

5555
.. code-block:: tarantoolsession
5656
@@ -97,7 +97,7 @@ box.info.synchro
9797
tarantool> s = box.schema.space.create("sync", {is_sync=true})
9898
tarantool> _ = s:create_index('pk')
9999
100-
After that, use ``box.ctl.promote`` function to claim the queue:
100+
After that, use ``box.ctl.promote()`` function to claim a queue:
101101

102102
.. code-block:: tarantoolsession
103103

0 commit comments

Comments
 (0)