PostgreSQL parameters#

Note

Parameters can be specified in snake_case notation. Parameters that are passed are automatically converted to camelCase.

Parameters for creating a service#

These parameters are provided as parameters in the method CreateService.

When creating a new service, the parameters marked as Required should be provided.

If the selected version PostgreSQL supports other parameters, they can be set in the options parameter.

vendor#

PostgreSQL DBMS storage subsystem vendor.

Required

Datatype

Valid values

Defaults

No

String

pgsql
pgsql1c

pgsql

version#

DBMS engine version. Version depends on the vendor.

Required

Datatype

Valid values

Yes

String

pgsql: 14, 15, 16, 17, 18;
pgsql1c: 16, 17

replicationMode#

Replication mode in the Patroni cluster. Available only when the High-availability service option is selected.

Required

Datatype

Valid values

Defaults

Yes, if the High-availability service option is selected

String

asynchronous
synchronous
synchronous_strict

asynchronous

autovacuum#

Controls whether the server should run the autovacuum launcher daemon.

Required

Datatype

Valid values

Defaults

Auto

No

String

ON/OFF

ON

N/A

autovacuumAnalyzeScaleFactor#

Specifies a fraction of the table size to add to autovacuumAnalyzeThreshold when deciding whether to trigger an ANALYZE.

Required

Datatype

Valid values

Defaults

Auto

No

Float

0–100

0.1

N/A

autovacuumMaxWorkers#

Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time.

Required

Datatype

Valid values

Defaults

Auto

No

Integer

1–262143

3

= vCPU, min 3

autovacuumVacuumCostDelay#

Specifies the delay in milliseconds that will be used in automatic VACUUM operations when the cost limit is exceeded.

Required

Datatype

Valid values

Defaults

Auto

No

Integer

-1
1–100

20 (ver 10-11)
2 (ver 12+)

N/A

autovacuumVacuumCostLimit#

Specifies the cost limit value that will be used in automatic VACUUM operations.

Required

Datatype

Valid values

Defaults

Auto

No

Integer

-1
1–10000

-1

N/A

autovacuumVacuumScaleFactor#

Specifies a fraction of the table size to add to autovacuumVacuumThreshold when deciding whether to trigger a VACUUM.

Required

Datatype

Valid values

Defaults

Auto

No

Float

0–100

0.2

N/A

defaultPoolSize#

The size of the pool of open connections to databases (PgBouncer).

Required

Datatype

Valid values

Defaults

No

Integer

1–200

20

maxConnections#

The maximum number of simultaneous connections to the database server.

Required

Datatype

Valid values

Defaults

Auto

No

Integer

1–262143

100

200 × vCPU

sharedBuffers#

Sets the amount of memory the database server uses for shared memory buffers. See for details.

Required

Datatype

Valid values

Defaults

Auto

No

Integer

128–8589934584 KiB

128 MiB

25% RAM

walKeepSegments#

The minimum number of log files segments that should be kept in the pg_xlog directory, in case a standby server needs to fetch them for streaming replication. This parameter is relevant only for PostgreSQL: 12 version.

Required

Datatype

Valid values

Defaults

Auto

No

Integer

0–2147483647

0

4

walBuffers#

Shared memory to buffer WAL data not yet written to a volume. It is an integer number specifying the quantity of 8 KB units.

Required

Datatype

Valid values

Defaults

Auto

No

Integer

8–262143

1/32 shared buffers, no less than 8 (64 KiB), but no more that the size of 1 WAL segment

N/A

effectiveCacheSize#

Sets the planner’s assumption about the effective size of the disk cache that is available to a single query. See details.

Required

Datatype

Valid values

Defaults

Auto

No

Integer

8–17179869176 KiB

4 GiB

N/A

workMem#

Sets the base maximum amount of memory in bytes to be used by a query operation (such as a sort or hash table) before writing to temporary disk files.

Required

Datatype

Valid values

Defaults

Auto

No

Integer

64–2147483647 KiB

4 MiB

