blob: 1a375e16942b8654488aace9f45fe4045d065324 (
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
|
/**
* 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 "mongo/base/status.h"
namespace mongo {
class FieldRef;
namespace fieldchecker {
/**
* Returns OK if all the below conditions on 'field' are valid:
* + Non-empty
* + Not the _id field (or a subfield of the _id field, such as _id.x.y)
* + Does not start or end with a '.'
* + Does not start with a $
* Otherwise returns a code indicating cause of failure.
*/
Status isUpdatable(const FieldRef& field);
/**
* Same behavior of isUpdatable but allowing update fields to start with '$'. This
* supports $unset on legacy fields.
*/
Status isUpdatableLegacy(const FieldRef& field);
/**
* Returns true, the position 'pos' of the first $-sign if present in 'fieldRef', and
* how many other $-signs were found in 'count'. Otherwise return false.
*
* Note:
* isPositional assumes that the field is updatable. Call isUpdatable() above to
* verify.
*/
bool isPositional(const FieldRef& fieldRef, size_t* pos, size_t* count = NULL);
} // namespace fieldchecker
} // namespace mongo
|
