File tree 13 files changed +36
-44
lines changed
dev_guide/internals/iproto
13 files changed +36
-44
lines changed Original file line number Diff line number Diff line change @@ -605,6 +605,8 @@ IPROTO_UNKNOWN
605
605
606
606
Code: -1.
607
607
608
+ Unknown request or response type.
609
+
608
610
.. _internals-iproto-keys-error :
609
611
610
612
IPROTO_ERROR
Original file line number Diff line number Diff line change @@ -27,7 +27,7 @@ The constants are divided into several types:
27
27
* :ref: `request type <reference_lua-box_iproto_type >` (:ref: `IPROTO_OK <internals-iproto-ok >`)
28
28
* :ref: `flag <reference_lua-box_iproto_flag >` (:ref: `IPROTO_COMMIT <box_protocol-commit >`)
29
29
* :ref: `ballot key <reference_lua-box_iproto_ballot >` (:ref: `IPROTO_FLAG_COMMIT <box_protocol-flags >`)
30
- * :ref: `metadata key <reference_lua-box_iproto_metadata >` (`` IPROTO_FIELD_IS_NULLABLE ` `)
30
+ * :ref: `metadata key <reference_lua-box_iproto_metadata >` (:ref: ` IPROTO_FIELD_IS_NULLABLE < internals-iproto-keys-sql-specific > `)
31
31
* :ref: `RAFT key <reference_lua-box_iproto_raft >` (:ref: `IPROTO_TERM <internals-iproto-keys-term >`)
32
32
33
33
Each type is located in the corresponding subnamespace without prefix.
@@ -64,7 +64,7 @@ The submodule exports:
64
64
API reference
65
65
-------------
66
66
67
- The table lists all available members and functions of the submodule:
67
+ The table lists all available functions and data of the submodule:
68
68
69
69
.. container :: table
70
70
Original file line number Diff line number Diff line change @@ -5,10 +5,10 @@ box.iproto.ballot_key
5
5
6
6
.. module :: box.iproto
7
7
8
- .. data :: ballot_key
8
+ .. data :: ballot_key
9
9
10
- The ``box.iproto.ballot_key `` namespace contains the keys from the :ref: `IPROTO_BALLOT <box_protocol-ballots >` requests.
11
- Learn more: :ref: `IPROTO_BALLOT keys <internals-iproto-keys-ballot >`.
10
+ The ``box.iproto.ballot_key `` namespace contains the keys from the :ref: `IPROTO_BALLOT <box_protocol-ballots >` requests.
11
+ Learn more: :ref: `IPROTO_BALLOT keys <internals-iproto-keys-ballot >`.
12
12
13
13
Available keys:
14
14
Original file line number Diff line number Diff line change @@ -5,16 +5,16 @@ box.iproto.feature
5
5
6
6
.. module :: box.iproto
7
7
8
- .. data :: feature
8
+ .. data :: feature
9
9
10
- The ``box.iproto.feature `` namespace contains the IPROTO protocol features supported by the server.
11
- Each feature is mapped to its corresponding code.
12
- Learn more: :ref: `IPROTO_FEATURES <internals-iproto-keys-features >`.
10
+ The ``box.iproto.feature `` namespace contains the IPROTO protocol features supported by the server.
11
+ Each feature is mapped to its corresponding code.
12
+ Learn more: :ref: `IPROTO_FEATURES <internals-iproto-keys-features >`.
13
13
14
- The features in the namespace are written
14
+ The features in the namespace are written
15
15
16
- * in the lower case
17
- * without the ``IPROTO_FEATURE_ `` prefix
16
+ * in the lower case
17
+ * without the ``IPROTO_FEATURE_ `` prefix
18
18
19
19
Available features:
20
20
Original file line number Diff line number Diff line change @@ -5,10 +5,10 @@ box.iproto.flag
5
5
6
6
.. module :: box.iproto
7
7
8
- .. data :: flag
8
+ .. data :: flag
9
9
10
- The ``box.iproto.flag `` namespace contains the flags from the ``IPROTO_FLAGS `` key.
11
- Learn more: :ref: `IPROTO_FLAGS key <box_protocol-flags >`.
10
+ The ``box.iproto.flag `` namespace contains the flags from the ``IPROTO_FLAGS `` key.
11
+ Learn more: :ref: `IPROTO_FLAGS key <box_protocol-flags >`.
12
12
13
13
Available flags:
14
14
Original file line number Diff line number Diff line change @@ -5,10 +5,9 @@ box.iproto.key
5
5
6
6
.. module :: box.iproto
7
7
8
- .. data :: key
8
+ .. data :: key
9
9
10
- The ``box.iproto.key `` namespace contains the request keys.
11
- To
10
+ The ``box.iproto.key `` namespace contains the request keys.
12
11
13
12
Available keys:
14
13
Original file line number Diff line number Diff line change @@ -5,10 +5,10 @@ box.iproto.metadata_key
5
5
6
6
.. module :: box.iproto
7
7
8
- .. data :: metadata_key
8
+ .. data :: metadata_key
9
9
10
- The ``box.iproto.metadata_key `` namespace contains the ``IPROTO_FILED_* `` keys, which are nested in the
11
- :ref: `IPROTO_METADATA <internals-iproto-keys-metadata >` key.
10
+ The ``box.iproto.metadata_key `` namespace contains the ``IPROTO_FILED_* `` keys, which are nested in the
11
+ :ref: `IPROTO_METADATA <internals-iproto-keys-metadata >` key.
12
12
13
13
Available keys:
14
14
Original file line number Diff line number Diff line change @@ -18,7 +18,3 @@ box.iproto.override()
18
18
19
19
**Example: **
20
20
21
- .. code-block :: tarantoolsession
22
-
23
- tarantool>
24
-
Original file line number Diff line number Diff line change @@ -5,11 +5,11 @@ box.iproto.protocol_version
5
5
6
6
.. module :: box.iproto
7
7
8
- .. data :: protocol_version
8
+ .. data :: protocol_version
9
9
10
- The set of IPROTO protocol features supported by the server.
11
- Learn more: `src/box/iproto_features.h <https://github.com/tarantool/tarantool/blob/master/src/box/iproto_features.h >`__
12
- and `iproto_features_resolve() <https://github.com/tarantool/tarantool/blob/dec0e0221e183fa972efa65bb0fb658112f2196f/src/box/lua/net_box.lua#L93-L105 >`__).
10
+ The set of IPROTO protocol features supported by the server.
11
+ Learn more: `src/box/iproto_features.h <https://github.com/tarantool/tarantool/blob/master/src/box/iproto_features.h >`__
12
+ and `iproto_features_resolve() <https://github.com/tarantool/tarantool/blob/dec0e0221e183fa972efa65bb0fb658112f2196f/src/box/lua/net_box.lua#L93-L105 >`__).
13
13
14
14
**Example **
15
15
Original file line number Diff line number Diff line change @@ -5,10 +5,11 @@ box.iproto.protocol_version
5
5
6
6
.. module :: box.iproto
7
7
8
- .. data :: protocol_version
8
+ .. data :: protocol_version
9
+
10
+ Current IPROTO protocol version of the server.
11
+ Learn more: :ref: `IPROTO_ID <box_protocol-id >`.
9
12
10
- Current IPROTO protocol version of the server.
11
- Learn more: :ref: `IPROTO_ID <box_protocol-id >`.
12
13
13
14
**Example **
14
15
Original file line number Diff line number Diff line change @@ -5,10 +5,10 @@ box.iproto.raft
5
5
6
6
.. module :: box.iproto
7
7
8
- .. data :: raft_key
8
+ .. data :: raft_key
9
9
10
- The ``box.iproto.raft_key `` namespace contains the keys from the ``IPROTO_RAFT_* `` requests.
11
- Learn more: :ref: `Synchronous replication keys <internals-iproto-keys-syncro-replication >`.
10
+ The ``box.iproto.raft_key `` namespace contains the keys from the ``IPROTO_RAFT_* `` requests.
11
+ Learn more: :ref: `Synchronous replication keys <internals-iproto-keys-syncro-replication >`.
12
12
13
13
Available keys:
14
14
Original file line number Diff line number Diff line change @@ -5,10 +5,10 @@ box.iproto.type
5
5
6
6
.. module :: box.iproto
7
7
8
- .. data :: type
8
+ .. data :: type
9
9
10
- The ``box.iproto.type `` namespace contains all available request types.
11
- Learn more about the requests: :ref: `Client-server requests and responses <internals-requests_responses >`.
10
+ The ``box.iproto.type `` namespace contains all available request types.
11
+ Learn more about the requests: :ref: `Client-server requests and responses <internals-requests_responses >`.
12
12
13
13
Available types:
14
14
Original file line number Diff line number Diff line change @@ -21,12 +21,6 @@ box.iproto.send()
21
21
22
22
**Possible errors: **
23
23
24
- * Index is not of type 'TREE'.
25
- * :errcode: `ER_TRANSACTION_CONFLICT ` if a transaction conflict is detected in the
26
- :ref: `MVCC transaction mode <txn_mode_transaction-manager >`.
27
-
28
- **Complexity factors: ** Index size, Index type.
29
-
30
24
**Example: **
31
25
32
26
You can’t perform that action at this time.
0 commit comments