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
|
/**
* 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/pipeline/document_source_internal_inhibit_optimization.h"
#include "mongo/db/pipeline/visitors/document_source_visitor_registry.h"
#include "mongo/db/query/query_knobs_gen.h"
#define MONGO_LOGV2_DEFAULT_COMPONENT ::mongo::logv2::LogComponent::kQuery
namespace mongo {
namespace optimizer {
/**
* Visitor that is responsible for indicating whether a DocumentSource is eligible for Bonsai by
* setting the 'eligible' member variable. Stages which are "test-only" and not officially supported
* should set 'eligible' to false.
*/
struct ABTUnsupportedDocumentSourceVisitorContext : public DocumentSourceVisitorContextBase {
bool eligible{true};
};
} // namespace optimizer
template <typename T>
void coutPrintAttr(const logv2::detail::NamedArg<T>& arg) {
std::cout << arg.name << " : " << arg.value << "\n";
}
template <typename T, typename... Args>
void coutPrintAttr(const logv2::detail::NamedArg<T>& arg,
const logv2::detail::NamedArg<Args>&... args) {
std::cout << arg.name << " : " << arg.value << "\n";
coutPrintAttr(args...);
}
template <typename... Args>
void coutPrint(const std::string& msg, const logv2::detail::NamedArg<Args>&... args) {
std::cout << "********* " << msg << " *********\n";
coutPrintAttr(args...);
std::cout << "********* " << msg << " *********\n";
}
#define OPTIMIZER_DEBUG_LOG(ID, DLEVEL, FMTSTR_MESSAGE, ...) \
LOGV2_DEBUG(ID, DLEVEL, FMTSTR_MESSAGE, ##__VA_ARGS__); \
if (internalCascadesOptimizerStdCoutDebugOutput.load()) \
::mongo::coutPrint(FMTSTR_MESSAGE, __VA_ARGS__);
/**
* Returns whether the given Pipeline and aggregate command is eligible to use the bonsai
* optimizer.
*/
bool isEligibleForBonsai(const AggregateCommandRequest& request,
const Pipeline& pipeline,
OperationContext* opCtx,
const CollectionPtr& collection);
/**
* Returns whether the given find command is eligible to use the bonsai optimizer.
*/
bool isEligibleForBonsai(const CanonicalQuery& cq,
OperationContext* opCtx,
const CollectionPtr& collection);
/**
* These functions are exposed only for testing; they only perform checks against the query
* structure. Other callers should use the functions above, which check command and collection
* options for further details.
*/
bool isEligibleForBonsai_forTesting(const CanonicalQuery& cq);
bool isEligibleForBonsai_forTesting(ServiceContext* serviceCtx, const Pipeline& pipeline);
} // namespace mongo
#undef MONGO_LOGV2_DEFAULT_COMPONENT
|