/
RulePushAggregates.java
1089 lines (985 loc) · 50.4 KB
/
RulePushAggregates.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
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* 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.*;
import org.teiid.api.exception.query.QueryMetadataException;
import org.teiid.api.exception.query.QueryPlannerException;
import org.teiid.api.exception.query.QueryResolverException;
import org.teiid.core.TeiidComponentException;
import org.teiid.core.id.IDGenerator;
import org.teiid.core.types.DataTypeManager;
import org.teiid.language.SQLConstants.NonReserved;
import org.teiid.query.QueryPlugin;
import org.teiid.query.analysis.AnalysisRecord;
import org.teiid.query.function.FunctionLibrary;
import org.teiid.query.metadata.QueryMetadataInterface;
import org.teiid.query.metadata.TempMetadataAdapter;
import org.teiid.query.metadata.TempMetadataStore;
import org.teiid.query.optimizer.capabilities.CapabilitiesFinder;
import org.teiid.query.optimizer.capabilities.SourceCapabilities.Capability;
import org.teiid.query.optimizer.relational.OptimizerRule;
import org.teiid.query.optimizer.relational.RelationalPlanner;
import org.teiid.query.optimizer.relational.RuleStack;
import org.teiid.query.optimizer.relational.plantree.NodeConstants;
import org.teiid.query.optimizer.relational.plantree.NodeConstants.Info;
import org.teiid.query.optimizer.relational.plantree.NodeEditor;
import org.teiid.query.optimizer.relational.plantree.NodeFactory;
import org.teiid.query.optimizer.relational.plantree.PlanNode;
import org.teiid.query.resolver.util.ResolverUtil;
import org.teiid.query.resolver.util.ResolverVisitor;
import org.teiid.query.rewriter.QueryRewriter;
import org.teiid.query.sql.LanguageObject;
import org.teiid.query.sql.lang.CompareCriteria;
import org.teiid.query.sql.lang.Criteria;
import org.teiid.query.sql.lang.IsNullCriteria;
import org.teiid.query.sql.lang.JoinType;
import org.teiid.query.sql.lang.OrderBy;
import org.teiid.query.sql.lang.Select;
import org.teiid.query.sql.lang.SetQuery.Operation;
import org.teiid.query.sql.symbol.*;
import org.teiid.query.sql.symbol.AggregateSymbol.Type;
import org.teiid.query.sql.util.SymbolMap;
import org.teiid.query.sql.visitor.AggregateSymbolCollectorVisitor;
import org.teiid.query.sql.visitor.ElementCollectorVisitor;
import org.teiid.query.sql.visitor.ExpressionMappingVisitor;
import org.teiid.query.sql.visitor.GroupsUsedByElementsVisitor;
import org.teiid.query.util.CommandContext;
import org.teiid.translator.SourceSystemFunctions;
/**
* @since 4.2
*/
public class RulePushAggregates implements
OptimizerRule {
private IDGenerator idGenerator;
private CommandContext context;
private List<PlanNode> groupingNodes;
public RulePushAggregates(IDGenerator idGenerator) {
this.idGenerator = idGenerator;
}
/**
* @see org.teiid.query.optimizer.relational.OptimizerRule#execute(org.teiid.query.optimizer.relational.plantree.PlanNode,
* org.teiid.query.metadata.QueryMetadataInterface, org.teiid.query.optimizer.capabilities.CapabilitiesFinder,
* org.teiid.query.optimizer.relational.RuleStack, AnalysisRecord, CommandContext)
* @since 4.2
*/
public PlanNode execute(PlanNode plan,
QueryMetadataInterface metadata,
CapabilitiesFinder capFinder,
RuleStack rules,
AnalysisRecord analysisRecord,
CommandContext ctx) throws QueryPlannerException,
QueryMetadataException,
TeiidComponentException {
this.context = ctx;
groupingNodes = NodeEditor.findAllNodes(plan, NodeConstants.Types.GROUP, NodeConstants.Types.ACCESS);
outer: for (int i = 0; i < groupingNodes.size(); i++) {
PlanNode groupNode = groupingNodes.get(i);
if (groupNode.hasBooleanProperty(Info.ROLLUP)) {
continue;
}
PlanNode child = groupNode.getFirstChild();
List<Expression> groupingExpressions = (List<Expression>)groupNode.getProperty(NodeConstants.Info.GROUP_COLS);
if (groupingExpressions == null) {
groupingExpressions = Collections.emptyList();
}
try {
if (child.getType() == NodeConstants.Types.SOURCE) {
PlanNode setOp = child.getFirstChild();
pushGroupNodeOverUnion(metadata, capFinder, groupNode, child, groupingExpressions, setOp, analysisRecord);
continue;
} else if (child.getType() != NodeConstants.Types.JOIN) {
PlanNode access = NodeEditor.findNodePreOrder(child, NodeConstants.Types.ACCESS, NodeConstants.Types.SOURCE | NodeConstants.Types.JOIN | NodeConstants.Types.SET_OP);
if (access != null) {
PlanNode parent = access.getParent();
while (parent != groupNode) {
if (parent.getType() != NodeConstants.Types.SELECT) {
continue outer;
}
parent = parent.getParent();
}
Set<AggregateSymbol> aggregates = collectAggregates(groupNode);
//hybrid of the join/union/decompose pushing logic
if (access.hasBooleanProperty(Info.IS_MULTI_SOURCE)) {
if (!RuleRaiseAccess.isPartitioned(metadata, groupingExpressions, groupNode)) {
if (aggregates.isEmpty()) {
//TODO: insert distinct if supported by the access node
continue;
}
for (AggregateSymbol agg : aggregates) {
if (!agg.canStage()) {
continue outer;
}
}
boolean shouldPushdown = canPushGroupByToUnionChild(metadata, capFinder, groupingExpressions, aggregates, access, analysisRecord, groupNode);
if (!shouldPushdown) {
continue;
}
Set<Expression> stagedGroupingSymbols = new LinkedHashSet<Expression>();
aggregates = stageAggregates(groupNode, metadata, stagedGroupingSymbols, aggregates);
if (aggregates.isEmpty() && stagedGroupingSymbols.isEmpty()) {
continue;
}
addGroupBy(child, new ArrayList<Expression>(stagedGroupingSymbols), aggregates, metadata, groupNode.getParent(), capFinder, false, stagedGroupingSymbols.isEmpty() && containsNullDependent(aggregates));
} else if (groupNode.getFirstChild() == access
&& RuleRaiseAccess.canRaiseOverGroupBy(groupNode, child, aggregates, metadata, capFinder, analysisRecord, false)
&& canFilterEmpty(metadata, capFinder, child, groupingExpressions)) {
if (groupingExpressions.isEmpty()) {
addEmptyFilter(aggregates, groupNode, metadata, capFinder, RuleRaiseAccess.getModelIDFromAccess(child, metadata));
}
FrameUtil.convertNode(groupNode.getParent(), null, null, ((SymbolMap)groupNode.getProperty(Info.SYMBOL_MAP)).inserseMapping(), metadata, false);
RuleRaiseAccess.performRaise(null, access, access.getParent());
if (groupingExpressions.isEmpty() && RuleRaiseAccess.canRaiseOverSelect(access, metadata, capFinder, access.getParent(), null)) {
RuleRaiseAccess.performRaise(null, access, access.getParent());
}
}
}
//TODO: consider pushing aggregate in general
}
continue;
}
} catch (QueryResolverException e) {
throw new TeiidComponentException(QueryPlugin.Event.TEIID30264, e);
}
Set<AggregateSymbol> aggregates = collectAggregates(groupNode);
pushGroupNode(groupNode, groupingExpressions, aggregates, metadata, capFinder, context);
}
return plan;
}
/**
* The plan tree looks like:
* group [agg(x), {a, b}]
* source
* set op
* child 1
* ...
*
* we need to make it into
*
* group [agg(agg(x)), {a, b}]
* source
* set op
* project
* [select]
* group [agg(x), {a, b}]
* source
* child 1
* ...
*
* Or if the child does not support pushdown we add dummy aggregate projection
* count(*) = 1, count(x) = case x is null then 0 else 1 end, avg(x) = x, etc.
*/
private void pushGroupNodeOverUnion(QueryMetadataInterface metadata, CapabilitiesFinder capFinder,
PlanNode groupNode, PlanNode unionSourceParent,
List<Expression> groupingExpressions, PlanNode setOp, AnalysisRecord record)
throws TeiidComponentException, QueryMetadataException,
QueryPlannerException, QueryResolverException {
if (setOp == null || setOp.getProperty(NodeConstants.Info.SET_OPERATION) != Operation.UNION) {
return;
}
LinkedHashSet<AggregateSymbol> aggregates = collectAggregates(groupNode);
Map<ElementSymbol, List<Set<Constant>>> partitionInfo = (Map<ElementSymbol, List<Set<Constant>>>)unionSourceParent.getProperty(Info.PARTITION_INFO);
//check to see if any aggregate is dependent upon cardinality
boolean cardinalityDependent = AggregateSymbol.areAggregatesCardinalityDependent(aggregates);
LinkedList<PlanNode> unionChildren = new LinkedList<PlanNode>();
findUnionChildren(unionChildren, cardinalityDependent, setOp);
SymbolMap parentMap = (SymbolMap)unionSourceParent.getProperty(NodeConstants.Info.SYMBOL_MAP);
//partitioned union
if (partitionInfo != null && !Collections.disjoint(partitionInfo.keySet(), groupingExpressions)) {
decomposeGroupBy(groupNode, unionSourceParent, groupingExpressions, aggregates, unionChildren, parentMap, metadata, capFinder);
return;
}
/*
* if there are no aggregates, this is just duplicate removal
* mark the union as not all, which should be removed later but
* serves as a hint to distribute a distinct to the union queries
*/
if (aggregates.isEmpty()) {
if (!groupingExpressions.isEmpty()) {
setOp.setProperty(NodeConstants.Info.USE_ALL, Boolean.FALSE);
boolean allCols = true;
for (Expression ex : groupingExpressions) {
if (!(ex instanceof ElementSymbol)) {
allCols = false;
break;
}
}
if (allCols) {
//since there are no expressions in the grouping cols, we know the grouping node is now not needed.
RuleAssignOutputElements.removeGroupBy(groupNode, metadata);
}
}
return;
}
for (AggregateSymbol agg : aggregates) {
if (!agg.canStage()) {
return;
}
}
//TODO: merge virtual, plan unions, raise null - change the partition information
if (unionChildren.size() < 2) {
return;
}
List<AggregateSymbol> copy = new ArrayList<AggregateSymbol>(aggregates);
aggregates.clear();
Map<AggregateSymbol, Expression> aggMap = buildAggregateMap(copy, metadata, aggregates);
boolean shouldPushdown = false;
List<Boolean> pushdownList = new ArrayList<Boolean>(unionChildren.size());
for (PlanNode planNode : unionChildren) {
boolean pushdown = canPushGroupByToUnionChild(metadata, capFinder, groupingExpressions, aggregates, planNode, record, groupNode);
pushdownList.add(pushdown);
shouldPushdown |= pushdown;
}
if (!shouldPushdown) {
return;
}
GroupSymbol group = unionSourceParent.getGroups().iterator().next().clone();
Iterator<Boolean> pushdownIterator = pushdownList.iterator();
boolean first = true;
for (PlanNode planNode : unionChildren) {
addUnionGroupBy(groupingExpressions, aggregates, parentMap, metadata, capFinder, group, first, planNode, !pushdownIterator.next(), false);
first = false;
}
updateParentAggs(groupNode, aggMap, metadata);
List<Expression> symbols = (List<Expression>) NodeEditor.findNodePreOrder(unionSourceParent, NodeConstants.Types.PROJECT).getProperty(Info.PROJECT_COLS);
GroupSymbol modifiedGroup = group.clone();
SymbolMap symbolMap = createSymbolMap(modifiedGroup, symbols, unionSourceParent, metadata);
unionSourceParent.setProperty(Info.SYMBOL_MAP, symbolMap);
//correct the parent frame
Map<Expression, ElementSymbol> mapping = new HashMap<Expression, ElementSymbol>();
Iterator<ElementSymbol> elemIter = symbolMap.getKeys().iterator();
for (Expression expr : groupingExpressions) {
mapping.put(expr, elemIter.next());
}
for (AggregateSymbol agg : aggregates) {
mapping.put(agg, elemIter.next());
}
PlanNode node = unionSourceParent;
while (node != groupNode.getParent()) {
FrameUtil.convertNode(node, null, null, mapping, metadata, false);
node = node.getParent();
}
removeUnnecessaryViews(unionSourceParent, metadata, capFinder);
}
private void updateParentAggs(PlanNode groupNode,
Map<AggregateSymbol, Expression> aggMap, QueryMetadataInterface metadata)
throws QueryMetadataException, TeiidComponentException, QueryPlannerException {
LinkedHashSet<AggregateSymbol> compositeAggs = new LinkedHashSet<AggregateSymbol>();
boolean hasExpressionMapping = false;
SymbolMap oldGroupingMap = (SymbolMap) groupNode.getProperty(Info.SYMBOL_MAP);
/* we operate over the old group node map since the aggMap is based only
* upon the aggs for the target node and not all of the possible aggregates,
* which will cause a failure if we introduce an expression mapping
*/
for (Expression ex : oldGroupingMap.asMap().values()) {
if (!(ex instanceof AggregateSymbol)) {
continue;
}
Expression mappedAgg = aggMap.get(ex);
if (mappedAgg != null) {
if (mappedAgg instanceof AggregateSymbol) {
compositeAggs.add((AggregateSymbol) mappedAgg);
} else {
compositeAggs.addAll(AggregateSymbolCollectorVisitor.getAggregates(mappedAgg, false));
hasExpressionMapping = true;
}
} else {
compositeAggs.add((AggregateSymbol) ex);
}
}
if (!hasExpressionMapping) {
//if no new expressions are created we can just modify the existing aggregates
FrameUtil.correctSymbolMap(aggMap, groupNode);
} else {
//if new expressions are created we insert a view to handle the projection
groupNode.getGroups().clear();
GroupSymbol oldGroup = oldGroupingMap.asMap().keySet().iterator().next().getGroupSymbol();
SymbolMap groupingMap = RelationalPlanner.buildGroupingNode(compositeAggs, (List<? extends Expression>) groupNode.getProperty(Info.GROUP_COLS), groupNode, context, idGenerator);
ArrayList<Expression> projectCols = new ArrayList<Expression>(oldGroupingMap.asMap().size());
SymbolMap correctedMap = new SymbolMap();
Map<Expression, ElementSymbol> inverseMap = groupingMap.inserseMapping();
for (Map.Entry<ElementSymbol, Expression> entry : oldGroupingMap.asMap().entrySet()) {
Expression ses = null;
if (entry.getValue() instanceof AggregateSymbol) {
Expression ex = aggMap.get(entry.getValue());
if (ex == null) {
ses = inverseMap.get(entry.getValue());
} else if (ex instanceof AggregateSymbol) {
ses = inverseMap.get(ex);
} else {
ExpressionMappingVisitor.mapExpressions(ex, inverseMap);
ses = new ExpressionSymbol("expr", ex); //$NON-NLS-1$
}
} else {
ses = inverseMap.get(entry.getValue());
}
ses = (Expression) ses.clone();
projectCols.add(new AliasSymbol(Symbol.getShortName(entry.getKey()), ses));
correctedMap.addMapping(entry.getKey(), SymbolMap.getExpression(ses));
}
PlanNode projectNode = groupNode.getParent();
if (projectNode.getType() != NodeConstants.Types.PROJECT) {
projectNode = NodeFactory.getNewNode(NodeConstants.Types.PROJECT);
groupNode.addAsParent(projectNode);
projectNode.setProperty(Info.PROJECT_COLS, projectCols);
RuleDecomposeJoin.createSource(oldGroup, projectNode, correctedMap);
} else {
FrameUtil.convertFrame(projectNode, oldGroup, null, correctedMap.asMap(), metadata);
}
}
}
/* if partitioned, then we don't need decomposition or the top level group by
*
* source
* set op
* project
* group [agg(x), {a, b}]
* source
* child 1
* ...
*
*/
private void decomposeGroupBy(PlanNode groupNode, PlanNode sourceNode,
List<Expression> groupingExpressions,
LinkedHashSet<AggregateSymbol> aggregates,
LinkedList<PlanNode> unionChildren, SymbolMap parentMap, QueryMetadataInterface metadata,
CapabilitiesFinder capFinder) throws QueryPlannerException, QueryMetadataException, TeiidComponentException, QueryResolverException {
// remove the group node
groupNode.getParent().replaceChild(groupNode, groupNode.getFirstChild());
GroupSymbol group = sourceNode.getGroups().iterator().next().clone();
boolean first = true;
for (PlanNode planNode : unionChildren) {
addUnionGroupBy(groupingExpressions, aggregates,
parentMap, metadata, capFinder, group, first,
planNode, false, true);
first = false;
}
List<Expression> symbols = (List<Expression>) NodeEditor.findNodePreOrder(sourceNode, NodeConstants.Types.PROJECT).getProperty(Info.PROJECT_COLS);
GroupSymbol modifiedGroup = group.clone();
SymbolMap symbolMap = createSymbolMap(modifiedGroup, symbols, sourceNode, metadata);
sourceNode.setProperty(Info.SYMBOL_MAP, symbolMap);
//map from the anon group to the updated inline view group
SymbolMap map = (SymbolMap)groupNode.getProperty(Info.SYMBOL_MAP);
Map<Expression, ElementSymbol> inverse = map.inserseMapping();
SymbolMap newMapping = (SymbolMap) NodeEditor.findNodePreOrder(sourceNode, NodeConstants.Types.GROUP).getProperty(Info.SYMBOL_MAP);
GroupSymbol oldGroup = null;
Map<ElementSymbol, ElementSymbol> updatedMapping = new HashMap<ElementSymbol, ElementSymbol>();
for (Map.Entry<ElementSymbol, Expression> entry : symbolMap.asMap().entrySet()) {
Expression ex = newMapping.getMappedExpression((ElementSymbol) entry.getValue());
ElementSymbol orig = inverse.get(ex);
oldGroup = orig.getGroupSymbol();
updatedMapping.put(orig, entry.getKey());
}
FrameUtil.convertFrame(sourceNode, oldGroup, Collections.singleton(modifiedGroup), updatedMapping, metadata);
removeUnnecessaryViews(sourceNode, metadata, capFinder);
}
/**
* TODO: remove me - the logic in {@link #addUnionGroupBy} should be redone
* to not use a view, but the logic there is more straight-forward there
* and then we correct here.
* @param sourceNode
* @param metadata
* @param capFinder
* @param context
* @throws QueryPlannerException
* @throws QueryMetadataException
* @throws TeiidComponentException
*/
private void removeUnnecessaryViews(PlanNode sourceNode,
QueryMetadataInterface metadata, CapabilitiesFinder capFinder)
throws QueryPlannerException, QueryMetadataException,
TeiidComponentException {
for (PlanNode source : NodeEditor.findAllNodes(sourceNode.getFirstChild(), NodeConstants.Types.SOURCE, NodeConstants.Types.ACCESS)) {
PlanNode planNode = source.getFirstChild();
if (planNode == null || planNode.getType() != NodeConstants.Types.ACCESS) {
continue;
}
//temporarily remove the access node
NodeEditor.removeChildNode(source, planNode);
PlanNode parent = RuleMergeVirtual.doMerge(source, source.getParent(), false, metadata, capFinder);
//add it back
if (parent.getFirstChild() == source) {
source.getFirstChild().addAsParent(planNode);
} else {
parent.getFirstChild().addAsParent(planNode);
}
while (RuleRaiseAccess.raiseAccessNode(planNode, planNode, metadata, capFinder, true, null, context) != null) {
//continue to raise
}
}
}
private void addUnionGroupBy(
List<Expression> groupingExpressions,
LinkedHashSet<AggregateSymbol> aggregates, SymbolMap parentMap,
QueryMetadataInterface metadata, CapabilitiesFinder capFinder,
GroupSymbol group, boolean first, PlanNode planNode, boolean viewOnly, boolean partitioned)
throws QueryMetadataException, TeiidComponentException,
QueryPlannerException, QueryResolverException {
List<Expression> groupingColumns = LanguageObject.Util.deepClone(groupingExpressions, Expression.class);
//branches other than the first need to have their projected column names updated
if (!first) {
PlanNode sortNode = NodeEditor.findNodePreOrder(planNode, NodeConstants.Types.SORT, NodeConstants.Types.SOURCE);
List<Expression> sortOrder = null;
OrderBy orderBy = null;
if (sortNode != null) {
orderBy = (OrderBy)sortNode.getProperty(Info.SORT_ORDER);
sortOrder = orderBy.getSortKeys();
}
List<Expression> projectCols = FrameUtil.findTopCols(planNode);
List<ElementSymbol> virtualElements = parentMap.getKeys();
for (int i = 0; i < virtualElements.size(); i++) {
ElementSymbol virtualElem = virtualElements.get(i);
Expression projectedSymbol = projectCols.get(i);
if (!Symbol.getShortName(projectedSymbol).equals(Symbol.getShortName(virtualElem))) {
if (sortOrder != null) {
int sortIndex = sortOrder.indexOf(projectedSymbol);
if (sortIndex > -1) {
updateSymbolName(sortOrder, sortIndex, virtualElem, sortOrder.get(sortIndex));
orderBy.getOrderByItems().get(sortIndex).setSymbol(sortOrder.get(sortIndex));
}
}
updateSymbolName(projectCols, i, virtualElem, projectedSymbol);
}
}
}
PlanNode view = RuleDecomposeJoin.createSource(group, planNode, parentMap);
PlanNode projectPlanNode = NodeFactory.getNewNode(NodeConstants.Types.PROJECT);
Select allSymbols = new Select();
for (Expression expr : groupingColumns) {
allSymbols.addSymbol(new ExpressionSymbol("expr", expr)); //$NON-NLS-1$
}
if (viewOnly) {
for (AggregateSymbol agg : aggregates) {
agg = (AggregateSymbol)agg.clone();
if (agg.getAggregateFunction() == Type.COUNT) {
if (agg.getArgs().length == 0) {
allSymbols.addSymbol(new ExpressionSymbol("stagedAgg", new Constant(1))); //$NON-NLS-1$
} else {
SearchedCaseExpression count = new SearchedCaseExpression(Arrays.asList(new IsNullCriteria(agg.getArg(0))), Arrays.asList(new Constant(Integer.valueOf(0))));
count.setElseExpression(new Constant(Integer.valueOf(1)));
count.setType(DataTypeManager.DefaultDataClasses.INTEGER);
allSymbols.addSymbol(new ExpressionSymbol("stagedAgg", count)); //$NON-NLS-1$
}
} else { //min, max, sum
assert agg.getArgs().length == 1; //prior canStage should ensure this is true
Expression ex = agg.getArg(0);
ex = ResolverUtil.convertExpression(ex, DataTypeManager.getDataTypeName(agg.getType()), metadata);
allSymbols.addSymbol(new ExpressionSymbol("stagedAgg", ex)); //$NON-NLS-1$
}
}
} else {
allSymbols.addSymbols(aggregates);
}
if (first) {
QueryRewriter.makeSelectUnique(allSymbols, false);
}
projectPlanNode.setProperty(NodeConstants.Info.PROJECT_COLS, allSymbols.getSymbols());
projectPlanNode.addGroups(view.getGroups());
view.addAsParent(projectPlanNode);
if (!viewOnly) {
addGroupBy(view, groupingColumns, aggregates, metadata, projectPlanNode.getParent(), capFinder, true, groupingColumns.isEmpty() && (partitioned || containsNullDependent(aggregates)));
}
}
private void updateSymbolName(List<Expression> projectCols, int i,
ElementSymbol virtualElem, Expression projectedSymbol) {
if (projectedSymbol instanceof AliasSymbol) {
((AliasSymbol)projectedSymbol).setShortName(Symbol.getShortName(virtualElem));
} else {
projectCols.set(i, new AliasSymbol(Symbol.getShortName(virtualElem), projectedSymbol));
}
}
private boolean canPushGroupByToUnionChild(QueryMetadataInterface metadata,
CapabilitiesFinder capFinder,
List<Expression> groupingExpressions,
Set<AggregateSymbol> aggregates,
PlanNode planNode, AnalysisRecord record, PlanNode groupingNode)
throws QueryMetadataException, TeiidComponentException {
if (planNode.getType() != NodeConstants.Types.ACCESS) {
return false;
}
boolean result = RuleRaiseAccess.canRaiseOverGroupBy(groupingNode, planNode, aggregates, metadata, capFinder, record, false);
if (!result) {
return false;
}
if (containsNullDependent(aggregates) && !canFilterEmpty(metadata, capFinder, planNode, groupingExpressions)) {
return false;
}
return true;
}
private boolean containsNullDependent(Collection<AggregateSymbol> aggregates) {
for (AggregateSymbol aggregateSymbol : aggregates) {
//we don't consider count here as we dealing with the original aggregates, not the mapped expressions
if (aggregateSymbol.getFunctionDescriptor() != null && aggregateSymbol.getFunctionDescriptor().isNullDependent()) {
return true;
}
}
return false;
}
private boolean canFilterEmpty(QueryMetadataInterface metadata,
CapabilitiesFinder capFinder, PlanNode planNode, List<Expression> groupingExpressions) throws QueryMetadataException,
TeiidComponentException {
if (!groupingExpressions.isEmpty()) {
return true;
}
Object modelId = RuleRaiseAccess.getModelIDFromAccess(planNode, metadata);
return (/*CapabilitiesUtil.supports(Capability.CRITERIA_COMPARE_ORDERED, modelId, metadata, capFinder)
&&*/ CapabilitiesUtil.supports(Capability.QUERY_AGGREGATES_COUNT_STAR, modelId, metadata, capFinder)
/*&& CapabilitiesUtil.supports(Capability.QUERY_HAVING, modelId, metadata, capFinder)*/);
}
/**
* Recursively searches the union tree for all applicable source nodes
*/
static PlanNode findUnionChildren(List<PlanNode> unionChildren, boolean carinalityDependent, PlanNode setOp) {
if (setOp.getType() != NodeConstants.Types.SET_OP || setOp.getProperty(NodeConstants.Info.SET_OPERATION) != Operation.UNION) {
return setOp;
}
if (!setOp.hasBooleanProperty(NodeConstants.Info.USE_ALL)) {
if (carinalityDependent) {
return setOp;
}
setOp.setProperty(NodeConstants.Info.USE_ALL, Boolean.TRUE);
}
for (PlanNode planNode : setOp.getChildren()) {
PlanNode child = findUnionChildren(unionChildren, carinalityDependent, planNode);
if (child != null) {
unionChildren.add(child);
}
}
return null;
}
static SymbolMap createSymbolMap(GroupSymbol group,
List<? extends Expression> virtualElements,
PlanNode child, QueryMetadataInterface metadata)
throws TeiidComponentException, QueryMetadataException {
List<ElementSymbol> projectedSymbols = defineNewGroup(group,
virtualElements, metadata);
SymbolMap symbolMap = SymbolMap.createSymbolMap(projectedSymbols,
(List<Expression>)NodeEditor.findNodePreOrder(child, NodeConstants.Types.PROJECT).getProperty(NodeConstants.Info.PROJECT_COLS));
return symbolMap;
}
static List<ElementSymbol> defineNewGroup(GroupSymbol group,
List<? extends Expression> virtualElements,
QueryMetadataInterface metadata) throws TeiidComponentException,
QueryMetadataException {
TempMetadataStore store = new TempMetadataStore();
TempMetadataAdapter tma = new TempMetadataAdapter(metadata, store);
try {
group.setMetadataID(ResolverUtil.addTempGroup(tma, group, virtualElements, false));
} catch (QueryResolverException e) {
throw new TeiidComponentException(QueryPlugin.Event.TEIID30265, e);
}
List<ElementSymbol> projectedSymbols = ResolverUtil.resolveElementsInGroup(group, metadata);
return projectedSymbols;
}
/**
* Walk up the plan from the GROUP node. Should encounter only (optionally) a SELECT and can stop at the PROJECT node. Need to
* collect any AggregateSymbols used in the select criteria or projected columns.
*
* @param groupNode
* @return the set of aggregate symbols found
* @since 4.2
*/
static LinkedHashSet<AggregateSymbol> collectAggregates(PlanNode groupNode) {
LinkedHashSet<AggregateSymbol> aggregates = new LinkedHashSet<AggregateSymbol>();
PlanNode currentNode = groupNode.getParent();
SymbolMap symbolMap = (SymbolMap) groupNode.getProperty(NodeConstants.Info.SYMBOL_MAP);
while (currentNode != null) {
if (currentNode.getType() == NodeConstants.Types.PROJECT) {
List<Expression> projectedSymbols = (List<Expression>)currentNode.getProperty(NodeConstants.Info.PROJECT_COLS);
for (Expression symbol : projectedSymbols) {
mapAggregates(ElementCollectorVisitor.getAggregates(symbol, true), symbolMap, aggregates);
}
break;
}
if (currentNode.getType() == NodeConstants.Types.SELECT) {
Criteria crit = (Criteria)currentNode.getProperty(NodeConstants.Info.SELECT_CRITERIA);
mapAggregates(ElementCollectorVisitor.getAggregates(crit, true), symbolMap, aggregates);
}
currentNode = currentNode.getParent();
}
return aggregates;
}
static void mapAggregates(Collection<ElementSymbol> symbols, SymbolMap map, Collection<? super AggregateSymbol> aggs) {
for (ElementSymbol es : symbols) {
Expression ex = map.getMappedExpression(es);
if (ex instanceof AggregateSymbol) {
aggs.add((AggregateSymbol) ex);
}
}
}
/**
* Attempt to push the group node below one or more joins, manipulating the parent plan as necessary. This may involve
* modifying symbols in parent nodes (to account for staged aggregates).
* @throws QueryPlannerException
*
* @since 4.2
*/
private void pushGroupNode(PlanNode groupNode,
List<Expression> groupingExpressions,
Set<AggregateSymbol> allAggregates,
QueryMetadataInterface metadata,
CapabilitiesFinder capFinder, CommandContext cc) throws TeiidComponentException,
QueryMetadataException, QueryPlannerException {
Map<PlanNode, List<AggregateSymbol>> aggregateMap = createNodeMapping(groupNode, allAggregates, true);
if (aggregateMap == null) {
return;
}
Map<PlanNode, List<Expression>> groupingMap = createNodeMapping(groupNode, groupingExpressions, false);
Set<PlanNode> possibleTargetNodes = new LinkedHashSet<PlanNode>(aggregateMap.keySet());
possibleTargetNodes.addAll(groupingMap.keySet());
for (Map.Entry<PlanNode, List<AggregateSymbol>> entry : aggregateMap.entrySet()) {
if (AggregateSymbol.areAggregatesCardinalityDependent(entry.getValue())) {
//can't change the cardinality on the other side of the join -
//unless it's a 1-1 join, in which case this optimization isn't needed
//TODO: make a better choice if there are multiple targets
possibleTargetNodes.clear();
possibleTargetNodes.add(entry.getKey());
break;
}
}
for (PlanNode planNode : possibleTargetNodes) {
Set<Expression> stagedGroupingSymbols = new LinkedHashSet<Expression>();
Collection<AggregateSymbol> aggregates = aggregateMap.get(planNode);
planNode = canPush(groupNode, stagedGroupingSymbols, planNode);
if (planNode == null) {
continue;
}
filterExpressions(stagedGroupingSymbols, planNode.getGroups(), groupingExpressions, false);
collectSymbolsFromOtherAggregates(allAggregates, aggregates, planNode, stagedGroupingSymbols);
//perform a costing check, if there's not a significant reduction, then don't stage
float cardinality = NewCalculateCostUtil.computeCostForTree(planNode, metadata);
float ndv = NewCalculateCostUtil.getNDVEstimate(planNode, metadata, cardinality, stagedGroupingSymbols, false);
if (ndv != NewCalculateCostUtil.UNKNOWN_VALUE && cardinality / ndv < 4) {
continue;
}
if (aggregates != null) {
aggregates = stageAggregates(groupNode, metadata, stagedGroupingSymbols, aggregates);
} else {
aggregates = new ArrayList<AggregateSymbol>(1);
}
if (aggregates.isEmpty() && stagedGroupingSymbols.isEmpty()) {
continue;
}
addGroupBy(planNode, new ArrayList<Expression>(stagedGroupingSymbols), aggregates, metadata, groupNode.getParent(), capFinder, true, stagedGroupingSymbols.isEmpty() && containsNullDependent(aggregates));
}
}
/**
* TODO: if aggregates are empty, then could insert a dup remove node instead
*/
private void addGroupBy(
PlanNode child, List<Expression> stagedGroupingSymbols,
Collection<AggregateSymbol> aggregates, QueryMetadataInterface metadata, PlanNode endNode, CapabilitiesFinder capFinder, boolean considerMultiSource, boolean filterEmpty) throws QueryMetadataException,
TeiidComponentException, QueryPlannerException {
PlanNode stageGroup = NodeFactory.getNewNode(NodeConstants.Types.GROUP);
child.addAsParent(stageGroup);
aggregates = new LinkedHashSet<AggregateSymbol>(aggregates);
if (filterEmpty) {
// if the source has no rows we need to insert a select node with criteria
addEmptyFilter(aggregates, stageGroup, metadata, capFinder, RuleRaiseAccess.getModelIDFromAccess(NodeEditor.findNodePreOrder(child, NodeConstants.Types.ACCESS), metadata));
}
Map<Expression, ElementSymbol> reverseMapping = RelationalPlanner.buildGroupingNode(aggregates, stagedGroupingSymbols, stageGroup, context, idGenerator).inserseMapping();
GroupSymbol newGroup = reverseMapping.values().iterator().next().getGroupSymbol();
PlanNode node = stageGroup.getParent();
while (node != endNode) {
if (node.getType() == NodeConstants.Types.JOIN) {
node.getGroups().removeAll(FrameUtil.findJoinSourceNode(stageGroup.getFirstChild()).getGroups());
node.getGroups().add(newGroup);
}
FrameUtil.convertNode(node, null, null, reverseMapping, metadata, false);
if (node.getType() == NodeConstants.Types.JOIN) {
//reset the left/right/non-equi join criteria
RuleChooseJoinStrategy.chooseJoinStrategy(node, metadata);
}
node = node.getParent();
}
//check for push down
PlanNode accessNode = stageGroup.getFirstChild();
if (accessNode.getType() != NodeConstants.Types.ACCESS) {
groupingNodes.add(stageGroup);
} else if (RuleRaiseAccess.canRaiseOverGroupBy(stageGroup, accessNode, aggregates, metadata, capFinder, null, false)) {
if (considerMultiSource && accessNode.hasBooleanProperty(Info.IS_MULTI_SOURCE)) {
groupingNodes.add(stageGroup);
} else {
accessNode.getGroups().clear();
accessNode.getGroups().addAll(stageGroup.getGroups());
RuleRaiseAccess.performRaise(null, accessNode, stageGroup);
if (filterEmpty && RuleRaiseAccess.canRaiseOverSelect(accessNode, metadata, capFinder, accessNode.getParent(), null)) {
RuleRaiseAccess.performRaise(null, accessNode, accessNode.getParent());
}
}
}
}
private void addEmptyFilter(Collection<AggregateSymbol> aggregates,
PlanNode stageGroup, QueryMetadataInterface metadata, CapabilitiesFinder capFinder, Object modelId) throws QueryMetadataException, TeiidComponentException {
PlanNode selectNode = NodeFactory.getNewNode(NodeConstants.Types.SELECT);
AggregateSymbol count = new AggregateSymbol(NonReserved.COUNT, false, null);
aggregates.add(count); //consider the count aggregate for the push down call below
Criteria crit = new CompareCriteria(count, CompareCriteria.GT, new Constant(new Integer(0)));
selectNode.setProperty(NodeConstants.Info.SELECT_CRITERIA, crit);
selectNode.setProperty(NodeConstants.Info.IS_HAVING, Boolean.TRUE);
stageGroup.addAsParent(selectNode);
}
Set<AggregateSymbol> stageAggregates(PlanNode groupNode,
QueryMetadataInterface metadata,
Set<Expression> stagedGroupingSymbols,
Collection<AggregateSymbol> aggregates) throws TeiidComponentException, QueryPlannerException {
//remove any aggregates that are computed over a group by column
for (final Iterator<AggregateSymbol> iterator = aggregates.iterator(); iterator.hasNext();) {
final AggregateSymbol symbol = iterator.next();
if (symbol.getArgs().length != 1 || symbol.isCardinalityDependent()) {
continue;
}
Expression expr = symbol.getArg(0);
if (stagedGroupingSymbols.contains(expr)) {
iterator.remove();
}
}
if (aggregates.isEmpty()) {
return Collections.emptySet();
}
// Fix any aggregate expressions so they correctly recombine the staged aggregates
Set<AggregateSymbol> newAggs = new HashSet<AggregateSymbol>();
Map<AggregateSymbol, Expression> aggMap;
try {
aggMap = buildAggregateMap(aggregates, metadata, newAggs);
} catch (QueryResolverException e) {
throw new QueryPlannerException(QueryPlugin.Event.TEIID30266, e);
}
updateParentAggs(groupNode, aggMap, metadata);
return newAggs;
}
private void collectSymbolsFromOtherAggregates(Collection<AggregateSymbol> allAggregates,
Collection<AggregateSymbol> aggregates,
PlanNode current,
Set<Expression> stagedGroupingSymbols) {
Set<AggregateSymbol> otherAggs = new HashSet<AggregateSymbol>(allAggregates);
if (aggregates != null) {
otherAggs.removeAll(aggregates);
}
PlanNode source = FrameUtil.findJoinSourceNode(current);
for (AggregateSymbol aggregateSymbol : otherAggs) {
for (ElementSymbol symbol : ElementCollectorVisitor.getElements(aggregateSymbol, true)) {
if (source.getGroups().contains(symbol.getGroupSymbol())) {
stagedGroupingSymbols.add(symbol);
}
}
}
}
/**
* Ensures that we are only pushing through inner equi joins or cross joins. Also collects the necessary staged grouping symbols
* @return null if we cannot push otherwise the target join node
*/
private PlanNode canPush(PlanNode groupNode,
Set<Expression> stagedGroupingSymbols,
PlanNode planNode) {
PlanNode parentJoin = planNode.getParent();
Set<GroupSymbol> groups = FrameUtil.findJoinSourceNode(planNode).getGroups();
PlanNode result = planNode;
while (parentJoin != groupNode) {
if (parentJoin.getType() != NodeConstants.Types.JOIN
|| parentJoin.hasCollectionProperty(NodeConstants.Info.NON_EQUI_JOIN_CRITERIA)
|| ((JoinType)parentJoin.getProperty(NodeConstants.Info.JOIN_TYPE)).isOuter()) {
return null;
}
//we move the target up if the filtered expressions introduce outside groups
if (planNode == parentJoin.getFirstChild()) {
if (parentJoin.hasCollectionProperty(NodeConstants.Info.LEFT_EXPRESSIONS)
&& filterExpressions(stagedGroupingSymbols, groups, (List<Expression>)parentJoin.getProperty(NodeConstants.Info.LEFT_EXPRESSIONS), true)) {
result = parentJoin;
groups = result.getGroups();
}
} else {
if (parentJoin.hasCollectionProperty(NodeConstants.Info.RIGHT_EXPRESSIONS)
&& filterExpressions(stagedGroupingSymbols, groups, (List<Expression>)parentJoin.getProperty(NodeConstants.Info.RIGHT_EXPRESSIONS), true)) {
result = parentJoin;
groups = result.getGroups();
}
}
planNode = parentJoin;
parentJoin = parentJoin.getParent();
}
if (result.getParent() == groupNode) {
//can't be pushed as we are already at the direct child
return null;
}
return result;
}
/**
* @return true if the filtered expressions contain outside groups
*/
private boolean filterExpressions(Set<Expression> stagedGroupingSymbols,
Set<GroupSymbol> groups,
Collection<? extends Expression> symbols, boolean wholeExpression) {
boolean result = false;
for (Expression ex : symbols) {
Set<GroupSymbol> groups2 = GroupsUsedByElementsVisitor.getGroups(ex);
if (!Collections.disjoint(groups, groups2)) {
if (!result) {
boolean containsAll = groups.containsAll(groups2);
if (!wholeExpression && !containsAll) {
//collect only matching subexpressions - but the best that we'll currently do is elementsymbols
filterExpressions(stagedGroupingSymbols, groups, ElementCollectorVisitor.getElements(ex, true), true);
continue;
}
result = !containsAll;
}
stagedGroupingSymbols.add(SymbolMap.getExpression(ex));
}
}
return result;
}
private <T extends Expression> Map<PlanNode, List<T>> createNodeMapping(PlanNode groupNode,
Collection<T> expressions, boolean aggs) {
Map<PlanNode, List<T>> result = new LinkedHashMap<PlanNode, List<T>>();
if (expressions == null) {
return result;
}
for (T aggregateSymbol : expressions) {
if (aggs) {
AggregateSymbol as = (AggregateSymbol)aggregateSymbol;
if ((!as.canStage() && as.isCardinalityDependent()) || (as.getAggregateFunction() == Type.COUNT && as.getArgs().length == 0)) {
return null; //count(*) is not yet handled. a general approach would be count(*) => count(r.col) * count(l.col), but the logic here assumes a simpler initial mapping
}
}
Set<GroupSymbol> groups = GroupsUsedByElementsVisitor.getGroups(aggregateSymbol);
if (groups.isEmpty()) {
continue;
}
PlanNode originatingNode = FrameUtil.findOriginatingNode(groupNode.getFirstChild(), groups);
if (originatingNode == null) {
if (aggs) {
return null; //should never happen
}
continue;
}
PlanNode parentAccess = NodeEditor.findParent(originatingNode, NodeConstants.Types.ACCESS, NodeConstants.Types.GROUP);
if (parentAccess != null) {
while (parentAccess.getType() == NodeConstants.Types.SELECT) {
parentAccess = parentAccess.getParent();
}
originatingNode = parentAccess;
}
if (originatingNode.getParent() == groupNode) {
//anything logically applied after the join and is
//dependent upon the cardinality prevents us from optimizing.
if (aggs && ((AggregateSymbol)aggregateSymbol).isCardinalityDependent()) {
return null;
}
continue;
}
if (originatingNode.getType() != NodeConstants.Types.ACCESS) {
continue; //don't perform intermediate grouping
}
if (aggs && ((AggregateSymbol)aggregateSymbol).isDistinct()) {
//TODO: support distinct
continue;
}
List<T> symbols = result.get(originatingNode);
if (symbols == null) {
symbols = new LinkedList<T>();
result.put(originatingNode, symbols);
}
symbols.add(aggregateSymbol);
}
return result;
}
private static Map<AggregateSymbol, Expression> buildAggregateMap(Collection<? extends AggregateSymbol> aggregateExpressions,
QueryMetadataInterface metadata, Set<AggregateSymbol> nestedAggregates) throws QueryResolverException,
TeiidComponentException {
Map<AggregateSymbol, Expression> aggMap = new LinkedHashMap<AggregateSymbol, Expression>();
for (AggregateSymbol partitionAgg : aggregateExpressions) {
Expression newExpression = null;