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) 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/catalog/collection.h"
#include "mongo/db/query/canonical_query.h"
namespace mongo {
/**
* Returns 'true' if 'sortPattern' contains any sort pattern parts that share a common prefix, false
* otherwise.
*/
bool sortPatternHasPartsWithCommonPrefix(const SortPattern& sortPattern);
/**
* Returns 'true' if 'query' on the given 'collection' can be answered using a special IDHACK plan.
*/
bool isIdHackEligibleQuery(const CollectionPtr& collection, const CanonicalQuery& query);
/**
* Checks if the given query can be executed with the SBE engine based on the canonical query.
*
* This method determines whether the query may be compatible with SBE based only on high-level
* information from the canonical query, before query planning has taken place (such as ineligible
* expressions or collections).
*
* If this method returns true, query planning should be done, followed by another layer of
* validation to make sure the query plan can be executed with SBE. If it returns false, SBE query
* planning can be short-circuited as it is already known that the query is ineligible for SBE.
*/
bool isQuerySbeCompatible(const CollectionPtr* collection, const CanonicalQuery* cq);
/**
* Checks if the given query can be executed with the SBE engine based on the query solution.
*
* This method determines whether the query may be compatible with SBE based on the query solution
* (such as ineligible plan stages). It should be used in conjunction with the higher level
* isQuerySbeCompatible() check to ensure that all aspects of the query are validated for
* compatibility.
*/
bool isQueryPlanSbeCompatible(const QuerySolution* root);
} // namespace mongo
|
