Skip to main content

Restore

Creates a new MongoDB 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​

RecoveryTargetSpec​

timestamp : int64​

Timestamp of the recovery target

backupId : string​

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

name : string​

Name of the new MongoDB cluster. The name must be unique within the folder. The name can't be changed after the MongoDB cluster is created.

description : string​

Description of the new MongoDB cluster.

labels : string​

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

environment : Cluster.Environment​

Deployment environment of the new MongoDB cluster.

configSpec : ConfigSpec​

Configuration for the MongoDB cluster to be created.

hostSpecs : HostSpec​

Configurations for MongoDB hosts that should be created for the cluster that is being created from the backup.

networkId : string​

ID of the network to create the MongoDB cluster in.

folderId : string​

Required. ID of the folder to create the MongoDB cluster in.

recoveryTargetSpec : RecoveryTargetSpec​

Specification of the moment to which the MongoDB cluster should be restored.

securityGroupIds : string​

User security groups

deletionProtection : bool​

Deletion Protection inhibits deletion of the cluster

maintenanceWindow : MaintenanceWindow​

Maintenance window settings for the cluster.

ConfigSpec​

version : string​

Version of MongoDB used in the cluster. Possible values: 3.6, 4.0, 4.2, 4.4, 4.4-enterprise, 5.0, 5.0-enterprise, 6.0, 6.0-enterprise.

featureCompatibilityVersion : string​

MongoDB feature compatibility version. See usage details in MongoDB documentation.

Possible values:

  • 3.6 - persist data compatibility for version 3.6. After setting this option the data will not be compatible with 3.4 or older.
  • 4.0 - persist data compatibility for version 4.0. After setting this option the data will not be compatible with 3.6 or older.
  • 4.2 - persist data compatibility for version 4.2. After setting this option the data will not be compatible with 4.0 or older.
  • 4.4 - persist data compatibility for version 4.4. After setting this option the data will not be compatible with 4.2 or older.
  • 5.0 - persist data compatibility for version 5.0. After setting this option the data will not be compatible with 4.4 or older.
  • 6.0 - persist data compatibility for version 6.0. After setting this option the data will not be compatible with 5.0 or older.

One of mongodbSpec​

  • mongodbSpec_3_6 : MongodbSpec3_6​

    Configuration and resource allocation for a MongoDB 3.6 cluster.

  • mongodbSpec_4_0 : MongodbSpec4_0​

    Configuration and resource allocation for a MongoDB 4.0 cluster.

  • mongodbSpec_4_2 : MongodbSpec4_2​

    Configuration and resource allocation for a MongoDB 4.2 cluster.

  • mongodbSpec_4_4 : MongodbSpec4_4​

    Configuration and resource allocation for a MongoDB 4.4 cluster.

  • mongodbSpec_5_0 : MongodbSpec5_0​

    Configuration and resource allocation for a MongoDB 5.0 cluster.

  • mongodbSpec_6_0 : MongodbSpec6_0​

    Configuration and resource allocation for a MongoDB 6.0 cluster.

  • mongodbSpec_4_4Enterprise : MongodbSpec4_4_enterprise​

    Configuration and resource allocation for a MongoDB 4.4 Enterprise cluster.

  • mongodbSpec_5_0Enterprise : MongodbSpec5_0_enterprise​

    Configuration and resource allocation for a MongoDB 5.0 Enterprise cluster.

  • mongodbSpec_6_0Enterprise : MongodbSpec6_0_enterprise​

    Configuration and resource allocation for a MongoDB 6.0 Enterprise cluster.

backupWindowStart : google.type.TimeOfDay​

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

backupRetainPeriodDays : google.protobuf.Int64Value​

Retain period of automatically created backup in days

performanceDiagnostics : PerformanceDiagnosticsConfig​

Performance Diagnosics configuration

access : Access​

Access policy to DB

mongodb : MongodbSpec​

Configuration and resource allocation for a MongoDB 7.0 Enterprise cluster.

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

RecoveryTargetSpec​

timestamp : int64​

Timestamp of the recovery target

MaintenanceWindow​

A maintenance window settings.

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.

MongodbSpec3_6​

Mongod​
config : config.MongodConfig3_6​

Configuration for mongod 3.6 hosts.

resources : Resources​

Resources allocated to each mongod host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoCfg​
config : config.MongoCfgConfig3_6​

Configuration for mongocfg 3.6 hosts.

resources : Resources​

Resources allocated to each mongocfg host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Mongos​
config : config.MongosConfig3_6​

Configuration for mongos 3.6 hosts.

resources : Resources​

Resources allocated to each mongos host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoInfra​
configMongos : config.MongosConfig3_6​

Configuration for mongoinfra 3.6 hosts.

configMongocfg : config.MongoCfgConfig3_6​
resources : Resources​

Resources allocated to each mongoinfra (mongos+mongocfg) host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

mongod : Mongod​

Configuration and resource allocation for mongod 3.6 hosts.

mongocfg : MongoCfg​

Configuration and resource allocation for mongocfg 3.6 hosts.

mongos : Mongos​

Configuration and resource allocation for mongos 3.6 hosts.

mongoinfra : MongoInfra​

Configuration and resource allocation for mongoinfra (mongos+mongocfg) 3.6 hosts.

MongodbSpec4_0​

Mongod​
config : config.MongodConfig4_0​

Configuration for mongod 4.0 hosts.

