forked from polarsignals/frostdb
-
Notifications
You must be signed in to change notification settings - Fork 0
/
logicalplan.go
416 lines (343 loc) · 9.75 KB
/
logicalplan.go
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
package logicalplan
import (
"context"
"fmt"
"strings"
"github.com/apache/arrow/go/v15/arrow"
"github.com/apache/arrow/go/v15/arrow/memory"
"github.com/dreamsxin/frostdb/dynparquet"
"github.com/dreamsxin/frostdb/pqarrow/convert"
)
// LogicalPlan is a logical representation of a query. Each LogicalPlan is a
// sub-tree of the query. It is built recursively.
type LogicalPlan struct {
Input *LogicalPlan
// Each LogicalPlan struct must only have one of the following.
SchemaScan *SchemaScan
TableScan *TableScan
Filter *Filter
Distinct *Distinct
Projection *Projection
Aggregation *Aggregation
Limit *Limit
}
// Callback is a function that is called throughout a chain of operators
// modifying the underlying data.
type Callback func(ctx context.Context, r arrow.Record) error
// IterOptions are a set of options for the TableReader Iterators.
type IterOptions struct {
PhysicalProjection []Expr
Projection []Expr
Filter Expr
DistinctColumns []Expr
ReadMode ReadMode
}
type Option func(opts *IterOptions)
func WithReadMode(m ReadMode) Option {
return func(opts *IterOptions) {
opts.ReadMode = m
}
}
func WithPhysicalProjection(e ...Expr) Option {
return func(opts *IterOptions) {
opts.PhysicalProjection = append(opts.PhysicalProjection, e...)
}
}
func WithProjection(e ...Expr) Option {
return func(opts *IterOptions) {
opts.Projection = append(opts.Projection, e...)
}
}
func WithFilter(e Expr) Option {
return func(opts *IterOptions) {
opts.Filter = e
}
}
func WithDistinctColumns(e ...Expr) Option {
return func(opts *IterOptions) {
opts.DistinctColumns = append(opts.DistinctColumns, e...)
}
}
func (plan *LogicalPlan) String() string {
return plan.string(0)
}
func (plan *LogicalPlan) string(indent int) string {
res := ""
switch {
case plan.SchemaScan != nil:
res = plan.SchemaScan.String()
case plan.TableScan != nil:
res = plan.TableScan.String()
case plan.Filter != nil:
res = plan.Filter.String()
case plan.Projection != nil:
res = plan.Projection.String()
case plan.Aggregation != nil:
res = plan.Aggregation.String()
case plan.Distinct != nil:
res = plan.Distinct.String()
default:
res = "Unknown LogicalPlan"
}
res = strings.Repeat(" ", indent) + res
if plan.Input != nil {
res += "\n" + plan.Input.string(indent+1)
}
return res
}
func (plan *LogicalPlan) DataTypeForExpr(expr Expr) (arrow.DataType, error) {
switch {
case plan.SchemaScan != nil:
t, err := plan.SchemaScan.DataTypeForExpr(expr)
if err != nil {
return nil, fmt.Errorf("data type for expr %v within SchemaScan: %w", expr, err)
}
return t, nil
case plan.TableScan != nil:
t, err := plan.TableScan.DataTypeForExpr(expr)
if err != nil {
return nil, fmt.Errorf("data type for expr %v within TableScan: %w", expr, err)
}
return t, nil
case plan.Filter != nil:
t, err := plan.Input.DataTypeForExpr(expr)
if err != nil {
return nil, fmt.Errorf("data type for expr %v within Filter: %w", expr, err)
}
return t, nil
case plan.Projection != nil:
for _, e := range plan.Projection.Exprs {
if e.Name() == expr.Name() {
return e.DataType(plan.Input)
}
}
t, err := expr.DataType(plan.Input)
if err != nil {
return nil, fmt.Errorf("data type for expr %v within Projection: %w", expr, err)
}
return t, nil
case plan.Aggregation != nil:
if agg, ok := expr.(*AggregationFunction); ok {
if agg.Func == AggFuncCount {
return arrow.PrimitiveTypes.Int64, nil
}
return agg.Expr.DataType(plan.Input)
}
t, err := expr.DataType(plan.Input)
if err != nil {
return nil, fmt.Errorf("data type for expr %v within Aggregation: %w", expr, err)
}
return t, nil
case plan.Distinct != nil:
t, err := expr.DataType(plan.Input)
if err != nil {
return nil, fmt.Errorf("data type for expr %v within Distinct: %w", expr, err)
}
return t, nil
default:
return nil, fmt.Errorf("unknown logical plan")
}
}
// TableReader returns the table reader.
func (plan *LogicalPlan) TableReader() (TableReader, error) {
if plan.TableScan != nil {
return plan.TableScan.TableProvider.GetTable(plan.TableScan.TableName)
}
if plan.SchemaScan != nil {
return plan.SchemaScan.TableProvider.GetTable(plan.SchemaScan.TableName)
}
if plan.Input != nil {
return plan.Input.TableReader()
}
return nil, fmt.Errorf("no table reader provided")
}
// InputSchema returns the schema that the query will execute against.
func (plan *LogicalPlan) InputSchema() *dynparquet.Schema {
tableReader, err := plan.TableReader()
if err != nil {
return nil
}
return tableReader.Schema()
}
type PlanVisitor interface {
PreVisit(plan *LogicalPlan) bool
PostVisit(plan *LogicalPlan) bool
}
func (plan *LogicalPlan) Accept(visitor PlanVisitor) bool {
continu := visitor.PreVisit(plan)
if !continu {
return false
}
if plan.Input != nil {
continu = plan.Input.Accept(visitor)
if !continu {
return false
}
}
return visitor.PostVisit(plan)
}
type TableReader interface {
View(ctx context.Context, fn func(ctx context.Context, tx uint64) error) error
Iterator(
ctx context.Context,
tx uint64,
pool memory.Allocator,
callbacks []Callback,
options ...Option,
) error
SchemaIterator(
ctx context.Context,
tx uint64,
pool memory.Allocator,
callbacks []Callback,
options ...Option,
) error
Schema() *dynparquet.Schema
}
type TableProvider interface {
GetTable(name string) (TableReader, error)
}
type TableScan struct {
TableProvider TableProvider
TableName string
// PhysicalProjection describes the columns that are to be physically read
// by the table scan. This is an Expr so it can be either a column or
// dynamic column.
PhysicalProjection []Expr
// Filter is the predicate that is to be applied by the table scan to rule
// out any blocks of data to be scanned at all.
Filter Expr
// Distinct describes the columns that are to be distinct.
Distinct []Expr
// Projection is the list of columns that are to be projected.
Projection []Expr
// ReadMode indicates the mode to use when reading.
ReadMode ReadMode
}
func (scan *TableScan) DataTypeForExpr(expr Expr) (arrow.DataType, error) {
tp, err := scan.TableProvider.GetTable(scan.TableName)
if err != nil {
return nil, fmt.Errorf("get table %q: %w", scan.TableName, err)
}
s := tp.Schema()
if s == nil {
return nil, fmt.Errorf("table %q has no schema", scan.TableName)
}
t, err := DataTypeForExprWithSchema(expr, s)
if err != nil {
return nil, fmt.Errorf("type for expr %q in table %q: %w", expr, scan.TableName, err)
}
return t, nil
}
func DataTypeForExprWithSchema(expr Expr, s *dynparquet.Schema) (arrow.DataType, error) {
switch expr := expr.(type) {
case *Column:
colDef, found := s.FindDynamicColumnForConcreteColumn(expr.ColumnName)
if found {
t, err := convert.ParquetNodeToType(colDef.StorageLayout)
if err != nil {
return nil, fmt.Errorf("convert parquet node to type: %w", err)
}
return t, nil
}
colDef, found = s.FindColumn(expr.ColumnName)
if found {
t, err := convert.ParquetNodeToType(colDef.StorageLayout)
if err != nil {
return nil, fmt.Errorf("convert parquet node to type: %w", err)
}
return t, nil
}
return nil, fmt.Errorf("column %q not found", expr.ColumnName)
case *DynamicColumn:
colDef, found := s.FindDynamicColumn(expr.ColumnName)
if found {
t, err := convert.ParquetNodeToType(colDef.StorageLayout)
if err != nil {
return nil, fmt.Errorf("convert parquet node to type: %w", err)
}
return t, nil
}
return nil, fmt.Errorf("dynamic column %q not found", expr.ColumnName)
default:
return nil, fmt.Errorf("unhandled expr type %T", expr)
}
}
func (scan *TableScan) String() string {
return "TableScan" +
" Table: " + scan.TableName +
" Projection: " + fmt.Sprint(scan.Projection) +
" Filter: " + fmt.Sprint(scan.Filter) +
" Distinct: " + fmt.Sprint(scan.Distinct)
}
type ReadMode int
const (
// ReadModeDefault is the default read mode. Reads from in-memory and object
// storage.
ReadModeDefault ReadMode = iota
// ReadModeInMemoryOnly reads from in-memory storage only.
ReadModeInMemoryOnly
// ReadModeDataSourcesOnly reads from data sources only.
ReadModeDataSourcesOnly
)
type SchemaScan struct {
TableProvider TableProvider
TableName string
// PhysicalProjection describes the columns that are to be physically read
// by the table scan.
PhysicalProjection []Expr
// filter is the predicate that is to be applied by the table scan to rule
// out any blocks of data to be scanned at all.
Filter Expr
// Distinct describes the columns that are to be distinct.
Distinct []Expr
// Projection is the list of columns that are to be projected.
Projection []Expr
// ReadMode indicates the mode to use when reading.
ReadMode ReadMode
}
func (s *SchemaScan) String() string {
return "SchemaScan"
}
func (s *SchemaScan) DataTypeForExpr(expr Expr) (arrow.DataType, error) {
switch expr := expr.(type) {
case *Column:
if expr.ColumnName == "name" {
return arrow.BinaryTypes.String, nil
}
return nil, fmt.Errorf("unknown column %s", expr.ColumnName)
default:
return nil, fmt.Errorf("unhandled expr %T", expr)
}
}
type Filter struct {
Expr Expr
}
func (f *Filter) String() string {
return "Filter" + " Expr: " + fmt.Sprint(f.Expr)
}
type Distinct struct {
Exprs []Expr
}
func (d *Distinct) String() string {
return "Distinct"
}
type Projection struct {
Exprs []Expr
}
func (p *Projection) String() string {
return "Projection (" + fmt.Sprint(p.Exprs) + ")"
}
type Aggregation struct {
AggExprs []*AggregationFunction
GroupExprs []Expr
}
func (a *Aggregation) String() string {
return "Aggregation " + fmt.Sprint(a.AggExprs) + " Group: " + fmt.Sprint(a.GroupExprs)
}
type Limit struct {
Expr Expr
}
func (l *Limit) String() string {
return "Limit" + " Expr: " + fmt.Sprint(l.Expr)
}