Skip to main content

Create

Creates an SQL Server cluster in the specified 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 SQL Server cluster in.

To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request.

name : string​

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

description : string​

Description of the SQL Server cluster.

labels : string​

Custom labels for the SQL Server cluster as key:value pairs. For example, "project":"mvp" or "source":"dictionary".

environment : Cluster.Environment​

Deployment environment of the SQL Server cluster.

configSpec : ConfigSpec​

Configurations of SQL Server and hosts of the cluster.

databaseSpecs : DatabaseSpec​

One or more configurations of databases to be created in the SQL Server cluster.

userSpecs : UserSpec​

One or more configurations of database users to be created in the SQL Server cluster.

hostSpecs : HostSpec​

One or more configurations of hosts to be created in the SQL Server cluster.

networkId : string​

ID of the network to create the SQL Server cluster in.

securityGroupIds : string​

User security groups.

deletionProtection : bool​

Determines whether the cluster is protected from being deleted.

sqlcollation : string​

Name of SQL Collation that cluster will be created with.

hostGroupIds : string​

Host groups hosting VMs of the cluster.

serviceAccountId : string​

ID of the service account used for access to Object Storage.

ConfigSpec​

version : string​

Version of SQL Server used in the cluster.

Possible values:

  • 2016sp2std,
  • 2016sp2ent,
  • 2017std,
  • 2017ent,
  • 2019std,
  • 2019ent.

One of sqlserverConfig​

Configuration of an SQL Server cluster.

  • sqlserverConfig_2016sp2std : config.SQLServerConfig2016sp2std​

    Configuration for an SQL Server 2016 SP2 Standard edition cluster.

  • sqlserverConfig_2016sp2ent : config.SQLServerConfig2016sp2ent​

    Configuration for an SQL Server 2016 SP2 Enterprise edition cluster.

  • sqlserverConfig_2017std : config.SQLServerConfig2017std​

    Configuration for an SQL Server 2017 Standard edition cluster.

  • sqlserverConfig_2017ent : config.SQLServerConfig2017ent​

    Configuration for an SQL Server 2017 Enterprise edition cluster.

  • sqlserverConfig_2019std : config.SQLServerConfig2019std​

    Configuration for an SQL Server 2019 Standard edition cluster.

  • sqlserverConfig_2019ent : config.SQLServerConfig2019ent​

    Configuration for an SQL Server 2019 Enterprise edition cluster.

resources : Resources​

Resources allocated to SQL Server hosts.

backupWindowStart : google.type.TimeOfDay​

Start time for the daily backup in UTC timezone.

access : Access​

Database access policy.

secondaryConnections : ClusterConfig.SecondaryConnections​

Secondary replicas connection mode

DatabaseSpec​

name : string​

Name of the database.

UserSpec​

name : string​

Name of the SQL Server user.

password : string​

Password of the SQL Server user.

permissions : Permission​

Set of permissions to grant to the user.

serverRoles : ServerRole​

Set of server roles.

HostSpec​

zoneId : string​

ID of the availability zone where the host resides.

To get the 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​

Determines whether the host gets 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 - do not assign a public IP to the host;
  • true - assign a public IP to the host.

SQLServerConfig2016sp2std​

SQL Server 2016 SP2 Standard edition supported configuration options are listed here.

Detailed description for each set of options is available in SQL Server documentation.

Any options that are not listed here are not supported.

maxDegreeOfParallelism : google.protobuf.Int64Value​

Limits the number of processors to use in parallel plan execution per task.

See in-depth description in SQL Server documentation.

costThresholdForParallelism : google.protobuf.Int64Value​

Specifies the threshold at which SQL Server creates and runs parallel plans for queries.

SQL Server creates and runs a parallel plan for a query only when the estimated cost to run a serial plan for the same query is higher than the value of the option.

See in-depth description in SQL Server documentation.

auditLevel : google.protobuf.Int64Value​

Describes how to configure login auditing to monitor SQL Server Database Engine login activity.

Possible values:

  • 0 - do not log login attempts;
  • 1 - log only failed login attempts;
  • 2 - log only successful login attempts (not recommended);
  • 3 - log all login attempts (not recommended).

See in-depth description in SQL Server documentation.

fillFactorPercent : google.protobuf.Int64Value​

Manages the fill factor server configuration option.

When an index is created or rebuilt, the fill factor determines the percentage of space on each index leaf-level page to be filled with data, reserving the rest as free space for future growth.

Values 0 and 100 mean full page usage (no space reserved).

See in-depth description in SQL Server documentation.

optimizeForAdHocWorkloads : google.protobuf.BoolValue​

Determines whether plans should be cached only after second execution.

Allows to avoid SQL cache bloat because of single-use plans.

See in-depth description in SQL Server documentation.

SQLServerConfig2016sp2ent​

