1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
# Copyright (C) 2017 MongoDB Inc.
#
# This program is free software: you can redistribute it and/or modify
# 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
collation:
type: object
description: "The collation to use for the shard key index."
optional: true
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
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
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
|
