blob: 4cb5076aa88eca173676f4ccb0ced26f40f77e9e (
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
|
/**
* Copyright (C) 2013 MongoDB 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/>.
*
* 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 GNU Affero General 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/field_ref.h"
#include "mongo/db/catalog/collection.h"
#include "mongo/s/chunk_version.h"
namespace mongo {
class UpdateLifecycle {
public:
virtual ~UpdateLifecycle() {}
/**
* Update the cached collection pointer that this lifecycle object uses.
*/
virtual void setCollection(Collection* collection) = 0;
/**
* Can the update continue?
*
* The (only) implementation will check the following:
* 1.) Collection still exists
* 2.) Shard version has not changed (indicating that the query/update is not valid
*/
virtual bool canContinue() const = 0;
/**
* Return a pointer to any indexes if there is a collection.
*/
virtual const IndexPathSet* getIndexKeys() const = 0;
/**
* Returns the shard keys as immutable fields
* Immutable fields in this case mean that they are required to exist, cannot change values
* and must not be multi-valued (in an array, or an array)
*/
virtual const std::vector<FieldRef*>* getImmutableFields() const = 0;
};
} // namespace mongo
|