From 39654eba454c66d9c4214762b441a1705ea3122b Mon Sep 17 00:00:00 2001 From: mar Date: Tue, 28 Apr 2026 17:33:38 +0500 Subject: [PATCH] doc: write about tt-connect and direct terminals --- doc/tooling/tcm/index.rst | 1 + doc/tooling/tcm/tcm_terminals.rst | 22 ++++++++++++++++++++++ doc/tooling/tcm/tcm_ui_overview.rst | 4 +++- 3 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 doc/tooling/tcm/tcm_terminals.rst diff --git a/doc/tooling/tcm/index.rst b/doc/tooling/tcm/index.rst index 2c22f851b..a96c3921f 100644 --- a/doc/tooling/tcm/index.rst +++ b/doc/tooling/tcm/index.rst @@ -47,4 +47,5 @@ to read data. LDAP authorization is supported as well. tcm_dev_mode tcm_configuration_reference tcm_integrity_check + tcm_terminals Releases diff --git a/doc/tooling/tcm/tcm_terminals.rst b/doc/tooling/tcm/tcm_terminals.rst new file mode 100644 index 000000000..5ed824b7d --- /dev/null +++ b/doc/tooling/tcm/tcm_terminals.rst @@ -0,0 +1,22 @@ +.. _tcm_terminals: + +Terminals +========= + +|tcm_full_name| (TCM) provides two ways to interact with Tarantool instances: + +– ``direct`` — a terminal that connects directly to a Tarantool instance using the go-tarantool __ library, bypassing the tt connect utility +– ``tt-connect`` — a terminal that uses the :ref:`tt-cli` utility to connect to a Tarantool instance + +Both terminals allow executing SQL queries, managing cluster state, viewing metrics, and more. + +.. _tcm_terminals_direct: + +Terminal direct +--------------- + + +.. _tcm_terminals_tt-connect: + +Terminal tt-connect +------------------- diff --git a/doc/tooling/tcm/tcm_ui_overview.rst b/doc/tooling/tcm/tcm_ui_overview.rst index f425a7c89..9a0b8873f 100644 --- a/doc/tooling/tcm/tcm_ui_overview.rst +++ b/doc/tooling/tcm/tcm_ui_overview.rst @@ -145,7 +145,9 @@ It provides a set of tabs for performing actions on the selected Tarantool insta or as a console output of ``box.cfg``, ``box.info``, and other built-in functions - **SQL** and **Terminal** tabs: run SQL and Lua commands on the instance - **Logs** tab: view instance logs -- **Slabs** tab: view :ref:`slab allocator ` statistics +- **Slabs** tab: view :ref:`slab allocator ` statistics. TCM provides two ways to interact with Tarantool instances: + – ``direct`` — a terminal that connects directly to a Tarantool instance using the go-tarantool __ library, bypassing the tt connect utility + – ``tt-connect`` — a terminal that uses the :ref:`tt-cli` utility to connect to a Tarantool instance - **Users** tab: manage Tarantool :ref:`users and roles ` on the instance - **Funcs**: manage and call stored functions - **Metrics**: view instance metrics