Skip to main content

Restore

Creates a new MySQL cluster using the specified backup.

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

const ClickhouseConfig_LogLevel =
  cloudApi.mdb.clickhouse_config_clickhouse.ClickhouseConfig_LogLevel;
const Cluster = cloudApi.dataproc.cluster.Cluster;
const Cluster_Environment = cloudApi.mdb.clickhouse_cluster.Cluster_Environment;
const Compression_Method =
  cloudApi.mdb.clickhouse_config_clickhouse.Compression_Method;
const Host_Type = cloudApi.mdb.clickhouse_cluster.Host_Type;
const Kafka_AutoOffsetReset =
  cloudApi.mdb.clickhouse_config_clickhouse.Kafka_AutoOffsetReset;
const Kafka_Debug = cloudApi.mdb.clickhouse_config_clickhouse.Kafka_Debug;
const Kafka_SaslMechanism =
  cloudApi.mdb.clickhouse_config_clickhouse.Kafka_SaslMechanism;
const Kafka_SecurityProtocol =
  cloudApi.mdb.clickhouse_config_clickhouse.Kafka_SecurityProtocol;
const Layout_Type = cloudApi.mdb.clickhouse_config_clickhouse.Layout_Type;
const PostgresqlSource_SslMode =
  cloudApi.mdb.clickhouse_config_clickhouse.PostgresqlSource_SslMode;