resources : Resources​

Resources allocated to each mongod host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoCfg​
config : config.MongoCfgConfig4_0​

Configuration for mongocfg 4.0 hosts.

resources : Resources​

Resources allocated to each mongocfg host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Mongos​
config : config.MongosConfig4_0​

Configuration for mongos 4.0 hosts.

resources : Resources​

Resources allocated to each mongos host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoInfra​
configMongos : config.MongosConfig4_0​

Configuration for mongoinfra 4.0 hosts.

configMongocfg : config.MongoCfgConfig4_0​
resources : Resources​

Resources allocated to each mongoinfra (mongos+mongocfg) host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

mongod : Mongod​

Configuration and resource allocation for mongod 4.0 hosts.

mongocfg : MongoCfg​

Configuration and resource allocation for mongocfg 4.0 hosts.

mongos : Mongos​

Configuration and resource allocation for mongos 4.0 hosts.

mongoinfra : MongoInfra​

Configuration and resource allocation for mongoinfra (mongos+mongocfg) 4.0 hosts.

MongodbSpec4_2​

Mongod​
config : config.MongodConfig4_2​

Configuration for mongod 4.2 hosts.

resources : Resources​

Resources allocated to each mongod host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoCfg​
config : config.MongoCfgConfig4_2​

Configuration for mongocfg 4.2 hosts.

resources : Resources​

Resources allocated to each mongocfg host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Mongos​
config : config.MongosConfig4_2​

Configuration for mongos 4.2 hosts.

resources : Resources​

Resources allocated to each mongos host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoInfra​
configMongos : config.MongosConfig4_2​

Configuration for mongoinfra 4.2 hosts.

configMongocfg : config.MongoCfgConfig4_2​
resources : Resources​

Resources allocated to each mongoinfra (mongos+mongocfg) host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

mongod : Mongod​

Configuration and resource allocation for mongod 4.2 hosts.

mongocfg : MongoCfg​

Configuration and resource allocation for mongocfg 4.2 hosts.

mongos : Mongos​

Configuration and resource allocation for mongos 4.2 hosts.

mongoinfra : MongoInfra​

Configuration and resource allocation for mongoinfra (mongos+mongocfg) 4.2 hosts.

MongodbSpec4_4​

Mongod​
config : config.MongodConfig4_4​

Configuration for mongod 4.4 hosts.

resources : Resources​

Resources allocated to each mongod host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoCfg​
config : config.MongoCfgConfig4_4​

Configuration for mongocfg 4.4 hosts.

resources : Resources​

Resources allocated to each mongocfg host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Mongos​
config : config.MongosConfig4_4​

Configuration for mongos 4.4 hosts.

resources : Resources​

Resources allocated to each mongos host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoInfra​
configMongos : config.MongosConfig4_4​

Configuration for mongoinfra 4.4 hosts.

configMongocfg : config.MongoCfgConfig4_4​
resources : Resources​

Resources allocated to each mongoinfra (mongos+mongocfg) host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

mongod : Mongod​

Configuration and resource allocation for mongod 4.4 hosts.

mongocfg : MongoCfg​

Configuration and resource allocation for mongocfg 4.4 hosts.

mongos : Mongos​

Configuration and resource allocation for mongos 4.4 hosts.

mongoinfra : MongoInfra​

Configuration and resource allocation for mongoinfra (mongos+mongocfg) 4.4 hosts.

MongodbSpec5_0​

Mongod​
config : config.MongodConfig5_0​

Configuration for mongod 5.0 hosts.

resources : Resources​

Resources allocated to each mongod host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoCfg​
config : config.MongoCfgConfig5_0​

Configuration for mongocfg 5.0 hosts.

resources : Resources​

Resources allocated to each mongocfg host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Mongos​
config : config.MongosConfig5_0​

Configuration for mongos 5.0 hosts.

resources : Resources​

Resources allocated to each mongos host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoInfra​
configMongos : config.MongosConfig5_0​

Configuration for mongoinfra 5.0 hosts.

configMongocfg : config.MongoCfgConfig5_0​
resources : Resources​

Resources allocated to each mongoinfra (mongos+mongocfg) host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

mongod : Mongod​

Configuration and resource allocation for mongod 5.0 hosts.

mongocfg : MongoCfg​

Configuration and resource allocation for mongocfg 5.0 hosts.

mongos : Mongos​

Configuration and resource allocation for mongos 5.0 hosts.

mongoinfra : MongoInfra​

Configuration and resource allocation for mongoinfra (mongos+mongocfg) 5.0 hosts.

MongodbSpec6_0​

Mongod​
config : config.MongodConfig6_0​

Configuration for mongod 6.0 hosts.

resources : Resources​

Resources allocated to each mongod host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoCfg​
config : config.MongoCfgConfig6_0​

Configuration for mongocfg 6.0 hosts.

resources : Resources​

Resources allocated to each mongocfg host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Mongos​
config : config.MongosConfig6_0​

Configuration for mongos 6.0 hosts.

resources : Resources​

Resources allocated to each mongos host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoInfra​
configMongos : config.MongosConfig6_0​

Configuration for mongoinfra 6.0 hosts.

configMongocfg : config.MongoCfgConfig6_0​
resources : Resources​

Resources allocated to each mongoinfra (mongos+mongocfg) host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

mongod : Mongod​

