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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
/**
* 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/catalog/collection_info_cache.h"
#include "mongo/db/collection_index_usage_tracker.h"
#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;
class IndexDescriptor;
class OperationContext;
/**
* this is for storing things that you want to cache about a single collection
* life cycle is managed for you from inside Collection
*/
class CollectionInfoCacheImpl : public CollectionInfoCache {
public:
explicit CollectionInfoCacheImpl(Collection* collection, const NamespaceString& ns);
~CollectionInfoCacheImpl();
/**
* 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& getIndexKeys(OperationContext* opCtx) const;
/**
* Returns cached index usage statistics for this collection. The map returned will contain
* entry for each index in the collection along with both a usage counter and a timestamp
* representing the date/time the counter is valid from.
*
* Note for performance that this method returns a copy of a StringMap.
*/
CollectionIndexUsageMap getIndexUsageStats() const;
/**
* Builds internal cache state based on the current state of the Collection's IndexCatalog
*/
void init(OperationContext* opCtx);
/**
* Register a newly-created index with the cache. Must be called whenever an index is
* built on the associated collection.
*
* Must be called under exclusive collection lock.
*/
void addedIndex(OperationContext* opCtx, const IndexDescriptor* desc);
/**
* Deregister a newly-dropped index with the cache. Must be called whenever an index is
* dropped on the associated collection.
*
* Must be called under exclusive collection lock.
*/
void droppedIndex(OperationContext* opCtx, StringData indexName);
/**
* Removes all cached query plans.
*/
void clearQueryCache();
/**
* Signal to the cache that a query operation has completed. 'indexesUsed' should list the
* set of indexes used by the winning plan, if any.
*/
void notifyOfQuery(OperationContext* opCtx, const std::set<std::string>& indexesUsed);
void setNs(NamespaceString ns) override;
private:
void computeIndexKeys(OperationContext* opCtx);
void updatePlanCacheIndexEntries(OperationContext* opCtx);
/**
* Rebuilds cached information that is dependent on index composition. Must be called
* when index composition changes.
*/
void rebuildIndexData(OperationContext* opCtx);
Collection* _collection; // not owned
NamespaceString _ns;
// --- 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;
// Tracks index usage statistics for this collection.
CollectionIndexUsageTracker _indexUsageTracker;
bool _hasTTLIndex = false;
};
} // namespace mongo
|
