summaryrefslogtreecommitdiff
path: root/src/mongo/db/pipeline/change_stream_preimage.idl
blob: 4d3fa3e3b73c386e2763b497dc11f0f8bf9efe39 (plain)
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
# 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"

server_parameters:
    expiredChangeStreamPreImageRemovalJobSleepSecs:
        description: >-
            Specifies the period within which expired pre-image removal job is running.
        set_at: [ startup ]
        cpp_vartype: AtomicWord<int>
        cpp_varname: gExpiredChangeStreamPreImageRemovalJobSleepSecs
        validator:
            gte: 1
        default: 10

    batchedExpiredChangeStreamPreImageRemoval:
        description: >-
            Specifies if expired pre-images are removed in batches rather than document-by-document.
        set_at: [ startup, runtime ]
        cpp_vartype: AtomicWord<bool>
        cpp_varname: gBatchedExpiredChangeStreamPreImageRemoval
        default: true

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