Skip to main content

EnableSharding

Enables sharding for the cluster: creates 3 mongoinfra (or 3 mongocfg and 2 mongos) hosts that would support adding and using shards in the cluster.

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

const EnableClusterShardingRequest =
  cloudApi.mdb.mongodb_cluster_service.EnableClusterShardingRequest;
const Host_Type = cloudApi.mdb.mongodb_cluster.Host_Type;

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

  const operation = await client.enableSharding(
    EnableClusterShardingRequest.fromPartial({
      clusterId: "clusterId",
      // mongocfg: {
      // resources: {
      // resourcePresetId: "resourcePresetId",
      // diskSize: 0,
      // diskTypeId: "diskTypeId"
      // }
      // },
      // mongos: {
      // resources: {
      // resourcePresetId: "resourcePresetId",
      // diskSize: 0,
      // diskTypeId: "diskTypeId"
      // }
      // },
      // hostSpecs: [{
      // zoneId: "zoneId",
      // subnetId: "subnetId",
      // assignPublicIp: true,
      // type: Host_Type.MONGOD,
      // shardName: "shardName",
      // hidden: {
      // value: true
      // },
      // secondaryDelaySecs: {
      // value: 0
      // },
      // priority: {
      // value: 0
      // },
      // tags: {"key": "tags"}
      // }],
      // mongoinfra: {
      // resources: {
      // resourcePresetId: "resourcePresetId",
      // diskSize: 0,
      // diskTypeId: "diskTypeId"
      // }
      // }
    })
  );
  await waitForOperation(operation, session);
})();

EnableClusterShardingRequest​

MongoCfg​

resources : Resources​

Resources for mongocfg hosts.

Mongos​

resources : Resources​

Resources for mongos hosts.

MongoInfra​

resources : Resources​

Resources for mongoinfra (mongos+mongocfg) hosts.

clusterId : string​

ID of the MongoDB cluster to enable sharding for.

mongocfg : MongoCfg​

mongocfg specification for sharding.

mongos : Mongos​

mongos specification for sharding.

hostSpecs : HostSpec​

Configurations for mongos and mongocfg hosts.

mongoinfra : MongoInfra​

mongos specification for sharding.

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, in bytes.

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.

MongoCfg​

resources : Resources​

Resources for mongocfg hosts.

Mongos​

resources : Resources​

Resources for mongos hosts.

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 network ID is set in the Cluster.network_id field.

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.
type : Host.Type​

Type of the host to be deployed.

shardName : string​

Name of the shard that the host belongs to.

hidden : google.protobuf.BoolValue​

Is host hidden in replSet

secondaryDelaySecs : google.protobuf.Int64Value​

The number of seconds "behind" the primary that this replica set member should "lag"

priority : google.protobuf.DoubleValue​

Priority of host for the election in replSet

tags : string​

Host tags

MongoInfra​

resources : Resources​

Resources for mongoinfra (mongos+mongocfg) hosts.

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.