const RestoreClusterRequest =
  cloudApi.mdb.clickhouse_cluster_service.RestoreClusterRequest;

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

  const operation = await client.restore(
    RestoreClusterRequest.fromPartial({
      backupId: "backupId",
      // additionalBackupIds: ["additionalBackupIds"],
      name: "name",
      // description: "description",
      // labels: {"key": "labels"},
      environment: Cluster_Environment.PRODUCTION,
      configSpec: {
        // version: "version",
        // clickhouse: {
        // config: {
        // logLevel: ClickhouseConfig_LogLevel.TRACE,
        // mergeTree: {
        // replicatedDeduplicationWindow: {
        // value: 0
        // },
        // replicatedDeduplicationWindowSeconds: {
        // value: 0
        // },
        // partsToDelayInsert: {
        // value: 0
        // },
        // partsToThrowInsert: {
        // value: 0
        // },
        // inactivePartsToDelayInsert: {
        // value: 0
        // },
        // inactivePartsToThrowInsert: {
        // value: 0
        // },
        // maxReplicatedMergesInQueue: {
        // value: 0
        // },
        // numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge: {
        // value: 0
        // },
        // maxBytesToMergeAtMinSpaceInPool: {
        // value: 0
        // },
        // maxBytesToMergeAtMaxSpaceInPool: {
        // value: 0
        // },
        // minBytesForWidePart: {
        // value: 0
        // },
        // minRowsForWidePart: {
        // value: 0
        // },
        // ttlOnlyDropParts: {
        // value: true
        // },
        // allowRemoteFsZeroCopyReplication: {
        // value: true
        // },
        // mergeWithTtlTimeout: {
        // value: 0
        // },
        // mergeWithRecompressionTtlTimeout: {
        // value: 0
        // },
        // maxPartsInTotal: {
        // value: 0
        // },
        // maxNumberOfMergesWithTtlInPool: {
        // value: 0
        // },
        // cleanupDelayPeriod: {
        // value: 0
        // },
        // numberOfFreeEntriesInPoolToExecuteMutation: {
        // value: 0
        // },
        // maxAvgPartSizeForTooManyParts: {
        // value: 0
        // },
        // minAgeToForceMergeSeconds: {
        // value: 0
        // },
        // minAgeToForceMergeOnPartitionOnly: {
        // value: true
        // },
        // mergeSelectingSleepMs: {
        // value: 0
        // },
        // mergeMaxBlockSize: {
        // value: 0
        // },
        // checkSampleColumnIsCorrect: {
        // value: true
        // },
        // maxMergeSelectingSleepMs: {
        // value: 0
        // },
        // maxCleanupDelayPeriod: {
        // value: 0
        // }
        // },
        // compression: [{
        // method: Compression_Method.LZ4,
        // minPartSize: 0,
        // minPartSizeRatio: 0,
        // level: {
        // value: 0
        // }
        // }],
        // dictionaries: [{
        // name: "name",
        // structure: {
        // id: {
        // name: "name"
        // },
        // key: {
        // attributes: [{
        // name: "name",
        // type: "type",
        // nullValue: "nullValue",
        // expression: "expression",
        // hierarchical: true,
        // injective: true
        // }]
        // },
        // rangeMin: {
        // name: "name",
        // type: "type",
        // nullValue: "nullValue",
        // expression: "expression",
        // hierarchical: true,
        // injective: true
        // },
        // rangeMax: {
        // name: "name",
        // type: "type",
        // nullValue: "nullValue",
        // expression: "expression",
        // hierarchical: true,
        // injective: true
        // },
        // attributes: [{
        // name: "name",
        // type: "type",
        // nullValue: "nullValue",
        // expression: "expression",
        // hierarchical: true,
        // injective: true
        // }]
        // },
        // layout: {
        // type: Layout_Type.FLAT,
        // sizeInCells: 0,
        // maxArraySize: 0
        // },
        // fixedLifetime: 0,
        // lifetimeRange: {
        // min: 0,
        // max: 0
        // },
        // httpSource: {
        // url: "url",
        // format: "format",
        // headers: [{
        // name: "name",
        // value: "value"
        // }]
        // },
        // mysqlSource: {
        // db: "db",
        // table: "table",
        // port: 0,
        // user: "user",
        // password: "password",
        // replicas: [{
        // host: "host",
        // priority: 0,
        // port: 0,
        // user: "user",
        // password: "password"
        // }],
        // where: "where",
        // invalidateQuery: "invalidateQuery",
        // closeConnection: {
        // value: true
        // },
        // shareConnection: {
        // value: true
        // }
        // },
        // clickhouseSource: {
        // db: "db",
        // table: "table",
        // host: "host",
        // port: 0,
        // user: "user",
        // password: "password",
        // where: "where",
        // secure: {
        // value: true
        // }
        // },
        // mongodbSource: {
        // db: "db",
        // collection: "collection",
        // host: "host",
        // port: 0,
        // user: "user",
        // password: "password",
        // options: "options"
        // },
        // postgresqlSource: {
        // db: "db",
        // table: "table",
        // hosts: ["hosts"],
        // port: 0,
        // user: "user",
        // password: "password",
        // invalidateQuery: "invalidateQuery",
        // sslMode: PostgresqlSource_SslMode.DISABLE
        // }
        // }],
        // graphiteRollup: [{
        // name: "name",
        // patterns: [{
        // regexp: "regexp",
        // function: "function",
        // retention: [{
        // age: 0,
        // precision: 0
        // }]
        // }],
        // pathColumnName: "pathColumnName",
        // timeColumnName: "timeColumnName",
        // valueColumnName: "valueColumnName",
        // versionColumnName: "versionColumnName"
        // }],
        // kafka: {
        // securityProtocol: Kafka_SecurityProtocol.SECURITY_PROTOCOL_PLAINTEXT,
        // saslMechanism: Kafka_SaslMechanism.SASL_MECHANISM_GSSAPI,
        // saslUsername: "saslUsername",
        // saslPassword: "saslPassword",
        // enableSslCertificateVerification: {
        // value: true
        // },
        // maxPollIntervalMs: {
        // value: 0
        // },
        // sessionTimeoutMs: {
        // value: 0
        // },
        // debug: Kafka_Debug.DEBUG_GENERIC,
        // autoOffsetReset: Kafka_AutoOffsetReset.AUTO_OFFSET_RESET_SMALLEST
        // },
        // kafkaTopics: [{
        // name: "name",
        // settings: {
        // securityProtocol: Kafka_SecurityProtocol.SECURITY_PROTOCOL_PLAINTEXT,
        // saslMechanism: Kafka_SaslMechanism.SASL_MECHANISM_GSSAPI,
        // saslUsername: "saslUsername",
        // saslPassword: "saslPassword",
        // enableSslCertificateVerification: {
        // value: true
        // },
        // maxPollIntervalMs: {
        // value: 0
        // },
        // sessionTimeoutMs: {
        // value: 0
        // },
        // debug: Kafka_Debug.DEBUG_GENERIC,
        // autoOffsetReset: Kafka_AutoOffsetReset.AUTO_OFFSET_RESET_SMALLEST
        // }
        // }],
        // rabbitmq: {
        // username: "username",
        // password: "password",
        // vhost: "vhost"
        // },
        // maxConnections: {
        // value: 0
        // },
        // maxConcurrentQueries: {
        // value: 0
        // },
        // keepAliveTimeout: {
        // value: 0
        // },
        // uncompressedCacheSize: {
        // value: 0
        // },
        // markCacheSize: {
        // value: 0
        // },
        // maxTableSizeToDrop: {
        // value: 0
        // },
        // maxPartitionSizeToDrop: {
        // value: 0
        // },
        // builtinDictionariesReloadInterval: {
        // value: 0
        // },
        // timezone: "timezone",
        // geobaseEnabled: {
        // value: true
        // },
        // geobaseUri: "geobaseUri",
        // queryLogRetentionSize: {
        // value: 0
        // },
        // queryLogRetentionTime: {
        // value: 0
        // },
        // queryThreadLogEnabled: {
        // value: true
        // },
        // queryThreadLogRetentionSize: {
        // value: 0
        // },
        // queryThreadLogRetentionTime: {
        // value: 0
        // },
        // partLogRetentionSize: {
        // value: 0
        // },
        // partLogRetentionTime: {
        // value: 0
        // },
        // metricLogEnabled: {
        // value: true
        // },
        // metricLogRetentionSize: {
        // value: 0
        // },
        // metricLogRetentionTime: {
        // value: 0
        // },
        // traceLogEnabled: {
        // value: true
        // },
        // traceLogRetentionSize: {
        // value: 0
        // },
        // traceLogRetentionTime: {
        // value: 0
        // },
        // textLogEnabled: {
        // value: true
        // },
        // textLogRetentionSize: {
        // value: 0
        // },
        // textLogRetentionTime: {
        // value: 0
        // },
        // textLogLevel: ClickhouseConfig_LogLevel.TRACE,
        // opentelemetrySpanLogEnabled: {
        // value: true
        // },
        // opentelemetrySpanLogRetentionSize: {
        // value: 0
        // },
        // opentelemetrySpanLogRetentionTime: {
        // value: 0
        // },
        // queryViewsLogEnabled: {
        // value: true
        // },
        // queryViewsLogRetentionSize: {
        // value: 0
        // },
        // queryViewsLogRetentionTime: {
        // value: 0
        // },
        // asynchronousMetricLogEnabled: {
        // value: true
        // },
        // asynchronousMetricLogRetentionSize: {
        // value: 0
        // },
        // asynchronousMetricLogRetentionTime: {
        // value: 0
        // },
        // sessionLogEnabled: {
        // value: true
        // },
        // sessionLogRetentionSize: {
        // value: 0
        // },
        // sessionLogRetentionTime: {
        // value: 0
        // },
        // zookeeperLogEnabled: {
        // value: true
        // },
        // zookeeperLogRetentionSize: {
        // value: 0
        // },
        // zookeeperLogRetentionTime: {
        // value: 0
        // },
        // asynchronousInsertLogEnabled: {
        // value: true
        // },
        // asynchronousInsertLogRetentionSize: {
        // value: 0
        // },
        // asynchronousInsertLogRetentionTime: {
        // value: 0
        // },
        // backgroundPoolSize: {
        // value: 0
        // },
        // backgroundMergesMutationsConcurrencyRatio: {
        // value: 0
        // },
        // backgroundSchedulePoolSize: {
        // value: 0
        // },
        // backgroundFetchesPoolSize: {
        // value: 0
        // },
        // backgroundMovePoolSize: {
        // value: 0
        // },
        // backgroundDistributedSchedulePoolSize: {
        // value: 0
        // },
        // backgroundBufferFlushSchedulePoolSize: {
        // value: 0
        // },
        // backgroundMessageBrokerSchedulePoolSize: {
        // value: 0
        // },
        // backgroundCommonPoolSize: {
        // value: 0
        // },
        // defaultDatabase: {
        // value: "value"
        // },
        // totalMemoryProfilerStep: {
        // value: 0
        // },
        // totalMemoryTrackerSampleProbability: {
        // value: 0
        // },
        // queryMaskingRules: [{
        // name: "name",
        // regexp: "regexp",
        // replace: "replace"
        // }],
        // dictionariesLazyLoad: {
        // value: true
        // },
        // queryCache: {
        // maxSizeInBytes: {
        // value: 0
        // },
        // maxEntries: {
        // value: 0
        // },
        // maxEntrySizeInBytes: {
        // value: 0
        // },
        // maxEntrySizeInRows: {
        // value: 0
        // }
        // }
        // },
        // resources: {
        // resourcePresetId: "resourcePresetId",
        // diskSize: 0,
        // diskTypeId: "diskTypeId"
        // }
        // },
        // zookeeper: {
        // resources: {
        // resourcePresetId: "resourcePresetId",
        // diskSize: 0,
        // diskTypeId: "diskTypeId"
        // }
        // },
        // backupWindowStart: {
        // hours: 0,
        // minutes: 0,
        // seconds: 0,
        // nanos: 0
        // },
        // access: {
        // dataLens: true,
        // webSql: true,
        // metrika: true,
        // serverless: true,
        // dataTransfer: true,
        // yandexQuery: true
        // },
        // cloudStorage: {
        // enabled: true,
        // moveFactor: {
        // value: 0
        // },
        // dataCacheEnabled: {
        // value: true
        // },
        // dataCacheMaxSize: {
        // value: 0
        // },
        // preferNotToMerge: {
        // value: true
        // }
        // },
        // sqlDatabaseManagement: {
        // value: true
        // },
        // sqlUserManagement: {
        // value: true
        // },
        // adminPassword: "adminPassword",
        // embeddedKeeper: {
        // value: true
        // },
        // backupRetainPeriodDays: {
        // value: 0
        // }
      },
      // hostSpecs: [{
      // zoneId: "zoneId",
      // type: Host_Type.CLICKHOUSE,
      // subnetId: "subnetId",
      // assignPublicIp: true,
      // shardName: "shardName"
      // }],
      networkId: "networkId",
      // folderId: "folderId",
      // serviceAccountId: "serviceAccountId",
      // securityGroupIds: ["securityGroupIds"],
      // deletionProtection: true
    })
  );
  const finishedOp = await waitForOperation(operation, session);

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

