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
145
146
147
148
149
150
|
/**
* Copyright (C) 2020-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/util/duration.h"
#include <queue>
#include "mongo/db/exec/sbe/stages/stages.h"
#include "mongo/db/exec/working_set.h"
#include "mongo/db/pipeline/pipeline.h"
#include "mongo/db/pipeline/plan_executor_pipeline.h"
#include "mongo/db/query/cqf_get_executor.h"
#include "mongo/db/query/optimizer/explain_interface.h"
#include "mongo/db/query/plan_executor.h"
#include "mongo/db/query/plan_yield_policy_sbe.h"
#include "mongo/db/query/query_solution.h"
#include "mongo/db/query/sbe_plan_ranker.h"
#include "mongo/db/query/sbe_runtime_planner.h"
#include "mongo/db/query/sbe_stage_builder.h"
#include "mongo/db/shard_role.h"
namespace mongo::plan_executor_factory {
/**
* Creates a new 'PlanExecutor' capable of executing the query 'cq', or a non-OK status if a
* plan executor could not be created.
*
* Passing YIELD_AUTO will construct a yielding executor which may yield in the following
* circumstances:
* - During plan selection inside the call to make().
* - On any call to getNext().
* - On any call to restoreState().
* - While executing the plan inside executePlan().
*
* If auto-yielding is enabled, a yield during make() may result in the PlanExecutorImpl being
* killed, in which case this method will return a non-OK status.
*
* The caller must provide either a non-null value for 'collection, or a non-empty 'nss'
* NamespaceString but not both.
*
* Note that the PlanExecutor will use the ExpressionContext associated with 'cq' and the
* OperationContext associated with that ExpressionContext.
*/
StatusWith<std::unique_ptr<PlanExecutor, PlanExecutor::Deleter>> make(
std::unique_ptr<CanonicalQuery> cq,
std::unique_ptr<WorkingSet> ws,
std::unique_ptr<PlanStage> rt,
VariantCollectionPtrOrAcquisition collection,
PlanYieldPolicy::YieldPolicy yieldPolicy,
size_t plannerOptions,
NamespaceString nss = NamespaceString(),
std::unique_ptr<QuerySolution> qs = nullptr);
/**
* This overload is provided for executors that do not need a CanonicalQuery. For example, the
* outer plan executor for an aggregate command does not have a CanonicalQuery.
*
* Note that the PlanExecutor will use the OperationContext associated with the 'expCtx'
* ExpressionContext.
*/
StatusWith<std::unique_ptr<PlanExecutor, PlanExecutor::Deleter>> make(
const boost::intrusive_ptr<ExpressionContext>& expCtx,
std::unique_ptr<WorkingSet> ws,
std::unique_ptr<PlanStage> rt,
VariantCollectionPtrOrAcquisition collection,
PlanYieldPolicy::YieldPolicy yieldPolicy,
size_t plannerOptions,
NamespaceString nss = NamespaceString(),
std::unique_ptr<QuerySolution> qs = nullptr);
StatusWith<std::unique_ptr<PlanExecutor, PlanExecutor::Deleter>> make(
OperationContext* opCtx,
std::unique_ptr<WorkingSet> ws,
std::unique_ptr<PlanStage> rt,
std::unique_ptr<QuerySolution> qs,
std::unique_ptr<CanonicalQuery> cq,
const boost::intrusive_ptr<ExpressionContext>& expCtx,
VariantCollectionPtrOrAcquisition collection,
size_t plannerOptions,
NamespaceString nss,
PlanYieldPolicy::YieldPolicy yieldPolicy);
/**
* Constructs a PlanExecutor for the query 'cq' which will execute the SBE plan 'root'. A yield
* policy can optionally be provided if the plan should automatically yield during execution.
* "optimizerData" is used to print optimizer ABT plans, and may be empty.
*/
StatusWith<std::unique_ptr<PlanExecutor, PlanExecutor::Deleter>> make(
OperationContext* opCtx,
std::unique_ptr<CanonicalQuery> cq,
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 isFromPlanCache,
bool generatedByBonsai);
/**
* Similar to the factory function above in that it also constructs an executor for the winning SBE
* plan passed in 'candidates' vector. This overload allows callers to pass a pre-existing queue
* ('stash') of BSON objects or record ids to return to the caller.
*/
StatusWith<std::unique_ptr<PlanExecutor, PlanExecutor::Deleter>> make(
OperationContext* opCtx,
std::unique_ptr<CanonicalQuery> cq,
sbe::CandidatePlans candidates,
const MultipleCollectionAccessor& collections,
size_t plannerOptions,
NamespaceString nss,
std::unique_ptr<PlanYieldPolicySBE> yieldPolicy);
/**
* Constructs a plan executor for executing the given 'pipeline'.
*/
std::unique_ptr<PlanExecutor, PlanExecutor::Deleter> make(
boost::intrusive_ptr<ExpressionContext> expCtx,
std::unique_ptr<Pipeline, PipelineDeleter> pipeline,
PlanExecutorPipeline::ResumableScanType resumableScanType =
PlanExecutorPipeline::ResumableScanType::kNone);
} // namespace mongo::plan_executor_factory
|
