Версия:

Справочники / Утилита tarantoolctl
Справочники / Утилита tarantoolctl

Утилита tarantoolctl

Утилита 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.

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

tarantoolctl start NAME

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

Additionally, this command sets the TARANTOOLCTL environment variable to „true“, to mark that the instance was started by tarantoolctl.

tarantoolctl stop NAME
Остановка экземпляра Tarantool’а.
tarantoolctl status NAME

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

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

tarantoolctl restart NAME

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

Additionally, this command sets the TARANTOOL_RESTARTED environment variable to „true“, to mark that the instance was restarted by 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 для фильтрации вывода по идентификатору реплики. Можно передавать несколько раз.

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

tarantoolctl rocks install NAME
Установка модуля в текущей директории.
tarantoolctl rocks remove NAME
Удаление модуля.
tarantoolctl rocks show NAME
Отображение информации об установленном модуле.
tarantoolctl rocks search NAME
Поиск модулей по репозиторию.
tarantoolctl rocks list
Вывод списка всех установленных модулей.
tarantoolctl rocks pack {<rockspec> | <name> [<version>]}

Create a rock by packing sources or binaries.

As an argument, you can specify:

  • a .rockspec file to create a source rock containing the module’s sources, or
  • the name of an installed module (and its version if there are more than one) to create a binary rock containing the compiled module.
tarantoolctl rocks unpack {<rock_file> | <rockspec> | <name> [version]}

Unpack the contents of a rock into a new directory under the current one.

As an argument, you can specify:

  • source or binary rock files,
  • .rockspec files, or
  • names of rocks or .rockspec files in remote repositories (and the rock version if there are more than one).

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

  • --server=server_name check this server first, then the usual list.
  • --only-server=server_name check this server only, ignore the usual list.