Skip to main content

List

Retrieves the list of clusters in a folder.

import { cloudApi, serviceClients, Session } from "@yandex-cloud/nodejs-sdk";

const ListClustersRequest =
cloudApi.dataproc.cluster_service.ListClustersRequest;

(async () => {
const authToken = process.env["YC_OAUTH_TOKEN"];
const session = new Session({ oauthToken: authToken });
const client = session.client(serviceClients.ClusterServiceClient);

const result = await client.list(
ListClustersRequest.fromPartial({
folderId: "folderId",
// pageSize: 0,
// pageToken: "pageToken",
// filter: "filter"
})
);
console.log(result);
})();

ListClustersRequest​

folderId : string​

ID of the folder to list clusters in.

To get this ID, make a yandex.cloud.resourcemanager.v1.FolderService.List request.

pageSize : int64​

The maximum number of results per page to return.

If the number of available results is larger than page_size, the API returns a ListClustersResponse.next_page_token that can be used to get the next page of results in the subsequent ClusterService.List requests.

pageToken : string​

Page token that can be used to iterate through multiple pages of results.

To get the next page of results, set page_token to the ListClustersResponse.next_page_token returned by the previous ClusterService.List request.

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_-]+.

ListClustersResponse​

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.page_size, use the next_page_token as the value for the ListClustersRequest.page_token in the subsequent ClusterService.List request to iterate through multiple pages of results.

Each of the subsequent ClusterService.List requests should use the next_page_token value returned by the previous request to continue paging through the results.

Cluster​

An object that represents MySQL cluster.

See the documentation for details.

Environment​
  • ENVIRONMENT_UNSPECIFIED

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

Health​
  • HEALTH_UNKNOWN

    Health of the cluster is unknown ([Host.health][15] for every host in the cluster is UNKNOWN).

  • ALIVE

    Cluster is alive and well ([Host.health][16] for every host in the cluster is ALIVE).

  • DEAD

    Cluster is inoperable ([Host.health][17] for every host in the cluster is DEAD).

  • DEGRADED

    Cluster is degraded ([Host.health][18] for at least one host in the cluster is not ALIVE).

Status​
  • 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.

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 : google.protobuf.Timestamp​

Creation timestamp of the cluster.

name : string​

Name of the cluster.

description : string​

Description of the cluster.

labels : string​

Custom labels for the cluster as key:value pairs.

environment : Environment​

Deployment environment of the MySQL cluster.

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 : Health​

Aggregated health of the cluster.

status : Status​

Current state of the cluster.

maintenanceWindow : MaintenanceWindow​

Maintenance window settings for the cluster.

plannedOperation : MaintenanceOperation​

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

securityGroupIds : string​

Effective list of security group IDs applied to the cluster.

deletionProtection : bool​

This option prevents unintended deletion of the cluster.

hostGroupIds : string​

Host groups hosting VMs of the cluster.

Monitoring​

Cluster-related monitoring system data.

name : string​

Name of the monitoring system.

description : string​

Description of the monitoring system.

Link to the monitoring system charts for the cluster.

ClusterConfig​

version : string​

Version of MySQL used in the cluster.

One of mysqlConfig​

Cluster-wide MySQL configuration.

  • mysqlConfig_5_7 : config.MysqlConfigSet5_7​

    Configuration of a MySQL 5.7 server.

  • mysqlConfig_8_0 : config.MysqlConfigSet8_0​

    Configuration of a MySQL 8.0 server.

resources : Resources​

Resource preset for the cluster hosts.

backupWindowStart : google.type.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 : google.protobuf.Int64Value​

Retention policy of automated backups.

MaintenanceWindow​

Configuration of a maintenance window in a MySQL cluster.

One of policy​

The maintenance policy in effect.

  • anytime : AnytimeMaintenanceWindow​

    Maintenance operation can be scheduled anytime.

  • weeklyMaintenanceWindow : WeeklyMaintenanceWindow​

    Maintenance operation can be scheduled on a weekly basis.