N/A

maintenanceWorkMem#

Specifies the maximum amount of memory in bytes to be used by database maintenance operations, such as VACUUM, CREATE INDEX, and ALTER TABLE ADD FOREIGN KEY.

Required

Datatype

Valid values

Defaults

Auto

No

Integer

1 MiB–2 GiB

64 MiB

N/A

effectiveIoConcurrency#

Sets the number of concurrent disk I/O operations.

Required

Datatype

Valid values

Defaults

Auto

No

Integer

0–1000

1

N/A

maxWorkerProcesses#

Sets the maximum number of background processes that the system can support.

Required

Datatype

Valid values

Defaults

Auto

No

Integer

0–262143

8

= vCPU

maxParallelWorkersPerGather#

Sets the maximum number of workers that can be started by a single Gather node. Parallel workers are taken from the pool of processes established by maxWorkerProcesses.

Required

Datatype

Valid values

Defaults

Auto

No

Integer

0–1024

2

vCPU/2

maxParallelMaintenanceWorkers#

Sets the maximum number of parallel workers that can be started by a single utility command. This parameter is relevant only for PostgreSQL versions 11 and higher.

Required

Datatype

Valid values

Defaults

Auto

No

Integer

0–1024

2

vCPU/2

maxParallelWorkers#

Sets the maximum number of workers that the system can support for parallel operations.

Required

Datatype

Valid values

Defaults

Auto

No

Integer

0–1024

8

= vCPU

maxClientConn#

The maximum permitted number of simultaneous client connections to PgBouncer.

Required

Datatype

Valid values

Defaults

No

Integer

1–1000

100

poolMode#

PgBouncer operating mode.

Required

Datatype

Valid values

Defaults

No

String

session
transaction
statement

session

monitoring - The monitoring information for the instance#

Connection to a monitoring service.

Required

Editable

Datatype

Valid values

Defaults

For all services, except for Prometheus

Yes

Boolean

true
false

false

monitorBy#

Monitoring service ID. The specified service must be deployed in the same project as the current service.

Required

Editable

Datatype

Valid values

Yes, if the monitoring = true parameter is passed. If monitoring = false, the parameter cannot be passed

Yes

String

The ID of a monitoring service running within the same VPC as the current service

monitoringLabels#

Labels to be assigned to the metrics of the monitored service in the monitoring service.

Required

Editable

Datatype

Valid values

No. If monitoring = false, the parameter cannot be passed

Yes

Dict

The label name may contain digits, Latin letters, and an underscore character. The label value may contain any ASCII characters.

logging#

Connection to a logging service.

Required

Editable

Datatype

Valid values

Defaults

For all services, except for ELK and Prometheus

Yes

Boolean

true
false

false

logTo#

Logging service ID. The logged service must be deployed in the same project as the current service.

Required

Editable

Datatype

Valid values

Defaults

Yes, if the logging = true parameter is passed. If logging = false, the parameter cannot be passed

Yes

String

The ID of a monitoring service running within the same VPC as the current service

loggingTags#

Tags to be assigned in the logging service to the log records of the current service.

Required

Editable

Datatype

Valid values

Defaults

No. If logging = false, the parameter cannot be passed

Yes

List of strings

String of 256 characters max

options#

Container for other parameters PostgreSQL.

Required

Datatype

Valid values

No

Dict

N/A

pgbouncerOptions#

Container for other PgBouncer parameters.

Required

Datatype

Valid values

No

Dict

N/A

User creation parameters#

These parameters are specified in the parameters attribute of the User object when the latter is passed in the users parameter of the ModifyService method.

The Editable property indicates whether the parameter value can be edited after the user has been created.

connectionLimit#

Limit on the number of user connections to the database.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

Integer

-1–2147483647

-1

password#

Database user password.

Required

Editable

Datatype

Valid values

Defaults

Yes

Yes

String

It should not contain such characters as ', ", ` and \

N/A

passwordEncryption#

Database user password encryption algorithm.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

String