Configuration and resource allocation for mongod 6.0 hosts.

mongocfg : MongoCfg​

Configuration and resource allocation for mongocfg 6.0 hosts.

mongos : Mongos​

Configuration and resource allocation for mongos 6.0 hosts.

mongoinfra : MongoInfra​

Configuration and resource allocation for mongoinfra (mongos+mongocfg) 6.0 hosts.

MongodbSpec4_4_enterprise​

Mongod​
config : config.MongodConfig4_4_enterprise​

Configuration for mongod 4.4 hosts.

resources : Resources​

Resources allocated to each mongod host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoCfg​
config : config.MongoCfgConfig4_4_enterprise​

Configuration for mongocfg 4.4 hosts.

resources : Resources​

Resources allocated to each mongocfg host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Mongos​
config : config.MongosConfig4_4_enterprise​

Configuration for mongos 4.4 hosts.

resources : Resources​

Resources allocated to each mongos host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoInfra​
configMongos : config.MongosConfig4_4_enterprise​

Configuration for mongoinfra 4.4 hosts.

configMongocfg : config.MongoCfgConfig4_4_enterprise​
resources : Resources​

Resources allocated to each mongoinfra (mongos+mongocfg) host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

mongod : Mongod​

Configuration and resource allocation for mongod 4.4 hosts.

mongocfg : MongoCfg​

Configuration and resource allocation for mongocfg 4.4 hosts.

mongos : Mongos​

Configuration and resource allocation for mongos 4.4 hosts.

mongoinfra : MongoInfra​

Configuration and resource allocation for mongoinfra (mongos+mongocfg) 4.4 hosts.

MongodbSpec5_0_enterprise​

Mongod​
config : config.MongodConfig5_0_enterprise​

Configuration for mongod 5.0 hosts.

resources : Resources​

Resources allocated to each mongod host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoCfg​
config : config.MongoCfgConfig5_0_enterprise​

Configuration for mongocfg 5.0 hosts.

resources : Resources​

Resources allocated to each mongocfg host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Mongos​
config : config.MongosConfig5_0_enterprise​

Configuration for mongos 5.0 hosts.

resources : Resources​

Resources allocated to each mongos host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoInfra​
configMongos : config.MongosConfig5_0_enterprise​

Configuration for mongoinfra 5.0 hosts.

configMongocfg : config.MongoCfgConfig5_0_enterprise​
resources : Resources​

Resources allocated to each mongoinfra (mongos+mongocfg) host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

mongod : Mongod​

Configuration and resource allocation for mongod 5.0 hosts.

mongocfg : MongoCfg​

Configuration and resource allocation for mongocfg 5.0 hosts.

mongos : Mongos​

Configuration and resource allocation for mongos 5.0 hosts.

mongoinfra : MongoInfra​

Configuration and resource allocation for mongoinfra (mongos+mongocfg) 5.0 hosts.

MongodbSpec6_0_enterprise​

Mongod​
config : config.MongodConfig6_0_enterprise​

Configuration for mongod 6.0 hosts.

resources : Resources​

Resources allocated to each mongod host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoCfg​
config : config.MongoCfgConfig6_0_enterprise​

Configuration for mongocfg 6.0 hosts.

resources : Resources​

Resources allocated to each mongocfg host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Mongos​
config : config.MongosConfig6_0_enterprise​

Configuration for mongos 6.0 hosts.

resources : Resources​

Resources allocated to each mongos host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoInfra​
configMongos : config.MongosConfig6_0_enterprise​

Configuration for mongoinfra 6.0 hosts.

configMongocfg : config.MongoCfgConfig6_0_enterprise​
resources : Resources​

Resources allocated to each mongoinfra (mongos+mongocfg) host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

mongod : Mongod​

Configuration and resource allocation for mongod 6.0 hosts.

mongocfg : MongoCfg​

Configuration and resource allocation for mongocfg 6.0 hosts.

mongos : Mongos​

Configuration and resource allocation for mongos 6.0 hosts.

mongoinfra : MongoInfra​

Configuration and resource allocation for mongoinfra (mongos+mongocfg) 6.0 hosts.

PerformanceDiagnosticsConfig​

profilingEnabled : bool​

Access​

dataLens : bool​

Allow access for DataLens.

dataTransfer : bool​

Allow access for DataTransfer.

MongodbSpec​

Mongod​
config : config.MongodConfig​
resources : Resources​

Resources allocated to each mongod host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoCfg​
config : config.MongoCfgConfig​

Configuration for mongocfg hosts.

resources : Resources​

Resources allocated to each mongocfg host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Mongos​
config : config.MongosConfig​

Configuration for mongos hosts.

resources : Resources​

Resources allocated to each mongos host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoInfra​
configMongos : config.MongosConfig​

Configuration for mongoinfra hosts.

configMongocfg : config.MongoCfgConfig​
resources : Resources​

Resources allocated to each mongoinfra (mongos+mongocfg) host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

mongod : Mongod​

Configuration and resource allocation for mongod hosts.

mongocfg : MongoCfg​

Configuration and resource allocation for mongocfg hosts.

mongos : Mongos​

Configuration and resource allocation for mongos hosts.

mongoinfra : MongoInfra​

Configuration and resource allocation for mongoinfra (mongos+mongocfg) hosts.

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

MongodConfig3_6​

Configuration of a mongod daemon. Supported options are a limited subset of all options described in MongoDB documentation.

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

