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
|
/**
* Copyright (C) 2021-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/query/canonical_query.h"
#include "mongo/db/query/classic_plan_cache.h"
#include "mongo/db/query/collection_query_info.h"
#include "mongo/db/query/sbe_plan_cache.h"
namespace mongo {
namespace plan_cache_detail {
/**
* Serializes indexability discriminators, appending them to keyBuilder. This function is used
* during the computation of a query's plan cache key to ensure that two queries with different
* index eligibilities will have different cache keys.
*/
void encodeIndexability(const MatchExpression* tree,
const PlanCacheIndexabilityState& indexabilityState,
StringBuilder* keyBuilder);
/**
* A dispatch tag for the factory functions below.
*/
template <typename KeyType>
struct PlanCacheKeyTag {};
/**
* Creates a key for the classic plan cache from the canonical query and a single collection.
*/
PlanCacheKey make(const CanonicalQuery& query,
const CollectionPtr& collection,
PlanCacheKeyTag<PlanCacheKey> tag);
/**
* Similar to above, but for the SBE plan cache key.
*/
sbe::PlanCacheKey make(const CanonicalQuery& query,
const CollectionPtr& collection,
PlanCacheKeyTag<sbe::PlanCacheKey> tag);
} // namespace plan_cache_detail
namespace plan_cache_key_factory {
/**
* A factory helper to make a plan cache key of the given type.
*
* Note: when requesting an SBE plan cache key, callers must have already established the shard
* version on the collection (if this is a sharded cluster).
*/
template <typename Key>
Key make(const CanonicalQuery& query, const CollectionPtr& collection) {
return plan_cache_detail::make(query, collection, plan_cache_detail::PlanCacheKeyTag<Key>{});
}
/**
* Similar to above, a factory helper to make a SBE plan cache key, but used for agg queries that
* might involve multiple collections.
*/
sbe::PlanCacheKey make(const CanonicalQuery& query, const MultipleCollectionAccessor& collections);
} // namespace plan_cache_key_factory
} // namespace mongo
|
