MySQL 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 MySQL supports other parameters, they can be set in the options parameter.

vendor

MySQL DBMS engine vendor.

Required	Datatype	Valid values
Yes	String	mariadb percona mysql

version

DBMS engine version. Version depends on the vendor.

Required	Datatype	Valid values
Yes	String	mariadb: 10.4, 10.5, 10.6, 10.11; percona: 5.7, 8.0; mysql: 8.0

maxConnections

The maximum permitted number of simultaneous client connections that a MySQL host can handle.

Required	Datatype	Valid values	Defaults	Auto
No	Integer	10–100000	151	MiB RAM/32, min 151

maxAllowedPacket

The maximum size of one packet, any generated/intermediate string, or any parameter sent by the function`mysql_stmt_send_long_data() <https://dev.mysql.com/doc/c-api/8.0/en/mysql-stmt-send-long-data.html>`_.

Required	Datatype	Valid values	Defaults	Auto
Yes	Integer	1–1024 MiB	16 MiB (MariaDB); 64 MiB (Percona)	N/A

maxConnectErrors

Maximum number of connection errors, when the server blocks further connections to the host.

Required	Datatype	Valid values	Defaults	Auto
No	Integer	1– 18446744073709551615	100	N/A

innodbBufferPoolSize

InnoDB buffer size (in bytes) used to cache table data and indexes. A larger buffer allows you to reduce the number of I/O operations when repeatedly requesting the same data.

Required	Datatype	Valid values	Defaults	Auto
No	Integer	min: 128 MiB max: 50% RAM, if ≤ 4 GiB 75% RAM, if ≥ 4 GiB	128 MiB	50% RAM, if ≤ 4 GiB; 75% RAM, if ≥ 4 GiB

innodbBufferPoolInstances

The number of regions that innodbBufferPoolSize is divided into when innodbBufferPoolSize > 1 GiB. Dividing the buffer pool allows you to use it more efficiently. This parameter is relevant for Percona 5.7, 8.0 and MariaDB 10.2, 10.3, 10.4.

Required	Datatype	Valid values	Defaults	Auto
No	Integer	1–64	8 or 1, if innodbBufferPoolSize < 1 GiB	The number of full GiB in innodbBufferPoolSize , if the parameter value is greater than 1 GiB

innodbLogFileSize

The size of a single file in bytes in the redo system log. The larger the value, the less checkpoint flush activity is required in the buffer pool, saving disk I/O.

Required	Datatype	Valid values	Defaults	Auto
No	Integer	4 MiB–4 GiB	96 MiB (for MariaDB v.10.5 and higher) 48 MiB (for MariaDB v.10.4 and lower) 48 MiB (for Percona 8)	(innodbBufferPoolSize × 25%)/2, but no more than 4 GiB

innodbLogFilesInGroup

The number of system log files in a log group.

Required	Datatype	Valid values	Defaults	Auto
No	Integer	2–100	2	N/A

innodbChangeBuffering

This parameter controls the cached data to optimize delays for write operations to secondary indexes so that the I/O operations can be performed sequentially.

Required	Datatype	Valid values	Defaults	Auto
No	String	inserts none deletes purges changes all	none: ≥ MariaDB 10.5.15, 10.6.7, 10.7.3, 10.8.2; all: ≤ MariaDB 10.5.14, 10.6.6, 10.7.2, 10.8.1; Percona 8	N/A

innodbIoCapacity

The number of I/O operations per second (IOPS) available to InnoDB background tasks.

Required	Datatype	Valid values	Defaults	Auto
No	Integer	100– 18446744073709551615	200	N/A

innodbIoCapacityMax

The maximum number of IOPS that InnoDB background tasks can perform.

Required	Datatype	Valid values	Defaults	Auto
No	Integer	100– 18446744073709551615	max(innodb_io_capacity × 2, 2000)	N/A

innodbPurgeThreads

The number of background threads allocated for the InnoDB purge operation. Increasing the value improve the efficiency of the systems where data operations are performed on multiple tables.

Required	Datatype	Valid values	Defaults	Auto
No	Integer	1–32	4	N/A

innodbThreadConcurrency

The maximum number of threads permitted inside of InnoDB. This parameter is relevant for Percona 5.7, 8.0 and MariaDB 10.2, 10.3, 10.4.

Required	Datatype	Valid values	Defaults	Auto
No	Integer	0–1000	0	N/A

innodbSyncArraySize

The size of the mutex/lock wait array. Increasing the value increases the level of parallelism when the number of pending threads is large. This parameter is relevant for Percona 5.7, 8.0 and MariaDB 10.2, 10.3, 10.4.

Required	Datatype	Valid values	Defaults	Auto
No	Integer	1–1024	1	N/A

innodbFlushLogAtTrxCommit

Controls the MySQL behaviour for transaction commit operations.

• 0 — Logs are written and flushed to disk once per second. Transactions for which logs have not been flushed can be lost in a crash.

• 1 (default) — This value provides for the highest availability level. InnoDB redo logs are written and flushed to disk at each transaction commit.

• 2 — InnoDB redo logs are written after each transaction commit and flushed to disk once per second. An OS or power outage can cause the loss of transactions in the last second.

Required	Datatype	Valid values	Defaults	Auto
No	Integer	0 1 2	1	N/A

threadCacheSize

The number of threads that the server caches to establish new network connections.

Required	Datatype	Valid values	Defaults	Auto
No	Integer	0–16384	-1 (autosizing)	N/A

tmpTableSize

The maximum size of internal in-memory temporary tables (bytes). This parameter does not apply to user-created MEMORY tables.

