Skip to content

Commit 18d4efd

Browse files
authored
Adds description of IPROTO_INSERT_ARROW request (#5382)
* Adds description of IPROTO_INSERT_ARROW request * The structure of the `IPROTO_INSERT_ARROW` request is similar to `IPROTO_INSERT` * Changes the latest IPROTO version to `10`
1 parent 6c72a2f commit 18d4efd

File tree

5 files changed

+173
-3
lines changed

5 files changed

+173
-3
lines changed
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
@startuml
2+
3+
skinparam {
4+
HyperlinkColor #0077FF
5+
FontColor #313131
6+
BorderColor #313131
7+
BackgroundColor transparent
8+
}
9+
10+
json "**IPROTO_INSERT_ARROW**" as insert_request {
11+
"Size": "MP_UINT",
12+
"Header": {
13+
"[[https://tarantool.io/en/doc/latest/reference/internals/iproto/keys IPROTO_REQUEST_TYPE]]": "IPROTO_INSERT_ARROW",
14+
"[[https://tarantool.io/en/doc/latest/reference/internals/iproto/keys IPROTO_SYNC]]": "MP_UINT"
15+
},
16+
"Body": {
17+
"[[https://tarantool.io/en/doc/latest/reference/internals/iproto/keys IPROTO_SPACE_ID]]": "MP_UINT",
18+
"[[https://tarantool.io/en/doc/latest/reference/internals/iproto/keys IPROTO_INSERT_ARROW]]": "MP_ARROW"
19+
}
20+
}
21+
22+
json "**Response to IPROTO_INSERT_ARROW**" as insert_response {
23+
"Size": "MP_UINT",
24+
"Header": {
25+
"[[https://tarantool.io/en/doc/latest/reference/internals/iproto/keys IPROTO_REQUEST_TYPE]]": "IPROTO_OK",
26+
"[[https://tarantool.io/en/doc/latest/reference/internals/iproto/keys IPROTO_SYNC]]": "MP_UINT",
27+
"[[https://tarantool.io/en/doc/latest/reference/internals/iproto/keys IPROTO_SCHEMA_VERSION]]": "MP_UINT"
28+
},
29+
"Body": {
30+
"[[https://tarantool.io/en/doc/latest/reference/internals/iproto/keys IPROTO_DATA]]": "Empty body"
31+
}
32+
}
33+
34+
@enduml
Lines changed: 117 additions & 0 deletions
Loading

doc/reference/internals/iproto/keys.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -491,6 +491,9 @@ Available IPROTO_FEATURES are the following:
491491
- ``IPROTO_FEATURE_WATCHERS = 3`` -- remote watchers support: :ref:`IPROTO_WATCH <box_protocol-watch>`,
492492
:ref:`IPROTO_UNWATCH <box_protocol-unwatch>`, and :ref:`IPROTO_EVENT <box_protocol-event>` commands.
493493

494+
- ``IPROTO_FEATURE_INSERT_ARROW = 12`` -- support of data insertion in the Arrow format. Learn more
495+
about the :ref:`feature <internals-iproto-insert-arrow>`. Available since version :doc:`3.3.0 </release/3.3.0>`.
496+
494497
.. _internals-iproto-keys-sync:
495498

496499
IPROTO_SYNC

doc/reference/internals/iproto/requests.rst

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,11 @@ Overview
8282
- 0x0c
8383
- Increment the LSN and do nothing else
8484

85+
* - :ref:`IPROTO_INSERT_ARROW <internals-iproto-insert-arrow>`
86+
- 0x11
87+
- Iproto Insert Arrow data request. Available since
88+
version :doc:`3.3.0 </release/3.3.0>`.
89+
8590
* - :ref:`IPROTO_PING <box_protocol-ping>`
8691
- 0x40
8792
- Ping (:ref:`conn:ping() <conn-ping>`)
@@ -90,8 +95,6 @@ Overview
9095
- 0x49
9196
- Share iproto version and supported features
9297

93-
94-
9598
.. _internals-iproto-ok:
9699

97100
IPROTO_OK
@@ -392,6 +395,19 @@ are the same, but the LSN must be increased because a data-change
392395
must be recorded.
393396
The body is: nothing.
394397

398+
.. _internals-iproto-insert-arrow:
399+
400+
IPROTO_INSERT_ARROW
401+
-------------------
402+
403+
Since version :doc:`3.3.0 </release/3.3.0>`.
404+
405+
Code: 0x11
406+
The body is a 2-item map:
407+
408+
.. raw:: html
409+
:file: images/iproto_insert_arrow.svg
410+
395411

396412
.. _box_protocol-ping:
397413

prolog.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434

3535
<br />
3636

37-
.. |iproto_version| replace:: 3
37+
.. |iproto_version| replace:: 10
3838

3939
.. |tcm_full_name| replace:: Tarantool Cluster Manager
4040

0 commit comments

Comments
 (0)