summaryrefslogtreecommitdiff
path: root/src/mongo/db/update/object_replace_node.h
blob: d9a48eebec8f5d7874ad596f0ff8a40c1ecf100d (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

/**
 *    Copyright (C) 2018-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.
 */

#pragma once

#include "mongo/db/update/update_node.h"
#include "mongo/stdx/memory.h"

namespace mongo {

/**
 * An UpdateNode representing a replacement-style update.
 */
class ObjectReplaceNode : public UpdateNode {

public:
    /**
     * Initializes the node with the document to replace with. Any zero-valued timestamps (except
     * for the _id) are updated to the current time.
     */
    explicit ObjectReplaceNode(BSONObj val);

    std::unique_ptr<UpdateNode> clone() const final {
        return stdx::make_unique<ObjectReplaceNode>(*this);
    }

    void setCollator(const CollatorInterface* collator) final {}

    /**
     * Replaces the document that 'applyParams.element' belongs to with '_val'. If '_val' does not
     * contain an _id, the _id from the original document is preserved. 'applyParams.element' must
     * be the root of the document. 'applyParams.pathToCreate' and 'applyParams.pathTaken' must be
     * empty. Always returns a result stating that indexes are affected when the replacement is not
     * a noop.
     */
    ApplyResult apply(ApplyParams applyParams) const final;

private:
    // Object to replace with.
    BSONObj _val;

    // True if _val contains an _id.
    bool _containsId;
};

}  // namespace mongo