Утилита tarantoolctl
tarantoolctl
представляет собой утилиту для администрирования экземпляров, файлов контрольной точки и модулей в Tarantool’е. Утилита поставляется и устанавливается как часть дистрибутива Tarantool’а.
См. также примеры использования 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
.
tarantoolctl start NAME
Запуск экземпляра Tarantool’а.
Кроме того, данная команда задает значение переменной окружения TARANTOOLCTL = „true“ (правда), чтобы отметить, что экземпляр был запущен с помощью
tarantoolctl
.Примечание
tarantoolctl
работает для экземпляров, где не вызвана функцияbox.cfg{}
или вызовbox.cfg{}
отложен.Например, это можно использовать для управления экземплярами, которые получают конфигурацию из внешнего сервера. Для таких экземпляров
tarantoolctl start
goes to background whenbox.cfg{}
is called, so it will wait until options forbox.cfg
are received. However this is not the case for daemon management systems likesystemd
, 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
- Вход в интерактивную Lua-консоль экземпляра.
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 ..]
- Стандартный вывод содержимого .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
для фильтрации вывода по идентификатору реплики. Можно передавать несколько раз.
tarantoolctl rocks install NAME
- Установка модуля в текущей директории.
tarantoolctl rocks remove NAME
- Удаление модуля.
tarantoolctl rocks show NAME
- Отображение информации об установленном модуле.
tarantoolctl rocks search NAME
- Поиск модулей по репозиторию.
tarantoolctl rocks list
- Вывод списка всех установленных модулей.
tarantoolctl rocks pack {<rockspec> | <имя> [<версия>]}
Создание модуля путем компоновки исходных или бинарных файлов.
В качестве аргумента можно указать:
- файл в формате
.rockspec
для создания модуля, который содержит исходные файлы или - имя установленного модуля (с версией, если их больше одной) для создания модуля, который содержит скомпилированные файлы.
- файл в формате
tarantoolctl rocks unpack {<rock_file> | <rockspec> | <имя> [версия]}
Распаковка содержимого модуля в новую директорию в текущей директории.
В качестве аргумента можно указать:
- исходные или бинарные файлы модуля,
- файлы
.rockspec
или - имя модулей или файлов в формате
.rockspec
в удаленных репозиториях (с версией модуля, если их больше одной).
Поддерживаемые опции:
--server=имя_севрера
сначала проверить данный сервер, затем по списку.--only-server=имя_сервера
проверить только данный сервер, остальные пропустить.