MaintenanceOperation​

A planned maintenance operation.

info : string​

Information about this maintenance operation.

delayedUntil : google.protobuf.Timestamp​

Time until which this maintenance operation is delayed.

MysqlConfigSet5_7​

effectiveConfig : MysqlConfig5_7​

Effective settings for a MySQL 5.7 cluster (a combination of settings defined in user_config and default_config).

userConfig : MysqlConfig5_7​

User-defined settings for a MySQL 5.7 cluster.

defaultConfig : MysqlConfig5_7​

Default configuration for a MySQL 5.7 cluster.

MysqlConfigSet8_0​

effectiveConfig : MysqlConfig8_0​

Effective settings for a MySQL 8.0 cluster (a combination of settings defined in user_config and default_config).

userConfig : MysqlConfig8_0​

User-defined settings for a MySQL 8.0 cluster.

defaultConfig : MysqlConfig8_0​

Default configuration for a MySQL 8.0 cluster.

Resources​

Cluster resource preset.

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

Access​

dataLens : bool​

Allows access from DataLens.

See the documentation for details.

webSql : bool​

Allows SQL queries to the cluster databases from management console.

See the documentation for details.

dataTransfer : bool​

Allow access for DataTransfer.

PerformanceDiagnostics​

enabled : bool​

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

sessionsSamplingInterval : int64​

Interval (in seconds) for my_session sampling.

statementsSamplingInterval : int64​

Interval (in seconds) for my_statements sampling.

AnytimeMaintenanceWindow​

WeeklyMaintenanceWindow​

Weelky maintenance window settings.

WeekDay​
  • WEEK_DAY_UNSPECIFIED

  • MON

  • TUE

  • WED

  • THU

  • FRI

  • SAT

  • SUN

day : WeekDay​

Day of the week (in DDD format).

hour : int64​

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

MysqlConfig5_7​

Options and structure of MysqlConfig5_7 reflects MySQL 5.7 configuration file.

SQLMode​
  • SQLMODE_UNSPECIFIED

  • ALLOW_INVALID_DATES

  • ANSI_QUOTES

  • ERROR_FOR_DIVISION_BY_ZERO

  • HIGH_NOT_PRECEDENCE

  • IGNORE_SPACE

  • NO_AUTO_VALUE_ON_ZERO

  • NO_BACKSLASH_ESCAPES

  • NO_ENGINE_SUBSTITUTION

  • NO_UNSIGNED_SUBTRACTION

  • NO_ZERO_DATE

  • NO_ZERO_IN_DATE

  • NO_FIELD_OPTIONS

  • NO_KEY_OPTIONS

  • NO_TABLE_OPTIONS

  • ONLY_FULL_GROUP_BY

  • PAD_CHAR_TO_FULL_LENGTH

  • PIPES_AS_CONCAT

  • REAL_AS_FLOAT

  • STRICT_ALL_TABLES

  • STRICT_TRANS_TABLES

  • ANSI

  • TRADITIONAL

  • DB2

  • MAXDB

  • MSSQL

  • MYSQL323

  • MYSQL40

  • ORACLE

  • POSTGRESQL

  • NO_AUTO_CREATE_USER

  • NO_DIR_IN_CREATE

AuthPlugin​
TransactionIsolation​
  • TRANSACTION_ISOLATION_UNSPECIFIED

  • READ_COMMITTED

  • REPEATABLE_READ

  • SERIALIZABLE

BinlogRowImage​
  • BINLOG_ROW_IMAGE_UNSPECIFIED

  • FULL

  • MINIMAL

  • NOBLOB

SlaveParallelType​
  • SLAVE_PARALLEL_TYPE_UNSPECIFIED

  • DATABASE

  • LOGICAL_CLOCK

LogSlowRateType​
  • LOG_SLOW_RATE_TYPE_UNSPECIFIED

  • SESSION

  • QUERY