####### CollectionConfig {#wiredtiger_collectionconfig}

######## Compressor {#collectionconfig_compressor}

  • COMPRESSOR_UNSPECIFIED

  • NONE

    No compression.

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

blockCompressor : Compressor​

Default type of compression to use for collection data.

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

collectionConfig : CollectionConfig​

Collection configuration for WiredTiger.

Journal​
enabled : google.protobuf.BoolValue​

Whether the journal is enabled or disabled. Possible values:

  • true (default) - the journal is enabled.
  • false - the journal is disabled.
commitInterval : google.protobuf.Int64Value​

Commit interval between journal operations, in milliseconds. Default: 100.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

journal : Journal​

Configuration of the MongoDB journal.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][5].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode.

Network​
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongod will accept.

storage : Storage​

storage section of mongod configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongod configuration.

net : Network​

net section of mongod configuration.

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.

DiskSizeAutoscaling​

plannedUsageThreshold : google.protobuf.Int64Value​

Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent.

emergencyUsageThreshold : google.protobuf.Int64Value​

Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent.

diskSizeLimit : google.protobuf.Int64Value​

Limit on how large the storage for database instances can automatically grow, in bytes.

MongoCfgConfig3_6​

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data. This is the default profiler level.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][6].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Operation profiling level. For details, see MongoDB documentation.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode. For details see MongoDB documentation.

Network​
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of incoming connections.

storage : Storage​

storage section of mongocfg configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongocfg configuration.

net : Network​

net section of mongocfg configuration.

MongosConfig3_6​

Network​
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of incoming connections.

net : Network​

Network settings for mongos.

Mongod​

config : config.MongodConfig3_6​

Configuration for mongod 3.6 hosts.

resources : Resources​

Resources allocated to each mongod host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoCfg​

config : config.MongoCfgConfig3_6​

Configuration for mongocfg 3.6 hosts.

resources : Resources​

Resources allocated to each mongocfg host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Mongos​

config : config.MongosConfig3_6​

Configuration for mongos 3.6 hosts.

resources : Resources​

Resources allocated to each mongos host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoInfra​

configMongos : config.MongosConfig3_6​

Configuration for mongoinfra 3.6 hosts.

configMongocfg : config.MongoCfgConfig3_6​
resources : Resources​

Resources allocated to each mongoinfra (mongos+mongocfg) host.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongodConfig4_0​

Configuration of a mongod daemon. Supported options are a limited subset of all options described in MongoDB documentation.

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

####### CollectionConfig {#wiredtiger_collectionconfig}

######## Compressor {#collectionconfig_compressor}

  • COMPRESSOR_UNSPECIFIED

  • NONE

    No compression.

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

blockCompressor : Compressor​

Default type of compression to use for collection data.

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

collectionConfig : CollectionConfig​

Collection configuration for WiredTiger.

Journal​
commitInterval : google.protobuf.Int64Value​

Commit interval between journal operations, in milliseconds. Default: 100.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

journal : Journal​

Configuration of the MongoDB journal.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][7].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode.

Network​
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongod will accept.

storage : Storage​

storage section of mongod configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongod configuration.

net : Network​

net section of mongod configuration.

MongoCfgConfig4_0​

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][8].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode. For details see MongoDB documentation.

Network​
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongocfg will accept.

storage : Storage​

storage section of mongocfg configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongocfg configuration.

net : Network​

net section of mongocfg configuration.

MongosConfig4_0​

Network​
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongos will accept.

net : Network​

Network settings for mongos.

MongodConfig4_2​

Configuration of a mongod daemon. Supported options are a limited subset of all options described in MongoDB documentation.

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

####### CollectionConfig {#wiredtiger_collectionconfig}

######## Compressor {#collectionconfig_compressor}

  • COMPRESSOR_UNSPECIFIED

  • NONE

    No compression.

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

blockCompressor : Compressor​

Default type of compression to use for collection data.

####### IndexConfig {#wiredtiger_indexconfig}

prefixCompression : google.protobuf.BoolValue​

Enables or disables prefix compression

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

collectionConfig : CollectionConfig​

Collection configuration for WiredTiger.

indexConfig : IndexConfig​

Index configuration for WiredTiger

Journal​
commitInterval : google.protobuf.Int64Value​

Commit interval between journal operations, in milliseconds. Default: 100.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

journal : Journal​

Configuration of the MongoDB journal.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][9].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode.

slowOpSampleRate : google.protobuf.DoubleValue​

The fraction of slow operations that should be profiled or logged. operationProfiling.slowOpSampleRate accepts values between 0 and 1, inclusive.

Network​
Compression​

####### Compressor {#compression_compressor}

  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongod will accept.

compression : Compression​

Compression settings

SetParameter​
enableFlowControl : google.protobuf.BoolValue​

Enables or disables the mechanism that controls the rate at which the primary applies its writes with the goal of keeping the secondary members majority committed lag under a configurable maximum value.

storage : Storage​

storage section of mongod configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongod configuration.

net : Network​

net section of mongod configuration.

setParameter : SetParameter​

replication section of mongod configuration.

MongoCfgConfig4_2​

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][10].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode. For details see MongoDB documentation.

Network​
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongocfg will accept.

storage : Storage​

storage section of mongocfg configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongocfg configuration.

net : Network​

