-
Notifications
You must be signed in to change notification settings - Fork 228
/
CapabilitiesUtil.java
521 lines (446 loc) · 21.4 KB
/
CapabilitiesUtil.java
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
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
/*
* JBoss, Home of Professional Open Source.
* See the COPYRIGHT.txt file distributed with this work for information
* regarding copyright ownership. Some portions may be licensed
* to Red Hat, Inc. under one or more contributor license agreements.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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 GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301 USA.
*/
package org.teiid.query.optimizer.relational.rules;
import java.util.Iterator;
import java.util.List;
import org.teiid.api.exception.query.QueryMetadataException;
import org.teiid.core.TeiidComponentException;
import org.teiid.core.types.DataTypeManager;
import org.teiid.language.SortSpecification.NullOrdering;
import org.teiid.metadata.FunctionMethod;
import org.teiid.metadata.FunctionMethod.PushDown;
import org.teiid.metadata.Schema;
import org.teiid.query.function.FunctionLibrary;
import org.teiid.query.metadata.QueryMetadataInterface;
import org.teiid.query.optimizer.capabilities.CapabilitiesFinder;
import org.teiid.query.optimizer.capabilities.SourceCapabilities;
import org.teiid.query.optimizer.capabilities.SourceCapabilities.Capability;
import org.teiid.query.sql.LanguageObject;
import org.teiid.query.sql.lang.JoinType;
import org.teiid.query.sql.lang.OrderByItem;
import org.teiid.query.sql.lang.SetQuery.Operation;
import org.teiid.query.sql.symbol.AggregateSymbol;
import org.teiid.query.sql.symbol.AggregateSymbol.Type;
import org.teiid.query.sql.symbol.ElementSymbol;
import org.teiid.query.sql.symbol.Expression;
import org.teiid.query.sql.symbol.Function;
import org.teiid.query.sql.util.SymbolMap;
import org.teiid.translator.ExecutionFactory.NullOrder;
import org.teiid.translator.ExecutionFactory.SupportedJoinCriteria;
import org.teiid.translator.SourceSystemFunctions;
/**
*/
public class CapabilitiesUtil {
/**
* Can't construct - just a utilities class
*/
private CapabilitiesUtil() {
}
static boolean supportsInlineView(Object modelID, QueryMetadataInterface metadata, CapabilitiesFinder capFinder)
throws QueryMetadataException, TeiidComponentException {
return supports(Capability.QUERY_FROM_INLINE_VIEWS, modelID, metadata, capFinder);
}
public static boolean supportsSelfJoins(Object modelID, QueryMetadataInterface metadata, CapabilitiesFinder capFinder)
throws QueryMetadataException, TeiidComponentException {
if (metadata.isVirtualModel(modelID)){
return false;
}
// Find capabilities
SourceCapabilities caps = getCapabilities(modelID, metadata, capFinder);
return caps.supportsCapability(Capability.QUERY_FROM_JOIN_SELFJOIN) &&
caps.supportsCapability(Capability.QUERY_FROM_GROUP_ALIAS);
}
public static boolean supportsGroupAliases(Object modelID, QueryMetadataInterface metadata, CapabilitiesFinder capFinder)
throws QueryMetadataException, TeiidComponentException {
return supports(Capability.QUERY_FROM_GROUP_ALIAS, modelID, metadata, capFinder);
}
public static boolean supportsJoin(Object modelID, JoinType joinType, QueryMetadataInterface metadata, CapabilitiesFinder capFinder)
throws QueryMetadataException, TeiidComponentException {
if (metadata.isVirtualModel(modelID)){
return false;
}
// Find capabilities
SourceCapabilities caps = getCapabilities(modelID, metadata, capFinder);
if (!joinType.isOuter()) {
return caps.supportsCapability(Capability.QUERY_FROM_JOIN_INNER) || caps.supportsCapability(Capability.QUERY_FROM_JOIN_OUTER);
}
if(! caps.supportsCapability(Capability.QUERY_FROM_JOIN_OUTER)) {
return false;
}
return !joinType.equals(JoinType.JOIN_FULL_OUTER) || caps.supportsCapability(Capability.QUERY_FROM_JOIN_OUTER_FULL);
}
public static boolean supportsAggregates(List groupCols, Object modelID, QueryMetadataInterface metadata, CapabilitiesFinder capFinder)
throws QueryMetadataException, TeiidComponentException {
if (metadata.isVirtualModel(modelID)){
return false;
}
// Find capabilities
SourceCapabilities caps = getCapabilities(modelID, metadata, capFinder);
if (groupCols != null && !groupCols.isEmpty()) {
if (!caps.supportsCapability(Capability.QUERY_GROUP_BY)) {
return false;
}
boolean supportsFunctionsInGroupBy = caps.supportsCapability(Capability.QUERY_FUNCTIONS_IN_GROUP_BY);
boolean supportsInlineView = caps.supportsCapability(Capability.QUERY_FROM_INLINE_VIEWS);
// Also verify that if there is a function that we can support pushdown of functions in group by
Iterator colIter = groupCols.iterator();
while(colIter.hasNext()) {
Expression col = (Expression) colIter.next();
if(!(col instanceof ElementSymbol) && !supportsFunctionsInGroupBy && !supportsInlineView) {
// Function in GROUP BY can't be pushed
return false;
}
}
}
return true;
}
public static boolean supportsAggregateFunction(Object modelID, AggregateSymbol aggregate, QueryMetadataInterface metadata, CapabilitiesFinder capFinder)
throws QueryMetadataException, TeiidComponentException {
if (metadata.isVirtualModel(modelID)){
return false;
}
// Find capabilities
SourceCapabilities caps = getCapabilities(modelID, metadata, capFinder);
// Check particular function
Type func = aggregate.getAggregateFunction();
switch (func) {
case COUNT:
if(aggregate.getArgs().length == 0) {
if(! caps.supportsCapability(Capability.QUERY_AGGREGATES_COUNT_STAR)) {
return false;
}
} else {
if(! caps.supportsCapability(Capability.QUERY_AGGREGATES_COUNT)) {
return false;
}
}
break;
case SUM:
if(! caps.supportsCapability(Capability.QUERY_AGGREGATES_SUM)) {
return false;
}
break;
case AVG:
if(! caps.supportsCapability(Capability.QUERY_AGGREGATES_AVG)) {
return false;
}
break;
case MIN:
if(! caps.supportsCapability(Capability.QUERY_AGGREGATES_MIN)) {
return false;
}
break;
case MAX:
if(! caps.supportsCapability(Capability.QUERY_AGGREGATES_MAX)) {
return false;
}
break;
case ARRAY_AGG:
if(! caps.supportsCapability(Capability.QUERY_AGGREGATES_ARRAY)) {
return false;
}
break;
case STRING_AGG:
if(! caps.supportsCapability(Capability.QUERY_AGGREGATES_STRING)) {
return false;
}
break;
case RANK:
case DENSE_RANK:
case ROW_NUMBER:
case FIRST_VALUE:
case LAST_VALUE:
case LEAD:
case LAG:
if (!caps.supportsCapability(Capability.ELEMENTARY_OLAP)) {
return false;
}
break;
case USER_DEFINED:
if (!supportsScalarFunction(modelID, aggregate, metadata, capFinder)) {
return false;
}
break;
default:
if (aggregate.isEnhancedNumeric()) {
if (!caps.supportsCapability(Capability.QUERY_AGGREGATES_ENHANCED_NUMERIC)) {
return false;
}
} else {
return false;
}
break;
}
// Check DISTINCT if necessary
if(aggregate.isDistinct() && ! caps.supportsCapability(Capability.QUERY_AGGREGATES_DISTINCT)) {
return false;
}
if (aggregate.getCondition() != null && !caps.supportsCapability(Capability.ADVANCED_OLAP)) {
return false;
}
// Passed all the checks!
return true;
}
public static boolean supportsScalarFunction(Object modelID, Function function, QueryMetadataInterface metadata, CapabilitiesFinder capFinder)
throws QueryMetadataException, TeiidComponentException {
FunctionMethod method = function.getFunctionDescriptor().getMethod();
if (metadata.isVirtualModel(modelID) || method.getPushdown() == PushDown.CANNOT_PUSHDOWN){
return false;
}
SourceCapabilities caps = getCapabilities(modelID, metadata, capFinder);
//capabilities check is only valid for non-schema scoped functions
//technically the other functions are scoped to SYS or their function model, but that's
//not formally part of their metadata yet
Schema schema = method.getParent();
//TODO: this call should be functionDescriptor.getFullName - but legacy function models are parsed without setting the parent model as the schema
String fullName = method.getFullName();
if (schema == null || !schema.isPhysical()) {
// Find capabilities
if (!caps.supportsFunction(fullName)) {
if(SourceSystemFunctions.CONCAT2.equalsIgnoreCase(fullName)) {
//special handling for delayed rewrite of concat2
return (schema == null
&& caps.supportsFunction(SourceSystemFunctions.CONCAT)
&& caps.supportsFunction(SourceSystemFunctions.IFNULL)
&& caps.supportsCapability(Capability.QUERY_SEARCHED_CASE));
} else if(SourceSystemFunctions.FROM_UNIXTIME.equalsIgnoreCase(fullName)) {
return (schema == null
&& caps.supportsFunction(SourceSystemFunctions.TIMESTAMPADD));
} else {
return false ;
}
}
if (FunctionLibrary.isConvert(function)) {
Class<?> fromType = function.getArg(0).getType();
Class<?> targetType = function.getType();
if (fromType == targetType) {
return true; //this should be removed in rewrite
}
return caps.supportsConvert(DataTypeManager.getTypeCode(fromType), DataTypeManager.getTypeCode(targetType));
}
} else if (!isSameConnector(modelID, schema, metadata, capFinder)) {
return caps.supportsFunction(fullName);
}
return true;
}
public static boolean supportsSelectDistinct(Object modelID, QueryMetadataInterface metadata, CapabilitiesFinder capFinder)
throws QueryMetadataException, TeiidComponentException {
return supports(Capability.QUERY_SELECT_DISTINCT, modelID, metadata, capFinder);
}
public static boolean supportsSelectExpression(Object modelID, QueryMetadataInterface metadata, CapabilitiesFinder capFinder)
throws QueryMetadataException, TeiidComponentException {
return supports(Capability.QUERY_SELECT_EXPRESSION, modelID, metadata, capFinder);
}
public static boolean supportsOrderBy(Object modelID, QueryMetadataInterface metadata, CapabilitiesFinder capFinder)
throws QueryMetadataException, TeiidComponentException {
return supports(Capability.QUERY_ORDERBY, modelID, metadata, capFinder);
}
public static boolean supportsSetOp(Object modelID, Operation setOp, QueryMetadataInterface metadata, CapabilitiesFinder capFinder)
throws QueryMetadataException, TeiidComponentException {
if (metadata.isVirtualModel(modelID)){
return false;
}
// Find capabilities
SourceCapabilities caps = getCapabilities(modelID, metadata, capFinder);
switch (setOp) {
case EXCEPT:
return caps.supportsCapability(Capability.QUERY_EXCEPT);
case INTERSECT:
return caps.supportsCapability(Capability.QUERY_INTERSECT);
case UNION:
return caps.supportsCapability(Capability.QUERY_UNION);
}
return false;
}
public static boolean supportsSetQueryOrderBy(Object modelID, QueryMetadataInterface metadata, CapabilitiesFinder capFinder)
throws QueryMetadataException, TeiidComponentException {
return supports(Capability.QUERY_SET_ORDER_BY, modelID, metadata, capFinder);
}
public static boolean supportsCaseExpression(Object modelID, QueryMetadataInterface metadata, CapabilitiesFinder capFinder)
throws QueryMetadataException, TeiidComponentException {
return supports(Capability.QUERY_CASE, modelID, metadata, capFinder);
}
public static boolean supportsSearchedCaseExpression(Object modelID, QueryMetadataInterface metadata, CapabilitiesFinder capFinder)
throws QueryMetadataException, TeiidComponentException {
return supports(Capability.QUERY_SEARCHED_CASE, modelID, metadata, capFinder);
}
public static int getMaxInCriteriaSize(Object modelID, QueryMetadataInterface metadata, CapabilitiesFinder capFinder)
throws QueryMetadataException, TeiidComponentException {
return getIntProperty(Capability.MAX_IN_CRITERIA_SIZE, modelID, metadata, capFinder);
}
public static Object getProperty(Capability cap, Object modelID, QueryMetadataInterface metadata, CapabilitiesFinder capFinder)
throws QueryMetadataException, TeiidComponentException {
if (metadata.isVirtualModel(modelID)){
return null;
}
// Find capabilities
SourceCapabilities caps = getCapabilities(modelID, metadata, capFinder);
return caps.getSourceProperty(cap);
}
/**
* Values are expected to be non-negative except for unknown/invalid = -1
* @param cap
* @param modelID
* @param metadata
* @param capFinder
* @return
* @throws QueryMetadataException
* @throws TeiidComponentException
*/
public static int getIntProperty(Capability cap, Object modelID, QueryMetadataInterface metadata, CapabilitiesFinder capFinder)
throws QueryMetadataException, TeiidComponentException {
Object i = getProperty(cap, modelID, metadata, capFinder);
int value = -1;
if(i != null) {
value = ((Integer)i).intValue();
}
// Check for invalid values and send back code for UNKNOWN
if(value <= 0) {
value = -1;
}
return value;
}
public static int getMaxDependentPredicates(Object modelID, QueryMetadataInterface metadata, CapabilitiesFinder capFinder)
throws QueryMetadataException, TeiidComponentException {
return getIntProperty(Capability.MAX_DEPENDENT_PREDICATES, modelID, metadata, capFinder);
}
public static int getMaxFromGroups(Object modelID, QueryMetadataInterface metadata, CapabilitiesFinder capFinder)
throws QueryMetadataException, TeiidComponentException {
return getIntProperty(Capability.MAX_QUERY_FROM_GROUPS, modelID, metadata, capFinder);
}
public static SupportedJoinCriteria getSupportedJoinCriteria(Object modelID, QueryMetadataInterface metadata, CapabilitiesFinder capFinder) throws QueryMetadataException, TeiidComponentException {
if (metadata.isVirtualModel(modelID)){
return SupportedJoinCriteria.ANY;
}
SourceCapabilities caps = getCapabilities(modelID, metadata, capFinder);
SupportedJoinCriteria crits = (SupportedJoinCriteria)caps.getSourceProperty(Capability.JOIN_CRITERIA_ALLOWED);
if (crits == null) {
return SupportedJoinCriteria.ANY;
}
return crits;
}
public static NullOrder getDefaultNullOrder(Object modelID, QueryMetadataInterface metadata, CapabilitiesFinder capFinder) throws QueryMetadataException, TeiidComponentException {
if (metadata.isVirtualModel(modelID)){
return NullOrder.UNKNOWN;
}
SourceCapabilities caps = getCapabilities(modelID, metadata, capFinder);
NullOrder order = (NullOrder)caps.getSourceProperty(Capability.QUERY_ORDERBY_DEFAULT_NULL_ORDER);
if (order == null) {
return NullOrder.UNKNOWN;
}
return order;
}
public static boolean supportsRowLimit(Object modelID, QueryMetadataInterface metadata, CapabilitiesFinder capFinder)
throws QueryMetadataException, TeiidComponentException {
return supports(Capability.ROW_LIMIT, modelID, metadata, capFinder);
}
public static boolean supportsRowOffset(Object modelID, QueryMetadataInterface metadata, CapabilitiesFinder capFinder)
throws QueryMetadataException, TeiidComponentException {
return supports(Capability.ROW_OFFSET, modelID, metadata, capFinder);
}
public static boolean isSameConnector(Object modelID, Object modelID1, QueryMetadataInterface metadata, CapabilitiesFinder capFinder)
throws QueryMetadataException, TeiidComponentException {
if (modelID == null || modelID1 == null || metadata.isVirtualModel(modelID) || metadata.isVirtualModel(modelID1)){
return false;
}
if (modelID.equals(modelID1)) {
return true;
}
if (capFinder == null) {
return false;
}
// Find capabilities
SourceCapabilities caps = getCapabilities(modelID, metadata, capFinder);
SourceCapabilities caps1 = getCapabilities(modelID1, metadata, capFinder);
Object connectorID = caps.getSourceProperty(Capability.CONNECTOR_ID);
return connectorID != null && connectorID.equals(caps1.getSourceProperty(Capability.CONNECTOR_ID));
}
static SourceCapabilities getCapabilities(Object modelID, QueryMetadataInterface metadata, CapabilitiesFinder capFinder)
throws QueryMetadataException, TeiidComponentException {
// Find capabilities
String modelName = metadata.getFullName(modelID);
return capFinder.findCapabilities(modelName);
}
public static boolean requiresCriteria(Object modelID, QueryMetadataInterface metadata, CapabilitiesFinder capFinder)
throws QueryMetadataException, TeiidComponentException {
return supports(Capability.REQUIRES_CRITERIA, modelID, metadata, capFinder);
}
public static boolean useAnsiJoin(Object modelID, QueryMetadataInterface metadata, CapabilitiesFinder capFinder)
throws QueryMetadataException, TeiidComponentException {
return supports(Capability.QUERY_FROM_ANSI_JOIN, modelID, metadata, capFinder);
}
public static boolean supports(Capability cap, Object modelID, QueryMetadataInterface metadata, CapabilitiesFinder capFinder)
throws QueryMetadataException, TeiidComponentException {
if (metadata.isVirtualModel(modelID)){
return false;
}
// Find capabilities
SourceCapabilities caps = getCapabilities(modelID, metadata, capFinder);
if (caps == null) {
throw new AssertionError(modelID);
}
return caps.supportsCapability(cap);
}
/**
* Validate that the elements are searchable and can be used in a criteria against this source.
* TODO: this check is too general and not type based
*/
static boolean checkElementsAreSearchable(List<? extends LanguageObject> objs, QueryMetadataInterface metadata, int searchableType)
throws QueryMetadataException, TeiidComponentException {
if (objs != null) {
for (LanguageObject lo : objs) {
if (lo instanceof OrderByItem) {
lo = ((OrderByItem)lo).getSymbol();
}
if (!(lo instanceof Expression)) {
continue;
}
lo = SymbolMap.getExpression((Expression)lo);
if (!(lo instanceof ElementSymbol)) {
continue;
}
if (!metadata.elementSupports(((ElementSymbol)lo).getMetadataID(), searchableType)) {
return false;
}
}
}
return true;
}
static boolean supportsNullOrdering(QueryMetadataInterface metadata,
CapabilitiesFinder capFinder, Object modelID, OrderByItem symbol)
throws QueryMetadataException, TeiidComponentException {
boolean supportsNullOrdering = CapabilitiesUtil.supports(Capability.QUERY_ORDERBY_NULL_ORDERING, modelID, metadata, capFinder);
NullOrder defaultNullOrder = CapabilitiesUtil.getDefaultNullOrder(modelID, metadata, capFinder);
if (symbol.getNullOrdering() != null && !supportsNullOrdering) {
if (symbol.getNullOrdering() == NullOrdering.FIRST) {
if (defaultNullOrder != NullOrder.FIRST && !(symbol.isAscending() && defaultNullOrder == NullOrder.LOW)
&& !(!symbol.isAscending() && defaultNullOrder == NullOrder.HIGH)) {
return false;
}
} else if (defaultNullOrder != NullOrder.LAST && !(symbol.isAscending() && defaultNullOrder == NullOrder.HIGH)
&& !(!symbol.isAscending() && defaultNullOrder == NullOrder.LOW)) {
return false;
}
}
return true;
}
}