LogSlowFilterType​
  • LOG_SLOW_FILTER_TYPE_UNSPECIFIED

  • FULL_SCAN

  • FULL_JOIN

  • TMP_TABLE

  • TMP_TABLE_ON_DISK

  • FILESORT

  • FILESORT_ON_DISK

BinlogTransactionDependencyTracking​
  • BINLOG_TRANSACTION_DEPENDENCY_TRACKING_UNSPECIFIED

  • COMMIT_ORDER

  • WRITESET

  • WRITESET_SESSION

innodbBufferPoolSize : google.protobuf.Int64Value​

Size of the InnoDB buffer pool used for caching table and index data.

See MySQL documentation for details.

maxConnections : google.protobuf.Int64Value​

The maximum permitted number of simultaneous client connections.

See MySQL documentation for details.

longQueryTime : google.protobuf.DoubleValue​

Time that it takes to process a query before it is considered slow.

See MySQL documentation for details.

generalLog : google.protobuf.BoolValue​

Enable writing of general query log of MySQL.

See MySQL documentation for details.

auditLog : google.protobuf.BoolValue​

Enable writing of audit log of MySQL.

See MySQL documentation for details.

sqlMode : SQLMode​

Server SQL mode of MySQL.

See MySQL documentation for details.

maxAllowedPacket : google.protobuf.Int64Value​

The maximum size in bytes of one packet.

See MySQL documentation for details.

defaultAuthenticationPlugin : AuthPlugin​

Authentication plugin used in the managed MySQL cluster.

See MySQL documentation for details.

innodbFlushLogAtTrxCommit : google.protobuf.Int64Value​

Transaction log flush behaviour.

See MySQL documentation for details.

innodbLockWaitTimeout : google.protobuf.Int64Value​

Max time in seconds for a transaction to wait for a row lock.

See MySQL documentation for details.

transactionIsolation : TransactionIsolation​

Default transaction isolation level.

See MySQL documentation for details.

innodbPrintAllDeadlocks : google.protobuf.BoolValue​

Print information about deadlocks in error log.

See MySQL documentation for details.

netReadTimeout : google.protobuf.Int64Value​

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

See MySQL documentation for details.

netWriteTimeout : google.protobuf.Int64Value​

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

See MySQL documentation for details.

groupConcatMaxLen : google.protobuf.Int64Value​

The maximum permitted result length in bytes for the GROUP_CONCAT() function.

See MySQL documentation for details.

tmpTableSize : google.protobuf.Int64Value​

The maximum size of internal in-memory temporary tables.

See MySQL documentation for details.

maxHeapTableSize : google.protobuf.Int64Value​

This variable sets the maximum size to which user-created MEMORY tables are permitted to grow.

See MySQL documentation for details.

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 : google.protobuf.BoolValue​

Enables InnoDB adaptive hash index.

See MySQL documentation for details.

innodbNumaInterleave : google.protobuf.BoolValue​

Enables the NUMA interleave memory policy for allocation of the InnoDB buffer pool.

See MySQL documentation for details.

innodbLogBufferSize : google.protobuf.Int64Value​

The size in bytes of the buffer that InnoDB uses to write to the log files on disk.

See MySQL documentation for details.

innodbLogFileSize : google.protobuf.Int64Value​

The size in bytes of the single InnoDB Redo log file.

See MySQL documentation for details.

innodbIoCapacity : google.protobuf.Int64Value​

Limits IO available for InnoDB background tasks.

See MySQL documentation for details.

innodbIoCapacityMax : google.protobuf.Int64Value​

Limits IO available for InnoDB background tasks.

See MySQL documentation for details.

innodbReadIoThreads : google.protobuf.Int64Value​

The number of I/O threads for read operations in InnoDB.

See MySQL documentation for details.

innodbWriteIoThreads : google.protobuf.Int64Value​

The number of I/O threads for write operations in InnoDB.

See MySQL documentation for details.

innodbPurgeThreads : google.protobuf.Int64Value​

The number of background threads devoted to the InnoDB purge operation.

