blob: 294f371eef0239fd80dd90c01d8e3e45e0acd484 (
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
|
// collection_info_cache.h
/**
* 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/>.
*
* 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/query/plan_cache.h"
#include "mongo/db/query/query_settings.h"
#include "mongo/db/update_index_data.h"
namespace mongo {
class Collection;
/**
* this is for storing things that you want to cache about a single collection
* life cycle is managed for you from inside Collection
*/
class CollectionInfoCache {
public:
CollectionInfoCache( Collection* collection );
/*
* Resets entire cache state. Must be called under exclusive DB lock.
*/
void reset( OperationContext* txn );
//
// New Query Execution
//
/**
* Get the PlanCache for this collection.
*/
PlanCache* getPlanCache() const;
/**
* Get the QuerySettings for this collection.
*/
QuerySettings* getQuerySettings() const;
// -------------------
/* get set of index keys for this namespace. handy to quickly check if a given
field is indexed (Note it might be a secondary component of a compound index.)
*/
const UpdateIndexData& indexKeys( OperationContext* txn ) const;
// ---------------------
/**
* Called when an index is added to this collection.
*/
void addedIndex( OperationContext* txn ) { reset( txn ); }
void clearQueryCache();
/* you must notify the cache if you are doing writes, as query plan utility will change */
void notifyOfWriteOp();
private:
Collection* _collection; // not owned
// --- index keys cache
bool _keysComputed;
UpdateIndexData _indexedPaths;
// A cache for query plans.
std::unique_ptr<PlanCache> _planCache;
// Query settings.
// Includes index filters.
std::unique_ptr<QuerySettings> _querySettings;
/**
* Must be called under exclusive DB lock.
*/
void computeIndexKeys( OperationContext* txn );
void updatePlanCacheIndexEntries( OperationContext* txn );
};
} // namespace mongo
|