Skip to content

Commit

Permalink
Update box_info_cluster_meaning.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
p7nov authored Oct 8, 2024
1 parent 87af27a commit 4722200
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions doc/reference/reference_lua/compat/box_info_cluster_meaning.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ Option: ``box_info_cluster_meaning``

Starting from version 3.0, the :ref:`box_info_cluster` table stores the information
about the entire cluster. In earlier versions, it stored only the current replica set
information. The ``box_info_cluster_meaning`` compat option allows to define the
the scope of ``box.info.cluster``: the entire cluster or a single replica set.
information. The ``box_info_cluster_meaning`` compat option in Tarantool 3.0 or later
allows to rollback to the old meaning of ``box.info.cluster`` - display information
about a single replica set.

Old and new behavior
--------------------
Expand All @@ -24,13 +25,13 @@ cluster with all its replica sets.
tarantool> box.info.cluster
---
- <cluster information>
- name: my_cluster
...
tarantool> box.info.replicaset
---
- uuid: <replicaset uuid>
- <... other attributes of the replicaset>
- uuid: 0a3ff0c7-9075-441c-b0f5-b93a24be07cb
name: router-001
...
.. note::
Expand All @@ -47,14 +48,14 @@ Old behavior: ``box.info.cluster`` displays information about the current replic
tarantool> box.info.cluster
---
- uuid: <replicaset uuid>
- <... other attributes of the replicaset>
- uuid: 0a3ff0c7-9075-441c-b0f5-b93a24be07cb
name: router-001
...
tarantool> box.info.replicaset
---
- uuid: <replicaset uuid>
- <... other attributes of the replicaset>
- uuid: 0a3ff0c7-9075-441c-b0f5-b93a24be07cb
name: router-001
...
Known compatibility issues
Expand All @@ -69,4 +70,4 @@ Detecting issues in your codebase
Look for all usages of ``box.info.cluster``, ``info.cluster``, and
``.cluster``, ``['cluster']``, ``["cluster"]`` in the application code
written before the change. To make it work the same way on Tarantool 3.0 or later,
replace the ``cluster`` key with ``replicaset``.
replace the ``cluster`` key with ``replicaset``.

0 comments on commit 4722200

Please sign in to comment.