RestoreClusterRequest​

backupId : string​

ID of the backup to create a cluster from. To get the backup ID, use a ClusterService.ListBackups request.

time : google.protobuf.Timestamp​

Timestamp of the moment to which the MySQL cluster should be restored.

name : string​

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

description : string​

Description of the new MySQL cluster.

labels : string​

Custom labels for the MySQL cluster as key:value pairs. Maximum 64 per resource. For example, "project": "mvp" or "source": "dictionary".

environment : Cluster.Environment​

Deployment environment of the new MySQL cluster.

configSpec : ConfigSpec​

Configuration for the MySQL cluster to be created.

hostSpecs : HostSpec​

Configurations for MySQL hosts that should be added to the cluster that is being created from the backup.

networkId : string​

ID of the network to create the MySQL cluster in.

ConfigSpec​

version : string​

Version of MySQL used in the cluster. Possible values:

  • 5.7

One of mysqlConfig​

Configuration of a MySQL cluster.

  • mysqlConfig_5_7 : config.MysqlConfig5_7​

    Configuration for a MySQL 5.7 cluster.

resources : Resources​

Resources allocated to MySQL hosts.

backupWindowStart : google.type.TimeOfDay​

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

HostSpec​

zoneId : string​

ID of the availability zone where the host resides. To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request.

subnetId : string​

ID of the subnet that the host should belong to. This subnet should be a part of the network that the cluster belongs to. The ID of the network is set in the field Cluster.network_id.

assignPublicIp : bool​

Whether the host should get a public IP address on creation.

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

Possible values:

  • false - don't assign a public IP to the host.
  • true - the host should have a public IP address.

MysqlConfig5_7​

Options and structure of MysqlConfig5_7 reflects MySQL 5.7 configuration file

innodbBufferPoolSize : google.protobuf.Int64Value​

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

For details, see MySQL documentation for the parameter.

maxConnections : google.protobuf.Int64Value​

The maximum permitted number of simultaneous client connections.

For details, see MySQL documentation for the variable.

longQueryTime : google.protobuf.DoubleValue​

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

For details, see MySQL documentation for the variable.

Resources​

resourcePresetId : string​

ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.

diskSize : int64​

Volume of the storage available to a host.

diskTypeId : string​

Type of the storage environment for the host. Possible values:

  • network-ssd - network SSD drive,
  • local-ssd - local SSD storage.

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.