Параметры PostgreSQL

Примечание

Параметры можно указывать в нотации snake_case. Переданные параметры автоматически преобразуются в camelCase.

Параметры создания сервиса

Эти параметры указываются в качестве parameters в методе CreateService.

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

Если выбранная версия PostgreSQL поддерживает другие параметры, то их можно задать внутри параметра options.

version

Версия СУБД.

Необходимо	Тип данных	Допустимые значения
Да	String	12 13 14 15 16

replicationMode

Режим репликации в кластере Patroni. Доступен только при выборе опции Отказоустойчивый сервис.

Необходимо	Тип данных	Допустимые значения	По умолчанию
Да, если выбрана опция Отказоустойчивый сервис	String	asynchronous synchronous synchronous_strict	asynchronous

autovacuum

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

Необходимо	Тип данных	Допустимые значения	По умолчанию	Auto
Нет	String	ON/OFF	ON	N/A

autovacuumAnalyzeScaleFactor

Процент от размера таблицы, который будет добавляться к autovacuumAnalyzeThreshold при выборе порога срабатывания команды ANALYZE.

Необходимо	Тип данных	Допустимые значения	По умолчанию	Auto
Нет	Float	0–100	0.1	N/A

autovacuumMaxWorkers

Максимальное число процессов автоочистки, которые могут выполняться одновременно (не считая процесс, запускающий автоочистку).

Необходимо	Тип данных	Допустимые значения	По умолчанию	Auto
Нет	Integer	1–262143	3	= vCPU, min 3

autovacuumVacuumCostDelay

Задержка в миллисекундах при превышении предела стоимости, которая будет применяться при автоматических операциях VACUUM.

Необходимо	Тип данных	Допустимые значения	По умолчанию	Auto
Нет	Integer	-1 1–100	20 (вер. 10-11) 2 (вер. 12+)	N/A

autovacuumVacuumCostLimit

Предел, который учитывается при автоматических операциях VACUUM.

Необходимо	Тип данных	Допустимые значения	По умолчанию	Auto
Нет	Integer	-1 1–10000	-1	N/A

autovacuumVacuumScaleFactor

Процент от размера таблицы, который будет добавляться к autovacuumVacuumThreshold при выборе порога срабатывания команды VACUUM.

Необходимо	Тип данных	Допустимые значения	По умолчанию	Auto
Нет	Float	0–100	0.2	N/A

defaultPoolSize

Размер пула открытых подключений к базам данных (PgBouncer).

Необходимо	Тип данных	Допустимые значения	По умолчанию
Нет	Integer	1–200	20

maxConnections

Максимальное число одновременных подключений к серверу БД.

Необходимо	Тип данных	Допустимые значения	По умолчанию	Auto
Нет	Integer	1–262143	100	200 × vCPU

sharedBuffers

Объём памяти, который будет использовать сервер баз данных под буферы в разделяемой памяти. Ознакомиться с описанием можно здесь.

Необходимо	Тип данных	Допустимые значения	По умолчанию	Auto
Нет	Integer	128–8589934584 КиБ	128 МиБ	25% RAM

walKeepSegments

Минимальное число файлов имеющихся сегментов журнала, которые будут сохраняться в каталоге pg_xlog, чтобы сервер мог выбрать их при потоковой репликации. Параметр актуален только для следующих версий PostgreSQL: 12.

Необходимо	Тип данных	Допустимые значения	По умолчанию	Auto
Нет	Integer	0–2147483647	0	4

walBuffers

Объём разделяемой памяти, который будет использоваться для буферизации данных WAL, ещё не записанных на диск. Указывается в виде целого числа, означающего количество юнитов размером 8 КиБ.

Необходимо	Тип данных	Допустимые значения	По умолчанию	Auto
Нет	Integer	8–262143	1/32 shared buffers, не менее 8 (64 КиБ), но не более размера одного сегмента WAL	N/A

effectiveCacheSize

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

Необходимо	Тип данных	Допустимые значения	По умолчанию	Auto
Нет	Integer	8–17179869176 КиБ	4 ГиБ	N/A

workMem

Объём памяти в байтах, который будет использоваться для внутренних операций сортировки и хеш-таблиц, прежде чем будут задействованы временные файлы на диске.

Необходимо	Тип данных	Допустимые значения	По умолчанию	Auto
Нет	Integer	64–2147483647 КиБ	4 МиБ	N/A

maintenanceWorkMem

Максимальный объём памяти в байтах для операций обслуживания БД (VACUUM, CREATE INDEX и ALTER TABLE ADD FOREIGN KEY).

Необходимо	Тип данных	Допустимые значения	По умолчанию	Auto
Нет	Integer	1 МиБ–2 ГиБ	64 МиБ	N/A

effectiveIoConcurrency

Допустимое количество параллельных операций ввода/вывода.

Необходимо	Тип данных	Допустимые значения	По умолчанию	Auto
Нет	Integer	0–1000	1	N/A

maxWorkerProcesses

Максимальное количество фоновых процессов, которое можно запустить в текущей системе.

Необходимо	Тип данных	Допустимые значения	По умолчанию	Auto
Нет	Integer	0–262143	8	= vCPU

maxParallelWorkersPerGather

Максимальное количество рабочих процессов, которые могут запускаться одним узлом Gather. Параллельные рабочие процессы берутся из пула процессов, контролируемого параметром maxWorkerProcesses.

Необходимо	Тип данных	Допустимые значения	По умолчанию	Auto
Нет	Integer	0–1024	2	vCPU/2

maxParallelMaintenanceWorkers