net section of mongocfg configuration.

MongosConfig4_2​

Network​
Compression​

####### Compressor {#compression_compressor}

  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongos will accept.

compression : Compression​

Compression settings

net : Network​

Network settings for mongos.

MongodConfig4_4​

Configuration of a mongod daemon. Supported options are a limited subset of all options described in MongoDB documentation.

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

####### CollectionConfig {#wiredtiger_collectionconfig}

######## Compressor {#collectionconfig_compressor}

  • COMPRESSOR_UNSPECIFIED

  • NONE

    No compression.

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

blockCompressor : Compressor​

Default type of compression to use for collection data.

####### IndexConfig {#wiredtiger_indexconfig}

prefixCompression : google.protobuf.BoolValue​

Enables or disables prefix compression

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

collectionConfig : CollectionConfig​

Collection configuration for WiredTiger.

indexConfig : IndexConfig​

Index configuration for WiredTiger

Journal​
commitInterval : google.protobuf.Int64Value​

Commit interval between journal operations, in milliseconds. Default: 100.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

journal : Journal​

Configuration of the MongoDB journal.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][11].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode.

slowOpSampleRate : google.protobuf.DoubleValue​

The fraction of slow operations that should be profiled or logged. operationProfiling.slowOpSampleRate accepts values between 0 and 1, inclusive.

Network​
Compression​

####### Compressor {#compression_compressor}

  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongod will accept.

compression : Compression​

Compression settings

SetParameter​
enableFlowControl : google.protobuf.BoolValue​

Enables or disables the mechanism that controls the rate at which the primary applies its writes with the goal of keeping the secondary members majority committed lag under a configurable maximum value.

storage : Storage​

storage section of mongod configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongod configuration.

net : Network​

net section of mongod configuration.

setParameter : SetParameter​

replication section of mongod configuration.

MongoCfgConfig4_4​

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][12].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode. For details see MongoDB documentation.

Network​
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongocfg will accept.

storage : Storage​

storage section of mongocfg configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongocfg configuration.

net : Network​

net section of mongocfg configuration.

MongosConfig4_4​

Network​
Compression​

####### Compressor {#compression_compressor}

  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongos will accept.

compression : Compression​

Compression settings

net : Network​

Network settings for mongos.

MongodConfig5_0​

Configuration of a mongod daemon. Supported options are a limited subset of all options described in MongoDB documentation.

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

####### CollectionConfig {#wiredtiger_collectionconfig}

######## Compressor {#collectionconfig_compressor}

  • COMPRESSOR_UNSPECIFIED

  • NONE

    No compression.

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

blockCompressor : Compressor​

Default type of compression to use for collection data.

####### IndexConfig {#wiredtiger_indexconfig}

prefixCompression : google.protobuf.BoolValue​

Enables or disables prefix compression

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

collectionConfig : CollectionConfig​

Collection configuration for WiredTiger.

indexConfig : IndexConfig​

Index configuration for WiredTiger

Journal​
commitInterval : google.protobuf.Int64Value​

Commit interval between journal operations, in milliseconds. Default: 100.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

journal : Journal​

Configuration of the MongoDB journal.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][13].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode.

slowOpSampleRate : google.protobuf.DoubleValue​

The fraction of slow operations that should be profiled or logged. operationProfiling.slowOpSampleRate accepts values between 0 and 1, inclusive.

Network​
Compression​

####### Compressor {#compression_compressor}

  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongod will accept.

compression : Compression​

Compression settings

SetParameter​
enableFlowControl : google.protobuf.BoolValue​

Enables or disables the mechanism that controls the rate at which the primary applies its writes with the goal of keeping the secondary members majority committed lag under a configurable maximum value.

minSnapshotHistoryWindowInSeconds : google.protobuf.Int64Value​

The minimum time window in seconds for which the storage engine keeps the snapshot history.

storage : Storage​

storage section of mongod configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongod configuration.

net : Network​

net section of mongod configuration.

setParameter : SetParameter​

SetParameter section of mongod configuration.

MongoCfgConfig5_0​

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][14].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode. For details see MongoDB documentation.

Network​
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongocfg will accept.

storage : Storage​

storage section of mongocfg configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongocfg configuration.

net : Network​

net section of mongocfg configuration.

MongosConfig5_0​

Network​
Compression​

####### Compressor {#compression_compressor}

  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongos will accept.

compression : Compression​

Compression settings

net : Network​

Network settings for mongos.

MongodConfig6_0​

Configuration of a mongod daemon. Supported options are a limited subset of all options described in MongoDB documentation.

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

####### CollectionConfig {#wiredtiger_collectionconfig}

######## Compressor {#collectionconfig_compressor}

  • COMPRESSOR_UNSPECIFIED

  • NONE

    No compression.

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

blockCompressor : Compressor​

Default type of compression to use for collection data.

####### IndexConfig {#wiredtiger_indexconfig}

prefixCompression : google.protobuf.BoolValue​

Enables or disables prefix compression

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

collectionConfig : CollectionConfig​

Collection configuration for WiredTiger.

indexConfig : IndexConfig​

Index configuration for WiredTiger

Journal​
commitInterval : google.protobuf.Int64Value​

Commit interval between journal operations, in milliseconds. Default: 100.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

journal : Journal​

Configuration of the MongoDB journal.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][15].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode.

