Managed Service for MySQL API, REST: Cluster.List

Field

Description

folderId

string

Required field. ID of the folder to list clusters in.
To get this ID, make a yandex.cloud.resourcemanager.v1.FolderService.List request.

The maximum string length in characters is 50.

pageSize

string (int64)

The maximum number of results per page to return.
If the number of available results is larger than pageSize, the API returns a ListClustersResponse.nextPageToken that can be used to get the next page of results in the subsequent ClusterService.List requests.

Acceptable values are 0 to 1000, inclusive.

pageToken

string

Page token that can be used to iterate through multiple pages of results.
To get the next page of results, set pageToken to the ListClustersResponse.nextPageToken returned by the previous ClusterService.List request.

The maximum string length in characters is 100.

filter

string

A filter expression that selects clusters listed in the response.
The expression must specify:

1. The field name. Currently you can only use filtering with the Cluster.name field.
2. An = operator.
3. The value in double quotes ("). Must be 1-63 characters long and match the regular expression [a-zA-Z0-9_-]+.

The maximum string length in characters is 1000.

Field

Description

clusters[]

Cluster

List of clusters.

nextPageToken

string

The token that can be used to get the next page of results.
If the number of results is larger than ListClustersRequest.pageSize, use the nextPageToken as the value for the ListClustersRequest.pageToken in the subsequent ClusterService.List request to iterate through multiple pages of results.
Each of the subsequent ClusterService.List requests should use the nextPageToken value returned by the previous request to continue paging through the results.

Field

Description

id

string

ID of the cluster.
This ID is assigned by the platform at the time of creation.

folderId

string

ID of the folder that the cluster belongs to.

createdAt

string (date-time)

Creation timestamp of the cluster.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

name

string

Name of the cluster.

description

string

Description of the cluster.

labels

object (map<string, string>)

Custom labels for the cluster as key:value pairs.

environment

enum (Environment)

Deployment environment of the MySQL cluster.

• PRODUCTION: Environment for stable versions of your apps.
  A conservative update policy is in effect: only bug fixes are applied during regular maintenance.
• PRESTABLE: Environment for testing, including the Managed Service for MySQL itself.
  This environment gets new features, improvements, and bug fixes in the first place, compared to the production environment.
  However, not every update ensures backward compatibility.

monitoring[]

Monitoring

Monitoring systems data that is relevant to the cluster.

config

ClusterConfig

Configuration of the cluster.

networkId

string

ID of the network that the cluster belongs to.

health

enum (Health)

Aggregated health of the cluster.

• HEALTH_UNKNOWN: Health of the cluster is unknown (Host.health for every host in the cluster is UNKNOWN).
• ALIVE: Cluster is alive and well (Host.health for every host in the cluster is ALIVE).
• DEAD: Cluster is inoperable (Host.health for every host in the cluster is DEAD).
• DEGRADED: Cluster is degraded (Host.health for at least one host in the cluster is not ALIVE).

status

enum (Status)

Current state of the cluster.

• STATUS_UNKNOWN: Cluster state is unknown.
• CREATING: Cluster is being created.
• RUNNING: Cluster is running normally.
• ERROR: Cluster encountered a problem and cannot operate.
• UPDATING: Cluster is being updated.
• STOPPING: Cluster is stopping.
• STOPPED: Cluster is stopped.
• STARTING: Cluster is starting.

maintenanceWindow

MaintenanceWindow

Maintenance window settings for the cluster.

plannedOperation

MaintenanceOperation

Planned maintenance operation to be started for the cluster within the nearest maintenanceWindow.

securityGroupIds[]

string

Effective list of security group IDs applied to the cluster.

deletionProtection

boolean

This option prevents unintended deletion of the cluster.

hostGroupIds[]

string

Host groups hosting VMs of the cluster.

diskEncryptionKeyId

string

ID of the key to encrypt cluster disks.

Field

Description

name

string

Name of the monitoring system.

description

string

Description of the monitoring system.

link

string

Link to the monitoring system charts for the cluster.

Field

Description

version

string

Version of MySQL used in the cluster.

mysqlConfig_5_7

MysqlConfigSet5_7

Configuration of a MySQL 5.7 server.

Includes only one of the fields mysqlConfig_5_7, mysqlConfig_8_0, mysqlConfig_8_4.

Cluster-wide MySQL configuration.

mysqlConfig_8_0

MysqlConfigSet8_0

Configuration of a MySQL 8.0 server.

Includes only one of the fields mysqlConfig_5_7, mysqlConfig_8_0, mysqlConfig_8_4.

Cluster-wide MySQL configuration.

mysqlConfig_8_4

MysqlConfigSet8_4

Configuration of a MySQL 8.4 server.

Includes only one of the fields mysqlConfig_5_7, mysqlConfig_8_0, mysqlConfig_8_4.

Cluster-wide MySQL configuration.

resources

Resources

Resource preset for the cluster hosts.

backupWindowStart

TimeOfDay

Time to start the daily backup, in the UTC timezone.

access

Access

Access policy for external services.

performanceDiagnostics

PerformanceDiagnostics

Configuration of the performance diagnostics service.

backupRetainPeriodDays

string (int64)

Retention policy of automated backups.

Acceptable values are 7 to 60, inclusive.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling

fullVersion

string

Full version

Field

Description

effectiveConfig

MysqlConfig5_7

Effective settings for a MySQL 5.7 cluster (a combination of settings defined
in userConfig and defaultConfig).

userConfig

MysqlConfig5_7

User-defined settings for a MySQL 5.7 cluster.

defaultConfig

MysqlConfig5_7

Default configuration for a MySQL 5.7 cluster.

Field

Description

innodbBufferPoolSize

string (int64)

Size of the InnoDB buffer pool used for caching table and index data.
See MySQL documentation for details.

The minimum value is 134217728.

maxConnections

string (int64)

The maximum permitted number of simultaneous client connections.
See MySQL documentation for details.

Acceptable values are 10 to 100000, inclusive.

longQueryTime

number (double)

Time that it takes to process a query before it is considered slow.
See MySQL documentation for details.

Acceptable values are 0 to 3600, inclusive.

generalLog

boolean

Enable writing of general query log of MySQL.
See MySQL documentation for details.

auditLog

boolean

Enable writing of audit log of MySQL.
See MySQL documentation for details.

sqlMode[]

enum (SQLMode)

Server SQL mode of MySQL.
See MySQL documentation for details.

• ALLOW_INVALID_DATES: Allow dates where the day or month part is 0. See MySQL documentation.
• ANSI_QUOTES: Treat " as an identifier quote character (like the ` quote character) rather than as a string quote character. See MySQL documentation.
• ERROR_FOR_DIVISION_BY_ZERO: Produce an error for divisions by zero. See MySQL documentation.
• HIGH_NOT_PRECEDENCE: Give NOT higher precedence in negation than it has in non-high-precedence mode. See MySQL documentation.
• IGNORE_SPACE: Allow spaces between a function name and the ( character. See MySQL documentation.
• NO_AUTO_VALUE_ON_ZERO: Do not reset the AUTO_INCREMENT column to 0 when inserting 0 into it. See MySQL documentation.
• NO_BACKSLASH_ESCAPES: Disable the use of the backslash character (\) as an escape character within strings. See MySQL documentation.
• NO_ENGINE_SUBSTITUTION: Do not substitute the default storage engine when a statement specifies a storage engine that is disabled or not compiled in. See MySQL documentation.
• NO_UNSIGNED_SUBTRACTION: Disable unsigned subtraction so that subtraction results are always signed. See MySQL documentation.
• NO_ZERO_DATE: Disable the MySQL-specific date 0000-00-00. See MySQL documentation.
• NO_ZERO_IN_DATE: Disable month or day parts of 0 in dates. See MySQL documentation.
• NO_FIELD_OPTIONS: Ignore field options in CREATE TABLE statements (MySQL 5.7 compatibility). See MySQL documentation.
• NO_KEY_OPTIONS: Ignore key options in CREATE TABLE statements (MySQL 5.7 compatibility). See MySQL documentation.
• NO_TABLE_OPTIONS: Ignore table options in CREATE TABLE statements (MySQL 5.7 compatibility). See MySQL documentation.
• ONLY_FULL_GROUP_BY: Reject queries for which the select list, HAVING condition, or ORDER BY list refer to non-aggregated columns that are not named in the GROUP BY clause. See MySQL documentation.
• PAD_CHAR_TO_FULL_LENGTH: Pad CHAR column values with spaces to the full column length when retrieving them. See MySQL documentation.
• PIPES_AS_CONCAT: Treat \|\| as a string concatenation operator rather than as OR. See MySQL documentation.
• REAL_AS_FLOAT: Treat REAL as a synonym for FLOAT rather than DOUBLE. See MySQL documentation.
• STRICT_ALL_TABLES: Strict mode for all storage engines. Invalid data values cause errors, not warnings. See MySQL documentation.
• STRICT_TRANS_TABLES: Strict mode for transactional storage engines. Invalid data values cause errors, not warnings. See MySQL documentation.
• ANSI: Equivalent to REAL_AS_FLOAT, PIPES_AS_CONCAT, ANSI_QUOTES, IGNORE_SPACE, and ONLY_FULL_GROUP_BY. See MySQL documentation.
• TRADITIONAL: Equivalent to STRICT_TRANS_TABLES, STRICT_ALL_TABLES, NO_ZERO_IN_DATE, NO_ZERO_DATE, ERROR_FOR_DIVISION_BY_ZERO, and NO_AUTO_CREATE_USER. See MySQL documentation.
• DB2: IBM DB2 compatibility mode. See MySQL documentation.
• MAXDB: SAP MaxDB compatibility mode. See MySQL documentation.
• MSSQL: Microsoft SQL Server compatibility mode. See MySQL documentation.
• MYSQL323: MySQL 3.23 compatibility mode. See MySQL documentation.
• MYSQL40: MySQL 4.0 compatibility mode. See MySQL documentation.
• ORACLE: Oracle compatibility mode. See MySQL documentation.
• POSTGRESQL: PostgreSQL compatibility mode. See MySQL documentation.
• NO_AUTO_CREATE_USER: Prevent GRANT from creating new users implicitly. See MySQL documentation.
• NO_DIR_IN_CREATE: Prevent the use of .. in directory paths in CREATE TABLE statements. See MySQL documentation.

maxAllowedPacket

string (int64)

The maximum size in bytes of one packet.
See MySQL documentation for details.

Acceptable values are 1048576 to 1073741824, inclusive.

defaultAuthenticationPlugin

enum (AuthPlugin)

Authentication plugin used in the managed MySQL cluster.
See MySQL documentation for details.

• MYSQL_NATIVE_PASSWORD: Using Native Pluggable Authentication.
• CACHING_SHA2_PASSWORD: Using Caching SHA-2 Pluggable Authentication.
• SHA256_PASSWORD: Using SHA-256 Pluggable Authentication.
• MYSQL_NO_LOGIN: Use MYSQL_NO_LOGIN Pluggable Authentication.
• MDB_IAMPROXY_AUTH: Use IAM Pluggable Authentication.

innodbFlushLogAtTrxCommit

string (int64)

Transaction log flush behaviour.
See MySQL documentation for details.

Acceptable values are 1 to 2, inclusive.

innodbLockWaitTimeout

string (int64)

Max time in seconds for a transaction to wait for a row lock.
See MySQL documentation for details.

Acceptable values are 1 to 28800, inclusive.

transactionIsolation

enum (TransactionIsolation)

Default transaction isolation level.
See MySQL documentation for details.

• READ_COMMITTED: Read committed isolation level. A consistent read within the same transaction reads the snapshot established by the first read.
• REPEATABLE_READ: Repeatable read isolation level. All consistent reads within the same transaction read the snapshot established by the first read.
• SERIALIZABLE: Serializable isolation level. All statements implicitly convert to SELECT ... FOR SHARE if autocommit is disabled.

innodbPrintAllDeadlocks

boolean

Print information about deadlocks in error log.
See MySQL documentation for details.

netReadTimeout

string (int64)

The number of seconds to wait for more data from a connection before aborting the read.
See MySQL documentation for details.

Acceptable values are 1 to 1200, inclusive.

netWriteTimeout

string (int64)

The number of seconds to wait for a block to be written to a connection before aborting the write.
See MySQL documentation for details.

Acceptable values are 1 to 1200, inclusive.

groupConcatMaxLen

string (int64)

The maximum permitted result length in bytes for the GROUP_CONCAT() function.
See MySQL documentation for details.

Acceptable values are 4 to 33554432, inclusive.

tmpTableSize

string (int64)

The maximum size of internal in-memory temporary tables.
See MySQL documentation for details.

Acceptable values are 1024 to 536870912, inclusive.

maxHeapTableSize

string (int64)

This variable sets the maximum size to which user-created MEMORY tables are permitted to grow.
See MySQL documentation for details.

Acceptable values are 16384 to 536870912, inclusive.

defaultTimeZone

string

The servers default time zone.
See MySQL documentation for details.

characterSetServer

string

The servers default character set.
See MySQL documentation for details.

collationServer

string

The server default collation.
See MySQL documentation for details.

innodbAdaptiveHashIndex

boolean

Enables InnoDB adaptive hash index.
See MySQL documentation for details.

innodbNumaInterleave

boolean

Enables the NUMA interleave memory policy for allocation of the InnoDB buffer pool.
See MySQL documentation for details.

innodbLogBufferSize

string (int64)

The size in bytes of the buffer that InnoDB uses to write to the log files on disk.
See MySQL documentation for details.

Acceptable values are 1048576 to 268435456, inclusive.

innodbLogFileSize

string (int64)

The size in bytes of the single InnoDB Redo log file.
See MySQL documentation for details.

Acceptable values are 268435456 to 8589934592, inclusive.

innodbIoCapacity

string (int64)

Limits IO available for InnoDB background tasks.
See MySQL documentation for details.

Acceptable values are 100 to 100000, inclusive.

innodbIoCapacityMax

string (int64)

Limits IO available for InnoDB background tasks.
See MySQL documentation for details.

Acceptable values are 100 to 100000, inclusive.

innodbReadIoThreads

string (int64)

The number of I/O threads for read operations in InnoDB.
See MySQL documentation for details.

Acceptable values are 1 to 16, inclusive.

innodbWriteIoThreads

string (int64)

The number of I/O threads for write operations in InnoDB.
See MySQL documentation for details.

Acceptable values are 1 to 16, inclusive.

innodbPurgeThreads

string (int64)

The number of background threads devoted to the InnoDB purge operation.
See MySQL documentation for details.

Acceptable values are 1 to 16, inclusive.

innodbThreadConcurrency

string (int64)

Defines the maximum number of threads permitted inside of InnoDB.
See MySQL documentation for details.

Acceptable values are 0 to 1000, inclusive.

innodbTempDataFileMaxSize

string (int64)

Limits the max size of InnoDB temp tablespace.
See MySQL documentation for details.

Acceptable values are 1073741824 to 107374182400, inclusive.

threadCacheSize

string (int64)

A number of threads the server should cache for reuse.
See MySQL documentation for details.

Acceptable values are 10 to 10000, inclusive.

threadStack

string (int64)

The stack size for each thread. The default is large enough for normal operation.
See MySQL documentation for details.

Acceptable values are 131072 to 16777216, inclusive.

joinBufferSize

string (int64)

The minimum size of the buffer that is used for plain index scans, range index scans, and joins that don't use indexes and thus perform full table scans.
See MySQL documentation for details.

Acceptable values are 1024 to 16777216, inclusive.

sortBufferSize

string (int64)

Each session that must perform a sort allocates a buffer of this size.
See MySQL documentation for details.

Acceptable values are 1024 to 16777216, inclusive.

tableDefinitionCache

string (int64)

The number of table definitions that can be stored in the definition cache.
See MySQL documentation for details.

Acceptable values are 400 to 524288, inclusive.

tableOpenCache

string (int64)

The number of open tables for all threads.
See MySQL documentation for details.

Acceptable values are 400 to 524288, inclusive.

tableOpenCacheInstances

string (int64)

The number of open tables cache instances.
See MySQL documentation for details.

Acceptable values are 1 to 32, inclusive.

explicitDefaultsForTimestamp

boolean

Determines whether the server enables certain nonstandard behaviors for default values and NULL-value handling in TIMESTAMP columns.
See MySQL documentation for details.

autoIncrementIncrement

string (int64)

Can be used to control the operation of AUTO_INCREMENT columns.
See MySQL documentation for details.

Acceptable values are 1 to 65535, inclusive.

autoIncrementOffset

string (int64)

Can be used to control the operation of AUTO_INCREMENT columns.
See MySQL documentation for details.

Acceptable values are 1 to 65535, inclusive.

syncBinlog

string (int64)

Controls how often the MySQL server synchronizes the binary log to disk.
See MySQL documentation for details.

Acceptable values are 0 to 4096, inclusive.

binlogCacheSize

string (int64)

The size of the cache to hold changes to the binary log during a transaction.
See MySQL documentation for details.

Acceptable values are 4096 to 67108864, inclusive.

binlogGroupCommitSyncDelay

string (int64)

Controls how many microseconds the binary log commit waits before synchronizing the binary log file to disk.
See MySQL documentation for the variable for details.

Acceptable values are 0 to 50000, inclusive.

binlogRowImage

enum (BinlogRowImage)

For MySQL row-based replication, this variable determines how row images are written to the binary log.
See MySQL documentation for details.

• FULL: Log all columns (full row image).
• MINIMAL: Log only changed columns and columns needed to identify the row.
• NOBLOB: Log all columns except BLOB and TEXT columns.

binlogRowsQueryLogEvents

boolean

When enabled, it causes the server to write informational log events such as row query log events into its binary log.
See MySQL documentation for details.

rplSemiSyncMasterWaitForSlaveCount

string (int64)

The number of replica acknowledgments the source must receive per transaction before proceeding.
See MySQL documentation for details.

The minimum value is 1.

slaveParallelType

enum (SlaveParallelType)

When using a multi-threaded replica, this variable specifies the policy used to decide which transactions are allowed to execute in parallel on the replica.
See MySQL documentation for details.

• DATABASE: Transactions are parallelized per database (schema).
• LOGICAL_CLOCK: Transactions are parallelized using the logical clock algorithm based on the binary log group commit.

slaveParallelWorkers

string (int64)

Sets the number of applier threads for executing replication transactions in parallel.
See MySQL documentation for details.

Acceptable values are 0 to 64, inclusive.

mdbPreserveBinlogBytes

string (int64)

The size of the binary log to hold.

Acceptable values are 1073741824 to 1099511627776, inclusive.

interactiveTimeout

string (int64)

The number of seconds the server waits for activity on an interactive connection before closing it.
See MySQL documentation for details.

Acceptable values are 600 to 86400, inclusive.

waitTimeout

string (int64)

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

Acceptable values are 600 to 86400, inclusive.

mdbOfflineModeEnableLag

string (int64)

Replication lag threshold (seconds) which will switch MySQL to 'offline_mode = ON' to prevent users from reading stale data.

Acceptable values are 30 to 86400, inclusive.

mdbOfflineModeDisableLag

string (int64)

Replication lag threshold (seconds) which will switch MySQL to 'offline_mode = OFF'.
Should be less than mdb_offline_mode_enable_lag value.

Acceptable values are 10 to 86400, inclusive.

rangeOptimizerMaxMemSize

string (int64)

The limit on memory consumption for the range optimizer.
See MySQL documentation for details.

Acceptable values are 60 to 268435456, inclusive.

innodbOnlineAlterLogMaxSize

string (int64)

The limit in bytes on the size of the temporary log files used during online DDL operations
For details, see MySQL documentation for the variable.

Acceptable values are 65536 to 107374182400, inclusive.

innodbFtMinTokenSize

string (int64)

Minimum length of words that are stored in an InnoDB FULLTEXT index
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 16, inclusive.

innodbFtMaxTokenSize

string (int64)

Maximum length of words that are stored in an InnoDB FULLTEXT index
For details, see MySQL documentation for the variable.

Acceptable values are 10 to 84, inclusive.

lowerCaseTableNames

string (int64)

Table names storage and comparison strategy
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 1, inclusive.

showCompatibility_56

boolean

Manages MySQL 5.6 compatibility
For details, see MySQL documentation for the variable.

slowQueryLog

boolean

Manages slow query log.
See MySQL documentation for details.

slowQueryLogAlwaysWriteTime

number (double)

Query execution time, after which query to be logged unconditionally, that is, `log_slow_rate_limit`` will not apply to it.
See Percona documentation for details.

Acceptable values are 0 to 3600, inclusive.

logSlowRateType

enum (LogSlowRateType)

Specifies slow log granularity for log_slow_rate_limit values QUERY or SESSION.
See Percona documentation for details.

• SESSION: Logging is controlled per session.
• QUERY: Logging is controlled per query.

logSlowRateLimit

string (int64)

Specifies what fraction of session/query should be logged. Logging is enabled for every nth session/query.
See Percona documentation for details.

Acceptable values are 1 to 1000, inclusive.

logSlowSpStatements

boolean

When TRUE, statements executed by stored procedures are logged to the slow log.
See Percona documentation for details.

logSlowFilter[]

enum (LogSlowFilterType)

Filters the slow log by the query's execution plan.
See Percona documentation for details.

• FULL_SCAN: Queries that perform a full table scan.
• FULL_JOIN: Queries that perform a full join (a join without indexes).
• TMP_TABLE: Queries that create an implicit internal temporary table.
• TMP_TABLE_ON_DISK: Queries that create an implicit internal temporary table on disk.
• FILESORT: Queries that use a filesort.
• FILESORT_ON_DISK: Queries that use a filesort on disk.

mdbPriorityChoiceMaxLag

string (int64)

Replication lag threshold (seconds) which allows replica to be promoted to master while executing "switchover from".
Should be less than mdb_offline_mode_disable_lag.

Acceptable values are 0 to 86400, inclusive.

innodbPageSize

string (int64)

Specifies the page size for InnoDB tablespaces.
For details, see MySQL documentation for the variable.

Acceptable values are 4096 to 65536, inclusive.

maxSpRecursionDepth

string (int64)

The number of times that any given stored procedure may be called recursively.
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 255, inclusive.

innodbCompressionLevel

string (int64)

The level of zlib compression to use for InnoDB compressed tables and indexes.
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 9, inclusive.

binlogTransactionDependencyTracking

enum (BinlogTransactionDependencyTracking)

Specifies how the source mysqld generates the dependency information that it writes in the binary log to help replicas determine which transactions can be executed in parallel.
For details, see MySQL documentation for the variable.

• COMMIT_ORDER: Transactions are made dependent based on commit order.
• WRITESET: Transactions are made dependent based on the write set of rows modified by the transaction.
• WRITESET_SESSION: Transactions are made dependent based on the write set and the commit order within a session.

autocommit

boolean

Config specific will be all changes to a table take effect immediately or you must use COMMIT to accept a transaction or ROLLBACK to cancel it.
For details, see MySQL documentation for the variable.

innodbStatusOutput

boolean

Enables or disables periodic output for the standard InnoDB Monitor.
For details, see MySQL documentation for the variable.

innodbStrictMode

boolean

When innodb_strict_mode is enabled, InnoDB returns errors rather than warnings when checking for invalid or incompatible table options.
For details, see MySQL documentation for the variable.

innodbPrintLockWaitTimeoutInfo

boolean

Makes InnoDB to write information about all lock wait timeout errors into the log file.
For details, see Percona documentation for the variable.

logErrorVerbosity

string (int64)

System variable specifies the verbosity for handling events intended for the error log
For details, see MySQL documentation for the variable.

Acceptable values are 2 to 3, inclusive.

maxDigestLength

string (int64)

The maximum number of bytes of memory reserved per session for computation of normalized statement digests.
For details, see MySQL documentation for the variable.

Acceptable values are 1024 to 1048576, inclusive.

queryCacheLimit

string (int64)

Do not cache results that are larger than this number of bytes.
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 4294967295, inclusive.

queryCacheSize

string (int64)

The amount of memory allocated for caching query results.
For details, see MySQL documentation for the variable.

queryCacheType

string (int64)

Set the query cache type.
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 2, inclusive.

lockWaitTimeout

string (int64)

This variable specifies the timeout in seconds for attempts to acquire metadata locks
For details, see MySQL documentation for the variable.

Acceptable values are 1 to 31536000, inclusive.

maxPreparedStmtCount

string (int64)

This variable limits the total number of prepared statements in the server.
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 1048576, inclusive.

optimizerSwitch

string

The system variable enables control over optimizer behavior.
For details, see MySQL documentation for the variable
https://dev.mysql.com/doc/refman/5.7/en/switchable-optimizations.html

optimizerSearchDepth

string (int64)

The maximum depth of search performed by the query optimizer
For details, see MySQL documentation for the variable

Acceptable values are 0 to 62, inclusive.

queryResponseTimeStats

boolean

Enables and disables collection of query times
For details, see Percona documentation for the variable.

userstat

boolean

Enables or disables collection of statistics
For details, see Percona documentation for the variable.

maxExecutionTime

string (int64)

The execution timeout for SELECT statements, in milliseconds. If the value is 0, timeouts are not enabled.
For details, see MySQL documentation for the variable

Acceptable values are 0 to 4294967295, inclusive.

auditLogPolicy

enum (AuditLogPolicy)

The policy controlling how the audit log plugin writes events to its log file
For details, see MySQL documentation for the variable

• ALL: Log all events.
• LOGINS: Log only login events.
• QUERIES: Log only query events.
• NONE: Do not log events.

innodbLruScanDepth

string (int64)

A parameter that influences the algorithms and heuristics for the flush operation for the InnoDB buffer pool
For details, see MySQL documentation for the variable

Acceptable values are 100 to 4294967295, inclusive.

mdbForceSsl

boolean

Force ssl on all hosts (require_secure_transport)

innodbChangeBuffering

enum (InnodbChangeBuffering)

An optimization for change buffering
For details, see MySQL documentation for the variable.

• INNODB_CHANGE_BUFFERING_NONE: Do not buffer any operations.
• INNODB_CHANGE_BUFFERING_INSERTS: Buffer insert operations.
• INNODB_CHANGE_BUFFERING_DELETES: Buffer delete-marking operations.
• INNODB_CHANGE_BUFFERING_CHANGES: Buffer insert and delete-marking operations.
• INNODB_CHANGE_BUFFERING_PURGES: Buffer operations where undo log records are discarded.
• INNODB_CHANGE_BUFFERING_ALL: Buffer all types of eligible operations.

maxWriteLockCount

string (int64)

Permit some pending read lock requests interval
P.S. Should be UInt64, but java fails to handle UInt64 limits
For details, see Percona documentation for the variable.

The minimum value is 1.

innodbAdaptiveHashIndexParts

string (int64)

Partitions the adaptive hash index search system.
For details, see MySQL documentation for the variable

Acceptable values are 1 to 512, inclusive.

Field

Description

effectiveConfig

MysqlConfig8_0

Effective settings for a MySQL 8.0 cluster (a combination of settings defined
in userConfig and defaultConfig).

userConfig

MysqlConfig8_0

User-defined settings for a MySQL 8.0 cluster.

defaultConfig

MysqlConfig8_0

Default configuration for a MySQL 8.0 cluster.

Field

Description

innodbBufferPoolSize

string (int64)

Size of the InnoDB buffer pool used for caching table and index data.
See MySQL documentation for details.

The minimum value is 134217728.

maxConnections

string (int64)

The maximum permitted number of simultaneous client connections.
See MySQL documentation for details.

Acceptable values are 10 to 100000, inclusive.

longQueryTime

number (double)

Time that it takes to process a query before it is considered slow.
See MySQL documentation for details.

Acceptable values are 0 to 3600, inclusive.

generalLog

boolean

Enable writing of general query log of MySQL.
See MySQL documentation for details.

auditLog

boolean

Enable writing of audit log of MySQL.
See MySQL documentation for details.

sqlMode[]

enum (SQLMode)

Server SQL mode of MySQL.
See MySQL documentation for details.

• ALLOW_INVALID_DATES: Allow dates where the day or month part is 0. See MySQL documentation.
• ANSI_QUOTES: Treat " as an identifier quote character (like the ` quote character) rather than as a string quote character. See MySQL documentation.
• ERROR_FOR_DIVISION_BY_ZERO: Produce an error for divisions by zero. See MySQL documentation.
• HIGH_NOT_PRECEDENCE: Give NOT higher precedence in negation than it has in non-high-precedence mode. See MySQL documentation.
• IGNORE_SPACE: Allow spaces between a function name and the ( character. See MySQL documentation.
• NO_AUTO_VALUE_ON_ZERO: Do not reset the AUTO_INCREMENT column to 0 when inserting 0 into it. See MySQL documentation.
• NO_BACKSLASH_ESCAPES: Disable the use of the backslash character (\) as an escape character within strings. See MySQL documentation.
• NO_ENGINE_SUBSTITUTION: Do not substitute the default storage engine when a statement specifies a storage engine that is disabled or not compiled in. See MySQL documentation.
• NO_UNSIGNED_SUBTRACTION: Disable unsigned subtraction so that subtraction results are always signed. See MySQL documentation.
• NO_ZERO_DATE: Disable the MySQL-specific date 0000-00-00. See MySQL documentation.
• NO_ZERO_IN_DATE: Disable month or day parts of 0 in dates. See MySQL documentation.
• ONLY_FULL_GROUP_BY: Reject queries for which the select list, HAVING condition, or ORDER BY list refer to non-aggregated columns that are not named in the GROUP BY clause. See MySQL documentation.
• PAD_CHAR_TO_FULL_LENGTH: Pad CHAR column values with spaces to the full column length when retrieving them. See MySQL documentation.
• PIPES_AS_CONCAT: Treat \|\| as a string concatenation operator rather than as OR. See MySQL documentation.
• REAL_AS_FLOAT: Treat REAL as a synonym for FLOAT rather than DOUBLE. See MySQL documentation.
• STRICT_ALL_TABLES: Strict mode for all storage engines. Invalid data values cause errors, not warnings. See MySQL documentation.
• STRICT_TRANS_TABLES: Strict mode for transactional storage engines. Invalid data values cause errors, not warnings. See MySQL documentation.
• TIME_TRUNCATE_FRACTIONAL: Causes fractional seconds to be truncated rather than rounded when inserting into a column that has a data type with a fractional seconds part. See MySQL documentation.
• ANSI: Equivalent to REAL_AS_FLOAT, PIPES_AS_CONCAT, ANSI_QUOTES, IGNORE_SPACE, and ONLY_FULL_GROUP_BY. See MySQL documentation.
• TRADITIONAL: Equivalent to STRICT_TRANS_TABLES, STRICT_ALL_TABLES, NO_ZERO_IN_DATE, NO_ZERO_DATE, ERROR_FOR_DIVISION_BY_ZERO, and NO_ENGINE_SUBSTITUTION. See MySQL documentation.
• NO_DIR_IN_CREATE: Prevent the use of .. in directory paths in CREATE TABLE statements. See MySQL documentation.

maxAllowedPacket

string (int64)

The maximum size in bytes of one packet.
See MySQL documentation for details.

Acceptable values are 1048576 to 1073741824, inclusive.

defaultAuthenticationPlugin

enum (AuthPlugin)

Authentication plugin used in the managed MySQL cluster.
See MySQL documentation for details.

• MYSQL_NATIVE_PASSWORD: Using Native Pluggable Authentication.
• CACHING_SHA2_PASSWORD: Using Caching SHA-2 Pluggable Authentication.
• SHA256_PASSWORD: Using SHA-256 Pluggable Authentication.
• MYSQL_NO_LOGIN: Use MYSQL_NO_LOGIN Pluggable Authentication.
• MDB_IAMPROXY_AUTH: Use IAM Pluggable Authentication.

innodbFlushLogAtTrxCommit

string (int64)

Transaction log flush behaviour.
See MySQL documentation for details.

Acceptable values are 1 to 2, inclusive.

innodbLockWaitTimeout

string (int64)

Max time in seconds for a transaction to wait for a row lock.
See MySQL documentation for details.

Acceptable values are 1 to 28800, inclusive.

transactionIsolation

enum (TransactionIsolation)

Default transaction isolation level.
See MySQL documentation for details.

• READ_COMMITTED: Read committed isolation level. A consistent read within the same transaction reads the snapshot established by the first read.
• REPEATABLE_READ: Repeatable read isolation level. All consistent reads within the same transaction read the snapshot established by the first read.
• SERIALIZABLE: Serializable isolation level. All statements implicitly convert to SELECT ... FOR SHARE if autocommit is disabled.

innodbPrintAllDeadlocks

boolean

Print information about deadlocks in error log.
See MySQL documentation for details.

netReadTimeout

string (int64)

The number of seconds to wait for more data from a connection before aborting the read.
See MySQL documentation for details.

Acceptable values are 1 to 1200, inclusive.

netWriteTimeout

string (int64)

The number of seconds to wait for a block to be written to a connection before aborting the write.
See MySQL documentation for details.

Acceptable values are 1 to 1200, inclusive.

groupConcatMaxLen

string (int64)

The maximum permitted result length in bytes for the GROUP_CONCAT() function.
See MySQL documentation for details.

Acceptable values are 4 to 33554432, inclusive.

tmpTableSize

string (int64)

The maximum size of internal in-memory temporary tables.
See MySQL documentation for details.

Acceptable values are 1024 to 536870912, inclusive.

maxHeapTableSize

string (int64)

This variable sets the maximum size to which user-created MEMORY tables are permitted to grow.
See MySQL documentation for details.

Acceptable values are 16384 to 536870912, inclusive.

defaultTimeZone

string

The servers default time zone.
See MySQL documentation for details.

characterSetServer

string

The servers default character set.
See MySQL documentation for details.

collationServer

string

The server default collation.
See MySQL documentation for details.

innodbAdaptiveHashIndex

boolean

Enables InnoDB adaptive hash index.
See MySQL documentation for details.

innodbNumaInterleave

boolean

Enables the NUMA interleave memory policy for allocation of the InnoDB buffer pool.
See MySQL documentation for details.

innodbLogBufferSize

string (int64)

The size in bytes of the buffer that InnoDB uses to write to the log files on disk.
See MySQL documentation for details.

Acceptable values are 1048576 to 268435456, inclusive.

innodbLogFileSize

string (int64)

The size in bytes of the single InnoDB Redo log file.
See MySQL documentation for details.

Acceptable values are 268435456 to 8589934592, inclusive.

innodbIoCapacity

string (int64)

Limits IO available for InnoDB background tasks.
See MySQL documentation for details.

Acceptable values are 100 to 100000, inclusive.

innodbIoCapacityMax

string (int64)

Limits IO available for InnoDB background tasks.
See MySQL documentation for details.

Acceptable values are 100 to 100000, inclusive.

innodbReadIoThreads

string (int64)

The number of I/O threads for read operations in InnoDB.
See MySQL documentation for details.

Acceptable values are 1 to 16, inclusive.

innodbWriteIoThreads

string (int64)

The number of I/O threads for write operations in InnoDB.
See MySQL documentation for details.

Acceptable values are 1 to 16, inclusive.

innodbPurgeThreads

string (int64)

The number of background threads devoted to the InnoDB purge operation.
See MySQL documentation for details.

Acceptable values are 1 to 16, inclusive.

innodbThreadConcurrency

string (int64)

Defines the maximum number of threads permitted inside of InnoDB.
See MySQL documentation for details.

Acceptable values are 0 to 1000, inclusive.

innodbTempDataFileMaxSize

string (int64)

Limits the max size of InnoDB temp tablespace.
See MySQL documentation for details.

Acceptable values are 1073741824 to 107374182400, inclusive.

threadCacheSize

string (int64)

How many threads the server should cache for reuse.
See MySQL documentation for details.

Acceptable values are 10 to 10000, inclusive.

threadStack

string (int64)

The stack size for each thread. The default is large enough for normal operation.
See MySQL documentation for details.

Acceptable values are 131072 to 16777216, inclusive.

joinBufferSize

string (int64)

The minimum size of the buffer that is used for plain index scans, range index scans, and joins that don't use indexes and thus perform full table scans.
See MySQL documentation for details.

Acceptable values are 1024 to 16777216, inclusive.

sortBufferSize

string (int64)

Each session that must perform a sort allocates a buffer of this size.
See MySQL documentation for details.

Acceptable values are 1024 to 16777216, inclusive.

tableDefinitionCache

string (int64)

The number of table definitions that can be stored in the definition cache.
See MySQL documentation for details.

Acceptable values are 400 to 524288, inclusive.

tableOpenCache

string (int64)

The number of open tables for all threads.
See MySQL documentation for details.

Acceptable values are 400 to 524288, inclusive.

tableOpenCacheInstances

string (int64)

The number of open tables cache instances.
See MySQL documentation for details.

Acceptable values are 1 to 32, inclusive.

explicitDefaultsForTimestamp

boolean

Determines whether the server enables certain nonstandard behaviors for default values and NULL-value handling in TIMESTAMP columns.
See MySQL documentation for details.

autoIncrementIncrement

string (int64)

Can be used to control the operation of AUTO_INCREMENT columns.
See MySQL documentation for details.

Acceptable values are 1 to 65535, inclusive.

autoIncrementOffset

string (int64)

Can be used to control the operation of AUTO_INCREMENT columns.
See MySQL documentation for details.

Acceptable values are 1 to 65535, inclusive.

syncBinlog

string (int64)

Controls how often the MySQL server synchronizes the binary log to disk.
See MySQL documentation for details.

Acceptable values are 0 to 4096, inclusive.

binlogCacheSize

string (int64)

The size of the cache to hold changes to the binary log during a transaction.
See MySQL documentation for details.

Acceptable values are 4096 to 67108864, inclusive.

binlogGroupCommitSyncDelay

string (int64)

Controls how many microseconds the binary log commit waits before synchronizing the binary log file to disk.
See MySQL documentation for details.

Acceptable values are 0 to 50000, inclusive.

binlogRowImage

enum (BinlogRowImage)

For MySQL row-based replication, this variable determines how row images are written to the binary log.
See MySQL documentation for details.

• FULL: Log all columns (full row image).
• MINIMAL: Log only changed columns and columns needed to identify the row.
• NOBLOB: Log all columns except BLOB and TEXT columns.

binlogRowsQueryLogEvents

boolean

When enabled, it causes the server to write informational log events such as row query log events into its binary log.
See MySQL documentation for details.

rplSemiSyncMasterWaitForSlaveCount

string (int64)

The number of replica acknowledgments the source must receive per transaction before proceeding.
See MySQL documentation for details.

The minimum value is 1.

slaveParallelType

enum (SlaveParallelType)

When using a multi-threaded replica, this variable specifies the policy used to decide which transactions are allowed to execute in parallel on the replica.
See MySQL documentation for details.

• DATABASE: Transactions are parallelized per database (schema).
• LOGICAL_CLOCK: Transactions are parallelized using the logical clock algorithm based on the binary log group commit.

slaveParallelWorkers

string (int64)

Sets the number of applier threads for executing replication transactions in parallel.
See MySQL documentation for details.

Acceptable values are 0 to 64, inclusive.

regexpTimeLimit

string (int64)

The time limit for regular expression matching operations performed by REGEXP_LIKE and similar functions.
See MySQL documentation for details.

Acceptable values are 0 to 1048576, inclusive.

mdbPreserveBinlogBytes

string (int64)

The size of the binary log to hold.

Acceptable values are 1073741824 to 1099511627776, inclusive.

interactiveTimeout

string (int64)

The number of seconds the server waits for activity on an interactive connection before closing it.
See MySQL documentation for details.

Acceptable values are 600 to 86400, inclusive.

waitTimeout

string (int64)

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

Acceptable values are 600 to 86400, inclusive.

mdbOfflineModeEnableLag

string (int64)

Replication lag threshold (seconds) which will switch MySQL to 'offline_mode = ON' to prevent users from reading stale data.

Acceptable values are 30 to 86400, inclusive.

mdbOfflineModeDisableLag

string (int64)

Replication lag threshold (seconds) which will switch MySQL to 'offline_mode = OFF'.
Should be less than mdb_offline_mode_enable_lag.

Acceptable values are 10 to 86400, inclusive.

rangeOptimizerMaxMemSize

string (int64)

The limit on memory consumption for the range optimizer.
See MySQL documentation for details.

Acceptable values are 60 to 268435456, inclusive.

innodbOnlineAlterLogMaxSize

string (int64)

The limit in bytes on the size of the temporary log files used during online DDL operations
See MySQL documentation for the variable for details.

Acceptable values are 65536 to 107374182400, inclusive.

innodbFtMinTokenSize

string (int64)

Minimum length of words that are stored in an InnoDB FULLTEXT index
See MySQL documentation for the variable for details.

Acceptable values are 0 to 16, inclusive.

innodbFtMaxTokenSize

string (int64)

Maximum length of words that are stored in an InnoDB FULLTEXT index
See MySQL documentation for the variable for details.

Acceptable values are 10 to 84, inclusive.

lowerCaseTableNames

string (int64)

Table names storage and comparison strategy
See MySQL documentation for the variable for details.

Acceptable values are 0 to 1, inclusive.

slowQueryLog

boolean

Manages slow query log.
See MySQL documentation for details.

slowQueryLogAlwaysWriteTime

number (double)

Query execution time, after which query to be logged unconditionally, that is, log_slow_rate_limit will not apply to it.
See Percona documentation for details.

Acceptable values are 0 to 3600, inclusive.

logSlowRateType

enum (LogSlowRateType)

Specifies slow log granularity for log_slow_rate_limit QUERY or SESSION value.
See Percona documentation for details.

• SESSION: Logging is controlled per session.
• QUERY: Logging is controlled per query.

logSlowRateLimit

string (int64)

Specifies what fraction of session/query should be logged. Logging is enabled for every nth session/query.
See Percona documentation for details.

Acceptable values are 1 to 1000, inclusive.

logSlowSpStatements

boolean

When TRUE, statements executed by stored procedures are logged to the slow log.
See Percona documentation for details.

logSlowFilter[]

enum (LogSlowFilterType)

Filters the slow log by the query's execution plan.
See Percona documentation for details.

• FULL_SCAN: Queries that perform a full table scan.
• FULL_JOIN: Queries that perform a full join (a join without indexes).
• TMP_TABLE: Queries that create an implicit internal temporary table.
• TMP_TABLE_ON_DISK: Queries that create an implicit internal temporary table on disk.
• FILESORT: Queries that use a filesort.
• FILESORT_ON_DISK: Queries that use a filesort on disk.

mdbPriorityChoiceMaxLag

string (int64)

Replication lag threshold (seconds) which allows replica to be promoted to master while executing "switchover from".
Should be less than mdb_offline_mode_disable_lag.

Acceptable values are 0 to 86400, inclusive.

innodbPageSize

string (int64)

Specifies the page size for InnoDB tablespaces.
For details, see MySQL documentation for the variable.

Acceptable values are 4096 to 65536, inclusive.

maxSpRecursionDepth

string (int64)

The number of times that any given stored procedure may be called recursively.
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 255, inclusive.

innodbCompressionLevel

string (int64)

The level of zlib compression to use for InnoDB compressed tables and indexes.
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 9, inclusive.

binlogTransactionDependencyTracking

enum (BinlogTransactionDependencyTracking)

Specifies how the source mysqld generates the dependency information that it writes in the binary log to help replicas determine which transactions can be executed in parallel.
For details, see MySQL documentation for the variable.

• COMMIT_ORDER: Transactions are made dependent based on commit order.
• WRITESET: Transactions are made dependent based on the write set of rows modified by the transaction.
• WRITESET_SESSION: Transactions are made dependent based on the write set and the commit order within a session.

autocommit

boolean

Config specific will be all changes to a table take effect immediately or you must use COMMIT to accept a transaction or ROLLBACK to cancel it.
For details, see MySQL documentation for the variable.

innodbStatusOutput

boolean

Enables or disables periodic output for the standard InnoDB Monitor.
For details, see MySQL documentation for the variable.

innodbStrictMode

boolean

When innodb_strict_mode is enabled, InnoDB returns errors rather than warnings when checking for invalid or incompatible table options.
For details, see MySQL documentation for the variable.

innodbPrintLockWaitTimeoutInfo

boolean

Makes InnoDB to write information about all lock wait timeout errors into the log file.
For details, see Percona documentation for the variable.

logErrorVerbosity

string (int64)

System variable specifies the verbosity for handling events intended for the error log
For details, see MySQL documentation for the variable.

Acceptable values are 2 to 3, inclusive.

maxDigestLength

string (int64)

The maximum number of bytes of memory reserved per session for computation of normalized statement digests.
For details, see MySQL documentation for the variable.

Acceptable values are 1024 to 1048576, inclusive.

lockWaitTimeout

string (int64)

This variable specifies the timeout in seconds for attempts to acquire metadata locks
For details, see MySQL documentation for the variable.

Acceptable values are 1 to 31536000, inclusive.

maxPreparedStmtCount

string (int64)

This variable limits the total number of prepared statements in the server.
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 4194304, inclusive.

optimizerSwitch

string

The system variable enables control over optimizer behavior.
For details, see MySQL documentation for the variable
https://dev.mysql.com/doc/refman/8.0/en/switchable-optimizations.html

optimizerSearchDepth

string (int64)

The maximum depth of search performed by the query optimizer
For details, see MySQL documentation for the variable

Acceptable values are 0 to 62, inclusive.

userstat

boolean

Enables or disables collection of statistics
For details, see Percona documentation for the variable.

maxExecutionTime

string (int64)

The execution timeout for SELECT statements, in milliseconds. If the value is 0, timeouts are not enabled.
For details, see MySQL documentation for the variable

Acceptable values are 0 to 4294967295, inclusive.

auditLogPolicy

enum (AuditLogPolicy)

The policy controlling how the audit log plugin writes events to its log file
For details, see MySQL documentation for the variable

• ALL: Log all events.
• LOGINS: Log only login events.
• QUERIES: Log only query events.
• NONE: Do not log events.

replicationSenderObserveCommitOnly

boolean

Limit callbacks to improve performance for semisynchronous replication
For details, see MySQL documentation for the variable.

replicationOptimizeForStaticPluginConfig

boolean

Use shared locks, and avoid unnecessary lock acquisitions, to improve performance for semisynchronous replication
For details, see MySQL documentation for the variable.

innodbLruScanDepth

string (int64)

A parameter that influences the algorithms and heuristics for the flush operation for the InnoDB buffer pool
For details, see MySQL documentation for the variable

Acceptable values are 100 to 4294967295, inclusive.

sqlRequirePrimaryKey

boolean

Whether statements that create new tables or alter the structure of existing tables enforce the requirement that tables have a primary key
For details, see MySQL documentation for the variable.

mdbForceSsl

boolean

Force ssl on all hosts (require_secure_transport)

innodbChangeBuffering

enum (InnodbChangeBuffering)

An optimization for change buffering
For details, see MySQL documentation for the variable.

• INNODB_CHANGE_BUFFERING_NONE: Do not buffer any operations.
• INNODB_CHANGE_BUFFERING_INSERTS: Buffer insert operations.
• INNODB_CHANGE_BUFFERING_DELETES: Buffer delete-marking operations.
• INNODB_CHANGE_BUFFERING_CHANGES: Buffer insert and delete-marking operations.
• INNODB_CHANGE_BUFFERING_PURGES: Buffer operations where undo log records are discarded.
• INNODB_CHANGE_BUFFERING_ALL: Buffer all types of eligible operations.

maxWriteLockCount

string (int64)

Permit some pending read lock requests interval
P.S. Should be UInt64, but java fails to handle UInt64 limits
For details, see Percona documentation for the variable.

The minimum value is 1.

innodbAdaptiveHashIndexParts

string (int64)

Partitions the adaptive hash index search system.
For details, see MySQL documentation for the variable

Acceptable values are 1 to 512, inclusive.

Field

Description

effectiveConfig

MysqlConfig8_4

Effective settings for a MySQL 8.4 cluster (a combination of settings defined
in userConfig and defaultConfig).

userConfig

MysqlConfig8_4

User-defined settings for a MySQL 8.4 cluster.

defaultConfig

MysqlConfig8_4

Default configuration for a MySQL 8.4 cluster.

Field

Description

innodbBufferPoolSize

string (int64)

Size of the InnoDB buffer pool used for caching table and index data.
For details, see MySQL documentation for the parameter.

The minimum value is 134217728.

maxConnections

string (int64)

The maximum permitted number of simultaneous client connections.
For details, see MySQL documentation for the variable.

Acceptable values are 10 to 100000, inclusive.

longQueryTime

number (double)

Time that it takes to process a query before it is considered slow.
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 3600, inclusive.

auditLog

boolean

Enable writing of audit log of MySQL.
For details, see MySQL documentation for the variable.

sqlMode[]

enum (SQLMode)

Server SQL mode of MySQL.
For details, see MySQL documentation for the variable.

• ALLOW_INVALID_DATES: Allow dates where the day or month part is 0. See MySQL documentation.
• ANSI_QUOTES: Treat " as an identifier quote character (like the ` quote character) rather than as a string quote character. See MySQL documentation.
• ERROR_FOR_DIVISION_BY_ZERO: Produce an error for divisions by zero. See MySQL documentation.
• HIGH_NOT_PRECEDENCE: Give NOT higher precedence in negation than it has in non-high-precedence mode. See MySQL documentation.
• IGNORE_SPACE: Allow spaces between a function name and the ( character. See MySQL documentation.
• NO_AUTO_VALUE_ON_ZERO: Do not reset the AUTO_INCREMENT column to 0 when inserting 0 into it. See MySQL documentation.
• NO_BACKSLASH_ESCAPES: Disable the use of the backslash character (\) as an escape character within strings. See MySQL documentation.
• NO_ENGINE_SUBSTITUTION: Do not substitute the default storage engine when a statement specifies a storage engine that is disabled or not compiled in. See MySQL documentation.
• NO_UNSIGNED_SUBTRACTION: Disable unsigned subtraction so that subtraction results are always signed. See MySQL documentation.
• NO_ZERO_DATE: Disable the MySQL-specific date 0000-00-00. See MySQL documentation.
• NO_ZERO_IN_DATE: Disable month or day parts of 0 in dates. See MySQL documentation.
• ONLY_FULL_GROUP_BY: Reject queries for which the select list, HAVING condition, or ORDER BY list refer to non-aggregated columns that are not named in the GROUP BY clause. See MySQL documentation.
• PAD_CHAR_TO_FULL_LENGTH: Pad CHAR column values with spaces to the full column length when retrieving them. See MySQL documentation.
• PIPES_AS_CONCAT: Treat \|\| as a string concatenation operator rather than as OR. See MySQL documentation.
• REAL_AS_FLOAT: Treat REAL as a synonym for FLOAT rather than DOUBLE. See MySQL documentation.
• STRICT_ALL_TABLES: Strict mode for all storage engines. Invalid data values cause errors, not warnings. See MySQL documentation.
• STRICT_TRANS_TABLES: Strict mode for transactional storage engines. Invalid data values cause errors, not warnings. See MySQL documentation.
• TIME_TRUNCATE_FRACTIONAL: Causes fractional seconds to be truncated rather than rounded when inserting into a column that has a data type with a fractional seconds part. See MySQL documentation.
• ANSI: Equivalent to REAL_AS_FLOAT, PIPES_AS_CONCAT, ANSI_QUOTES, IGNORE_SPACE, and ONLY_FULL_GROUP_BY. See MySQL documentation.
• TRADITIONAL: Equivalent to STRICT_TRANS_TABLES, STRICT_ALL_TABLES, NO_ZERO_IN_DATE, NO_ZERO_DATE, ERROR_FOR_DIVISION_BY_ZERO, and NO_ENGINE_SUBSTITUTION. See MySQL documentation.
• NO_DIR_IN_CREATE: Prevent the use of .. in directory paths in CREATE TABLE statements. See MySQL documentation.

maxAllowedPacket

string (int64)

The maximum size in bytes of one packet.
For details, see MySQL documentation for the variable.

Acceptable values are 1048576 to 1073741824, inclusive.

innodbFlushLogAtTrxCommit

string (int64)

Transaction log flush behaviour.
For details, see MySQL documentation for the variable

Acceptable values are 1 to 2, inclusive.

innodbLockWaitTimeout

string (int64)

Max time in seconds for a transaction to wait for a row lock
For details, see MySQL documentation for the variable

Acceptable values are 1 to 28800, inclusive.

transactionIsolation

enum (TransactionIsolation)

Default transaction isolation level.
For details, see MySQL documentation for the variable

• READ_COMMITTED: Read committed isolation level. A consistent read within the same transaction reads the snapshot established by the first read.
• REPEATABLE_READ: Repeatable read isolation level. All consistent reads within the same transaction read the snapshot established by the first read.
• SERIALIZABLE: Serializable isolation level. All statements implicitly convert to SELECT ... FOR SHARE if autocommit is disabled.

innodbPrintAllDeadlocks

boolean

Print information about deadlocks in error log
For details, see MySQL documentation for the variable

netReadTimeout

string (int64)

The number of seconds to wait for more data from a connection before aborting the read.
For details, see MySQL documentation for the variable

Acceptable values are 1 to 1200, inclusive.

netWriteTimeout

string (int64)

The number of seconds to wait for a block to be written to a connection before aborting the write.
For details, see MySQL documentation for the variable

Acceptable values are 1 to 1200, inclusive.

groupConcatMaxLen

string (int64)

The maximum permitted result length in bytes for the GROUP_CONCAT() function.
For details, see MySQL documentation for the variable

Acceptable values are 4 to 33554432, inclusive.

tmpTableSize

string (int64)

The maximum size of internal in-memory temporary tables.
For details, see MySQL documentation for the variable

Acceptable values are 1024 to 536870912, inclusive.

maxHeapTableSize

string (int64)

This variable sets the maximum size to which user-created MEMORY tables are permitted to grow.
For details, see MySQL documentation for the variable

Acceptable values are 16384 to 536870912, inclusive.

defaultTimeZone

string

The servers default time zone.
For details, see MySQL documentation for the variable

characterSetServer

string

The servers default character set.
For details, see MySQL documentation for the variable

collationServer

string

Set the default server collation.
For details, see MySQL documentation for the variable

innodbAdaptiveHashIndex

boolean

Enables Innodb adaptive hash index
For details, see MySQL documentation for the variable

innodbNumaInterleave

boolean

Enables the NUMA interleave memory policy for allocation of the InnoDB buffer pool.
For details, see MySQL documentation for the variable

innodbLogBufferSize

string (int64)

The size in bytes of the buffer that InnoDB uses to write to the log files on disk.
For details, see MySQL documentation for the variable

Acceptable values are 1048576 to 268435456, inclusive.

innodbLogFileSize

string (int64)

The size in bytes of the single Innodb Redo log file.
For details, see MySQL documentation for the variable

Acceptable values are 268435456 to 8589934592, inclusive.

innodbIoCapacity

string (int64)

Limits IO available for InnoDB background tasks
For details, see MySQL documentation for the variable

Acceptable values are 100 to 100000, inclusive.

innodbIoCapacityMax

string (int64)

Limits IO available for InnoDB background tasks
For details, see MySQL documentation for the variable

Acceptable values are 100 to 100000, inclusive.

innodbReadIoThreads

string (int64)

The number of I/O threads for read operations in InnoDB.
For details, see MySQL documentation for the variable

Acceptable values are 1 to 16, inclusive.

innodbWriteIoThreads

string (int64)

The number of I/O threads for write operations in InnoDB.
For details, see MySQL documentation for the variable

Acceptable values are 1 to 16, inclusive.

innodbPurgeThreads

string (int64)

The number of background threads devoted to the InnoDB purge operation.
For details, see MySQL documentation for the variable

Acceptable values are 1 to 16, inclusive.

innodbThreadConcurrency

string (int64)

Defines the maximum number of threads permitted inside of InnoDB.
For details, see MySQL documentation for the variable

Acceptable values are 0 to 1000, inclusive.

innodbTempDataFileMaxSize

string (int64)

Limits the max size of InnoDB temp tablespace
For details, see MySQL documentation for the variable

Acceptable values are 1073741824 to 107374182400, inclusive.

threadCacheSize

string (int64)

How many threads the server should cache for reuse.
For details, see MySQL documentation for the variable.

Acceptable values are 10 to 10000, inclusive.

threadStack

string (int64)

The stack size for each thread. The default is large enough for normal operation.
For details, see MySQL documentation for the variable.

Acceptable values are 131072 to 16777216, inclusive.

joinBufferSize

string (int64)

The minimum size of the buffer that is used for plain index scans, range index scans, and joins that don't use indexes and thus perform full table scans.
For details, see MySQL documentation for the variable.

Acceptable values are 1024 to 16777216, inclusive.

sortBufferSize

string (int64)

Each session that must perform a sort allocates a buffer of this size.
For details, see MySQL documentation for the variable.

Acceptable values are 1024 to 16777216, inclusive.

tableDefinitionCache

string (int64)

The number of table definitions that can be stored in the definition cache.
For details, see MySQL documentation for the variable.

Acceptable values are 400 to 524288, inclusive.

tableOpenCache

string (int64)

The number of open tables for all threads.
For details, see MySQL documentation for the variable.

Acceptable values are 400 to 524288, inclusive.

tableOpenCacheInstances

string (int64)

The number of open tables cache instances.
For details, see MySQL documentation for the variable.

Acceptable values are 1 to 32, inclusive.

explicitDefaultsForTimestamp

boolean

This system variable determines whether the server enables certain nonstandard behaviors for default values and NULL-value handling in TIMESTAMP columns.
For details, see MySQL documentation for the variable.

autoIncrementIncrement

string (int64)

Can be used to control the operation of AUTO_INCREMENT columns.
For details, see MySQL documentation for the variable.

Acceptable values are 1 to 65535, inclusive.

autoIncrementOffset

string (int64)

Can be used to control the operation of AUTO_INCREMENT columns.
For details, see MySQL documentation for the variable.

Acceptable values are 1 to 65535, inclusive.

syncBinlog

string (int64)

Controls how often the MySQL server synchronizes the binary log to disk.
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 4096, inclusive.

binlogCacheSize

string (int64)

The size of the cache to hold changes to the binary log during a transaction.
For details, see MySQL documentation for the variable.

Acceptable values are 4096 to 67108864, inclusive.

binlogGroupCommitSyncDelay

string (int64)

Controls how many microseconds the binary log commit waits before synchronizing the binary log file to disk.
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 50000, inclusive.

binlogRowImage

enum (BinlogRowImage)

For MySQL row-based replication, this variable determines how row images are written to the binary log.
For details, see MySQL documentation for the variable.

• FULL: Log all columns (full row image).
• MINIMAL: Log only changed columns and columns needed to identify the row.
• NOBLOB: Log all columns except BLOB and TEXT columns.

binlogRowsQueryLogEvents

boolean

When enabled, it causes the server to write informational log events such as row query log events into its binary log.
For details, see MySQL documentation for the variable.

rplSemiSyncMasterWaitForSlaveCount

string (int64)

The number of replica acknowledgments the source must receive per transaction before proceeding.
For details, see MySQL documentation for the variable.

The minimum value is 1.

slaveParallelType

enum (SlaveParallelType)

When using a multithreaded replica, this variable specifies the policy used to decide which transactions are allowed to execute in parallel on the replica.
For details, see MySQL documentation for the variable.

• DATABASE: Transactions are parallelized per database (schema).
• LOGICAL_CLOCK: Transactions are parallelized using the logical clock algorithm based on the binary log group commit.

slaveParallelWorkers

string (int64)

Sets the number of applier threads for executing replication transactions in parallel.
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 64, inclusive.

regexpTimeLimit

string (int64)

The time limit for regular expression matching operations performed by REGEXP_LIKE and similar functions
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 1048576, inclusive.

mdbPreserveBinlogBytes

string (int64)

The size of the binary log to hold.

Acceptable values are 1073741824 to 1099511627776, inclusive.

interactiveTimeout

string (int64)

The number of seconds the server waits for activity on an interactive connection before closing it.
For details, see MySQL documentation for the variable.

Acceptable values are 600 to 86400, inclusive.

waitTimeout

string (int64)

The number of seconds the server waits for activity on a noninteractive connection before closing it.
For details, see MySQL documentation for the variable.

Acceptable values are 600 to 86400, inclusive.

mdbOfflineModeEnableLag

string (int64)

Replication lag threshold (seconds) which will switch MySQL to 'offline_mode = ON' to prevent users from reading stale data.

Acceptable values are 30 to 86400, inclusive.

mdbOfflineModeDisableLag

string (int64)

Replication lag threshold (seconds) which will switch MySQL to 'offline_mode = OFF'.
Should be less than mdb_offline_mode_enable_lag.

Acceptable values are 10 to 86400, inclusive.

rangeOptimizerMaxMemSize

string (int64)

The limit on memory consumption for the range optimizer.
For details, see MySQL documentation for the variable.

Acceptable values are 60 to 268435456, inclusive.

innodbOnlineAlterLogMaxSize

string (int64)

The limit in bytes on the size of the temporary log files used during online DDL operations
For details, see MySQL documentation for the variable.

Acceptable values are 65536 to 107374182400, inclusive.

innodbFtMinTokenSize

string (int64)

Minimum length of words that are stored in an InnoDB FULLTEXT index
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 16, inclusive.

innodbFtMaxTokenSize

string (int64)

Maximum length of words that are stored in an InnoDB FULLTEXT index
For details, see MySQL documentation for the variable.

Acceptable values are 10 to 84, inclusive.

lowerCaseTableNames

string (int64)

Table names storage and comparison strategy
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 1, inclusive.

slowQueryLog

boolean

Manages slow query log
For details, see MySQL documentation for the variable.

slowQueryLogAlwaysWriteTime

number (double)

Query execution time, after which query to be logged unconditionally, that is, log_slow_rate_limit will not apply to it
For details, see Percona documentation for the variable.

Acceptable values are 0 to 3600, inclusive.

logSlowRateType

enum (LogSlowRateType)

Specifies slow log granularity for log_slow_rate_limit: QUERY or SESSION
For details, see Percona documentation for the variable.

• SESSION: Logging is controlled per session.
• QUERY: Logging is controlled per query.

logSlowRateLimit

string (int64)

Specifies what fraction of session/query should be logged. Logging is enabled for every nth session/query.
For details, see Percona documentation for the variable.

Acceptable values are 1 to 1000, inclusive.

logSlowSpStatements

boolean

When TRUE, statements executed by stored procedures are logged to the slow log
For details, see Percona documentation for the variable.

logSlowFilter[]

enum (LogSlowFilterType)

Filters the slow log by the query's execution plan
For details, see Percona documentation for the variable.

• FULL_SCAN: Queries that perform a full table scan.
• FULL_JOIN: Queries that perform a full join (a join without indexes).
• TMP_TABLE: Queries that create an implicit internal temporary table.
• TMP_TABLE_ON_DISK: Queries that create an implicit internal temporary table on disk.
• FILESORT: Queries that use a filesort.
• FILESORT_ON_DISK: Queries that use a filesort on disk.

mdbPriorityChoiceMaxLag

string (int64)

Replication lag threshold (seconds) which allows replica to be promoted to master while executing "switchover from".
Should be less than mdb_offline_mode_disable_lag.

Acceptable values are 0 to 86400, inclusive.

innodbPageSize

string (int64)

Specifies the page size for InnoDB tablespaces.
For details, see MySQL documentation for the variable.

Acceptable values are 4096 to 65536, inclusive.

maxSpRecursionDepth

string (int64)

The number of times that any given stored procedure may be called recursively.
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 255, inclusive.

innodbCompressionLevel

string (int64)

The level of zlib compression to use for InnoDB compressed tables and indexes.
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 9, inclusive.

autocommit

boolean

Config specific will be all changes to a table take effect immediately or you must use COMMIT to accept a transaction or ROLLBACK to cancel it.
For details, see MySQL documentation for the variable.

innodbStatusOutput

boolean

Enables or disables periodic output for the standard InnoDB Monitor.
For details, see MySQL documentation for the variable.

innodbStrictMode

boolean

When innodb_strict_mode is enabled, InnoDB returns errors rather than warnings when checking for invalid or incompatible table options.
For details, see MySQL documentation for the variable.

innodbPrintLockWaitTimeoutInfo

boolean

Makes InnoDB to write information about all lock wait timeout errors into the log file.
For details, see Percona documentation for the variable.

logErrorVerbosity

string (int64)

System variable specifies the verbosity for handling events intended for the error log
For details, see MySQL documentation for the variable.

Acceptable values are 2 to 3, inclusive.

maxDigestLength

string (int64)

The maximum number of bytes of memory reserved per session for computation of normalized statement digests.
For details, see MySQL documentation for the variable.

Acceptable values are 1024 to 1048576, inclusive.

lockWaitTimeout

string (int64)

This variable specifies the timeout in seconds for attempts to acquire metadata locks
For details, see MySQL documentation for the variable.

Acceptable values are 1 to 31536000, inclusive.

maxPreparedStmtCount

string (int64)

This variable limits the total number of prepared statements in the server.
For details, see MySQL documentation for the variable.

Acceptable values are 0 to 4194304, inclusive.

optimizerSwitch

string

The system variable enables control over optimizer behavior.
For details, see [MySQL documentation for the variable]
https://dev.mysql.com/doc/refman/8.4/en/server-system-variables.html#sysvar_optimizer_switch
https://dev.mysql.com/doc/refman/8.4/en/switchable-optimizations.html

optimizerSearchDepth

string (int64)

The maximum depth of search performed by the query optimizer
For details, see MySQL documentation for the variable

Acceptable values are 0 to 62, inclusive.

userstat

boolean

Enables or disables collection of statistics
For details, see Percona documentation for the variable.

maxExecutionTime

string (int64)

The execution timeout for SELECT statements, in milliseconds. If the value is 0, timeouts are not enabled.
For details, see MySQL documentation for the variable

Acceptable values are 0 to 4294967295, inclusive.

auditLogPolicy

enum (AuditLogPolicy)

The policy controlling how the audit log plugin writes events to its log file
For details, see MySQL documentation for the variable

• ALL: Log all events.
• LOGINS: Log only login events.
• QUERIES: Log only query events.
• NONE: Do not log events.

replicationSenderObserveCommitOnly

boolean

Limit callbacks to improve performance for semisynchronous replication
For details, see Percona documentation for the variable.

replicationOptimizeForStaticPluginConfig

boolean

Use shared locks, and avoid unnecessary lock acquisitions, to improve performance for semisynchronous replication
For details, see Percona documentation for the variable.

innodbLruScanDepth

string (int64)

A parameter that influences the algorithms and heuristics for the flush operation for the InnoDB buffer pool
For details, see MySQL documentation for the variable

Acceptable values are 100 to 4294967295, inclusive.

sqlRequirePrimaryKey

boolean

Whether statements that create new tables or alter the structure of existing tables enforce the requirement that tables have a primary key
For details, see Percona documentation for the variable.

mdbUseAsyncReplication

boolean

Enable async replication

mdbAsyncAllowedLag

string (int64)

Async replication allowed lag (seconds)

Acceptable values are 0 to 86400, inclusive.

mdbForceSsl

boolean

Force ssl on all hosts (require_secure_transport)

innodbChangeBuffering

enum (InnodbChangeBuffering)

An optimization for change buffering
For details, see Percona documentation for the variable.

• INNODB_CHANGE_BUFFERING_NONE: Do not buffer any operations.
• INNODB_CHANGE_BUFFERING_INSERTS: Buffer insert operations.
• INNODB_CHANGE_BUFFERING_DELETES: Buffer delete-marking operations.
• INNODB_CHANGE_BUFFERING_CHANGES: Buffer insert and delete-marking operations.
• INNODB_CHANGE_BUFFERING_PURGES: Buffer operations where undo log records are discarded.
• INNODB_CHANGE_BUFFERING_ALL: Buffer all types of eligible operations.

maxWriteLockCount

string (int64)

Permit some pending read lock requests interval
P.S. Should be UInt64, but java fails to handle UInt64 limits
For details, see Percona documentation for the variable.

The minimum value is 1.

innodbAdaptiveHashIndexParts

string (int64)

Partitions the adaptive hash index search system.
For details, see MySQL documentation for the variable

Acceptable values are 1 to 512, inclusive.

Field

Description

resourcePresetId

string

ID of the resource preset that defines available computational resources (vCPU, RAM, etc.) for a cluster host.
All available presets are listed in the documentation.

diskSize

string (int64)

Volume of the storage (for each cluster host, in bytes).

diskTypeId

string

Type of the storage.
Possible values:

• network-hdd - standard network storage
• network-ssd - fast network storage
• network-ssd-nonreplicated - fast network nonreplicated storage
• local-ssd - fast local storage.
  See the documentation for details.

Field

Description

hours

integer (int32)

Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
to allow the value "24:00:00" for scenarios like business closing time.

minutes

integer (int32)

Minutes of hour of day. Must be from 0 to 59.

seconds

integer (int32)

Seconds of minutes of the time. Must normally be from 0 to 59. An API may
allow the value 60 if it allows leap-seconds.

nanos

integer (int32)

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

Field

Description

dataLens

boolean

Allows access from DataLens.
See the documentation for details.

webSql

boolean

Allows SQL queries to the cluster databases from management console.
See the documentation for details.

dataTransfer

boolean

Allow access for DataTransfer.

yandexQuery

boolean

Allow access for YandexQuery.

Field

Description

enabled

boolean

Flag that shows if performance statistics gathering is enabled for the cluster.

sessionsSamplingInterval

string (int64)

Interval (in seconds) for my_session sampling.

Acceptable values are 1 to 86400, inclusive.

statementsSamplingInterval

string (int64)

Interval (in seconds) for my_statements sampling.

Acceptable values are 1 to 86400, inclusive.

Field

Description

plannedUsageThreshold

string (int64)

Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent.

Acceptable values are 0 to 100, inclusive.

emergencyUsageThreshold

string (int64)

Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent.

Acceptable values are 0 to 100, inclusive.

diskSizeLimit

string (int64)

Limit on how large the storage for database instances can automatically grow, in bytes.

Field

Description

anytime

object

Maintenance operation can be scheduled anytime.

Includes only one of the fields anytime, weeklyMaintenanceWindow.

The maintenance policy in effect.

weeklyMaintenanceWindow

WeeklyMaintenanceWindow

Maintenance operation can be scheduled on a weekly basis.

Includes only one of the fields anytime, weeklyMaintenanceWindow.

The maintenance policy in effect.

Field

Description

day

enum (WeekDay)

Day of the week (in DDD format).

• MON
• TUE
• WED
• THU
• FRI
• SAT
• SUN

hour

string (int64)

Hour of the day in UTC (in HH format).

Acceptable values are 1 to 24, inclusive.

Field

Description

info

string

Information about this maintenance operation.

The maximum string length in characters is 256.

delayedUntil

string (date-time)

Time until which this maintenance operation is delayed.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).