Zen

Source string Source string

179/10000 · 179
English Actions
Interactive console
The interactive console is Tarantool's basic command-line interface for entering requests and seeing results. It is what users see when they start the server without an :ref:`instance file <admin-instance_file>`. The interactive console is often called the Lua console to distinguish it from the administrative console, but in fact it can handle both Lua and SQL input.
The majority of examples in this manual show what users see with the interactive console. It includes:
``tarantool>`` prompt
instruction (a Lua request or an SQL statement)
response (a display in either YAML or Lua format)
-- Interactive console example with Lua input and YAML output --
tarantool> box.info().replication
---
- 1:
id: 1
uuid: a5d22f66-2d28-4a35-b78f-5bf73baf6c8a
lsn: 0
...
Interactive console input and output
The **input language** can be either Lua (default) or SQL. To change the input language, run ``\set language <language>``, for example:
-- Set input language to SQL --
tarantool> \set language sql
---
- true
...
The **delimiter** can be changed to any character with ``\set delimiter <character>``. By default, the delimiter is empty, which means the input does not need to end with a delimiter. For example, a common recommendation for SQL input is to use the semicolon delimiter:
-- Set ';' delimiter --
tarantool> \set delimiter ;
---
...
The **output format** can be either `YAML <http://yaml.org/spec>`_ (default) or Lua. To change the output format, run ``\set output <format>``, for example:
-- Set output format Lua --
tarantool> \set output lua
true
The default YAML output format is the following:
The output starts from a document-start line ``"---"``.
Each item begins on a separate line starting with ``"- "``.
Each sub-item in a nested structure is indented.
The output ends with a document-end line ``"..."``.
The alternative Lua format for console output is the following:
There are no lines for document-start or document-end.
Items are separated by commas.

Loading…

User avatar None

New source string

testing_project / Documentation: reference/tooling/interactive_console — English

-- Interactive console example with Lua input and YAML output --
tarantool> box.info().replication
---
- 1:
id: 1
uuid: a5d22f66-2d28-4a35-b78f-5bf73baf6c8a
lsn: 0
...
2 years ago
Browse all string changes

Things to check

Ellipsis

The string uses three dots (...) instead of an ellipsis character (…)

Reset

Glossary

English English
No related strings found in the glossary.

String information

Flags
read-only
String age
2 years ago
Last updated
2 years ago
Source string age
2 years ago
Translation file
string 7