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

# shardCollection IDL File

global:
    cpp_namespace: "mongo"

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

structs:
    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: "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
            implicitlyCreateIndex:
                description: "Creates an index on the shard key pattern if the collection is empty."
                type: optionalBool
            enforceUniquenessCheck:
                description: >-
                    Controls whether this command verifies that any unique indexes are prefixed by the shard
                    key pattern if unique is true. If true then it will verify and if false then it won't.
                type: optionalBool

    ConfigsvrShardCollectionRequest:
        description: "The request format of the internal shardCollection command on the config server"
        strict: false
        fields:
            _configsvrShardCollection:
                type: namespacestring
                description: "The namespace of the collection to shard in the form <database>.<collection>."
                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
            initialSplitPoints:
                type: array<object>
                description: "A specific set of points to create initial splits at, currently used only by mapReduce"
                optional: true
            collation:
                type: object
                description: "The collation to use for the shard key index."
                optional: true
            getUUIDfromPrimaryShard:
                type: bool
                description: "Whether the collection should be created on the primary shard. This should only be false when used in mapReduce."
                default: true
            implicitlyCreateIndex:
                description: "Creates an index on the shard key pattern if the collection is empty."
                type: optionalBool
            enforceUniquenessCheck:
                description: >-
                    Controls whether this command verifies that any unique indexes are prefixed by the shard
                    key pattern if unique is true. If true then it will verify and if false then it won't.
                type: optionalBool

    ConfigsvrShardCollectionResponse:
        description: "The response format of the internal shardCollection command on the config server"
        strict: false
        fields:
            collectionsharded:
                type: string
                description: "The name of the collection that just got sharded."
            collectionUUID:
                type: uuid
                description: "The UUID of the collection that just got sharded."
                optional: true

    ShardsvrShardCollection:
        description: "The internal shardCollection command on a primary shard"
        strict: false
        fields:
            _shardsvrShardCollection:
                type: namespacestring
                description: "The namespace of the collection to shard in the form <database>.<collection>."
                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
            initialSplitPoints:
                type: array<object>
                description: "A specific set of points to create initial splits at, currently used only by mapReduce"
                optional: true
            collation:
                type: object
                description: "The collation to use for the shard key index."
                optional: true
            getUUIDfromPrimaryShard:
                type: bool
                description: "Whether the collection should be created on the primary shard. This should only be false when used in mapReduce."
                default: true
            implicitlyCreateIndex:
                description: "Creates an index on the shard key pattern if the collection is empty."
                type: optionalBool
            enforceUniquenessCheck:
                description: >-
                    Controls whether this command verifies that any unique indexes are prefixed by the shard
                    key pattern if unique is true. If true then it will verify and if false then it won't.
                type: optionalBool

    ShardsvrShardCollectionResponse:
        description: "The response format of the internal shardCollection command on the primary shard"
        strict: false
        fields:
            collectionsharded:
                type: string
                description: "The name of the collection that just got sharded."
            collectionUUID:
                type: uuid
                description: "The UUID of the collection that just got sharded."
                optional: true

    ConfigsvrCommitShardCollection:
        description: "The internal commitShardCollection command on the config server"
        strict: false
        fields:
            _configsvrCommitShardCollection:
                type: string
                description: "The name of the collection that just got sharded."
            collectionUUID:
                type: uuid
                description: "The UUID of the collection that just got sharded."
                optional: true
