summaryrefslogtreecommitdiff
path: root/src/mongo/s/commands/refine_collection_shard_key.idl
diff options
context:
space:
mode:
Diffstat (limited to 'src/mongo/s/commands/refine_collection_shard_key.idl')
-rw-r--r--src/mongo/s/commands/refine_collection_shard_key.idl59
1 files changed, 59 insertions, 0 deletions
diff --git a/src/mongo/s/commands/refine_collection_shard_key.idl b/src/mongo/s/commands/refine_collection_shard_key.idl
new file mode 100644
index 00000000000..c77a44a1725
--- /dev/null
+++ b/src/mongo/s/commands/refine_collection_shard_key.idl
@@ -0,0 +1,59 @@
+# Copyright (C) 2019-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.
+#
+
+# refineCollectionShardKey IDL file
+
+global:
+ cpp_namespace: "mongo"
+
+imports:
+ - "mongo/idl/basic_types.idl"
+
+commands:
+ refineCollectionShardKey:
+ description: "The public refineCollectionShardKey command on mongos"
+ command_name: refineCollectionShardKey
+ strict: false
+ namespace: type
+ api_version: ""
+ type: namespacestring
+ fields:
+ key:
+ type: object
+ description: "The index specification document to use as the new shard key."
+ optional: false
+ collectionUUID:
+ type: uuid
+ description: "The expected UUID of the collection."
+ optional: true
+ 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