summaryrefslogtreecommitdiff
path: root/src/mongo/db/s/range_deletion_task.idl
diff options
context:
space:
mode:
Diffstat (limited to 'src/mongo/db/s/range_deletion_task.idl')
-rw-r--r--src/mongo/db/s/range_deletion_task.idl67
1 files changed, 67 insertions, 0 deletions
diff --git a/src/mongo/db/s/range_deletion_task.idl b/src/mongo/db/s/range_deletion_task.idl
new file mode 100644
index 00000000000..df008bedf34
--- /dev/null
+++ b/src/mongo/db/s/range_deletion_task.idl
@@ -0,0 +1,67 @@
+# 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.
+#
+
+# This file defines the format of documents stored in config.rangeDeletions. Each document
+# represents a chunk range to be deleted by the CollectionRangeDeleter.
+
+global:
+ cpp_namespace: "mongo"
+ cpp_includes : "mongo/s/catalog/type_chunk.h"
+
+imports:
+ - "mongo/idl/basic_types.idl"
+
+types:
+ chunkRangeType:
+ description: "Represents the bounds of a chunk range. See ChunkRange for the semantics of
+ the bounds."
+ bson_serialization_type: object
+ cpp_type: "mongo::ChunkRange"
+ serializer: "mongo::ChunkRange::toBSON"
+ deserializer: "mongo::ChunkRange::fromBSONThrowing"
+
+structs:
+ rangeDeletionTask:
+ description: "Represents a chunk range to be deleted by the range deleter."
+ strict: false
+ fields:
+ nss:
+ type: namespacestring
+ description: "The namespace of the collection that the chunk belongs to."
+ collectionUuid:
+ type: namespacestring
+ description: "The UUID of the collection that the chunk belongs to."
+ range:
+ type: chunkRangeType
+ description: "The range to be deleted. Needs to be optional since ChunkRange
+ doesn't have a default constructor."
+ optional: true
+ pending:
+ type: bool
+ description: "Flag that is present if the range is not yet ready for deletion"
+ optional: true