See MySQL documentation for details.

innodbThreadConcurrency : google.protobuf.Int64Value​

Defines the maximum number of threads permitted inside of InnoDB.

See MySQL documentation for details.

innodbTempDataFileMaxSize : google.protobuf.Int64Value​

Limits the max size of InnoDB temp tablespace.

See MySQL documentation for details.

threadCacheSize : google.protobuf.Int64Value​

A number of threads the server should cache for reuse.

See MySQL documentation for details.

threadStack : google.protobuf.Int64Value​

The stack size for each thread. The default is large enough for normal operation.

See MySQL documentation for details.

joinBufferSize : google.protobuf.Int64Value​

The minimum size of the buffer that is used for plain index scans, range index scans, and joins that do not use indexes and thus perform full table scans.

See MySQL documentation for details.

sortBufferSize : google.protobuf.Int64Value​

Each session that must perform a sort allocates a buffer of this size.

See MySQL documentation for details.

tableDefinitionCache : google.protobuf.Int64Value​

The number of table definitions that can be stored in the definition cache.

See MySQL documentation for details.

tableOpenCache : google.protobuf.Int64Value​

The number of open tables for all threads.

See MySQL documentation for details.

tableOpenCacheInstances : google.protobuf.Int64Value​

The number of open tables cache instances.

See MySQL documentation for details.

explicitDefaultsForTimestamp : google.protobuf.BoolValue​

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

See MySQL documentation for details.

autoIncrementIncrement : google.protobuf.Int64Value​

Can be used to control the operation of AUTO_INCREMENT columns.

See MySQL documentation for details.

autoIncrementOffset : google.protobuf.Int64Value​

Can be used to control the operation of AUTO_INCREMENT columns.

See MySQL documentation for details.

syncBinlog : google.protobuf.Int64Value​

Controls how often the MySQL server synchronizes the binary log to disk.

See MySQL documentation for details.

binlogCacheSize : google.protobuf.Int64Value​

The size of the cache to hold changes to the binary log during a transaction.

See MySQL documentation for details.

binlogGroupCommitSyncDelay : google.protobuf.Int64Value​

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.

binlogRowImage : BinlogRowImage​

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

See MySQL documentation for details.

binlogRowsQueryLogEvents : google.protobuf.BoolValue​

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 : google.protobuf.Int64Value​

The number of replica acknowledgments the source must receive per transaction before proceeding.

See MySQL documentation for details.

slaveParallelType : 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.

slaveParallelWorkers : google.protobuf.Int64Value​

Sets the number of applier threads for executing replication transactions in parallel.

See MySQL documentation for details.

mdbPreserveBinlogBytes : google.protobuf.Int64Value​

The size of the binary log to hold.

interactiveTimeout : google.protobuf.Int64Value​

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

See MySQL documentation for details.

waitTimeout : google.protobuf.Int64Value​

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

See MySQL documentation for details.

mdbOfflineModeEnableLag : google.protobuf.Int64Value​

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

mdbOfflineModeDisableLag : google.protobuf.Int64Value​

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

rangeOptimizerMaxMemSize : google.protobuf.Int64Value​

The limit on memory consumption for the range optimizer.

See MySQL documentation for details.

slowQueryLog : google.protobuf.BoolValue​

Manages slow query log.

See MySQL documentation for details.

slowQueryLogAlwaysWriteTime : google.protobuf.DoubleValue​

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.

logSlowRateType : LogSlowRateType​

Specifies slow log granularity for log_slow_rate_limit values QUERY or SESSION.

See Percona documentation for details.

logSlowRateLimit : google.protobuf.Int64Value​

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

See Percona documentation for details.

logSlowSpStatements : google.protobuf.BoolValue​

When TRUE, statements executed by stored procedures are logged to the slow log.

See Percona documentation for details.

logSlowFilter : LogSlowFilterType​

Filters the slow log by the query's execution plan.

See Percona documentation for details.

