1 files changed, 46 insertions, 0 deletions
diff --git a/src/mongo/db/pipeline/resume_token.idl b/src/mongo/db/pipeline/resume_token.idl
new file mode 100644
index 00000000000..ee20d401dd0
--- /dev/null
+++ b/src/mongo/db/pipeline/resume_token.idl
@@ -0,0 +1,46 @@
+# Copyright (C) 2023-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"
+    cpp_includes:
+        - "mongo/db/pipeline/resume_token.h"
+
+imports:
+    - "mongo/idl/basic_types.idl"
+
+types:
+    # A resume token is an opaque document we return to the user that contains all the information
+    # needed to resume a stream where they left off.  It also provides the ordering of streams
+    # from multiple shards.
+    resumeToken:
+        bson_serialization_type: object
+        description: An object representing a resume token for a change stream
+        cpp_type: ResumeToken
+        serializer: ResumeToken::toBSON
+        deserializer: ResumeToken::parse