summaryrefslogtreecommitdiff
path: root/src/mongo/db/pipeline/document_source_merge.idl
blob: 1b79ad9e67348a9cfdd5ced1fce5356118d14276 (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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# 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.
#

# Document source merge stage IDL file

global:
    cpp_namespace: "mongo"
    cpp_includes:
        - "mongo/db/namespace_string.h"
        - "mongo/db/pipeline/document_source_merge_spec.h"

imports:
    - "mongo/db/pipeline/document_source_merge_modes.idl"
    - "mongo/idl/basic_types.idl"
    - "mongo/s/chunk_version.idl"

types:
    MergeTargetNss:
        bson_serialization_type: any
        description: Names of the target database and collection. The database name defaults
                     to the database of the aggregation.
        cpp_type: mongo::NamespaceString
        serializer: "::mongo::mergeTargetNssSerializeToBSON"
        deserializer: "::mongo::mergeTargetNssParseFromBSON"

    MergeOnFields:
        bson_serialization_type: any
        description: A single field or array of fields that identify a document for merge.
        cpp_type: std::vector<std::string>
        serializer: "::mongo::mergeOnFieldsSerializeToBSON"
        deserializer: "::mongo::mergeOnFieldsParseFromBSON"

    MergeWhenMatchedPolicy:
        bson_serialization_type: any
        description: Defines a policy strategy describing what to do when there is a matching
                     document in the target collection. Can hold a value from the
                     MergeWhenMatchedMode enum, or a custom pipeline definition.
        cpp_type: "::mongo::MergeWhenMatchedPolicy"
        serializer: "::mongo::mergeWhenMatchedSerializeToBSON"
        deserializer: "::mongo::mergeWhenMatchedParseFromBSON"

structs:
    NamespaceSpec:
        description: A document used to specify a namespace.
        strict: true
        fields:
            db:
                type: string
                optional: true
                description: The database field for this namespace.
            coll:
                type: string
                optional: true
                description: The collection field for this namespace.

    DocumentSourceMergeSpec:
        description: A document used to specify the $merge stage of an aggregation pipeline.
        strict: true
        fields:
            into:
                cpp_name: targetNss
                type: MergeTargetNss
                description: Target namespace to merge documents from an aggregation pipeline into.

            on:
                type: MergeOnFields
                optional: true
                description: A single field or array of fields that uniquely identify a document.

            let:
                type: object
                optional: true
                description: Specifies variables to use in the update pipeline defined in
                             MergeWhenMatchedPolicy when the 'whenMatched' mode is a custom
                             pipeline.

            whenMatched:
                type: MergeWhenMatchedPolicy
                optional: true
                description: The merge mode for the merge operation when source and target elements
                             match.

            whenNotMatched:
                type: MergeWhenNotMatchedMode
                optional: true
                description: The merge mode for the merge operation when source and target elements
                             do not match.

            targetCollectionVersion:
                type: ChunkVersion
                optional: true
                description: If set, the collection's ChunkVersion found when parsed on mongos. Can
                             be used to check if a collection has since been dropped and re-created,
                             in which case the shard key may have changed. This also can be used to
                             detect if the collection has gone from unsharded to sharded, and thus
                             now has a shard key.