SQL Server 2016 SP2 Enterprise edition supported configuration options are listed here.

Detailed description for each set of options is available in SQL Server documentation.

Any options that are not listed here are not supported.

maxDegreeOfParallelism : google.protobuf.Int64Value​

Limits the number of processors to use in parallel plan execution per task.

See in-depth description in SQL Server documentation.

costThresholdForParallelism : google.protobuf.Int64Value​

Specifies the threshold at which SQL Server creates and runs parallel plans for queries.

SQL Server creates and runs a parallel plan for a query only when the estimated cost to run a serial plan for the same query is higher than the value of the option.

See in-depth description in SQL Server documentation.

auditLevel : google.protobuf.Int64Value​

Describes how to configure login auditing to monitor SQL Server Database Engine login activity.

Possible values:

  • 0 - do not log login attempts;
  • 1 - log only failed login attempts;
  • 2 - log only successful login attempts (not recommended);
  • 3 - log all login attempts (not recommended).

See in-depth description in SQL Server documentation.

fillFactorPercent : google.protobuf.Int64Value​

Manages the fill factor server configuration option. When an index is created or rebuilt, the fill factor determines the percentage of space on each index leaf-level page to be filled with data, reserving the rest as free space for future growth.

Values 0 and 100 mean full page usage (no space reserved).

See in-depth description in SQL Server documentation.

optimizeForAdHocWorkloads : google.protobuf.BoolValue​

Determines whether plans should be cached only after second execution.

Allows to avoid SQL cache bloat because of single-use plans.

See in-depth description in SQL Server documentation.

SQLServerConfig2017std​

SQL Server 2017 Standard edition supported configuration options are listed here.

Detailed description for each set of options is available in SQL Server documentation.

Any options that are not listed here are not supported.

maxDegreeOfParallelism : google.protobuf.Int64Value​

Limits the number of processors to use in parallel plan execution per task.

See in-depth description in SQL Server documentation.

costThresholdForParallelism : google.protobuf.Int64Value​

Specifies the threshold at which SQL Server creates and runs parallel plans for queries.

SQL Server creates and runs a parallel plan for a query only when the estimated cost to run a serial plan for the same query is higher than the value of the option.

See in-depth description in SQL Server documentation.

auditLevel : google.protobuf.Int64Value​

Describes how to configure login auditing to monitor SQL Server Database Engine login activity.

Possible values:

  • 0 - do not log login attempts;
  • 1 - log only failed login attempts;
  • 2 - log only successful login attempts (not recommended);
  • 3 - log all login attempts (not recommended).

See in-depth description in SQL Server documentation.

fillFactorPercent : google.protobuf.Int64Value​

Manages the fill factor server configuration option.

When an index is created or rebuilt, the fill factor determines the percentage of space on each index leaf-level page to be filled with data, reserving the rest as free space for future growth.

Values 0 and 100 mean full page usage (no space reserved).

See in-depth description in SQL Server documentation.

optimizeForAdHocWorkloads : google.protobuf.BoolValue​

Determines whether plans should be cached only after second execution.

Allows to avoid SQL cache bloat because of single-use plans.

See in-depth description in SQL Server documentation.

SQLServerConfig2017ent​

SQL Server 2017 Enterprise edition supported configuration options are listed here.

Detailed description for each set of options is available in SQL Server documentation.

Any options that are not listed here are not supported.

maxDegreeOfParallelism : google.protobuf.Int64Value​

Limits the number of processors to use in parallel plan execution per task.

See in-depth description in SQL Server documentation.

costThresholdForParallelism : google.protobuf.Int64Value​

Specifies the threshold at which SQL Server creates and runs parallel plans for queries.

SQL Server creates and runs a parallel plan for a query only when the estimated cost to run a serial plan for the same query is higher than the value of the option.

See in-depth description in SQL Server documentation.

auditLevel : google.protobuf.Int64Value​

Describes how to configure login auditing to monitor SQL Server Database Engine login activity.

Possible values:

  • 0 - do not log login attempts;
  • 1 - log only failed login attempts;
  • 2 - log only successful login attempts (not recommended);
  • 3 - log all login attempts (not recommended).

See in-depth description in SQL Server documentation.

fillFactorPercent : google.protobuf.Int64Value​

Manages the fill factor server configuration option. When an index is created or rebuilt, the fill factor determines the percentage of space on each index leaf-level page to be filled with data, reserving the rest as free space for future growth.

Values 0 and 100 mean full page usage (no space reserved).

See in-depth description in SQL Server documentation.

optimizeForAdHocWorkloads : google.protobuf.BoolValue​

Determines whether plans should be cached only after second execution.

Allows to avoid SQL cache bloat because of single-use plans.

See in-depth description in SQL Server documentation.

SQLServerConfig2019std​

SQL Server 2019 Standard edition supported configuration options are listed here.

