Справочник настроек¶
В таблице ниже приведены все настройки Picodata, доступные для изменения. Указаны способы изменения, значения по умолчанию и прочая полезная информация.
Справочник разделен на две части:
- настройки запуска Picodata (параметры инстанса и кластера), управляемые через файл конфигурации и параметры CLI
- настройки СУБД, управляемые через SQL-запросы
Настройки запуска Picodata¶
Легенда¶
audit—настройка применима к отдельному инстансу
cluster-name—настройка применима ко всему кластеру
| Название | Описание | Значение по умолчанию | CLI | Файл конфигурации | Переменная |
|---|---|---|---|---|---|
| admin-sock | Путь к unix-сокету для подключения к консоли администратора | admin.sock в рабочей директории инстанса | picodata run --admin-sock | instance.admin_socket | PICODATA_ADMIN_SOCK |
| audit | Конфигурация журнала аудита | null | picodata run --audit | instance.audit | PICODATA_AUDIT_LOG |
| boot_timeout | Время, в течение которого инстанс ожидает загрузки перед присоединением к кластеру (с) | 7200 | picodata run -c instance.boot_timeout=3600 | instance.boot.timeout | |
| config | Путь к файлу конфигурации в формате YAML | null | picodata run --config | PICODATA_CONFIG_FILE | |
| config-parameter | Список пар ключ-значение, определяющий параметры конфигурации | null | picodata run --config-parameter | PICODATA_CONFIG_PARAMETERS | |
| failure-domain | Список пар ключ-значение, разделенных запятыми, определяющий географическое расположение сервера | {} | picodata run --failure-domain | instance.failure_domain | PICODATA_FAILURE_DOMAIN |
| http-listen | Адрес HTTP-сервера | null | picodata run --http-listen | instance.http_listen | PICODATA_HTTP_LISTEN |
| init-replication-factor | Число реплик (инстансов с одинаковым набором хранимых данных) для каждого репликасета | 1 | picodata run --init-replication-factor | cluster.default_replication_factor | PICODATA_INIT_REPLICATION_FACTOR |
| instance-dir | Рабочая директория инстанса | ./ | picodata run --instance-dir | instance.instance_dir | PICODATA_INSTANCE_DIR |
| instance-name | Имя инстанса | null | picodata run --instance-name | instance.name | PICODATA_INSTANCE_NAME |
| iproto-advertise | Публичный сетевой адрес инстанса | 127.0.0.1:3301 | picodata run --iproto-advertise | instance.iproto_advertise | PICODATA_IPROTO_ADVERTISE |
| iproto-listen | Сетевой адрес инстанса | 127.0.0.1:3301 | picodata run --iproto-listen | instance.iproto_listen | PICODATA_IPROTO_LISTEN |
| log | Конфигурация отладочного журнала | null | picodata run --log | instance.log.destination | PICODATA_LOG |
| log-level | Уровень важности событий, регистрируемых в отладочном журнале | info | picodata run --log-level | instance.log.level | PICODATA_LOG_LEVEL |
| memtx-memory | Объем оперативной памяти в байтах, используемый движком хранения memtx | 67108864 | picodata run --memtx-memory | instance.memtx.memory | PICODATA_MEMTX_MEMORY |
| peer | Список сетевых адресов других инстансов, разделенных запятыми | - 127.0.0.1:3301 |
picodata run --peer picodata expel --peer picodata status --peer |
instance.peer | PICODATA_PEER |
| pg-listen | Адрес сервера для подключения по протоколу PostgreSQL | 127.0.0.1:4327 | picodata run --pg-listen | instance.pg.listen | PICODATA_PG_LISTEN |
| replicaset-name | Имя репликасета. Используется при инициализации кластера и присоединении инстанса к уже существующему кластеру | null | picodata run --replicaset-name | instance.replicaset_name | PICODATA_REPLICASET_NAME |
| script | Путь к файлу Lua-скрипта, который будет выполнен после присоединения инстанса к кластеру | null | picodata run --script | PICODATA_SCRIPT | |
| share-dir | Путь к директории, содержащей файлы плагинов | null | picodata run --share-dir | instance.share_dir | PICODATA_SHARE_DIR |
| shredding | Режим безопасного удаления рабочих файлов инстанса | false | picodata run --shredding | cluster.shredding | PICODATA_SHREDDING |
| tier | Имя тира, которому будет принадлежать инстанс | default | picodata run --tier | instance.tier | PICODATA_SHREDDING |
| auth-type | Метод аутентификации | md5 | picodata expel --auth-type | ||
| password-file | Путь к файлу с паролем указанного пользователя | null | picodata expel --password-file | PICODATA_PASSWORD_FILE | |
| service-password-file | Путь к текстовому файлу с паролем для системного пользователя pico_service | null |
picodata plugin configure --service-password-file picodata status --service-password-file |
PICODATA_SERVICE_PASSWORD_FILE | |
| default_bucket_count | Число сегментов в кластере по умолчанию | 3000 | cluster.default_bucket_count | ||
| bucket_count | Число сегментов в тире | 3000 | cluster.tier.<tier_name>.bucket_count | ||
| pg.ssl | Признак использования протокола SSL при подключении к SQL-консоли | false | picodata run -c instance.pg.ssl=true | instance.pg.ssl | |
| vinyl.bloom_fpr | Вероятность ложноположительного срабатывания фильтра Блума для движка хранения vinyl, измеряемая в долях единицы | 0.05 | picodata run -c instance.vinyl.bloom_fpr=0.10 | instance_vinyl_bloom_fpr | |
| vinyl.cache | Размер кэша в байтах для движка хранения vinyl | 134217728 | picodata run -c instance.vinyl.cache=256M | instance_vinyl_cache | |
| vinyl.max_tuple_size | Максимальный размер кортежа в байтах для движка хранения vinyl | 1048576 | picodata run -c instance.vinyl.max_tuple_size=2M | instance.vinyl.max_tuple_size | |
| vinyl.memory | Максимальное количество оперативной памяти в байтах, которое использует движок хранения vinyl | 134217728 | picodata run -c instance.vinyl.memory=256M | instance.vinyl.memory | |
| vinyl.page_size | Размер страницы в байтах, используемой движком хранения vinyl для операций чтения и записи на диск | 8192 | picodata run -c instance.vinyl.page_size=16M | instance.vinyl.page_size | |
| vinyl.range_size | Максимальный размер LSM-поддерева по умолчанию в байтах для движка хранения vinyl | 1073741824 | picodata run -c instance.vinyl.range_size=2G | instance.vinyl.range_size | |
| vinyl.read_threads | Максимальное количество потоков чтения для движка хранения vinyl | 1 | picodata run -c instance.vinyl.run_count_per_level=4 | instance.vinyl.read_threads | |
| vinyl.run_size_ratio | Соотношение между размерами разных уровней в LSM-дереве для движка хранения vinyl | 3.5 | picodata run -c instance.vinyl.run_size_ratio=7.0 | instance.vinyl.run_size_ratio | |
| vinyl.timeout | Максимальное время обработки запроса движком хранения vinyl в секундах | 60.0 | picodata run -c instance.vinyl.timeout=120.0 | instance.vinyl.timeout | |
| vinyl.write_threads | Максимальное количество потоков записи для движка хранения vinyl | 4 | picodata run -c instance.vinyl.write_threads=8 | instance.vinyl.write_threads |
Настройки СУБД¶
Легенда¶
pg_portal_max—настройка применима к кластеру
iproto_net_msg_max—настройка применима к отдельному тиру
| Название | Описание | Значение по умолчанию | Пример SQL-команды |
|---|---|---|---|
| auth_login_attempt_max | Максимальное количество неуспешных попыток аутентификации через picodata connect |
4 |
|
| auth_password_enforce_digits | Признак пароля пользователя, требующий наличия хотя бы одной цифры | true |
|
| auth_password_enforce_specialchars | Признак пароля пользователя, требующий наличия хотя бы одного спецсимвола | false |
|
| auth_password_enforce_lowercase | Признак пароля пользователя, требующий наличия хотя бы одного символа в нижнем регистре | true |
|
| auth_password_enforce_uppercase | Признак пароля пользователя, требующий наличия хотя бы одного символа в верхнем регистре | true |
|
| auth_password_length_min | Минимальная длина пароля, требуемая при установке или изменении пароля пользователя в Picodata | 8 |
|
| governor_auto_offline_timeout | Время в секундах, после которого инстанс, не отвечающий на запросы от raft-лидера, будет автоматически переведен в состояние Offline | 30.0 |
|
| governor_common_rpc_timeout | Время ожидания до перехода губернатора к новой итерации цикла, за которое инстансы должны ответить губернатору на его RPC-запросы | 3.0 |
|
| governor_plugin_rpc_timeout | Время ожидания до перехода губернатора к новой итерации цикла, за которое инстансы должны ответить губернатору на его RPC-запросы для настройки системы плагинов | 10.0 |
|
| governor_raft_op_timeout | Время ожидания до перехода губернатора к новой итерации цикла, за которое предложенные губернатором изменения в raft-журнал должны быть применены к локальной raft-машине | 3.0 |
|
| pg_portal_max | Размер хранилища порталов PostgreSQL | 1024 |
|
| pg_statement_max | Размер хранилища стейтментов PostgreSQL | 1024 |
|
| raft_snapshot_chunk_size_max | Максимальный размер фрагмента в raft-снапшоте в байтах | 16777216 |
|
| raft_snapshot_read_view_close_timeout | Время в секундах, после которого окно чтения (read view) снапшота будет принудительно закрыто | 86400 |
|
| raft_wal_count_max | Максимальное количество записей в raft-журнале, при превышении которого он будет автоматически компактизирован | 64 |
|
| raft_wal_size_max | Максимальный размер raft-журнала в байтах, при превышении которого он будет автоматически компактизирован | 67108864 |
|
| sql_storage_cache_count_max | Максимальное количество prepared statement-ов для размещения в LRU-кэше на узлах хранения Vshard | 50 |
|
| sql_storage_cache_size_max | Динамический параметр Box API, регулирующий размер LRU-кэша в байтах | 5242880 |
|
| sql_motion_row_max | Максимальное количество строк в виртуальной таблице, собирающей результаты отдельных локальных запросов | 5000 |
|
| sql_vdbe_opcode_max | Максимальное количество команд при исполнении локального плана с помощью VDBE на узле кластера | 45000 |
|
| iproto_net_msg_max | Максимальное количество сообщений, которое Picodata обрабатывает параллельно | 0x300 |
|
| memtx_checkpoint_count | Максимальное количество снапшотов, хранящихся в директории memtx_dir |
2 |
|
| memtx_checkpoint_interval | Период активности службы создания снапшотов (checkpoint daemon) в секундах | 3600.0 |
|