Required	Datatype	Valid values	Defaults	Auto
No	Integer	1 KiB–4 GiB	16 MiB	N/A

maxHeapTableSize

The maximum size in bytes to which user-created MEMORY tables are permitted to grow. The value of the variable is used to calculate MAX_ROWS values of the MEMORY table.

Required	Datatype	Valid values	Defaults	Auto
No	Integer	16 KiB–4 GiB	16 MiB	N/A

tableOpenCache

The number of open tables for all threads. Increasing this value increases the number of file descriptors that mysqld requires.

Required	Datatype	Valid values	Defaults	Auto
No	Integer	1–1048576	MariaDB: 2000 Percona 5.7: 2000 Percona 8: 4000	N/A

transactionIsolation

The transaction isolation level. See the MySQL documentation.

Required	Datatype	Valid values	Defaults	Auto
No	String	REPEATABLE-READ READ-UNCOMMITTED READ-COMMITTED SERIALIZABLE	REPEATABLE-READ	N/A

waitTimeout

The number of seconds the server waits for activity on a noninteractive connection before closing it.

Required	Datatype	Valid values	Defaults	Auto
No	Numeric	1–31536000	28800	N/A

connectTimeout

The number of seconds that the mysqld server waits for a connect packet before responding with Bad handshake.

Required	Datatype	Valid values	Defaults	Auto
No	Numeric	2–31536000	10	N/A

pxcStrictMode

PXC mode. The supported modes are detailed in the Percona documentation. It is applicable only in a high-availability configuration and only to percona.

Required	Datatype	Valid values	Defaults	Auto
Yes, if the High-availability service mode and percona vendor are selected.	String	DISABLED PERMISSIVE ENFORCING MASTER	ENFORCING	DISABLED

innodbStrictMode

MySQL operation modes. The supported modes are detailed in the MySQL documentation.

Required	Datatype	Valid values	Defaults	Auto
Yes	String	ON OFF	ON	OFF

gcacheSize

Gcache circular buffer storage size (the space the node uses for caching writesets), preallocated on startup.

Galera parameter. It is applicable only to a high-availability service.

Required	Datatype	Valid values	Defaults	Auto
No	Integer	128 MiB–0.3 * RAM	N/A	N/A

gcsFcLimit

If the recv queue length exceeds the number of writesets, replication is suspended. There can be much more writesets in master-slave configurations. Replication will resume according to the gcsFcFactor setting.

Galera parameter. It is applicable only to a high-availability service.

Required	Datatype	Valid values	Defaults	Auto
No	Integer	1–2147483647	N/A	N/A

gcsFcFactor

The fraction of gcsFcLimit at which replication is resumed when the recv queue length falls below this value.

Galera parameter. It is applicable only to a high-availability service.

Required	Datatype	Valid values	Defaults	Auto
No	Float	0.0–1.0	N/A	N/A

gcsFcMasterSlave

This variable indicates whether the cluster has only one source node. This determines whether the gcsFcLimit parameter is dynamically recalculated (if false) or not (if true).

Deprecated parameter. It is applicable only to Percona 5.7, MySQL 5.7, and MariaDB 10.2 and 10.3.

Galera parameter. It is applicable only to a high-availability service.

Required	Datatype	Valid values	Defaults	Auto
No	Boolean	true false	N/A	N/A

gcsFcSinglePrimary

Indicates that there is more than one replication source. As the number of nodes in the cluster grows, the value of gcsFcLimit dynamically increases. At the same time, the number of writes from nodes also increases. When this parameter is false (multi-primary), the gcsFcLimit parameter is dynamically modified. This gives each node extra margin to be a bit further behind applying writes. The gcsFcLimit parameter changes as the square root of the cluster size, i.e., in a four-node cluster, it is twice the base value. This is done to compensate noise as the replication rate increases.

This parameter replaces the deprecated gcsFcMasterSlave parameter and is applicable to Percona 8.0, MySQL 8.0, and MariaDB 10.4, 10.5, 10.6 and 10.7.

Galera parameter. It is applicable only to a high-availability service.

Required	Datatype	Valid values	Defaults	Auto
No	Boolean	true false	N/A	N/A

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 MySQL.

Note

If the parameter name includes a dot, then it cannot be passed in the container for additional parameters. If you need to use such parameter, contact technical support.

Required	Datatype	Valid values
No	Dict	N/A

galeraOptions

Container for other Galera parameters.

Note

If the parameter name includes a dot, then it cannot be passed in the container for additional parameters. If you need to use such parameter, contact technical support.

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.

host

Required	Editable	Datatype	Valid values	Defaults
No	No	String	Hostname up to 60 characters or IP address	%

password

Required	Editable	Datatype	Valid values	Defaults
Yes	Yes	String	It should not contain such characters as ', ", ` and \	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.

charset

Required	Editable	Datatype	Valid values	Defaults
No	No	String	Supported values: for MariaDB for MySQL and Percona	utf8

collate

Required	Editable	Datatype	Valid values	Defaults
No	No	String	Supported values: for MariaDB for MySQL and Percona	utf8_unicode_ci

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

User parameters to set when creating a database

These parameters are specified in the parameters attribute of the User object, which is nested in the users 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.

privileges

Required	Editable	Datatype	Valid values	Defaults
No	Yes	Array of strings	ALL ALTER ALTER ROUTINE CREATE CREATE ROUTINE CREATE TEMPORARY TABLES CREATE VIEW DELETE DROP EVENT EXECUTE INDEX INSERT LOCK TABLES SELECT SHOW VIEW TRIGGER UPDATE	ALL

options

Required	Editable	Datatype	Valid values	Defaults
No	Yes	Array of strings	GRANT NONE	N/A