mdbPriorityChoiceMaxLag : google.protobuf.Int64Value​

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.

innodbPageSize : google.protobuf.Int64Value​

Specifies the page size for InnoDB tablespaces.

For details, see MySQL documentation for the variable.

innodbOnlineAlterLogMaxSize : google.protobuf.Int64Value​

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.

innodbFtMinTokenSize : google.protobuf.Int64Value​

Minimum length of words that are stored in an InnoDB FULLTEXT index

For details, see MySQL documentation for the variable.

innodbFtMaxTokenSize : google.protobuf.Int64Value​

Maximum length of words that are stored in an InnoDB FULLTEXT index

For details, see MySQL documentation for the variable.

lowerCaseTableNames : google.protobuf.Int64Value​

Table names storage and comparison strategy

For details, see MySQL documentation for the variable.

showCompatibility_56 : google.protobuf.BoolValue​

Manages MySQL 5.6 compatibility

For details, see MySQL documentation for the variable.

maxSpRecursionDepth : google.protobuf.Int64Value​

The number of times that any given stored procedure may be called recursively.

For details, see MySQL documentation for the variable.

innodbCompressionLevel : google.protobuf.Int64Value​

The level of zlib compression to use for InnoDB compressed tables and indexes.

For details, see MySQL documentation for the variable.

binlogTransactionDependencyTracking : 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.

autocommit : google.protobuf.BoolValue​

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 : google.protobuf.BoolValue​

Enables or disables periodic output for the standard InnoDB Monitor.

For details, see MySQL documentation for the variable.

innodbStrictMode : google.protobuf.BoolValue​

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 : google.protobuf.BoolValue​

Makes InnoDB to write information about all lock wait timeout errors into the log file.

For details, see Percona documentation for the variable.

logErrorVerbosity : google.protobuf.Int64Value​

System variable specifies the verbosity for handling events intended for the error log

For details, see MySQL documentation for the variable.

maxDigestLength : google.protobuf.Int64Value​

The maximum number of bytes of memory reserved per session for computation of normalized statement digests.

For details, see MySQL documentation for the variable.

queryCacheLimit : google.protobuf.Int64Value​

Do not cache results that are larger than this number of bytes.

For details, see MySQL documentation for the variable.

queryCacheSize : google.protobuf.Int64Value​

The amount of memory allocated for caching query results.

For details, see MySQL documentation for the variable.

queryCacheType : google.protobuf.Int64Value​

Set the query cache type.

For details, see MySQL documentation for the variable.

lockWaitTimeout : google.protobuf.Int64Value​

This variable specifies the timeout in seconds for attempts to acquire metadata locks

For details, see MySQL documentation for the variable.

maxPreparedStmtCount : google.protobuf.Int64Value​

This variable limits the total number of prepared statements in the server.

For details, see MySQL documentation for the variable.

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 : google.protobuf.Int64Value​

The maximum depth of search performed by the query optimizer

For details, see MySQL documentation for the variable

queryResponseTimeStats : google.protobuf.BoolValue​

Enables and disables collection of query times

For details, see Percona documentation for the variable.

userstat : google.protobuf.BoolValue​

Enables or disables collection of statistics

For details, see Percona documentation for the variable.

maxExecutionTime : google.protobuf.Int64Value​

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

MysqlConfig8_0​

Options and structure of MysqlConfig8_0 reflects MySQL 8.0 configuration file.

SQLMode​
  • SQLMODE_UNSPECIFIED

  • ALLOW_INVALID_DATES

  • ANSI_QUOTES

  • ERROR_FOR_DIVISION_BY_ZERO

  • HIGH_NOT_PRECEDENCE

  • IGNORE_SPACE

  • NO_AUTO_VALUE_ON_ZERO

  • NO_BACKSLASH_ESCAPES

  • NO_ENGINE_SUBSTITUTION

  • NO_UNSIGNED_SUBTRACTION

  • NO_ZERO_DATE

  • NO_ZERO_IN_DATE

  • ONLY_FULL_GROUP_BY

  • PAD_CHAR_TO_FULL_LENGTH

  • PIPES_AS_CONCAT

  • REAL_AS_FLOAT

  • STRICT_ALL_TABLES

  • STRICT_TRANS_TABLES

  • TIME_TRUNCATE_FRACTIONAL

  • ANSI

  • TRADITIONAL

  • NO_DIR_IN_CREATE

