# Copyright (C) 2018-present MongoDB, Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the Server Side Public License, version 1,
# as published by MongoDB, Inc.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# Server Side Public License for more details.
#
# You should have received a copy of the Server Side Public License
# along with this program. If not, see
# <http://www.mongodb.com/licensing/server-side-public-license>.
#
# As a special exception, the copyright holders give permission to link the
# code of portions of this program with the OpenSSL library under certain
# conditions as described in each individual source file and distribute
# linked combinations including the program with the OpenSSL library. You
# must comply with the Server Side Public License in all respects for
# all of the code used other than as permitted herein. If you modify file(s)
# with this exception, you may extend this exception to your version of the
# file(s), but you are not obligated to do so. If you do not wish to do so,
# delete this exception statement from your version. If you delete this
# exception statement from all source files in the program, then also delete
# it in the license file.
#

global:
  cpp_namespace: "mongo"

imports:
  - "mongo/idl/basic_types.idl"

server_parameters:
    KillSessionsMaxConcurrency:
        description: >-
            The maximum number of hosts to for killSessionsRemote to kill sessions on at the same time.
        set_at: startup
        cpp_vartype: int
        cpp_varname: gKillSessionsMaxConcurrency
        default: 100

    KillSessionsPerHostTimeoutMS:
        description: >-
            The maximum number of miliseconds for killSessionsRemote to wait for host to respond.
        set_at: startup
        cpp_vartype: int
        cpp_varname: gKillSessionsPerHostTimeoutMS
        default: 60000

structs:
  ClusterMulticast:
    description: "A struct representing the 'multicast' command's arguments"
    strict: false
    fields:
      multicast: object
      $db:
        type: string
        cpp_name: db
      concurrency:
        type: int
        optional: true
      timeout:
        type: int
        optional: true

  ShardCollection:
    description: "The public shardCollection command on mongos"
    strict: false
    fields:
      shardCollection:
        type: namespacestring
        description: "The namespace of the collection to shard in the form <database>.<collection>."
        optional: true
      shardcollection:
          type: namespacestring
          description: "Same as the previous field, but refers to the deprecated version of this command's name"
          optional: true
      key:
        type: object
        description: "The index specification document to use as the shard key."
      unique:
        type: bool
        description: "Whether the shard key index should enforce a unique constraint"
        default: false
      numInitialChunks:
        type: safeInt64
        description: "The number of chunks to create initially when sharding an empty collection with a hashed shard key."
        default: 0
      presplitHashedZones:
        type: bool
        description: "True if the chunks should be pre-split based on the existing zones when sharding a collection with hashed shard key"
        default: false
      collation:
        type: object
        description: "The collation to use for the shard key index."
        optional: true