slowOpSampleRate : google.protobuf.DoubleValue​

The fraction of slow operations that should be profiled or logged. operationProfiling.slowOpSampleRate accepts values between 0 and 1, inclusive.

Network​
Compression​

####### Compressor {#compression_compressor}

  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongod will accept.

compression : Compression​

Compression settings

SetParameter​
enableFlowControl : google.protobuf.BoolValue​

Enables or disables the mechanism that controls the rate at which the primary applies its writes with the goal of keeping the secondary members majority committed lag under a configurable maximum value.

minSnapshotHistoryWindowInSeconds : google.protobuf.Int64Value​

The minimum time window in seconds for which the storage engine keeps the snapshot history.

storage : Storage​

storage section of mongod configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongod configuration.

net : Network​

net section of mongod configuration.

setParameter : SetParameter​

SetParameter section of mongod configuration.

MongoCfgConfig6_0​

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][16].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode. For details see MongoDB documentation.

Network​
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongocfg will accept.

storage : Storage​

storage section of mongocfg configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongocfg configuration.

net : Network​

net section of mongocfg configuration.

MongosConfig6_0​

Network​
Compression​

####### Compressor {#compression_compressor}

  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongos will accept.

compression : Compression​

Compression settings

net : Network​

Network settings for mongos.

MongodConfig4_4_enterprise​

Configuration of a mongod daemon. Supported options are a limited subset of all options described in MongoDB documentation.

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

####### CollectionConfig {#wiredtiger_collectionconfig}

######## Compressor {#collectionconfig_compressor}

  • COMPRESSOR_UNSPECIFIED

  • NONE

    No compression.

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

blockCompressor : Compressor​

Default type of compression to use for collection data.

####### IndexConfig {#wiredtiger_indexconfig}

prefixCompression : google.protobuf.BoolValue​

Enables or disables prefix compression

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

collectionConfig : CollectionConfig​

Collection configuration for WiredTiger.

indexConfig : IndexConfig​

Index configuration for WiredTiger

Journal​
commitInterval : google.protobuf.Int64Value​

Commit interval between journal operations, in milliseconds. Default: 100.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

journal : Journal​

Configuration of the MongoDB journal.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][17].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode.

slowOpSampleRate : google.protobuf.DoubleValue​

The fraction of slow operations that should be profiled or logged. operationProfiling.slowOpSampleRate accepts values between 0 and 1, inclusive.

Network​
Compression​

####### Compressor {#compression_compressor}

  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongod will accept.

compression : Compression​

Compression settings

Security​
KMIP​
serverName : string​

KMIP server name

port : google.protobuf.Int64Value​

KMIP server port

serverCa : string​

KMIP Server CA

clientCertificate : string​

KMIP client certificate + private key (unencrypted)

keyIdentifier : string​

KMIP Key identifier (if any)

enableEncryption : google.protobuf.BoolValue​

If encryption at rest should be enabled or not

kmip : KMIP​

kmip section of mongod security config

AuditLog​
filter : string​

Audit filter

SetParameter​
auditAuthorizationSuccess : google.protobuf.BoolValue​

Enables the auditing of authorization successes

enableFlowControl : google.protobuf.BoolValue​

Enables or disables the mechanism that controls the rate at which the primary applies its writes with the goal of keeping the secondary members majority committed lag under a configurable maximum value.

storage : Storage​

storage section of mongod configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongod configuration.

net : Network​

net section of mongod configuration.

security : Security​

security section of mongod configuration.

auditLog : AuditLog​

AuditLog section of mongod configuration.

setParameter : SetParameter​

SetParameter section of mongod configuration.

MongoCfgConfig4_4_enterprise​

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][18].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode. For details see MongoDB documentation.

Network​
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongocfg will accept.

storage : Storage​

storage section of mongocfg configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongocfg configuration.

net : Network​

net section of mongocfg configuration.

MongosConfig4_4_enterprise​

Network​
Compression​

####### Compressor {#compression_compressor}

  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongos will accept.

compression : Compression​

Compression settings

net : Network​

Network settings for mongos.

MongodConfig5_0_enterprise​

Configuration of a mongod daemon. Supported options are a limited subset of all options described in MongoDB documentation.

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

####### CollectionConfig {#wiredtiger_collectionconfig}

######## Compressor {#collectionconfig_compressor}

  • COMPRESSOR_UNSPECIFIED

  • NONE

    No compression.

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

blockCompressor : Compressor​

Default type of compression to use for collection data.

####### IndexConfig {#wiredtiger_indexconfig}

prefixCompression : google.protobuf.BoolValue​

Enables or disables prefix compression

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

collectionConfig : CollectionConfig​

Collection configuration for WiredTiger.

indexConfig : IndexConfig​

Index configuration for WiredTiger

Journal​
commitInterval : google.protobuf.Int64Value​

Commit interval between journal operations, in milliseconds. Default: 100.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

journal : Journal​

Configuration of the MongoDB journal.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][19].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode.

slowOpSampleRate : google.protobuf.DoubleValue​

The fraction of slow operations that should be profiled or logged. operationProfiling.slowOpSampleRate accepts values between 0 and 1, inclusive.

Network​
Compression​

####### Compressor {#compression_compressor}

  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongod will accept.

compression : Compression​

Compression settings

Security​
KMIP​
serverName : string​

KMIP server name

