blob: 9a80f0ae0f2cbcef212d3627c0b707844868d5c1 (
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
|
/**
* Copyright (C) 2013 10gen Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#pragma once
#include <boost/scoped_ptr.hpp>
#include <string>
#include "mongo/base/disallow_copying.h"
#include "mongo/bson/mutable/element.h"
#include "mongo/db/field_ref.h"
#include "mongo/db/jsobj.h"
#include "mongo/db/ops/modifier_interface.h"
namespace mongo {
class LogBuilder;
/**
* The $rename modifier moves the field from source to the destination to perform
* the rename.
*
* Example: {$rename: {<source>:<dest>}} where both <source/dest> are field names
* Start with {a:1} and applying a {$rename: {"a":"b"} } produces {b:1}
**/
class ModifierRename : public ModifierInterface {
MONGO_DISALLOW_COPYING(ModifierRename);
public:
ModifierRename();
virtual ~ModifierRename();
/**
* We will check that the to/from are valid paths; in prepare more validation is done
*/
virtual Status init(const BSONElement& modExpr);
/**
* In prepare we will ensure that all restrictions are met:
* -- The 'from' field exists, and is valid, else it is a no-op
* -- The 'to' field is valid as a destination
* -- The 'to' field is not on the path (or the same path) as the 'from' field
* -- Neither 'to' nor 'from' have an array ancestor
*/
virtual Status prepare(mutablebson::Element root,
const StringData& matchedField,
ExecInfo* execInfo);
/**
* We will transform the document by first making sure that the 'to' element
* is empty before moving the 'from' element there.
*/
virtual Status apply() const;
/**
* For the oplog entry we will generate an $unset on the 'from' field, and $set for
* the 'to' field. If no 'from' element is found then function will return immediately.
*/
virtual Status log(LogBuilder* logBuilder) const;
private:
// The source and destination fields
FieldRef _fromFieldRef;
FieldRef _toFieldRef;
// The state carried over from prepare for apply/log
struct PreparedState;
scoped_ptr<PreparedState> _preparedState;
};
} // namespace mongo
|