AuthPlugin​
TransactionIsolation​
  • TRANSACTION_ISOLATION_UNSPECIFIED

  • READ_COMMITTED

  • REPEATABLE_READ

  • SERIALIZABLE

BinlogRowImage​
  • BINLOG_ROW_IMAGE_UNSPECIFIED

  • FULL

  • MINIMAL

  • NOBLOB

SlaveParallelType​
  • SLAVE_PARALLEL_TYPE_UNSPECIFIED

  • DATABASE

  • LOGICAL_CLOCK

LogSlowRateType​
  • LOG_SLOW_RATE_TYPE_UNSPECIFIED

  • SESSION

  • QUERY

LogSlowFilterType​
  • LOG_SLOW_FILTER_TYPE_UNSPECIFIED

  • FULL_SCAN

  • FULL_JOIN

  • TMP_TABLE

  • TMP_TABLE_ON_DISK

  • FILESORT

  • FILESORT_ON_DISK

BinlogTransactionDependencyTracking​
  • BINLOG_TRANSACTION_DEPENDENCY_TRACKING_UNSPECIFIED

  • COMMIT_ORDER

  • WRITESET

  • WRITESET_SESSION

innodbBufferPoolSize : google.protobuf.Int64Value​

Size of the InnoDB buffer pool used for caching table and index data.

See MySQL documentation for details.

maxConnections : google.protobuf.Int64Value​

The maximum permitted number of simultaneous client connections.

See MySQL documentation for details.

longQueryTime : google.protobuf.DoubleValue​

Time that it takes to process a query before it is considered slow.

See MySQL documentation for details.

generalLog : google.protobuf.BoolValue​

Enable writing of general query log of MySQL.

See MySQL documentation for details.

auditLog : google.protobuf.BoolValue​

Enable writing of audit log of MySQL.

See MySQL documentation for details.

sqlMode : SQLMode​

Server SQL mode of MySQL.

See MySQL documentation for details.

maxAllowedPacket : google.protobuf.Int64Value​

The maximum size in bytes of one packet.

See MySQL documentation for details.

defaultAuthenticationPlugin : AuthPlugin​

Authentication plugin used in the managed MySQL cluster.

See MySQL documentation for details.

innodbFlushLogAtTrxCommit : google.protobuf.Int64Value​

Transaction log flush behaviour.

See MySQL documentation for details.

innodbLockWaitTimeout : google.protobuf.Int64Value​

Max time in seconds for a transaction to wait for a row lock.

See MySQL documentation for details.

transactionIsolation : TransactionIsolation​

Default transaction isolation level.

See MySQL documentation for details.

innodbPrintAllDeadlocks : google.protobuf.BoolValue​

Print information about deadlocks in error log.

See MySQL documentation for details.

netReadTimeout : google.protobuf.Int64Value​

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

See MySQL documentation for details.

netWriteTimeout : google.protobuf.Int64Value​

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

See MySQL documentation for details.

groupConcatMaxLen : google.protobuf.Int64Value​

The maximum permitted result length in bytes for the GROUP_CONCAT() function.

See MySQL documentation for details.

tmpTableSize : google.protobuf.Int64Value​

The maximum size of internal in-memory temporary tables.

See MySQL documentation for details.

maxHeapTableSize : google.protobuf.Int64Value​

This variable sets the maximum size to which user-created MEMORY tables are permitted to grow.

See MySQL documentation for details.

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 : google.protobuf.BoolValue​

Enables InnoDB adaptive hash index.

See MySQL documentation for details.

