Перейти к содержанию

Аргументы командной строки

Picodata является консольным приложением, которое поддерживает различные параметры запуска в виде аргументов командной строки и переменных окружения.

picodata help

Полная справка доступна с помощью команды picodata help:

USAGE:
    picodata <SUBCOMMAND>

OPTIONS:
    -h, --help       Print help information
    -V, --version    Print version information

SUBCOMMANDS:
    admin        Connect to admin console of a Picodata instance
    connect      Сonnect to a Picodata instance and start interactive SQL console
    expel        Expel node from cluster
    help         Print this message or the help of the given subcommand(s)
    run          Run the picodata instance
    test         Run picodata integration tests

picodata run

Запускает инстанс Picodata, см. Запуск Picodata.

picodata run [OPTIONS]

--admin-sock

--admin-sock <PATH>

Путь к unix-сокету для подключения с помощью команды picodata admin. Данный способ использует обычный текстовый протокол и привилегии администратора. См. Подключение и работа в консоли — Консоль администратора.

Значение по умолчанию: <data_dir>/admin.sock
Аналогичная переменная окружения: PICODATA_ADMIN_SOCK

--advertise

--advertise <[HOST][:PORT]>

Адрес, по которому другие инстансы смогут подключиться к данному инстансу. По умолчанию используется значение --listen.

Аналогичная переменная окружения: PICODATA_ADVERTISE

--audit

--audit <FILE>

Конфигурация журнала аудита. Доступны следующие варианты:

  • file:<FILE> или просто <FILE> — запись в файл
  • pipe:<COMMAND> или | <COMMAND> — перенаправление вывода в подпроцесс
  • syslog: — перенаправление вывода в службу syslog защищенной ОС

Аналогичная переменная окружения: PICODATA_AUDIT_LOG

--cluster-id

--cluster-id <NAME>

Имя кластера. Инстанс не сможет стать частью кластера, если у него указано другое имя.

Аналогичная переменная окружения: PICODATA_CLUSTER_ID

--data-dir

--data-dir <PATH>

Рабочая директория инстанса. Здесь Picodata хранит все данные.

Аналогичная переменная окружения: PICODATA_DATA_DIR

--failure-domain

--failure-domain <KEY=VALUE>

Список параметров географического расположения сервера (через запятую). Также этот аргумент называется зоной доступности. Каждый параметр должен быть в формате КЛЮЧ=ЗНАЧЕНИЕ. Следует помнить о том, что добавляемый инстанс должен обладать тем же набором доменов (т.е. ключей данного аргумента), что уже есть в кластере. Picodata будет избегать помещения двух инстансов в один репликасет, если хотя бы один параметр зоны доступности у них совпадает. Соответственно, инстансы будут формировать новые репликасеты.

Аналогичная переменная окружения: PICODATA_FAILURE_DOMAIN

--http-listen

--http-listen <[HOST][:PORT]>

Адрес HTTP-сервера. Интерфейс конфигурации сервера экспортирован в Lua-переменной _G.pico.httpd. При отсутствии параметра сервер не запускается, а указанная Lua-переменная имеет значение nil.

Аналогичная переменная окружения: PICODATA_HTTP_LISTEN

--init-cfg

--init-cfg <PATH>

Путь к файлу конфигурации, используемый при бутстрапе кластера.

Данный параметр не сочетается с --init-replication-factor
Аналогичная переменная окружения: PICODATA_INIT_CFG

--init-replication-factor

--init-replication-factor <INIT_REPLICATION_FACTOR>

Число реплик (инстансов с одинаковым набором хранимых данных) для каждого репликасета.

Данный параметр не сочетается с --init-cfg
Аналогичная переменная окружения: PICODATA_INIT_REPLICATION_FACTOR

--instance-id

--instance-id <NAME>

Название инстанса. При отсутствии параметра, значение будет автоматически сгенерировано raft-лидером в момент присоединения (joining) инстанса к кластеру.

Аналогичная переменная окружения: PICODATA_INSTANCE_ID

--listen

-l, --listen <[HOST][:PORT]>

Адрес и порт привязки инстанса.

Значение по умолчанию: localhost:3301
Аналогичная переменная окружения: PICODATA_LISTEN

--log

--log

Конфигурация журнала логирования. Доступны следующие варианты:

  • file:<FILE> или просто <FILE> — запись в файл
  • pipe:<COMMAND> или | <COMMAND> — перенаправление вывода в подпроцесс
  • syslog: — перенаправление вывода в службу syslog защищенной ОС