md5
scram-sha-256

scram-sha-256

replication#

Grants this user permission to start database replication.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

Boolean

False
True

False

roles#

Database user roles.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

Array of strings

pg_maintain
pg_monitor
pg_read_all_settings
pg_read_all_stats
pg_signal_backend
pg_stat_scan_tables

[]

settings#

User role parameters.

applicationName#

Application name displayed in PostgreSQL logs, monitoring, and statistics (pg_stat_activity).

Required

Editable

Datatype

Valid values

Defaults

No

Yes

String

String of up to 64 characters (printable ASCII characters)

N/A

defaultTransactionIsolation#

Default isolation level for new transactions.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

Enum

read committed, repeatable read, serializable

N/A

defaultTransactionReadOnly#

Specifies whether transactions start in read-only mode by default.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

Boolean

off, on

N/A

idleInTransactionSessionTimeout#

The maximum time an open transaction can remain idle. If set to 0, the time is unlimited.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

Integer

Integer in milliseconds >= 0

N/A

idleSessionTimeout#

The maximum time an open session can remain idle. If set to 0, the time is unlimited.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

Integer

Integer in milliseconds >= 0

N/A

lockTimeout#

The maximum time a query can wait to acquire a lock on a database object. If set to 0, the time is unlimited.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

Integer

Integer in milliseconds >= 0

N/A

searchPath#

The list of schemas and the order in which they are searched for database objects.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

String

Comma-separated list of schemas

N/A

statementTimeout#

The maximum time allowed for query execution. If set to 0, the time is unlimited.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

Integer

Integer in milliseconds >= 0

N/A

timezone#

User session time zone.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

String

String with the time zone name

N/A

Parameters for creating a database#

These parameters are specified in the parameters attribute of the Database object when the latter is passed in the databases parameter of the ModifyService method.

The Editable property indicates whether a parameter value can be edited after the database has been created.

The backupId and backupDbName parameters are used to restore a database from an existing backup. Information about existing backups can be obtained using the method ListBackups.

owner#

Name of the user who is the database owner. This must be one of the existing users. Such a user cannot be deleted as long as it is the database owner.

Required

Editable

Datatype

Valid values

Defaults

Yes

Yes

String

Existing database user

N/A

locale#

Required

Editable

Datatype

Valid values

Defaults

No

No

String

Any correct encoding value

ru_RU.UTF-8

encoding#

Required

Editable

Datatype

Valid values

Defaults

No

No

String

Any correct encoding value

UTF8

extensions#

Extensions to be installed for the database.

Note

The pg_stat_statements extension is available for the environment version paas_v3_6 or later.

Note

The pg_repack and pg_squeeze extensions are available for the environment version paas_v4_0 or later.

Note

For the pgsql1c vendor, the mchar, fasttrun, fulleq, and plantuner extensions are installed automatically.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

Array of strings

pgsql:
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_repack
pg_squeeze
pg_stat_statements
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
pgsql1c:
amcheck
auto_dump
autoinc
bloom
btree_gin
btree_gist
citext
cube
dblink
dict_int
dict_xsyn
earthdistance
file_fdw
fuzzystrmatch
hstore
insert_username
intagg
intarray
isn
ltree
moddatetime
pageinspect
pg_buffercache
pg_freespacemap
pg_prewarm
pg_stat_statements
pg_surgery
pg_trgm
pg_visibility
pg_wait_sampling
pg_walinspect
pgcrypto
pgrowlocks
pgstattuple
plpgsql
postgres_fdw
refint
seg
sslinfo
tablefunc
tcn
tsm_system_rows
tsm_system_time
unaccent
uuid-ossp
xml2

N/A

backupId#

Database backup ID.

Required

Editable

Datatype

Valid values

Defaults

No

No

String

ID of an existing database backup

N/A

backupDbName#

The name of a database from the backup specified in the backupId parameter.

Required

Editable

Datatype

Valid values

Defaults

Yes, if backupId is specified

No

String

The name of a database included in the backup

N/A