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
|
/**
* Copyright (C) 2022-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/exec/sbe/stages/stages.h"
#include "mongo/db/pipeline/pipeline.h"
#include "mongo/db/query/canonical_query.h"
#include "mongo/db/query/multiple_collection_accessor.h"
#include "mongo/db/query/optimizer/defs.h"
#include "mongo/db/query/optimizer/explain.h"
#include "mongo/db/query/plan_executor.h"
#include "mongo/db/query/plan_executor_factory.h"
#include "mongo/db/query/sbe_stage_builder.h"
namespace mongo {
// Arguments to create a PlanExecutor, except for the CanonicalQuery.
struct ExecParams {
OperationContext* opCtx;
std::unique_ptr<QuerySolution> solution;
std::pair<std::unique_ptr<sbe::PlanStage>, stage_builder::PlanStageData> root;
std::unique_ptr<optimizer::AbstractABTPrinter> optimizerData;
size_t plannerOptions;
NamespaceString nss;
std::unique_ptr<PlanYieldPolicySBE> yieldPolicy;
bool planIsFromCache;
bool generatedByBonsai;
};
/**
* Returns hints from the cascades query knobs.
*/
optimizer::QueryHints getHintsFromQueryKnobs();
/**
* Returns a the arguments to create a PlanExecutor for the given Pipeline, except the
* CanonicalQuery which must be provided by the caller.
*
* The CanonicalQuery parameter allows for code reuse between functions in this file and should not
* be set by callers.
*/
boost::optional<ExecParams> getSBEExecutorViaCascadesOptimizer(
OperationContext* opCtx,
boost::intrusive_ptr<ExpressionContext> expCtx,
const NamespaceString& nss,
const CollectionPtr& collection,
optimizer::QueryHints queryHints,
const boost::optional<BSONObj>& indexHint,
const Pipeline* pipeline,
const CanonicalQuery* = nullptr);
/**
* Returns a PlanExecutor for the given CanonicalQuery.
*/
boost::optional<ExecParams> getSBEExecutorViaCascadesOptimizer(const CollectionPtr& collection,
optimizer::QueryHints queryHints,
const CanonicalQuery* query);
/**
* Constructs a plan executor with the given CanonicalQuery and ExecParams.
*/
StatusWith<std::unique_ptr<PlanExecutor, PlanExecutor::Deleter>> makeExecFromParams(
std::unique_ptr<CanonicalQuery> cq, ExecParams execArgs);
} // namespace mongo
|