Максимальное количество рабочих процессов, которые могут запускаться одной служебной командой. Параметр актуален только для PostgreSQL, начиная с версии 11 и выше.

Необходимо	Тип данных	Допустимые значения	По умолчанию	Auto
Нет	Integer	0–1024	2	vCPU/2

maxParallelWorkers

Максимальное количество рабочих процессов, которое система сможет поддерживать для параллельных запросов.

Необходимо	Тип данных	Допустимые значения	По умолчанию	Auto
Нет	Integer	0–1024	8	= vCPU

maxClientConn

Максимально допустимое количество клиентских подключений к PgBouncer.

Необходимо	Тип данных	Допустимые значения	По умолчанию
Нет	Integer	1–1000	100

pool_mode

Режим работы PgBouncer.

Необходимо	Тип данных	Допустимые значения	По умолчанию
Нет	String	session transaction statement	session

monitoring

Подключение к сервису мониторинга.

Необходимо	Возможность редактирования	Тип данных	Допустимые значения	По умолчанию
Для всех сервисов, кроме Prometheus	Есть	Boolean	true false	false

monitorBy

Идентификатор сервиса мониторинга. Указанный сервис должен быть развёрнут в том же проекте, что и текущий сервис.

Необходимо	Возможность редактирования	Тип данных	Допустимые значения
Да, если передан параметр monitoring = true. Если monitoring = false, передача параметра невозможна	Есть	String	ID сервиса мониторинга, расположенного в том же VPC, что и текущий сервис

monitoringLabels

Метки, которые будут назначены метрикам мониторируемого сервиса в сервисе мониторинга.

Необходимо	Возможность редактирования	Тип данных	Допустимые значения
Нет. Если monitoring = false, передача параметра невозможна	Есть	Dict	Имя метки может содержать цифры, латинские буквы, символ подчёркивания. Значение метки может содержать любые ASCII-символы.

logging

Подключение к сервису логирования.

Необходимо	Возможность редактирования	Тип данных	Допустимые значения	По умолчанию
Для всех сервисов, кроме ELK и Prometheus	Есть	Boolean	true false	false

logTo

Идентификатор сервиса логирования. Логируемый сервис должен быть развёрнут в том же проекте, что и текущий сервис.

Необходимо	Возможность редактирования	Тип данных	Допустимые значения	По умолчанию
Да, если передан параметр logging = true. Если logging = false, передача параметра невозможна	Есть	String	ID сервиса мониторинга, расположенного в том же VPC, что и текущий сервис

loggingTags

Теги, которые будут назначены записям журнала текущего сервиса в сервисе логирования.

Необходимо	Возможность редактирования	Тип данных	Допустимые значения	По умолчанию
Нет. Если logging = false, передача параметра невозможна	Есть	List of strings	Строка не более 256 символов

options

Контейнер для других параметров PostgreSQL.

Примечание

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

Необходимо	Тип данных	Допустимые значения
Нет	Dict	N/A

pgbouncerOptions

Контейнер для других параметров PgBouncer.

Примечание

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

Необходимо	Тип данных	Допустимые значения
Нет	Dict	N/A

Параметры создания пользователя

Эти параметры указываются в поле parameters объекта User при передаче последнего в параметре users метода ModifyService.

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

password

Необходимо	Возможность редактирования	Тип данных	Допустимые значения	По умолчанию
Да	Есть	String	Не должен содержать символы ', ", ` и \	N/A

Параметры создания базы данных

Эти параметры указываются в поле parameters объекта Database при передаче последнего в параметре databases метода ModifyService.

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

С помощью параметров backupId и backupDbName осуществляется восстановление базы данных из имеющейся резервной копии. Информацию об имеющихся резервных копиях можно получить с помощью метода ListBackups.

owner

Имя пользователя, который является владельцем БД. Должен быть одним из существующих пользователей. Такого пользователя нельзя удалить, пока он является владельцем базы данных.

Необходимо	Возможность редактирования	Тип данных	Допустимые значения	По умолчанию
Да	Есть	String	Существующий пользователь базы данных	N/A

locale

Необходимо	Возможность редактирования	Тип данных	Допустимые значения	По умолчанию
Нет	Нет	String	Любое корректное значение кодировки	ru_RU.UTF-8

encoding

Необходимо	Возможность редактирования	Тип данных	Допустимые значения	По умолчанию
Нет	Нет	String	Любое корректное значение кодировки	UTF8

extensions

Список расширений, которые будут активированы для данной БД.

Необходимо	Возможность редактирования	Тип данных	Допустимые значения	По умолчанию
Нет	Есть	Array of strings	address_standardizer address_standardizer_data_us amcheck autoinc bloom btree_gin btree_gist citext cube dblink dict_int dict_xsyn earthdistance fuzzystrmatch hstore intarray isn lo ltree moddatetime pg_buffercache pg_trgm pg_visibility pgcrypto pgrowlocks pgstattuple postgis postgis_tiger_geocoder postgis_topology postgres_fdw seg tablefunc tcn timescaledb tsm_system_rows tsm_system_time unaccent uuid-ossp xml2	N/A

backupId

Идентификатор резервной копии базы данных.

Необходимо	Возможность редактирования	Тип данных	Допустимые значения	По умолчанию
Нет	Нет	String	Идентификатор существующей резервной копии базы данных	N/A

backupDbName

Имя базы данных из резервной копии, указанной в параметре backupId.

Необходимо	Возможность редактирования	Тип данных	Допустимые значения	По умолчанию
Да, если указан backupId	Нет	String	Имя базы данных, содержащейся в резервной копии	N/A