3
3
tt interactive console
4
4
======================
5
5
6
- Intro: tt connect. + take some desc from tarantool console page
7
-
8
- The ``tt `` utility features an command-line console that allows working interactively
9
- in the connected Tarantool instances. It is pretty similar to the :ref: `Tarantool interactive console <interactive_console >`,
10
- but allows connecting to any available instance (both local and remote) and provides
11
- wider formatting capabilities.
6
+ The ``tt `` utility features an command-line console that allows executing requests
7
+ and Lua code interactively on the connected Tarantool instances.
8
+ It is similar to the :ref: `Tarantool interactive console <interactive_console >` with
9
+ one key difference: the ``tt `` console allows connecting to any available instance,
10
+ both local and remote. Additionally, it offers more flexible output formatting capabilities.
12
11
13
12
.. _tt-interactive-console-enter :
14
13
@@ -27,8 +26,8 @@ in the corresponding options.
27
26
28
27
192.168.10.10:3301>
29
28
30
- When connecting to an instance from the same ``tt `` environment, you can use the `` <application>:<instance> ``
31
- string instead of the URI:
29
+ When connecting to an instance from the same ``tt `` environment, you can use the
30
+ `` <application>:<instance> `` string instead of the URI:
32
31
33
32
.. code-block :: console
34
33
@@ -77,7 +76,7 @@ language, run ``\set language <language>``, for example:
77
76
.. note ::
78
77
79
78
You can also specify the input language in the ``tt connect `` call using the
80
- ``-l ``/``--language `` option.
79
+ ``-l ``/``--language `` option:
81
80
82
81
.. code-block :: console
83
82
@@ -93,7 +92,7 @@ Console output
93
92
--------------
94
93
95
94
By default, the ``tt `` console prints the output data in the YAML format, each
96
- tuple on the new line.
95
+ tuple on the new line:
97
96
98
97
.. code-block :: console
99
98
@@ -104,8 +103,8 @@ tuple on the new line.
104
103
- [3, 'Ace of Base', 1987]
105
104
...
106
105
107
- You can switch to alternative output formats: Lua or human-readable tables using
108
- the ``\set output `` console command:
106
+ You can switch to alternative output formats -- Lua or human-readable tables --
107
+ using the ``\set output `` console command:
109
108
110
109
.. code-block :: console
111
110
@@ -127,7 +126,7 @@ the ``\set output`` console command:
127
126
The table output can be printed in the transposed format, where an object's fields
128
127
are arranged in columns instead of rows:
129
128
130
- .. code-block::console
129
+ .. code-block :: console
131
130
132
131
app:storage001> \set output ttable
133
132
app:storage001> box.space.bands:select { }
@@ -142,7 +141,7 @@ are arranged in columns instead of rows:
142
141
.. note ::
143
142
144
143
You can also specify the output format in the ``tt connect `` call using the
145
- ``-x ``/``--outputformat `` option.
144
+ ``-x ``/``--outputformat `` option:
146
145
147
146
.. code-block :: console
148
147
@@ -153,10 +152,10 @@ following commands:
153
152
154
153
* ``\set table_format `` -- table format: default (pseudographics, or ASCII table), Markdown,
155
154
or Jira-compatible format.
156
- * ``\set grahpics `` -- enable or disable graphics for table cells.
155
+ * ``\set grahpics `` -- enable or disable graphics for table cells in the default format .
157
156
* ``\set table_column_width `` -- maximum column width.
158
157
159
- .. code-block::console
158
+ .. code-block :: console
160
159
161
160
app:storage001> \set table_format jira
162
161
app:storage001> box.space.bands:select {}
@@ -196,15 +195,18 @@ Quit the ``tt`` console.
196
195
\\ shortcuts
197
196
~~~~~~~~~~~
198
197
199
- Show available keyboard shortcuts
198
+ Show available keyboard shortcuts.
200
199
201
200
\\ set language {lua|sql}
202
201
~~~~~~~~~~~~~~~~~~~~~~~~
203
202
204
- Set the input language: Lua or SQL .
205
- Possible values: `` lua `` (default), `` sql ``.
203
+ Set the input language.
204
+ Possible values:
206
205
207
- An analog of the :ref: ``tt connect <tt-connect>`` option ``-l ``/``--language ``
206
+ * ``lua `` (default)
207
+ * ``sql ``.
208
+
209
+ An analog of the :ref: `tt connect <tt-connect >` option ``-l ``/``--language ``
208
210
209
211
\\ set output FORMAT, \\ x{l|t|T|y}, \\ x
210
212
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -226,10 +228,10 @@ Possible ``FORMAT`` values:
226
228
The ``\x `` command switches the output format cyclically in the order
227
229
``yaml `` > ``lua `` > ``table `` > ``ttable ``.
228
230
229
- The format of ``table `` and ``ttable `` output can be adjusted using the :ref: ` \set table_format <> `,
230
- :ref: ` \set graphics <> `, and :ref: ` \set table_colum_width` commands.
231
+ The format of ``table `` and ``ttable `` output can be adjusted using the `` \set table_format ` `,
232
+ `` \set graphics`, and `` \set table_colum_width ` ` commands.
231
233
232
- An analog of the :ref: `` tt connect <tt-connect>` ` option ``-x ``/``--outputformat ``
234
+ An analog of the :ref: `tt connect <tt-connect >` option ``-x ``/``--outputformat ``
233
235
234
236
\\ set table_format
235
237
~~~~~~~~~~~~~~~~~~
@@ -238,8 +240,8 @@ Set the table format if the output format is ``table`` or ``ttable``.
238
240
Possible values:
239
241
240
242
* ``default `` -- a pseudographics (ASCII) table.
241
- * ``markdown `` -- a table in the Markdown format
242
- * ``jira `` -- a Jira-compatible table
243
+ * ``markdown `` -- a table in the Markdown format.
244
+ * ``jira `` -- a Jira-compatible table.
243
245
244
246
\\ set graphics {true|false}, \\ x{g|G}
245
247
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -259,8 +261,3 @@ Set maximum printed width of a table cell content. If the length exceeds this va
259
261
it continues on the next line starting from +
260
262
261
263
Shorthand: ``\xw ``
262
-
263
- .. _tt-interactive-console-shortcuts :
264
-
265
- Shortcuts
266
- ---------
0 commit comments