Аналогичная переменная окружения: PICODATA_LOG

--log-level

--log-level <LOG_LEVEL>

Уровень важности событий, регистрируемых в отладочном журнале.

Возможные значения: fatal, system, error, crit, warn, info, verbose, debug
Значение по умолчанию: info
Аналогичная переменная окружения: PICODATA_LOG_LEVEL

--memtx-memory

--memtx-memory <MEMTX_MEMORY>

Количество памяти, предоставляемое непосредственно на хранение данных.

Значение по умолчанию: 67108864 (64M)
Аналогичная переменная окружения: PICODATA_MEMTX_MEMORY

--peer

--peer <[HOST][:PORT]>

Один или несколько адресов других инстансов через запятую.

Значение по умолчанию: localhost:3301
Аналогичная переменная окружения: PICODATA_PEER

--replicaset-id

--replicaset-id <NAME>

Имя репликасета. При отсутствии параметра, значение будет автоматически выбрано raft-лидером в момент присоединения (joining) инстанса к кластеру.

Аналогичная переменная окружения: PICODATA_REPLICASET_ID

--script

--script <PATH>

Путь к файлу Lua-скрипта, который будет выполнен после присоединения инстанса к кластеру.

Аналогичная переменная окружения: PICODATA_SCRIPT

--service-password-file

--service-password-file <PATH>

Путь к файлу с паролем для системного пользователя pico_service. Этот пароль будет использован для взаимодействия с другими инстансами кластера. При несовпадении пароля присоединение инстанса к кластеру невозможно. При отсутствии параметра в качестве пароля используется пустая строка, см. Безопасный запуск.

Аналогичная переменная окружения: PICODATA_SERVICE_PASSWORD_FILE

--shredding

--shredding

Режим безопасного удаления рабочих файлов инстанса путем многократной перезаписи специальными битовыми последовательностями, см. Безопасный запуск.

Аналогичная переменная окружения: PICODATA_SHREDDING

--tier

--tier <TIER>

Название тира, которому будет принадлежать инстанс.

Аналогичная переменная окружения: PICODATA_INSTANCE_TIER

picodata admin

Подключается к консоли администратора, cм. Подключение и работа в консоли — Консоль администратора.

picodata admin <PATH>

Пример

$ picodata admin ./admin.sock
Connected to admin console by socket path "admin.sock"
type '\help' for interactive help
picodata>

picodata connect

Подключается к кластерной SQL-консоли. См. Пользовательская консоль

picodata connect [OPTIONS] <ADDRESS>
  • ADDRESS: Адрес инстанса Picodata в формате [user@][host][:port], соответствующий опции picodata run --advertise

Пример

$ picodata connect alice@localhost:3301
Enter password for alice:
Connected to interactive console by address "localhost:3301" under "alice" user
type '\help' for interactive help
picodata>

-a, --auth-type

-a, --auth-type <METHOD>

Метод аутентификации, см. Аутентификация с помощью LDAP.

Возможные значения: chap-sha1, ldap, md5
Значение по умолчанию: chap-sha1

--password-file

--password-file <PATH>

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

Аналогичная переменная окружения: PICODATA_PASSWORD_FILE

-u, --user

-u, --user <USER>

Имя пользователя, см. Управление доступом.

Игнорируется при указании имени пользователя в адресе
Значение по умолчанию: guest

picodata expel

Исключает инстанс Picodata из состава кластера.

Если инстанс хранит сегменты шардированных данных, перед его удалением данные будет автоматически перераспределены.

Если удаляемый инстанс является голосующим в Raft, то для его замены автоматически будет выбран новый голосующий узел.

Если удаляемый инстанс является raft-лидером, то будут организованы новые выборы.

Данное действие требует авторизации под учетной записью Администратора СУБД admin.

picodata expel [OPTIONS] <INSTANCE_ID>
  • INSTANCE_ID: Название инстанса

--cluster-id

--cluster-id <NAME>

Имя кластера, из которого должен быть исключен инстанс.

Значение по умолчанию: demo

--password-file

--password-file <PATH>

Путь к файлу с паролем Администратора СУБД admin (хранится в виде обычного текста). Без этого параметра пароль будет запрошен в интерактивном режиме.

Аналогичная переменная окружения: PICODATA_PASSWORD_FILE

--peer

--peer <[HOST][:PORT]>

Адрес любого инстанса из состава кластера.

Значение по умолчанию: localhost:3301