Skip to content

Commit df0f6f3

Browse files
Document box.info.schema_version (#3505)
1 parent 0addadc commit df0f6f3

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed

doc/reference/reference_lua/box_info.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,9 @@ Below is a list of all ``box.info`` functions and members.
102102
* - :doc:`./box_info/ro_reason`
103103
- Show the current mode of an instance (writable or read-only)
104104

105+
* - :doc:`./box_info/schema_version`
106+
- Show the database schema version
107+
105108
.. toctree::
106109
:hidden:
107110

@@ -114,3 +117,4 @@ Below is a list of all ``box.info`` functions and members.
114117
box_info/election
115118
box_info/synchro
116119
box_info/ro_reason
120+
box_info/schema_version
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
.. _box_info_schema_version:
2+
3+
================================================================================
4+
box.info.schema_version
5+
================================================================================
6+
7+
.. module:: box.info
8+
9+
.. data:: schema_version
10+
11+
Since :doc:`2.11.0 </release/2.11.0>`.
12+
Show the database schema version.
13+
A schema version is a number that indicates whether the :ref:`database schema <index-box-data_schema_description>` is changed.
14+
For example, the ``schema_version`` value grows if a :ref:`space <index-box_space>` or :ref:`index <index-box_index>` is added or deleted, or a space, index, or field name is changed.
15+
16+
:rtype: number
17+
18+
**Example:**
19+
20+
.. code-block:: tarantoolsession
21+
22+
tarantool> box.info.schema_version
23+
---
24+
- 84
25+
...

0 commit comments

Comments
 (0)