Skip to main content

Create

Creates a cluster in a folder.

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

const Cluster = cloudApi.dataproc.cluster.Cluster;
const CreateClusterRequest =
  cloudApi.dataproc.cluster_service.CreateClusterRequest;
const HadoopConfig_Service = cloudApi.dataproc.cluster.HadoopConfig_Service;
const Role = cloudApi.dataproc.subcluster.Role;

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

  const operation = await client.create(
    CreateClusterRequest.fromPartial({
      folderId: "folderId",
      // name: "name",
      // description: "description",
      // labels: {"key": "labels"},
      configSpec: {
        // versionId: "versionId",
        // hadoop: {
        // services: [HadoopConfig_Service.HDFS],
        // properties: {"key": "properties"},
        // sshPublicKeys: ["sshPublicKeys"],
        // initializationActions: [{
        // uri: "uri",
        // args: ["args"],
        // timeout: 0
        // }]
        // },
        // subclustersSpec: [{
        // name: "name",
        // role: Role.MASTERNODE,
        // resources: {
        // resourcePresetId: "resourcePresetId",
        // diskTypeId: "diskTypeId",
        // diskSize: 0
        // },
        // subnetId: "subnetId",
        // hostsCount: 0,
        // assignPublicIp: true,
        // autoscalingConfig: {
        // maxHostsCount: 0,
        // preemptible: true,
        // measurementDuration: {
        // seconds: 0,
        // nanos: 0
        // },
        // warmupDuration: {
        // seconds: 0,
        // nanos: 0
        // },
        // stabilizationDuration: {
        // seconds: 0,
        // nanos: 0
        // },
        // cpuUtilizationTarget: 0,
        // decommissionTimeout: 0
        // }
        // }]
      },
      zoneId: "zoneId",
      serviceAccountId: "serviceAccountId",
      // bucket: "bucket",
      // uiProxy: true,
      // securityGroupIds: ["securityGroupIds"],
      // hostGroupIds: ["hostGroupIds"],
      // deletionProtection: true,
      // logGroupId: "logGroupId"
    })
  );
  const finishedOp = await waitForOperation(operation, session);

  if (finishedOp.response) {
    const result = decodeMessage<typeof Cluster>(finishedOp.response);
    console.log(result);
  }
})();

CreateClusterRequest​

folderId : string​

ID of the folder to create the cluster in.

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

name : string​

Name of the cluster. The name must be unique within the folder.

description : string​

Description of the cluster.

labels : string​

Custom labels for the cluster as key:value pairs.

environment : Cluster.Environment​

Deployment environment of the MySQL cluster.

configSpec : ConfigSpec​

Configuration of the cluster.

databaseSpecs : DatabaseSpec​

Configuration of databases in the cluster.

userSpecs : UserSpec​

Configuration of database users in the cluster.

hostSpecs : HostSpec​

Configuration of hosts in the cluster.

networkId : string​

ID of the network to create the cluster in.

securityGroupIds : string​

List of security group IDs to apply to the cluster.

deletionProtection : bool​

This option prevents unintended deletion of the cluster.

hostGroupIds : string​

Host groups hosting VMs of the cluster.

ConfigSpec​

version : string​

Version of MySQL used in the cluster.

Possible values: 5.7, 8.0.

One of mysqlConfig​

Cluster-wide MySQL configuration.

  • mysqlConfig_5_7 : config.MysqlConfig5_7​

    Configuration for a MySQL 5.7 cluster.

  • mysqlConfig_8_0 : config.MysqlConfig8_0​

    Configuration for a MySQL 8.0 cluster.

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.

If the specific services need to access the cluster, then set the necessary values in this policy.

performanceDiagnostics : PerformanceDiagnostics​

Configuration of the performance diagnostics service.

backupRetainPeriodDays : google.protobuf.Int64Value​

Retention policy of automated backups.

DatabaseSpec​

name : string​

Name of the database.

UserSpec​

name : string​

Name of the user.

password : string​

Password of the user.

permissions : Permission​

Set of permissions granted to the user to access specific databases. One permission per database.

When a permission for a database is set, the user will have access to the database.

globalPermissions : GlobalPermission​

Set of global permissions to grant to the user.

connectionLimits : ConnectionLimits​

Set of user connection limits.

authenticationPlugin : AuthPlugin​

User authentication plugin.

HostSpec​

zoneId : string​

ID of the availability zone where the host resides.

To get a list of available zones, make the yandex.cloud.compute.v1.ZoneService.List request.

subnetId : string​

ID of the subnet to assign to the host.

This subnet should be a part of the cluster network (the network ID is specified in the ClusterService.CreateClusterRequest.network_id).

assignPublicIp : bool​

Option that enables public IP address for the host so that the host can be accessed from the internet.

After a host has been created, this setting cannot be changed. To remove an assigned public IP address, or to assign a public IP address to a host without one, recreate the host with the appropriate assign_public_ip value set.

Possible values:

  • false - don't assign a public IP address to the host.
  • true - assign a public IP address to the host.
replicationSource : string​

Host.name of the host to be used as the replication source (for cascading replication).

backupPriority : int64​

Host backup priority

priority : int64​

Host master promotion priority

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

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.

Permission​

Privilege​
  • PRIVILEGE_UNSPECIFIED

  • ALL_PRIVILEGES

    All privileges that can be made available to the user.

  • ALTER

    Altering tables.

  • ALTER_ROUTINE

    Altering stored routines and functions.

  • CREATE

    Creating tables or indexes.

  • CREATE_ROUTINE

    Creating stored routines.

  • CREATE_TEMPORARY_TABLES

    Creating temporary tables.

  • CREATE_VIEW

    Creating views.

  • DELETE

    Deleting tables.

  • DROP

    Removing tables or views.

  • EVENT

    Creating, altering, dropping, or displaying events for the Event Scheduler.

  • EXECUTE

    Executing stored routines.

  • INDEX

    Creating and removing indexes.

  • INSERT

    Inserting rows into the database.

  • LOCK_TABLES

    Using LOCK TABLES statement for tables available with SELECT privilege.

  • SELECT

    Selecting rows from tables. Some SELECT statements can be allowed without the SELECT privilege. All statements that read column values require the SELECT privilege. See MySQL documentation for details.

  • SHOW_VIEW

    Using the SHOW CREATE VIEW statement. Also needed for views used with EXPLAIN.

  • TRIGGER

    Creating, removing, executing, or displaying triggers for a table.

  • UPDATE

    Updating rows in the database.

  • REFERENCES

    Creation of a foreign key constraint for the parent table.

databaseName : string​

Name of the database that the permission grants access to.

roles : Privilege​

Roles granted to the user within the database.

See the documentation for details.

ConnectionLimits​

maxQuestionsPerHour : google.protobuf.Int64Value​

The maximum permitted number of user questions per hour.

maxUpdatesPerHour : google.protobuf.Int64Value​

The maximum permitted number of user updates per hour.

maxConnectionsPerHour : google.protobuf.Int64Value​

The maximum permitted number of simultaneous client connections per hour.

maxUserConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections permitted to any given MySQL user account.

Operation​

An Operation resource. For more information, see Operation.

id : string​

ID of the operation.

description : string​

Description of the operation. 0-256 characters long.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

createdBy : string​

ID of the user or service account who initiated the operation.

modifiedAt : google.protobuf.Timestamp​

The time when the Operation resource was last modified.

done : bool​

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

metadata : google.protobuf.Any​

Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.

One of result​

The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.

  • error : google.rpc.Status​

    The error result of the operation in case of failure or cancellation.

  • response : google.protobuf.Any​
    The normal response of the operation in case of success.

    If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.