SERVER-58684 Define data model for pre-image collections

2 files changed, 75 insertions, 0 deletions

diff --git a/src/mongo/db/pipeline/SConscript b/src/mongo/db/pipeline/SConscript
index d8ddcf85fc9..8d54554fd1e 100644
--- a/src/mongo/db/pipeline/SConscript
+++ b/src/mongo/db/pipeline/SConscript
@@ -15,6 +15,17 @@ env.SConscript(
 )
 
 env.Library(
+    target="change_stream_preimage",
+    source=[
+        "change_stream_preimage.idl",
+    ],
+    LIBDEPS=[
+        '$BUILD_DIR/mongo/base',
+        '$BUILD_DIR/mongo/idl/idl_parser',
+    ],
+)
+
+env.Library(
     target='aggregation',
     source=[
         'aggregation.cpp',
diff --git a/src/mongo/db/pipeline/change_stream_preimage.idl b/src/mongo/db/pipeline/change_stream_preimage.idl
new file mode 100644
index 00000000000..c60a285e103
--- /dev/null
+++ b/src/mongo/db/pipeline/change_stream_preimage.idl
@@ -0,0 +1,64 @@
+# Copyright (C) 2021-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.
+#
+
+# Pre-image IDL file.
+
+global:
+    cpp_namespace: "mongo"
+
+imports:
+    - "mongo/idl/basic_types.idl"
+
+structs:
+    ChangeStreamPreImageId:
+        description: Uniquely identifies a pre-image for a given node or replica set.
+        fields:
+            nsUUID:
+                description: UUID of the collection the pre-image of a document is from.
+                type: uuid
+            ts:
+                description: Timestamp of an oplog entry associated with this document.
+                type: timestamp
+            applyOpsIndex:
+                description: Index of an operation in an applyOps entry of a transaction.
+                             0 if the operation is not in a transaction or is the first operation in a transaction.
+                type: safeInt64
+                validator: { gte: 0 }
+    ChangeStreamPreImage:
+        description: A version of a document just before replace, update, or delete operation.
+        fields:
+            _id:
+                cpp_name: id
+                type: ChangeStreamPreImageId
+            operationTime:
+                description: Operation execution wall clock time. Used to determine if the
+                             pre-image expired.
+                type: date
+            preimage:
+                description: Pre-image of a document for an operation recorded to an oplog entry.
+                type: object