innodbNumaInterleave : google.protobuf.BoolValue​

Enables the NUMA interleave memory policy for allocation of the InnoDB buffer pool.

See MySQL documentation for details.

innodbLogBufferSize : google.protobuf.Int64Value​

The size in bytes of the buffer that InnoDB uses to write to the log files on disk.

See MySQL documentation for details.

innodbLogFileSize : google.protobuf.Int64Value​

The size in bytes of the single InnoDB Redo log file.

See MySQL documentation for details.

innodbIoCapacity : google.protobuf.Int64Value​

Limits IO available for InnoDB background tasks.

See MySQL documentation for details.

innodbIoCapacityMax : google.protobuf.Int64Value​

Limits IO available for InnoDB background tasks.

See MySQL documentation for details.

innodbReadIoThreads : google.protobuf.Int64Value​

The number of I/O threads for read operations in InnoDB.

See MySQL documentation for details.

innodbWriteIoThreads : google.protobuf.Int64Value​

The number of I/O threads for write operations in InnoDB.

See MySQL documentation for details.

innodbPurgeThreads : google.protobuf.Int64Value​

The number of background threads devoted to the InnoDB purge operation.

See MySQL documentation for details.

innodbThreadConcurrency : google.protobuf.Int64Value​

Defines the maximum number of threads permitted inside of InnoDB.

See MySQL documentation for details.

innodbTempDataFileMaxSize : google.protobuf.Int64Value​

Limits the max size of InnoDB temp tablespace.

See MySQL documentation for details.

threadCacheSize : google.protobuf.Int64Value​

How many threads the server should cache for reuse.

See MySQL documentation for details.

threadStack : google.protobuf.Int64Value​

The stack size for each thread. The default is large enough for normal operation.

See MySQL documentation for details.

joinBufferSize : google.protobuf.Int64Value​

The minimum size of the buffer that is used for plain index scans, range index scans, and joins that do not use indexes and thus perform full table scans.

See MySQL documentation for details.

sortBufferSize : google.protobuf.Int64Value​

Each session that must perform a sort allocates a buffer of this size.

See MySQL documentation for details.

tableDefinitionCache : google.protobuf.Int64Value​

The number of table definitions that can be stored in the definition cache.

See MySQL documentation for details.

tableOpenCache : google.protobuf.Int64Value​

The number of open tables for all threads.

See MySQL documentation for details.

tableOpenCacheInstances : google.protobuf.Int64Value​

The number of open tables cache instances.

See MySQL documentation for details.

explicitDefaultsForTimestamp : google.protobuf.BoolValue​

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

See MySQL documentation for details.

autoIncrementIncrement : google.protobuf.Int64Value​

Can be used to control the operation of AUTO_INCREMENT columns.

See MySQL documentation for details.

autoIncrementOffset : google.protobuf.Int64Value​

Can be used to control the operation of AUTO_INCREMENT columns.

See MySQL documentation for details.

syncBinlog : google.protobuf.Int64Value​

Controls how often the MySQL server synchronizes the binary log to disk.

See MySQL documentation for details.

binlogCacheSize : google.protobuf.Int64Value​

The size of the cache to hold changes to the binary log during a transaction.

See MySQL documentation for details.

binlogGroupCommitSyncDelay : google.protobuf.Int64Value​

Controls how many microseconds the binary log commit waits before synchronizing the binary log file to disk.

See MySQL documentation for details.

binlogRowImage : BinlogRowImage​

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

See MySQL documentation for details.

binlogRowsQueryLogEvents : google.protobuf.BoolValue​

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 : google.protobuf.Int64Value​

The number of replica acknowledgments the source must receive per transaction before proceeding.

See MySQL documentation for details.

slaveParallelType : 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.

slaveParallelWorkers : google.protobuf.Int64Value​

Sets the number of applier threads for executing replication transactions in parallel.

See MySQL documentation for details.

regexpTimeLimit : google.protobuf.Int64Value​

The time limit for regular expression matching operations performed by REGEXP_LIKE and similar functions.