port : google.protobuf.Int64Value​

KMIP server port

serverCa : string​

KMIP Server CA

clientCertificate : string​

KMIP client certificate + private key (unencrypted)

keyIdentifier : string​

KMIP Key identifier (if any)

enableEncryption : google.protobuf.BoolValue​

If encryption at rest should be enabled or not

kmip : KMIP​

kmip section of mongod security config

AuditLog​
filter : string​

Audit filter

runtimeConfiguration : google.protobuf.BoolValue​

Allows runtime configuration of audit filter and auditAuthorizationSuccess

SetParameter​
auditAuthorizationSuccess : google.protobuf.BoolValue​

Enables the auditing of authorization successes

enableFlowControl : google.protobuf.BoolValue​

Enables or disables the mechanism that controls the rate at which the primary applies its writes with the goal of keeping the secondary members majority committed lag under a configurable maximum value.

minSnapshotHistoryWindowInSeconds : google.protobuf.Int64Value​

The minimum time window in seconds for which the storage engine keeps the snapshot history.

storage : Storage​

storage section of mongod configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongod configuration.

net : Network​

net section of mongod configuration.

security : Security​

security section of mongod configuration.

auditLog : AuditLog​

AuditLog section of mongod configuration.

setParameter : SetParameter​

SetParameter section of mongod configuration.

MongoCfgConfig5_0_enterprise​

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][20].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode. For details see MongoDB documentation.

Network​
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongocfg will accept.

storage : Storage​

storage section of mongocfg configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongocfg configuration.

net : Network​

net section of mongocfg configuration.

MongosConfig5_0_enterprise​

Network​
Compression​

####### Compressor {#compression_compressor}

  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongos will accept.

compression : Compression​

Compression settings

net : Network​

Network settings for mongos.

MongodConfig6_0_enterprise​

Configuration of a mongod daemon. Supported options are a limited subset of all options described in MongoDB documentation.

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

####### CollectionConfig {#wiredtiger_collectionconfig}

######## Compressor {#collectionconfig_compressor}

  • COMPRESSOR_UNSPECIFIED

  • NONE

    No compression.

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

blockCompressor : Compressor​

Default type of compression to use for collection data.

####### IndexConfig {#wiredtiger_indexconfig}

prefixCompression : google.protobuf.BoolValue​

Enables or disables prefix compression

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

collectionConfig : CollectionConfig​

Collection configuration for WiredTiger.

indexConfig : IndexConfig​

Index configuration for WiredTiger

Journal​
commitInterval : google.protobuf.Int64Value​

Commit interval between journal operations, in milliseconds. Default: 100.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

journal : Journal​

Configuration of the MongoDB journal.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][21].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode.

slowOpSampleRate : google.protobuf.DoubleValue​

The fraction of slow operations that should be profiled or logged. operationProfiling.slowOpSampleRate accepts values between 0 and 1, inclusive.

Network​
Compression​

####### Compressor {#compression_compressor}

  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongod will accept.

compression : Compression​

Compression settings

Security​
KMIP​
serverName : string​

KMIP server name

port : google.protobuf.Int64Value​

KMIP server port

serverCa : string​

KMIP Server CA

clientCertificate : string​

KMIP client certificate + private key (unencrypted)

keyIdentifier : string​

KMIP Key identifier (if any)

enableEncryption : google.protobuf.BoolValue​

If encryption at rest should be enabled or not

kmip : KMIP​

kmip section of mongod security config

AuditLog​
filter : string​

Audit filter

runtimeConfiguration : google.protobuf.BoolValue​

Allows runtime configuration of audit filter and auditAuthorizationSuccess

SetParameter​
auditAuthorizationSuccess : google.protobuf.BoolValue​

Enables the auditing of authorization successes

enableFlowControl : google.protobuf.BoolValue​

Enables or disables the mechanism that controls the rate at which the primary applies its writes with the goal of keeping the secondary members majority committed lag under a configurable maximum value.

minSnapshotHistoryWindowInSeconds : google.protobuf.Int64Value​

The minimum time window in seconds for which the storage engine keeps the snapshot history.

storage : Storage​

storage section of mongod configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongod configuration.

net : Network​

net section of mongod configuration.

security : Security​

security section of mongod configuration.

auditLog : AuditLog​

AuditLog section of mongod configuration.

setParameter : SetParameter​

SetParameter section of mongod configuration.

MongoCfgConfig6_0_enterprise​

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][22].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode. For details see MongoDB documentation.

Network​
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongocfg will accept.

storage : Storage​

storage section of mongocfg configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongocfg configuration.

net : Network​

net section of mongocfg configuration.

MongosConfig6_0_enterprise​

Network​
Compression​

####### Compressor {#compression_compressor}

  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongos will accept.

compression : Compression​

Compression settings

net : Network​

Network settings for mongos.

MongodConfig​

Configuration of a mongod daemon. Supported options are a limited subset of all options described in MongoDB documentation.

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

####### CollectionConfig {#wiredtiger_collectionconfig}

######## Compressor {#collectionconfig_compressor}

  • COMPRESSOR_UNSPECIFIED

  • NONE

    No compression.

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

blockCompressor : Compressor​

Default type of compression to use for collection data.

####### IndexConfig {#wiredtiger_indexconfig}

prefixCompression : google.protobuf.BoolValue​

