Zen

Source string Source string

108/10000 · 108
English Actions
box.info.synchro
Since version :doc:`2.8.1 </release/2.8.1>`.
Show the current state of synchronous replication.
In :ref:`synchronous replication <repl_sync>`, transaction is considered committed only after achieving the required quorum number. While transactions are collecting confirmations from remote nodes, these transactions are waiting in the queue.
The following information is provided:
``queue``:
``owner`` (since version :doc:`2.10.0 </release/2.10.0>`) -- ID of the replica that owns the synchronous transaction queue. Once an owner instance appears, all other instances become read-only. If the ``owner`` field is ``0``, then every instance may be writable, but they can't create any synchronous transactions. To claim or reclaim the queue, use :ref:`box.ctl.promote() <box_ctl-promote>` on the instance that you want to promote. With elections enabled, an instance runs ``box.ctl.promote()`` command automatically after winning the elections. To clear the ownership, call :ref:`box.ctl.demote() <box_ctl-demote>` on the synchronous queue owner.
``term`` (since version :doc:`2.10.0 </release/2.10.0>`) -- current queue term. It contains the term of the last ``PROMOTE`` request. Usually, it is equal to :ref:`box.info.election.term <box_info_election>`. However, the queue term value may be less than the election term. It can happen when a new round of elections has started, but no instance has been promoted yet.
``len`` -- the number of entries that are currently waiting in the queue.
``busy`` (since version :doc:`2.10.0 </release/2.10.0>`) -- the boolean value is ``true`` when the instance is processing or writing some system request that modifies the queue (for example, ``PROMOTE``, ``CONFIRM``, or ``ROLLBACK``). Until the request is complete, any other incoming synchronous transactions and system requests will be delayed.
``quorum`` -- the resulting value of the :ref:`replication_synchro_quorum <cfg_replication-replication_synchro_quorum>` configuration option. Since version :doc:`2.5.3 </release/2.5.3>`, the option can be set as a dynamic formula. In this case, the value of the ``quorum`` member depends on the current number of replicas.
**Example 1:**
In this example, the ``quorum`` field is equal to ``1``. That is, synchronous transactions work like asynchronous ones. `1` means that a successful WAL writing to the master is enough to commit.
tarantool> box.info.synchro
---
- queue:
owner: 1
term: 2
len: 0
busy: false
quorum: 1
...
**Example 2:**
First, set a quorum number and a timeout for synchronous replication using the following command:
tarantool> box.cfg{
> replication_synchro_quorum=2,
> replication_synchro_timeout=1000
> }
Next, check the current state of synchronous replication:
tarantool> box.info.synchro
---
- queue:
owner: 1
term: 2
len: 0
busy: false
quorum: 2
...
Create a space called ``sync`` and enable synchronous replication on this space. Then, create an index.
tarantool> s = box.schema.space.create("sync", {is_sync=true})
tarantool> _ = s:create_index('pk')
After that, use ``box.ctl.promote()`` function to claim a queue:
tarantool> box.ctl.promote()
Next, perform data manipulations:
tarantool> require('fiber').new(function() box.space.sync:replace{1} end)
---
- status: suspended
name: lua
id: 119
...
tarantool> require('fiber').new(function() box.space.sync:replace{1} end)
---
- status: suspended
name: lua
id: 120
...
tarantool> require('fiber').new(function() box.space.sync:replace{1} end)
---
- status: suspended
name: lua
id: 121
...
If you call the ``box.info.synchro`` command again, you will see that now there are 3 transactions waiting in the queue:
tarantool> box.info.synchro
---
- queue:
owner: 1
term: 2
len: 3
busy: false
quorum: 2
...

Loading…

User avatar None

New source string

testing_project / Documentation: reference/reference_lua/box_info/synchro — English

tarantool> box.info.synchro
---
- queue:
owner: 1
term: 2
len: 0
busy: false
quorum: 1
...
a year ago
Browse all string changes

Things to check

Ellipsis

The string uses three dots (...) instead of an ellipsis character (…)

Reset

Glossary

English English
No related strings found in the glossary.

String information

Flags
read-only
String age
a year ago
Last updated
a year ago
Source string age
a year ago
Translation file
string 14