Detailed description for each set of options is available in SQL Server documentation.

Any options that are not listed here are not supported.

maxDegreeOfParallelism : google.protobuf.Int64Value​

Limits the number of processors to use in parallel plan execution per task.

See in-depth description in SQL Server documentation.

costThresholdForParallelism : google.protobuf.Int64Value​

Specifies the threshold at which SQL Server creates and runs parallel plans for queries.

SQL Server creates and runs a parallel plan for a query only when the estimated cost to run a serial plan for the same query is higher than the value of the option.

See in-depth description in SQL Server documentation.

auditLevel : google.protobuf.Int64Value​

Describes how to configure login auditing to monitor SQL Server Database Engine login activity.

Possible values:

  • 0 - do not log login attempts;
  • 1 - log only failed login attempts;
  • 2 - log only successful login attempts (not recommended);
  • 3 - log all login attempts (not recommended).

See in-depth description in SQL Server documentation.

fillFactorPercent : google.protobuf.Int64Value​

Manages the fill factor server configuration option.

When an index is created or rebuilt, the fill factor determines the percentage of space on each index leaf-level page to be filled with data, reserving the rest as free space for future growth.

Values 0 and 100 mean full page usage (no space reserved).

See in-depth description in SQL Server documentation.

optimizeForAdHocWorkloads : google.protobuf.BoolValue​

Determines whether plans should be cached only after second execution.

Allows to avoid SQL cache bloat because of single-use plans.

See in-depth description in SQL Server documentation.

SQLServerConfig2019ent​

SQL Server 2019 Enterprise edition supported configuration options are listed here.

Detailed description for each set of options is available in SQL Server documentation.

Any options that are not listed here are not supported.

maxDegreeOfParallelism : google.protobuf.Int64Value​

Limits the number of processors to use in parallel plan execution per task.

See in-depth description in SQL Server documentation.

costThresholdForParallelism : google.protobuf.Int64Value​

Specifies the threshold at which SQL Server creates and runs parallel plans for queries.

SQL Server creates and runs a parallel plan for a query only when the estimated cost to run a serial plan for the same query is higher than the value of the option.

See in-depth description in SQL Server documentation.

auditLevel : google.protobuf.Int64Value​

Describes how to configure login auditing to monitor SQL Server Database Engine login activity.

Possible values:

  • 0 - do not log login attempts;
  • 1 - log only failed login attempts;
  • 2 - log only successful login attempts (not recommended);
  • 3 - log all login attempts (not recommended).

See in-depth description in SQL Server documentation.

fillFactorPercent : google.protobuf.Int64Value​

Manages the fill factor server configuration option. When an index is created or rebuilt, the fill factor determines the percentage of space on each index leaf-level page to be filled with data, reserving the rest as free space for future growth.

Values 0 and 100 mean full page usage (no space reserved).

See in-depth description in SQL Server documentation.

optimizeForAdHocWorkloads : google.protobuf.BoolValue​

Determines whether plans should be cached only after second execution.

Allows to avoid SQL cache bloat because of single-use plans.

See in-depth description in SQL Server documentation.

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-hdd - network HDD drive;
  • network-ssd - network SSD drive;
  • local-ssd - local SSD storage.

Access​

dataLens : bool​

Allows access for DataLens.

webSql : bool​

Allows access for Web SQL.

Permission​

Role​

Role granted to the user within the database.

  • ROLE_UNSPECIFIED

    Role granted to the user within the database.

  • DB_OWNER

    Members of this fixed database role can perform all configuration and maintenance activities on a database and can also drop a database in SQL Server.

  • DB_SECURITYADMIN

    Members of this fixed database role can modify role membership for custom roles only and manage permissions. They can potentially elevate their privileges and their actions should be monitored.

  • DB_ACCESSADMIN

    Members of this fixed database role can add or remove access to a database for Windows logins, Windows groups, and SQL Server logins.

  • DB_BACKUPOPERATOR

    Members of this fixed database role can back up the database.

  • DB_DDLADMIN

    Members of this fixed database role can run any Data Definition Language (DDL) command in a database.

  • DB_DATAWRITER

    Members of this fixed database role can add, delete, or change data in all user tables.

  • DB_DATAREADER

    Members of this fixed database role can read all data from all user tables.

  • DB_DENYDATAWRITER

    Members of this fixed database role cannot add, modify, or delete any data in the user tables within a database. A denial has a higher priority than a grant, so you can use this role to quickly restrict one's privileges without explicitly revoking permissions or roles.

  • DB_DENYDATAREADER

    Members of this fixed database role cannot read any data in the user tables within a database. A denial has a higher priority than a grant, so you can use this role to quickly restrict one's privileges without explicitly revoking permissions or roles.

databaseName : string​

Name of the database the permission grants access to.

roles : Role​

Roles granted to the user within the database.

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.