Skip to content

Commit 9263ce3

Browse files
committed
Add tt console docs
1 parent d1b3132 commit 9263ce3

File tree

2 files changed

+31
-33
lines changed

2 files changed

+31
-33
lines changed

doc/reference/tooling/tt_cli/connect.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,13 @@ Options
3434

3535
.. option:: -l LANGUAGE, --language LANGUAGE
3636

37-
The input language of the :ref:`tt-interactive-console`: ``lua`` (default) or ``sql``.
37+
The input language of the :ref:`tt interactive console <tt-interactive-console>`:
38+
``lua`` (default) or ``sql``.
3839

3940
.. option:: -x FORMAT, --outputformat FORMAT
4041

41-
The output format of the :ref:`tt-interactive-console`: ``yaml`` (default),
42-
``lua``, ``table``, ``ttable``.
42+
The output format of the :ref:`tt interactive console <tt-interactive-console>`:
43+
``yaml`` (default), ``lua``, ``table``, ``ttable``.
4344

4445
Details
4546
-------

doc/reference/tooling/tt_cli/tt_interactive_console.rst

Lines changed: 27 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,11 @@
33
tt interactive console
44
======================
55

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.
1211

1312
.. _tt-interactive-console-enter:
1413

@@ -27,8 +26,8 @@ in the corresponding options.
2726
2827
192.168.10.10:3301>
2928
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:
3231

3332
.. code-block:: console
3433
@@ -77,7 +76,7 @@ language, run ``\set language <language>``, for example:
7776
.. note::
7877

7978
You can also specify the input language in the ``tt connect`` call using the
80-
``-l``/``--language`` option.
79+
``-l``/``--language`` option:
8180

8281
.. code-block:: console
8382
@@ -93,7 +92,7 @@ Console output
9392
--------------
9493

9594
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:
9796

9897
.. code-block:: console
9998
@@ -104,8 +103,8 @@ tuple on the new line.
104103
- [3, 'Ace of Base', 1987]
105104
...
106105
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:
109108

110109
.. code-block:: console
111110
@@ -127,7 +126,7 @@ the ``\set output`` console command:
127126
The table output can be printed in the transposed format, where an object's fields
128127
are arranged in columns instead of rows:
129128

130-
.. code-block::console
129+
.. code-block:: console
131130
132131
app:storage001> \set output ttable
133132
app:storage001> box.space.bands:select { }
@@ -142,7 +141,7 @@ are arranged in columns instead of rows:
142141
.. note::
143142

144143
You can also specify the output format in the ``tt connect`` call using the
145-
``-x``/``--outputformat`` option.
144+
``-x``/``--outputformat`` option:
146145

147146
.. code-block:: console
148147
@@ -153,10 +152,10 @@ following commands:
153152

154153
* ``\set table_format`` -- table format: default (pseudographics, or ASCII table), Markdown,
155154
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.
157156
* ``\set table_column_width`` -- maximum column width.
158157

159-
.. code-block::console
158+
.. code-block:: console
160159
161160
app:storage001> \set table_format jira
162161
app:storage001> box.space.bands:select {}
@@ -196,15 +195,18 @@ Quit the ``tt`` console.
196195
\\shortcuts
197196
~~~~~~~~~~~
198197

199-
Show available keyboard shortcuts
198+
Show available keyboard shortcuts.
200199

201200
\\set language {lua|sql}
202201
~~~~~~~~~~~~~~~~~~~~~~~~
203202

204-
Set the input language: Lua or SQL.
205-
Possible values: ``lua`` (default), ``sql``.
203+
Set the input language.
204+
Possible values:
206205

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``
208210

209211
\\set output FORMAT, \\x{l|t|T|y}, \\x
210212
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -226,10 +228,10 @@ Possible ``FORMAT`` values:
226228
The ``\x`` command switches the output format cyclically in the order
227229
``yaml`` > ``lua`` > ``table`` > ``ttable``.
228230

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.
231233

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``
233235

234236
\\set table_format
235237
~~~~~~~~~~~~~~~~~~
@@ -238,8 +240,8 @@ Set the table format if the output format is ``table`` or ``ttable``.
238240
Possible values:
239241

240242
* ``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.
243245

244246
\\set graphics {true|false}, \\x{g|G}
245247
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -259,8 +261,3 @@ Set maximum printed width of a table cell content. If the length exceeds this va
259261
it continues on the next line starting from +
260262

261263
Shorthand: ``\xw``
262-
263-
.. _tt-interactive-console-shortcuts:
264-
265-
Shortcuts
266-
---------

0 commit comments

Comments
 (0)