Enables or disables prefix compression

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

collectionConfig : CollectionConfig​

Collection configuration for WiredTiger.

indexConfig : IndexConfig​

Index configuration for WiredTiger

Journal​
commitInterval : google.protobuf.Int64Value​

Commit interval between journal operations, in milliseconds. Default: 100.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

journal : Journal​

Configuration of the MongoDB journal.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][23].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode.

slowOpSampleRate : google.protobuf.DoubleValue​

The fraction of slow operations that should be profiled or logged. operationProfiling.slowOpSampleRate accepts values between 0 and 1, inclusive.

Network​
Compression​

####### Compressor {#compression_compressor}

  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongod will accept.

compression : Compression​

Compression settings

Security​
KMIP​
serverName : string​

KMIP server name

port : google.protobuf.Int64Value​

KMIP server port

serverCa : string​

KMIP Server CA

clientCertificate : string​

KMIP client certificate + private key (unencrypted)

keyIdentifier : string​

KMIP Key identifier (if any)

enableEncryption : google.protobuf.BoolValue​

If encryption at rest should be enabled or not

kmip : KMIP​

kmip section of mongod security config

AuditLog​
filter : string​

Audit filter

runtimeConfiguration : google.protobuf.BoolValue​

Allows runtime configuration of audit filter and auditAuthorizationSuccess

SetParameter​
auditAuthorizationSuccess : google.protobuf.BoolValue​

Enables the auditing of authorization successes

enableFlowControl : google.protobuf.BoolValue​

Enables or disables the mechanism that controls the rate at which the primary applies its writes with the goal of keeping the secondary members majority committed lag under a configurable maximum value.

minSnapshotHistoryWindowInSeconds : google.protobuf.Int64Value​

The minimum time window in seconds for which the storage engine keeps the snapshot history.

storage : Storage​

storage section of mongod configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongod configuration.

net : Network​

net section of mongod configuration.

security : Security​

security section of mongod configuration.

auditLog : AuditLog​

AuditLog section of mongod configuration.

setParameter : SetParameter​

SetParameter section of mongod configuration.

MongoCfgConfig​

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][24].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode. For details see MongoDB documentation.

Network​
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongocfg will accept.

storage : Storage​

storage section of mongocfg configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongocfg configuration.

net : Network​

net section of mongocfg configuration.

MongosConfig​

Network​
Compression​

####### Compressor {#compression_compressor}

  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongos will accept.

compression : Compression​

Compression settings

net : Network​

Network settings for mongos.

EngineConfig​

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

CollectionConfig​

Compressor​
  • COMPRESSOR_UNSPECIFIED

  • NONE

    No compression.

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

blockCompressor : Compressor​

Default type of compression to use for collection data.

WiredTiger​

Configuration of WiredTiger storage engine.

EngineConfig​
cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

CollectionConfig​
Compressor​
  • COMPRESSOR_UNSPECIFIED

  • NONE

    No compression.

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

blockCompressor : Compressor​

Default type of compression to use for collection data.

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

collectionConfig : CollectionConfig​

Collection configuration for WiredTiger.

Journal​

enabled : google.protobuf.BoolValue​

Whether the journal is enabled or disabled. Possible values:

  • true (default) - the journal is enabled.
  • false - the journal is disabled.
commitInterval : google.protobuf.Int64Value​

Commit interval between journal operations, in milliseconds. Default: 100.

Storage​

WiredTiger​

Configuration of WiredTiger storage engine.

EngineConfig​
cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

CollectionConfig​

####### Compressor {#collectionconfig_compressor}

  • COMPRESSOR_UNSPECIFIED

  • NONE

    No compression.

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

blockCompressor : Compressor​

Default type of compression to use for collection data.

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

collectionConfig : CollectionConfig​

Collection configuration for WiredTiger.

Journal​
enabled : google.protobuf.BoolValue​

Whether the journal is enabled or disabled. Possible values:

  • true (default) - the journal is enabled.
  • false - the journal is disabled.
commitInterval : google.protobuf.Int64Value​

Commit interval between journal operations, in milliseconds. Default: 100.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

journal : Journal​

Configuration of the MongoDB journal.

OperationProfiling​

Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][25].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode.

Network​

maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongod will accept.

IndexConfig​

prefixCompression : google.protobuf.BoolValue​

Enables or disables prefix compression

Compression​

Compressor​
  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:

SetParameter​

enableFlowControl : google.protobuf.BoolValue​

Enables or disables the mechanism that controls the rate at which the primary applies its writes with the goal of keeping the secondary members majority committed lag under a configurable maximum value.

KMIP​

serverName : string​

KMIP server name

port : google.protobuf.Int64Value​

KMIP server port

serverCa : string​

KMIP Server CA

clientCertificate : string​

KMIP client certificate + private key (unencrypted)

keyIdentifier : string​

KMIP Key identifier (if any)

Security​

KMIP​
serverName : string​

KMIP server name

port : google.protobuf.Int64Value​

KMIP server port

serverCa : string​

KMIP Server CA

clientCertificate : string​

KMIP client certificate + private key (unencrypted)

keyIdentifier : string​

KMIP Key identifier (if any)

enableEncryption : google.protobuf.BoolValue​

If encryption at rest should be enabled or not

kmip : KMIP​

kmip section of mongod security config

AuditLog​

filter : string​

Audit filter

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.