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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
|
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef ORC_SRC_SEARCHARGUMENT_HH
#define ORC_SRC_SEARCHARGUMENT_HH
#include "ExpressionTree.hh"
#include "orc/sargs/SearchArgument.hh"
#include "sargs/PredicateLeaf.hh"
#include "wrap/orc-proto-wrapper.hh"
#include <deque>
#include <stdexcept>
#include <unordered_map>
namespace orc {
/**
* Primary interface for a search argument, which are the subset of predicates
* that can be pushed down to the RowReader. Each SearchArgument consists
* of a series of search clauses that must each be true for the row to be
* accepted by the filter.
*
* This requires that the filter be normalized into conjunctive normal form
* (<a href="http://en.wikipedia.org/wiki/Conjunctive_normal_form">CNF</a>).
*/
class SearchArgumentImpl : public SearchArgument {
public:
SearchArgumentImpl(TreeNode root, const std::vector<PredicateLeaf>& leaves);
/**
* Get the leaf predicates that are required to evaluate the predicate. The
* list will have the duplicates removed.
* @return the list of leaf predicates
*/
const std::vector<PredicateLeaf>& getLeaves() const;
/**
* Get the expression tree. This should only needed for file formats that
* need to translate the expression to an internal form.
*/
const ExpressionTree* getExpression() const;
/**
* Evaluate the entire predicate based on the values for the leaf predicates.
* @param leaves the value of each leaf predicate
* @return the value of the entire predicate
*/
TruthValue evaluate(const std::vector<TruthValue>& leaves) const override;
std::string toString() const override;
private:
std::shared_ptr<ExpressionTree> expressionTree_;
std::vector<PredicateLeaf> leaves_;
};
/**
* A builder object to create a SearchArgument from expressions. The user
* must call startOr, startAnd, or startNot before adding any leaves.
*/
class SearchArgumentBuilderImpl : public SearchArgumentBuilder {
public:
SearchArgumentBuilderImpl();
/**
* Start building an or operation and push it on the stack.
* @return this
*/
SearchArgumentBuilder& startOr() override;
/**
* Start building an and operation and push it on the stack.
* @return this
*/
SearchArgumentBuilder& startAnd() override;
/**
* Start building a not operation and push it on the stack.
* @return this
*/
SearchArgumentBuilder& startNot() override;
/**
* Finish the current operation and pop it off of the stack. Each start
* call must have a matching end.
* @return this
*/
SearchArgumentBuilder& end() override;
/**
* Add a less than leaf to the current item on the stack.
* @param column the field name of the column
* @param type the type of the expression
* @param literal the literal
* @return this
*/
SearchArgumentBuilder& lessThan(const std::string& column, PredicateDataType type,
Literal literal) override;
/**
* Add a less than leaf to the current item on the stack.
* @param columnId the column id of the column
* @param type the type of the expression
* @param literal the literal
* @return this
*/
SearchArgumentBuilder& lessThan(uint64_t columnId, PredicateDataType type,
Literal literal) override;
/**
* Add a less than equals leaf to the current item on the stack.
* @param column the field name of the column
* @param type the type of the expression
* @param literal the literal
* @return this
*/
SearchArgumentBuilder& lessThanEquals(const std::string& column, PredicateDataType type,
Literal literal) override;
/**
* Add a less than equals leaf to the current item on the stack.
* @param columnId the column id of the column
* @param type the type of the expression
* @param literal the literal
* @return this
*/
SearchArgumentBuilder& lessThanEquals(uint64_t columnId, PredicateDataType type,
Literal literal) override;
/**
* Add an equals leaf to the current item on the stack.
* @param column the field name of the column
* @param type the type of the expression
* @param literal the literal
* @return this
*/
SearchArgumentBuilder& equals(const std::string& column, PredicateDataType type,
Literal literal) override;
/**
* Add an equals leaf to the current item on the stack.
* @param columnId the column id of the column
* @param type the type of the expression
* @param literal the literal
* @return this
*/
SearchArgumentBuilder& equals(uint64_t columnId, PredicateDataType type,
Literal literal) override;
/**
* Add a null safe equals leaf to the current item on the stack.
* @param column the field name of the column
* @param type the type of the expression
* @param literal the literal
* @return this
*/
SearchArgumentBuilder& nullSafeEquals(const std::string& column, PredicateDataType type,
Literal literal) override;
/**
* Add a null safe equals leaf to the current item on the stack.
* @param columnId the column id of the column
* @param type the type of the expression
* @param literal the literal
* @return this
*/
SearchArgumentBuilder& nullSafeEquals(uint64_t columnId, PredicateDataType type,
Literal literal) override;
/**
* Add an in leaf to the current item on the stack.
* @param column the field name of the column
* @param type the type of the expression
* @param literals the literals
* @return this
*/
SearchArgumentBuilder& in(const std::string& column, PredicateDataType type,
const std::initializer_list<Literal>& literals) override;
/**
* Add an in leaf to the current item on the stack.
* @param columnId the column id of the column
* @param type the type of the expression
* @param literals the literals
* @return this
*/
SearchArgumentBuilder& in(uint64_t columnId, PredicateDataType type,
const std::initializer_list<Literal>& literals) override;
/**
* Add an in leaf to the current item on the stack.
* @param column the field name of the column
* @param type the type of the expression
* @param literals the literals
* @return this
*/
SearchArgumentBuilder& in(const std::string& column, PredicateDataType type,
const std::vector<Literal>& literals) override;
/**
* Add an in leaf to the current item on the stack.
* @param columnId the column id of the column
* @param type the type of the expression
* @param literals the literals
* @return this
*/
SearchArgumentBuilder& in(uint64_t columnId, PredicateDataType type,
const std::vector<Literal>& literals) override;
/**
* Add an is null leaf to the current item on the stack.
* @param column the field name of the column
* @param type the type of the expression
* @return this
*/
SearchArgumentBuilder& isNull(const std::string& column, PredicateDataType type) override;
/**
* Add an is null leaf to the current item on the stack.
* @param columnId the column id of the column
* @param type the type of the expression
* @return this
*/
SearchArgumentBuilder& isNull(uint64_t columnId, PredicateDataType type) override;
/**
* Add a between leaf to the current item on the stack.
* @param column the field name of the column
* @param type the type of the expression
* @param lower the literal
* @param upper the literal
* @return this
*/
SearchArgumentBuilder& between(const std::string& column, PredicateDataType type, Literal lower,
Literal upper) override;
/**
* Add a between leaf to the current item on the stack.
* @param columnId the column id of the column
* @param type the type of the expression
* @param lower the literal
* @param upper the literal
* @return this
*/
SearchArgumentBuilder& between(uint64_t columnId, PredicateDataType type, Literal lower,
Literal upper) override;
/**
* Add a truth value to the expression.
* @param truth truth value
* @return this
*/
SearchArgumentBuilder& literal(TruthValue truth) override;
/**
* Build and return the SearchArgument that has been defined. All of the
* starts must have been ended before this call.
* @return the new SearchArgument
*/
std::unique_ptr<SearchArgument> build() override;
private:
SearchArgumentBuilder& start(ExpressionTree::Operator op);
size_t addLeaf(PredicateLeaf leaf);
static bool isInvalidColumn(const std::string& column);
static bool isInvalidColumn(uint64_t columnId);
template <typename T>
SearchArgumentBuilder& compareOperator(PredicateLeaf::Operator op, T column,
PredicateDataType type, Literal literal);
template <typename T, typename CONTAINER>
SearchArgumentBuilder& addChildForIn(T column, PredicateDataType type,
const CONTAINER& literals);
template <typename T>
SearchArgumentBuilder& addChildForIsNull(T column, PredicateDataType type);
template <typename T>
SearchArgumentBuilder& addChildForBetween(T column, PredicateDataType type, Literal lower,
Literal upper);
public:
static TreeNode pushDownNot(TreeNode root);
static TreeNode foldMaybe(TreeNode expr);
static TreeNode flatten(TreeNode root);
static TreeNode convertToCNF(TreeNode root);
private:
std::deque<TreeNode> currTree_;
std::unordered_map<PredicateLeaf, size_t, PredicateLeafHash, PredicateLeafComparator> leaves_;
std::shared_ptr<ExpressionTree> root_;
};
} // namespace orc
#endif // ORC_SRC_SEARCHARGUMENT_HH
|
