Утилита `tarantoolctl`

tarantoolctl is a utility for administering Tarantool instances, checkpoint files and modules. It is shipped and installed as part of Tarantool distribution. This utility is intended for use by administrators only.

См. также примеры использования tarantoolctl в разделе Администрирование серверной части.

Формат команд

tarantoolctl COMMAND NAME [URI] [FILE] [OPTIONS..]

где:

COMMAND – это одна из следующих команд, описанных ниже: start, stop, status, restart, logrotate, check, enter, eval, connect, cat, play, rocks.
NAME – это имя файла экземпляра или модуля.
FILE – это путь к какому-либо файлу (.lua, .xlog или .snap).
URI – это URI некого экземпляра Tarantool.
OPTIONS – это параметры, которые принимают команды tarantoolctl.

Команды для управления экземплярами Tarantool

tarantoolctl start NAME

Запуск экземпляра Tarantool’а.

Кроме того, данная команда задает значение переменной окружения TARANTOOLCTL = „true“ (правда), чтобы отметить, что экземпляр был запущен с помощью tarantoolctl.

Примечание

tarantoolctl работает для экземпляров, где не вызвана функция box.cfg{} или вызов box.cfg{} отложен.

Например, это можно использовать для управления экземплярами, которые получают конфигурацию из внешнего сервера. Для таких экземпляров tarantoolctl start goes to background when box.cfg{} is called, so it will wait until options for box.cfg are received. However this is not the case for daemon management systems like systemd, as they handle backgrounding on their side.

tarantoolctl stop NAME

Остановка экземпляра Tarantool.

tarantoolctl status NAME

Отображение статуса экземпляра (работает/остановлен). Если есть PID-файл и активный управляющий сокет, возвращается код 0. В остальных случаях возвращается не 0.

Сообщает о типичных проблемах стандартного вывода ошибок (например, PID-файл есть, а управляющий сокет отсутствует).

tarantoolctl restart NAME

Остановка и запуск экземпляра Tarantool’а.

Кроме того, данная команда задает значение переменной окружения TARANTOOL_RESTARTED = „true“ (правда), чтобы отметить, что экземпляр был перезапущен с помощью tarantoolctl.

tarantoolctl logrotate NAME

Ротация файлов журнала работающего Tarantool-экземпляра. Работает только в том случае, если в файле экземпляра задан параметр записи журнала в файл. Отправка записей в конвейер или системный журнал syslog не имеет значения в данном случае.

tarantoolctl check NAME

Проверка файла экземпляра на ошибки синтаксиса.

tarantoolctl enter NAME [--language=language]

Enter an instance’s interactive Lua or SQL console.

Supported option:

--language=language to set interactive console language. Can be either Lua or SQL.

tarantoolctl eval NAME FILE

Выполнение локального Lua-файла на работающем экземпляре Tarantool.

tarantoolctl connect URI

Подключение к экземпляру Tarantool по порту административной консоли. Поддерживаются TCP и Unix сокеты.

Команды для управления файлами контрольной точки

tarantoolctl cat FILE.. [--space=space_no ..] [--show-system] [--from=from_lsn] [--to=to_lsn] [--replica=replica_id ..] [--format=format_name]: Стандартный вывод содержимого .snap-файла или .xlog-файла.
tarantoolctl play URI FILE.. [--space=space_no ..] [--show-system] [--from=from_lsn] [--to=to_lsn] [--replica=replica_id ..]: Передача содержимого .snap-файла или .xlog-файла на другой экземпляр Tarantool.

Поддерживаемые опции:

--space=space_no для фильтрации вывода по номеру спейса. Можно передавать несколько раз.
--show-system для отображения содержимого системных спейсов.
--from=from_lsn для отображения операций, начиная с заданного LSN.
--to=to_lsn для отображения операций, заканчивая заданным LSN.
--replica=replica_id для фильтрации вывода по идентификатору реплики. Можно передавать несколько раз.
--format=format_name для указания формата (по умолчанию yaml, может также принимать значения json и lua).

Команды для управления модулями Tarantool

tarantoolctl rocks build NAME

Build/compile and install a rock. Since version 2.4.1.

tarantoolctl rocks config URI

Query and set the LuaRocks configuration. Since version 2.4.1.

tarantoolctl rocks doc NAME

Отображение документации для установленного модуля.

tarantoolctl rocks download [NAME]

Download a specific rock or rockspec file from a rocks server. Since version 2.4.1.

tarantoolctl rocks help NAME

Помощь по командам.

tarantoolctl rocks init NAME

Initialize a directory for a Lua project using LuaRocks. Since version 2.4.1.

tarantoolctl rocks install NAME

Установка модуля в директорию .rocks, находящуюся в текущей директории.

tarantoolctl rocks lint FILE

Check the syntax of a rockspec. Since version 2.4.1.

tarantoolctl rocks list

Вывод списка всех установленных модулей.

tarantoolctl rocks make

Компиляция пакета в текущем каталоге с помощью rockspec и его установка.

tarantoolctl rocks make_manifest

Компиляция файла-манифеста для репозитория.

tarantoolctl rocks new_version NAME

Auto-write a rockspec for a new version of a rock. Since version 2.4.1.

tarantoolctl rocks pack NAME

Создание модуля путем компоновки исходных или бинарных файлов.

tarantoolctl rocks purge NAME

Remove all installed rocks from a tree. Since version 2.4.1.

tarantoolctl rocks remove NAME

Удаление модуля.

tarantoolctl rocks show NAME

Отображение информации об установленном модуле.

tarantoolctl rocks search NAME

Поиск модулей по репозиторию.

tarantoolctl rocks unpack NAME

Распаковка содержимого модуля.

tarantoolctl rocks which NAME

Tell which file corresponds to a given module name. Since version 2.4.1.

tarantoolctl rocks write_rockspec

Write a template for a rockspec file. Since version 2.4.1.

В качестве аргумента можно указать:

файл в формате .rockspec для создания модуля, который содержит исходные файлы или
имя установленного модуля (с версией, если их больше одной) для создания модуля, который содержит скомпилированные файлы.

tarantoolctl rocks unpack {<rock_file> | <rockspec> | <имя> [версия]}

Распаковка содержимого модуля в новую директорию в текущей директории.