See MySQL documentation for details.

mdbPreserveBinlogBytes : google.protobuf.Int64Value​

The size of the binary log to hold.

interactiveTimeout : google.protobuf.Int64Value​

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

See MySQL documentation for details.

waitTimeout : google.protobuf.Int64Value​

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

See MySQL documentation for details.

mdbOfflineModeEnableLag : google.protobuf.Int64Value​

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

mdbOfflineModeDisableLag : google.protobuf.Int64Value​

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

rangeOptimizerMaxMemSize : google.protobuf.Int64Value​

The limit on memory consumption for the range optimizer.

See MySQL documentation for details.

slowQueryLog : google.protobuf.BoolValue​

Manages slow query log.

See MySQL documentation for details.

slowQueryLogAlwaysWriteTime : google.protobuf.DoubleValue​

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.

logSlowRateType : LogSlowRateType​

Specifies slow log granularity for log_slow_rate_limit QUERY or SESSION value.

See Percona documentation for details.

logSlowRateLimit : google.protobuf.Int64Value​

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

See Percona documentation for details.

logSlowSpStatements : google.protobuf.BoolValue​

When TRUE, statements executed by stored procedures are logged to the slow log.

See Percona documentation for details.

logSlowFilter : LogSlowFilterType​

Filters the slow log by the query's execution plan.

See Percona documentation for details.

mdbPriorityChoiceMaxLag : google.protobuf.Int64Value​

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.

innodbPageSize : google.protobuf.Int64Value​

Specifies the page size for InnoDB tablespaces.

For details, see MySQL documentation for the variable.

innodbOnlineAlterLogMaxSize : google.protobuf.Int64Value​

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.

innodbFtMinTokenSize : google.protobuf.Int64Value​

Minimum length of words that are stored in an InnoDB FULLTEXT index

See MySQL documentation for the variable for details.

innodbFtMaxTokenSize : google.protobuf.Int64Value​

Maximum length of words that are stored in an InnoDB FULLTEXT index

See MySQL documentation for the variable for details.

lowerCaseTableNames : google.protobuf.Int64Value​

Table names storage and comparison strategy

See MySQL documentation for the variable for details.

maxSpRecursionDepth : google.protobuf.Int64Value​

The number of times that any given stored procedure may be called recursively.

For details, see MySQL documentation for the variable.

innodbCompressionLevel : google.protobuf.Int64Value​

The level of zlib compression to use for InnoDB compressed tables and indexes.

For details, see MySQL documentation for the variable.

binlogTransactionDependencyTracking : 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.

autocommit : google.protobuf.BoolValue​

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 : google.protobuf.BoolValue​

Enables or disables periodic output for the standard InnoDB Monitor.

For details, see MySQL documentation for the variable.

innodbStrictMode : google.protobuf.BoolValue​

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 : google.protobuf.BoolValue​

Makes InnoDB to write information about all lock wait timeout errors into the log file.

For details, see Percona documentation for the variable.

logErrorVerbosity : google.protobuf.Int64Value​

System variable specifies the verbosity for handling events intended for the error log

For details, see MySQL documentation for the variable.

maxDigestLength : google.protobuf.Int64Value​

The maximum number of bytes of memory reserved per session for computation of normalized statement digests.

For details, see MySQL documentation for the variable.

lockWaitTimeout : google.protobuf.Int64Value​

This variable specifies the timeout in seconds for attempts to acquire metadata locks

For details, see MySQL documentation for the variable.

maxPreparedStmtCount : google.protobuf.Int64Value​

This variable limits the total number of prepared statements in the server.

For details, see MySQL documentation for the variable.

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 : google.protobuf.Int64Value​

The maximum depth of search performed by the query optimizer

For details, see MySQL documentation for the variable

userstat : google.protobuf.BoolValue​

Enables or disables collection of statistics

For details, see Percona documentation for the variable.

maxExecutionTime : google.protobuf.Int64Value​

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