-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
LogicalPlanProducer.scala
685 lines (559 loc) · 33.5 KB
/
LogicalPlanProducer.scala
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
/*
* Copyright (c) 2002-2017 "Neo Technology,"
* Network Engine for Objects in Lund AB [http://neotechnology.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* 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
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.cypher.internal.compiler.v3_4.planner.logical.steps
import org.neo4j.cypher.internal.compiler.v3_4.helpers.ListSupport
import org.neo4j.cypher.internal.compiler.v3_4.planner._
import org.neo4j.cypher.internal.compiler.v3_4.planner.logical.LogicalPlanningContext
import org.neo4j.cypher.internal.compiler.v3_4.planner.logical.Metrics.CardinalityModel
import org.neo4j.cypher.internal.frontend.v3_4.ast
import org.neo4j.cypher.internal.frontend.v3_4.ast._
import org.neo4j.cypher.internal.ir.v3_4._
import org.neo4j.cypher.internal.util.v3_4.attribution.SequentialIdGen
import org.neo4j.cypher.internal.util.v3_4.{ExhaustiveShortestPathForbiddenException, InternalException}
import org.neo4j.cypher.internal.v3_4.expressions._
import org.neo4j.cypher.internal.v3_4.logical.plans.{DeleteExpression => DeleteExpressionPlan, Limit => LimitPlan, LoadCSV => LoadCSVPlan, Skip => SkipPlan, _}
/*
* The responsibility of this class is to produce the correct solved PlannerQuery when creating logical plans.
* No other functionality or logic should live here - this is supposed to be a very simple class that does not need
* much testing
*/
case class LogicalPlanProducer(cardinalityModel: CardinalityModel, readTransactionLayer: Int) extends ListSupport {
implicit val idGen = new SequentialIdGen()
def withNextTxLayer: LogicalPlanProducer = copy(readTransactionLayer = this.readTransactionLayer + 1)
def planLock(plan: LogicalPlan, nodesToLock: Set[IdName], context: LogicalPlanningContext): LogicalPlan =
annotate(LockNodes(plan, nodesToLock), plan.solved, context)
def solvePredicate(plan: LogicalPlan, solved: Expression, context: LogicalPlanningContext): LogicalPlan = {
val pq = plan.solved.amendQueryGraph(_.addPredicates(solved))
annotate(plan.updateSolved, pq, context)
}
def planAggregation(left: LogicalPlan,
grouping: Map[String, Expression],
aggregation: Map[String, Expression],
reportedGrouping: Map[String, Expression],
reportedAggregation: Map[String, Expression],
context: LogicalPlanningContext): LogicalPlan = {
val solved = left.solved.updateTailOrSelf(_.withHorizon(
AggregatingQueryProjection(groupingExpressions = reportedGrouping, aggregationExpressions = reportedAggregation)
))
annotate(Aggregation(left, grouping, aggregation), solved, context)
}
def planAllNodesScan(idName: IdName, argumentIds: Set[IdName], context: LogicalPlanningContext): LogicalPlan = {
val solved = RegularPlannerQuery(queryGraph = QueryGraph(argumentIds = argumentIds, patternNodes = Set(idName)))
annotate(AllNodesScan(idName, argumentIds), solved, context)
}
def planApply(left: LogicalPlan, right: LogicalPlan, context: LogicalPlanningContext): LogicalPlan = {
// We don't want to keep the arguments that this Apply is inserting on the RHS, so we remove them here.
val rhsSolved: PlannerQuery = right.solved.updateTailOrSelf(_.amendQueryGraph(_.withArgumentIds(Set.empty)))
val solved: PlannerQuery = left.solved ++ rhsSolved
annotate(Apply(left, right), solved, context)
}
def planTailApply(left: LogicalPlan, right: LogicalPlan, context: LogicalPlanningContext): LogicalPlan = {
val solved = left.solved.updateTailOrSelf(_.withTail(right.solved))
annotate(Apply(left, right), solved, context)
}
def planCartesianProduct(left: LogicalPlan, right: LogicalPlan, context: LogicalPlanningContext): LogicalPlan = {
val solved: PlannerQuery = left.solved ++ right.solved
annotate(CartesianProduct(left, right), solved, context)
}
def planDirectedRelationshipByIdSeek(idName: IdName,
relIds: SeekableArgs,
startNode: IdName,
endNode: IdName,
pattern: PatternRelationship,
argumentIds: Set[IdName],
solvedPredicates: Seq[Expression] = Seq.empty,
context: LogicalPlanningContext): LogicalPlan = {
val solved = RegularPlannerQuery(queryGraph = QueryGraph.empty
.addPatternRelationship(pattern)
.addPredicates(solvedPredicates: _*)
.addArgumentIds(argumentIds.toIndexedSeq)
)
annotate(DirectedRelationshipByIdSeek(idName, relIds, startNode, endNode, argumentIds), solved, context)
}
def planUndirectedRelationshipByIdSeek(idName: IdName,
relIds: SeekableArgs,
leftNode: IdName,
rightNode: IdName,
pattern: PatternRelationship,
argumentIds: Set[IdName],
solvedPredicates: Seq[Expression] = Seq.empty,
context: LogicalPlanningContext): LogicalPlan = {
val solved = RegularPlannerQuery(queryGraph = QueryGraph.empty
.addPatternRelationship(pattern)
.addPredicates(solvedPredicates: _*)
.addArgumentIds(argumentIds.toIndexedSeq)
)
annotate(UndirectedRelationshipByIdSeek(idName, relIds, leftNode, rightNode, argumentIds), solved, context)
}
def planSimpleExpand(left: LogicalPlan,
from: IdName,
dir: SemanticDirection,
to: IdName,
pattern: PatternRelationship,
mode: ExpansionMode,
context: LogicalPlanningContext): LogicalPlan = {
val solved = left.solved.amendQueryGraph(_.addPatternRelationship(pattern))
annotate(Expand(left, from, dir, pattern.types, to, pattern.name, mode), solved, context)
}
def planVarExpand(source: LogicalPlan,
from: IdName,
dir: SemanticDirection,
to: IdName,
pattern: PatternRelationship,
temporaryNode: IdName,
temporaryEdge: IdName,
edgePredicate: Expression,
nodePredicate: Expression,
solvedPredicates: Seq[Expression],
legacyPredicates: Seq[(LogicalVariable, Expression)] = Seq.empty,
mode: ExpansionMode,
context: LogicalPlanningContext): LogicalPlan = pattern.length match {
case l: VarPatternLength =>
val projectedDir = projectedDirection(pattern, from, dir)
val solved = source.solved.amendQueryGraph(_
.addPatternRelationship(pattern)
.addPredicates(solvedPredicates: _*)
)
annotate(VarExpand(
source = source,
from = from,
dir = dir,
projectedDir = projectedDir,
types = pattern.types,
to = to,
relName = pattern.name,
length = l,
mode = mode,
tempNode = temporaryNode,
tempEdge = temporaryEdge,
nodePredicate = nodePredicate,
edgePredicate = edgePredicate,
legacyPredicates = legacyPredicates), solved, context)
case _ => throw new InternalException("Expected a varlength path to be here")
}
def planHiddenSelection(predicates: Seq[Expression], left: LogicalPlan, context: LogicalPlanningContext): LogicalPlan = {
annotate(Selection(predicates, left), left.solved, context)
}
def planNodeByIdSeek(idName: IdName, nodeIds: SeekableArgs,
solvedPredicates: Seq[Expression] = Seq.empty,
argumentIds: Set[IdName], context: LogicalPlanningContext): LogicalPlan = {
val solved = RegularPlannerQuery(queryGraph = QueryGraph.empty
.addPatternNodes(idName)
.addPredicates(solvedPredicates: _*)
.addArgumentIds(argumentIds.toIndexedSeq)
)
annotate(NodeByIdSeek(idName, nodeIds, argumentIds), solved, context)
}
def planNodeByLabelScan(idName: IdName, label: LabelName, solvedPredicates: Seq[Expression],
solvedHint: Option[UsingScanHint] = None, argumentIds: Set[IdName], context: LogicalPlanningContext): LogicalPlan = {
val solved = RegularPlannerQuery(queryGraph = QueryGraph.empty
.addPatternNodes(idName)
.addPredicates(solvedPredicates: _*)
.addHints(solvedHint)
.addArgumentIds(argumentIds.toIndexedSeq)
)
annotate(NodeByLabelScan(idName, label, argumentIds), solved, context)
}
def planNodeIndexSeek(idName: IdName,
label: LabelToken,
propertyKeys: Seq[PropertyKeyToken],
valueExpr: QueryExpression[Expression],
solvedPredicates: Seq[Expression] = Seq.empty,
solvedHint: Option[UsingIndexHint] = None,
argumentIds: Set[IdName],
context: LogicalPlanningContext): LogicalPlan = {
val solved = RegularPlannerQuery(queryGraph = QueryGraph.empty
.addPatternNodes(idName)
.addPredicates(solvedPredicates: _*)
.addHints(solvedHint)
.addArgumentIds(argumentIds.toIndexedSeq)
)
annotate(NodeIndexSeek(idName, label, propertyKeys, valueExpr, argumentIds), solved, context)
}
def planNodeIndexScan(idName: IdName,
label: LabelToken,
propertyKey: PropertyKeyToken,
solvedPredicates: Seq[Expression] = Seq.empty,
solvedHint: Option[UsingIndexHint] = None,
argumentIds: Set[IdName],
context: LogicalPlanningContext): LogicalPlan = {
val solved = RegularPlannerQuery(queryGraph = QueryGraph.empty
.addPatternNodes(idName)
.addPredicates(solvedPredicates: _*)
.addHints(solvedHint)
.addArgumentIds(argumentIds.toIndexedSeq)
)
annotate(NodeIndexScan(idName, label, propertyKey, argumentIds), solved, context)
}
def planNodeIndexContainsScan(idName: IdName,
label: LabelToken,
propertyKey: PropertyKeyToken,
solvedPredicates: Seq[Expression],
solvedHint: Option[UsingIndexHint],
valueExpr: Expression,
argumentIds: Set[IdName],
context: LogicalPlanningContext): LogicalPlan = {
val solved = RegularPlannerQuery(queryGraph = QueryGraph.empty
.addPatternNodes(idName)
.addPredicates(solvedPredicates: _*)
.addHints(solvedHint)
.addArgumentIds(argumentIds.toIndexedSeq)
)
annotate(NodeIndexContainsScan(idName, label, propertyKey, valueExpr, argumentIds), solved, context)
}
def planNodeIndexEndsWithScan(idName: IdName,
label: LabelToken,
propertyKey: PropertyKeyToken,
solvedPredicates: Seq[Expression],
solvedHint: Option[UsingIndexHint],
valueExpr: Expression,
argumentIds: Set[IdName],
context: LogicalPlanningContext): LogicalPlan = {
val solved = RegularPlannerQuery(queryGraph = QueryGraph.empty
.addPatternNodes(idName)
.addPredicates(solvedPredicates: _*)
.addHints(solvedHint)
.addArgumentIds(argumentIds.toIndexedSeq)
)
annotate(NodeIndexEndsWithScan(idName, label, propertyKey, valueExpr, argumentIds), solved, context)
}
def planNodeHashJoin(nodes: Set[IdName], left: LogicalPlan, right: LogicalPlan, hints: Set[UsingJoinHint], context: LogicalPlanningContext): LogicalPlan = {
val plannerQuery = left.solved ++ right.solved
val solved = plannerQuery.amendQueryGraph(_.addHints(hints))
annotate(NodeHashJoin(nodes, left, right), solved, context)
}
def planValueHashJoin(left: LogicalPlan, right: LogicalPlan, join: Equals, originalPredicate: Equals, context: LogicalPlanningContext): LogicalPlan = {
val plannerQuery = left.solved ++ right.solved
val solved = plannerQuery.amendQueryGraph(_.addPredicates(originalPredicate))
annotate(ValueHashJoin(left, right, join), solved, context)
}
def planNodeUniqueIndexSeek(idName: IdName,
label: LabelToken,
propertyKeys: Seq[PropertyKeyToken],
valueExpr: QueryExpression[Expression],
solvedPredicates: Seq[Expression] = Seq.empty,
solvedHint: Option[UsingIndexHint] = None,
argumentIds: Set[IdName],
context: LogicalPlanningContext): LogicalPlan = {
val solved = RegularPlannerQuery(queryGraph = QueryGraph.empty
.addPatternNodes(idName)
.addPredicates(solvedPredicates: _*)
.addHints(solvedHint)
.addArgumentIds(argumentIds.toIndexedSeq)
)
annotate(NodeUniqueIndexSeek(idName, label, propertyKeys, valueExpr, argumentIds), solved, context)
}
def planAssertSameNode(node: IdName, left: LogicalPlan, right: LogicalPlan, context: LogicalPlanningContext): LogicalPlan = {
val solved: PlannerQuery = left.solved ++ right.solved
annotate(AssertSameNode(node, left, right), solved, context)
}
def planOptionalExpand(left: LogicalPlan,
from: IdName,
dir: SemanticDirection,
to: IdName,
pattern: PatternRelationship,
mode: ExpansionMode = ExpandAll,
predicates: Seq[Expression] = Seq.empty,
solvedQueryGraph: QueryGraph,
context: LogicalPlanningContext): LogicalPlan = {
val solved = left.solved.amendQueryGraph(_.withAddedOptionalMatch(solvedQueryGraph))
annotate(OptionalExpand(left, from, dir, pattern.types, to, pattern.name, mode, predicates), solved, context)
}
def planOptional(inputPlan: LogicalPlan, ids: Set[IdName], context: LogicalPlanningContext): LogicalPlan = {
val solved = RegularPlannerQuery(queryGraph = QueryGraph.empty
.withAddedOptionalMatch(inputPlan.solved.queryGraph)
.withArgumentIds(ids)
)
annotate(Optional(inputPlan, ids), solved, context)
}
def planOuterHashJoin(nodes: Set[IdName], left: LogicalPlan, right: LogicalPlan, context: LogicalPlanningContext): LogicalPlan = {
val solved = left.solved.amendQueryGraph(_.withAddedOptionalMatch(right.solved.queryGraph))
annotate(OuterHashJoin(nodes, left, right), solved, context)
}
def planSelection(left: LogicalPlan, predicates: Seq[Expression], reported: Seq[Expression], context: LogicalPlanningContext): LogicalPlan = {
val solved = left.solved.updateTailOrSelf(_.amendQueryGraph(_.addPredicates(reported: _*)))
annotate(Selection(predicates, left), solved, context)
}
def planSelectOrAntiSemiApply(outer: LogicalPlan, inner: LogicalPlan, expr: Expression, context: LogicalPlanningContext): LogicalPlan =
annotate(SelectOrAntiSemiApply(outer, inner, expr), outer.solved, context)
def planLetSelectOrAntiSemiApply(outer: LogicalPlan, inner: LogicalPlan, id: IdName, expr: Expression, context: LogicalPlanningContext): LogicalPlan =
annotate(LetSelectOrAntiSemiApply(outer, inner, id, expr), outer.solved, context)
def planSelectOrSemiApply(outer: LogicalPlan, inner: LogicalPlan, expr: Expression, context: LogicalPlanningContext): LogicalPlan =
annotate(SelectOrSemiApply(outer, inner, expr), outer.solved, context)
def planLetSelectOrSemiApply(outer: LogicalPlan, inner: LogicalPlan, id: IdName, expr: Expression, context: LogicalPlanningContext): LogicalPlan =
annotate(LetSelectOrSemiApply(outer, inner, id, expr), outer.solved, context)
def planLetAntiSemiApply(left: LogicalPlan, right: LogicalPlan, id: IdName, context: LogicalPlanningContext): LogicalPlan =
annotate(LetAntiSemiApply(left, right, id), left.solved, context)
def planLetSemiApply(left: LogicalPlan, right: LogicalPlan, id: IdName, context: LogicalPlanningContext): LogicalPlan =
annotate(LetSemiApply(left, right, id), left.solved, context)
def planAntiSemiApply(left: LogicalPlan, right: LogicalPlan, predicate: PatternExpression, expr: Expression, context: LogicalPlanningContext): LogicalPlan = {
val solved = left.solved.updateTailOrSelf(_.amendQueryGraph(_.addPredicates(expr)))
annotate(AntiSemiApply(left, right), solved, context)
}
def planSemiApply(left: LogicalPlan, right: LogicalPlan, predicate: Expression, context: LogicalPlanningContext): LogicalPlan = {
val solved = left.solved.updateTailOrSelf(_.amendQueryGraph(_.addPredicates(predicate)))
annotate(SemiApply(left, right), solved, context)
}
def planQueryArgument(queryGraph: QueryGraph, context: LogicalPlanningContext): LogicalPlan = {
val patternNodes = queryGraph.argumentIds intersect queryGraph.patternNodes
val patternRels = queryGraph.patternRelationships.filter(rel => queryGraph.argumentIds.contains(rel.name))
val otherIds = queryGraph.argumentIds -- patternNodes
planArgument(patternNodes, patternRels, otherIds, context)
}
def planArgumentFrom(plan: LogicalPlan, context: LogicalPlanningContext): LogicalPlan =
annotate(Argument(plan.availableSymbols), plan.solved, context)
def planArgument(patternNodes: Set[IdName],
patternRels: Set[PatternRelationship] = Set.empty,
other: Set[IdName] = Set.empty,
context: LogicalPlanningContext): LogicalPlan = {
val relIds = patternRels.map(_.name)
val coveredIds = patternNodes ++ relIds ++ other
val solved = RegularPlannerQuery(queryGraph =
QueryGraph(
argumentIds = coveredIds,
patternNodes = patternNodes,
patternRelationships = Set.empty
))
annotate(Argument(coveredIds), solved, context)
}
def planArgument(context: LogicalPlanningContext): LogicalPlan =
annotate(Argument(Set.empty), PlannerQuery.empty, context)
def planEmptyProjection(inner: LogicalPlan, context: LogicalPlanningContext): LogicalPlan =
annotate(EmptyResult(inner), inner.solved, context)
def planStarProjection(inner: LogicalPlan, expressions: Map[String, Expression], reported: Map[String, Expression], context: LogicalPlanningContext): LogicalPlan = {
val newSolved: PlannerQuery = inner.solved.updateTailOrSelf(_.updateQueryProjection(_.withProjections(reported)))
annotate(inner.updateSolved, newSolved, context)
}
def planRegularProjection(inner: LogicalPlan, expressions: Map[String, Expression], reported: Map[String, Expression], context: LogicalPlanningContext): LogicalPlan = {
val solved: PlannerQuery = inner.solved.updateTailOrSelf(_.updateQueryProjection(_.withProjections(reported)))
annotate(Projection(inner, expressions), solved, context)
}
def planRollup(lhs: LogicalPlan,
rhs: LogicalPlan,
collectionName: IdName,
variableToCollect: IdName,
nullable: Set[IdName],
context: LogicalPlanningContext): LogicalPlan = {
annotate(RollUpApply(lhs, rhs, collectionName, variableToCollect, nullable), lhs.solved, context)
}
def planCountStoreNodeAggregation(query: PlannerQuery, projectedColumn: IdName, labels: List[Option[LabelName]], argumentIds: Set[IdName], context: LogicalPlanningContext): LogicalPlan = {
val solved = RegularPlannerQuery(query.queryGraph, query.horizon)
annotate(NodeCountFromCountStore(projectedColumn, labels, argumentIds), solved, context)
}
def planCountStoreRelationshipAggregation(query: PlannerQuery, idName: IdName, startLabel: Option[LabelName],
typeNames: Seq[RelTypeName], endLabel: Option[LabelName], argumentIds: Set[IdName], context: LogicalPlanningContext): LogicalPlan = {
val solved: PlannerQuery = RegularPlannerQuery(query.queryGraph, query.horizon)
annotate(RelationshipCountFromCountStore(idName, startLabel, typeNames, endLabel, argumentIds), solved, context)
}
def planSkip(inner: LogicalPlan, count: Expression, context: LogicalPlanningContext): LogicalPlan = {
val solved = inner.solved.updateTailOrSelf(_.updateQueryProjection(_.updateShuffle(_.withSkipExpression(count))))
annotate(SkipPlan(inner, count), solved, context)
}
def planLoadCSV(inner: LogicalPlan, variableName: IdName, url: Expression, format: CSVFormat, fieldTerminator: Option[StringLiteral], context: LogicalPlanningContext): LogicalPlan = {
val solved = inner.solved.updateTailOrSelf(_.withHorizon(LoadCSVProjection(variableName, url, format, fieldTerminator)))
annotate(LoadCSVPlan(inner, url, variableName, format, fieldTerminator.map(_.value), context.legacyCsvQuoteEscaping), solved, context)
}
def planUnwind(inner: LogicalPlan, name: IdName, expression: Expression, context: LogicalPlanningContext): LogicalPlan = {
val solved = inner.solved.updateTailOrSelf(_.withHorizon(UnwindProjection(name, expression)))
annotate(UnwindCollection(inner, name, expression), solved, context)
}
def planCallProcedure(inner: LogicalPlan, call: ResolvedCall, context: LogicalPlanningContext): LogicalPlan = {
val solved = inner.solved.updateTailOrSelf(_.withHorizon(ProcedureCallProjection(call)))
annotate(ProcedureCall(inner, call), solved, context)
}
def planPassAll(inner: LogicalPlan, context: LogicalPlanningContext): LogicalPlan = {
val solved = inner.solved.updateTailOrSelf(_.withHorizon(PassthroughAllHorizon()))
annotate(inner.updateSolved, solved, context)
}
def planLimit(inner: LogicalPlan, count: Expression, ties: Ties = DoNotIncludeTies, context: LogicalPlanningContext): LogicalPlan = {
val solved = inner.solved.updateTailOrSelf(_.updateQueryProjection(_.updateShuffle(_.withLimitExpression(count))))
annotate(LimitPlan(inner, count, ties), solved, context)
}
def planSort(inner: LogicalPlan, descriptions: Seq[ColumnOrder], items: Seq[ast.SortItem], context: LogicalPlanningContext): LogicalPlan = {
val solved = inner.solved.updateTailOrSelf(_.updateQueryProjection(_.updateShuffle(_.withSortItems(items))))
annotate(Sort(inner, descriptions), solved, context)
}
def planShortestPath(inner: LogicalPlan, shortestPaths: ShortestPathPattern, predicates: Seq[Expression],
withFallBack: Boolean, disallowSameNode: Boolean = true, context: LogicalPlanningContext): LogicalPlan = {
val solved = inner.solved.amendQueryGraph(_.addShortestPath(shortestPaths).addPredicates(predicates: _*))
annotate(FindShortestPaths(inner, shortestPaths, predicates, withFallBack, disallowSameNode), solved, context)
}
def planEndpointProjection(inner: LogicalPlan, start: IdName, startInScope: Boolean, end: IdName, endInScope: Boolean, patternRel: PatternRelationship, context: LogicalPlanningContext): LogicalPlan = {
val relTypes = patternRel.types.asNonEmptyOption
val directed = patternRel.dir != SemanticDirection.BOTH
val solved = inner.solved.amendQueryGraph(_.addPatternRelationship(patternRel))
annotate(ProjectEndpoints(inner, patternRel.name,
start, startInScope,
end, endInScope,
relTypes, directed, patternRel.length), solved, context)
}
def planUnion(left: LogicalPlan, right: LogicalPlan, context: LogicalPlanningContext): LogicalPlan = {
annotate(Union(left, right), left.solved, context)
/* TODO: This is not correct in any way.
LogicalPlan.solved contains a PlannerQuery, but to represent a Union, we'd need a UnionQuery instead
Not very important at the moment, but dirty.
*/
}
def planDistinctStar(left: LogicalPlan, context: LogicalPlanningContext): LogicalPlan = {
val returnAll = QueryProjection.forIds(left.availableSymbols) map {
case AliasedReturnItem(e, Variable(key)) => key -> e // This smells awful.
}
annotate(Distinct(left, returnAll.toMap), left.solved, context)
}
def planDistinct(left: LogicalPlan, expressions: Map[String, Expression], reported: Map[String, Expression], context: LogicalPlanningContext): LogicalPlan = {
val solved: PlannerQuery = left.solved.updateTailOrSelf(_.updateQueryProjection(_ => DistinctQueryProjection(reported)))
annotate(Distinct(left, expressions), solved, context)
}
def updateSolvedForOr(orPlan: LogicalPlan, orPredicate: Ors, predicates: Set[Expression], context: LogicalPlanningContext): LogicalPlan = {
val solved = orPlan.solved.updateTailOrSelf { that =>
/*
* We want to report all solved predicates, so we have kept track of what each subplan reports to solve.
* There is no need to report the predicates that are inside the OR (exprs),
* since we will add the OR itself instead.
*/
val newSelections = Selections.from((predicates -- orPredicate.exprs + orPredicate).toSeq)
that.amendQueryGraph(qg => qg.withSelections(newSelections))
}
val cardinality = context.cardinality.apply(solved, context.input, context.semanticTable)
orPlan.updateSolved(CardinalityEstimation.lift(solved, cardinality))
}
def planTriadicSelection(positivePredicate: Boolean,
left: LogicalPlan,
sourceId: IdName,
seenId: IdName,
targetId: IdName,
right: LogicalPlan,
predicate: Expression,
context: LogicalPlanningContext): LogicalPlan = {
val solved = (left.solved ++ right.solved).updateTailOrSelf(_.amendQueryGraph(_.addPredicates(predicate)))
annotate(TriadicSelection(left, right, positivePredicate, sourceId, seenId, targetId), solved, context)
}
def planCreateNode(inner: LogicalPlan, pattern: CreateNodePattern, context: LogicalPlanningContext): LogicalPlan = {
val solved = inner.solved.amendQueryGraph(_.addMutatingPatterns(pattern))
annotate(CreateNode(inner, pattern.nodeName, pattern.labels, pattern.properties), solved, context)
}
def planMergeCreateNode(inner: LogicalPlan, pattern: CreateNodePattern, context: LogicalPlanningContext): LogicalPlan = {
val solved = inner.solved.amendQueryGraph(_.addMutatingPatterns(pattern))
annotate(MergeCreateNode(inner, pattern.nodeName, pattern.labels, pattern.properties), solved, context)
}
def planCreateRelationship(inner: LogicalPlan, pattern: CreateRelationshipPattern, context: LogicalPlanningContext): LogicalPlan = {
val solved = inner.solved.amendQueryGraph(_.addMutatingPatterns(pattern))
annotate(CreateRelationship(inner, pattern.relName, pattern.startNode, pattern.relType,
pattern.endNode, pattern.properties), solved, context)
}
def planMergeCreateRelationship(inner: LogicalPlan, pattern: CreateRelationshipPattern, context: LogicalPlanningContext): LogicalPlan = {
val solved = inner.solved.amendQueryGraph(_.addMutatingPatterns(pattern))
annotate(MergeCreateRelationship(inner, pattern.relName, pattern.startNode, pattern.relType,
pattern.endNode, pattern.properties), solved, context)
}
def planConditionalApply(lhs: LogicalPlan, rhs: LogicalPlan, idNames: Seq[IdName], context: LogicalPlanningContext): LogicalPlan = {
val solved = lhs.solved ++ rhs.solved
annotate(ConditionalApply(lhs, rhs, idNames), solved, context)
}
def planAntiConditionalApply(inner: LogicalPlan, outer: LogicalPlan, idNames: Seq[IdName], context: LogicalPlanningContext, maybeSolved: Option[PlannerQuery] = None): LogicalPlan = {
val solved = maybeSolved.getOrElse(inner.solved ++ outer.solved)
annotate(AntiConditionalApply(inner, outer, idNames), solved, context)
}
def planDeleteNode(inner: LogicalPlan, delete: DeleteExpression, context: LogicalPlanningContext): LogicalPlan = {
val solved = inner.solved.amendQueryGraph(_.addMutatingPatterns(delete))
if (delete.forced)
annotate(DetachDeleteNode(inner, delete.expression), solved, context)
else
annotate(DeleteNode(inner, delete.expression), solved, context)
}
def planDeleteRelationship(inner: LogicalPlan, delete: DeleteExpression, context: LogicalPlanningContext): LogicalPlan = {
val solved = inner.solved.amendQueryGraph(_.addMutatingPatterns(delete))
annotate(DeleteRelationship(inner, delete.expression), solved, context)
}
def planDeletePath(inner: LogicalPlan, delete: DeleteExpression, context: LogicalPlanningContext): LogicalPlan = {
val solved = inner.solved.amendQueryGraph(_.addMutatingPatterns(delete))
if (delete.forced)
annotate(DetachDeletePath(inner, delete.expression), solved, context)
else
annotate(DeletePath(inner, delete.expression), solved, context)
}
def planDeleteExpression(inner: LogicalPlan, delete: DeleteExpression, context: LogicalPlanningContext): LogicalPlan = {
val solved = inner.solved.amendQueryGraph(_.addMutatingPatterns(delete))
if (delete.forced)
annotate(DetachDeleteExpression(inner, delete.expression), solved, context)
else
annotate(DeleteExpressionPlan(inner, delete.expression), solved, context)
}
def planSetLabel(inner: LogicalPlan, pattern: SetLabelPattern, context: LogicalPlanningContext): LogicalPlan = {
val solved = inner.solved.amendQueryGraph(_.addMutatingPatterns(pattern))
annotate(SetLabels(inner, pattern.idName, pattern.labels), solved, context)
}
def planSetNodeProperty(inner: LogicalPlan, pattern: SetNodePropertyPattern, context: LogicalPlanningContext): LogicalPlan = {
val solved = inner.solved.amendQueryGraph(_.addMutatingPatterns(pattern))
annotate(SetNodeProperty(inner, pattern.idName, pattern.propertyKey, pattern.expression), solved, context)
}
def planSetNodePropertiesFromMap(inner: LogicalPlan,
pattern: SetNodePropertiesFromMapPattern, context: LogicalPlanningContext): LogicalPlan = {
val solved = inner.solved.amendQueryGraph(_.addMutatingPatterns(pattern))
annotate(SetNodePropertiesFromMap(inner, pattern.idName, pattern.expression, pattern.removeOtherProps), solved, context)
}
def planSetRelationshipProperty(inner: LogicalPlan, pattern: SetRelationshipPropertyPattern, context: LogicalPlanningContext): LogicalPlan = {
val solved = inner.solved.amendQueryGraph(_.addMutatingPatterns(pattern))
annotate(SetRelationshipPropery(inner, pattern.idName, pattern.propertyKey, pattern.expression), solved, context)
}
def planSetRelationshipPropertiesFromMap(inner: LogicalPlan,
pattern: SetRelationshipPropertiesFromMapPattern, context: LogicalPlanningContext): LogicalPlan = {
val solved = inner.solved.amendQueryGraph(_.addMutatingPatterns(pattern))
annotate(SetRelationshipPropertiesFromMap(inner, pattern.idName, pattern.expression, pattern.removeOtherProps), solved, context)
}
def planSetProperty(inner: LogicalPlan, pattern: SetPropertyPattern, context: LogicalPlanningContext): LogicalPlan = {
val solved = inner.solved.amendQueryGraph(_.addMutatingPatterns(pattern))
annotate(SetProperty(inner, pattern.entityExpression, pattern.propertyKeyName, pattern.expression), solved, context)
}
def planRemoveLabel(inner: LogicalPlan, pattern: RemoveLabelPattern, context: LogicalPlanningContext): LogicalPlan = {
val solved = inner.solved.amendQueryGraph(_.addMutatingPatterns(pattern))
annotate(RemoveLabels(inner, pattern.idName, pattern.labels), solved, context)
}
def planForeachApply(left: LogicalPlan, innerUpdates: LogicalPlan, pattern: ForeachPattern, context: LogicalPlanningContext): LogicalPlan = {
val solved = left.solved.amendQueryGraph(_.addMutatingPatterns(pattern))
annotate(ForeachApply(left, innerUpdates, pattern.variable.name, pattern.expression), solved, context)
}
def planEager(inner: LogicalPlan, context: LogicalPlanningContext): LogicalPlan =
annotate(Eager(inner), inner.solved, context)
def planError(inner: LogicalPlan, exception: ExhaustiveShortestPathForbiddenException, context: LogicalPlanningContext): LogicalPlan =
annotate(ErrorPlan(inner, exception), inner.solved, context)
def planProduceResult(inner: LogicalPlan, columns: Seq[String]): LogicalPlan = {
val result = ProduceResult(inner, columns)
result.readTransactionLayer.value = readTransactionLayer
result
}
private def annotate(plan: PlannerQuery with CardinalityEstimation => LogicalPlan, plannerQuery: PlannerQuery, context: LogicalPlanningContext): LogicalPlan = {
val cardinality = cardinalityModel(plannerQuery, context.input, context.semanticTable)
val solved = CardinalityEstimation.lift(plannerQuery, cardinality)
val p = plan(solved)
p.readTransactionLayer.value = readTransactionLayer
p
}
private def projectedDirection(pattern: PatternRelationship, from: IdName, dir: SemanticDirection): SemanticDirection = {
if (dir == SemanticDirection.BOTH) {
if (from == pattern.left)
SemanticDirection.OUTGOING
else
SemanticDirection.INCOMING
}
else
pattern.dir
}
}