-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
types.go
924 lines (733 loc) · 22.3 KB
/
types.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
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
/*
Copyright 2019 Google LLC
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package spansql
// This file holds the type definitions for the SQL dialect.
import (
"fmt"
"math"
"sort"
"strings"
"time"
"cloud.google.com/go/civil"
)
// TODO: More Position fields throughout; maybe in Query/Select.
// CreateTable represents a CREATE TABLE statement.
// https://cloud.google.com/spanner/docs/data-definition-language#create_table
type CreateTable struct {
Name ID
Columns []ColumnDef
Constraints []TableConstraint
PrimaryKey []KeyPart
Interleave *Interleave
RowDeletionPolicy *RowDeletionPolicy
Position Position // position of the "CREATE" token
}
func (ct *CreateTable) String() string { return fmt.Sprintf("%#v", ct) }
func (*CreateTable) isDDLStmt() {}
func (ct *CreateTable) Pos() Position { return ct.Position }
func (ct *CreateTable) clearOffset() {
for i := range ct.Columns {
// Mutate in place.
ct.Columns[i].clearOffset()
}
for i := range ct.Constraints {
// Mutate in place.
ct.Constraints[i].clearOffset()
}
ct.Position.Offset = 0
}
// TableConstraint represents a constraint on a table.
type TableConstraint struct {
Name ID // may be empty
Constraint Constraint
Position Position // position of the "CONSTRAINT" token, or Constraint.Pos()
}
func (tc TableConstraint) Pos() Position { return tc.Position }
func (tc *TableConstraint) clearOffset() {
switch c := tc.Constraint.(type) {
case ForeignKey:
c.clearOffset()
tc.Constraint = c
case Check:
c.clearOffset()
tc.Constraint = c
}
tc.Position.Offset = 0
}
type Constraint interface {
isConstraint()
SQL() string
Node
}
// Interleave represents an interleave clause of a CREATE TABLE statement.
type Interleave struct {
Parent ID
OnDelete OnDelete
}
// RowDeletionPolicy represents an row deletion policy clause of a CREATE, ALTER TABLE statement.
type RowDeletionPolicy struct {
Column ID
NumDays int64
}
// CreateIndex represents a CREATE INDEX statement.
// https://cloud.google.com/spanner/docs/data-definition-language#create-index
type CreateIndex struct {
Name ID
Table ID
Columns []KeyPart
Unique bool
NullFiltered bool
Storing []ID
Interleave ID
Position Position // position of the "CREATE" token
}
func (ci *CreateIndex) String() string { return fmt.Sprintf("%#v", ci) }
func (*CreateIndex) isDDLStmt() {}
func (ci *CreateIndex) Pos() Position { return ci.Position }
func (ci *CreateIndex) clearOffset() { ci.Position.Offset = 0 }
// CreateView represents a CREATE [OR REPLACE] VIEW statement.
// https://cloud.google.com/spanner/docs/data-definition-language#view_statements
type CreateView struct {
Name ID
OrReplace bool
Query Query
Position Position // position of the "CREATE" token
}
func (cv *CreateView) String() string { return fmt.Sprintf("%#v", cv) }
func (*CreateView) isDDLStmt() {}
func (cv *CreateView) Pos() Position { return cv.Position }
func (cv *CreateView) clearOffset() { cv.Position.Offset = 0 }
// DropTable represents a DROP TABLE statement.
// https://cloud.google.com/spanner/docs/data-definition-language#drop_table
type DropTable struct {
Name ID
Position Position // position of the "DROP" token
}
func (dt *DropTable) String() string { return fmt.Sprintf("%#v", dt) }
func (*DropTable) isDDLStmt() {}
func (dt *DropTable) Pos() Position { return dt.Position }
func (dt *DropTable) clearOffset() { dt.Position.Offset = 0 }
// DropIndex represents a DROP INDEX statement.
// https://cloud.google.com/spanner/docs/data-definition-language#drop-index
type DropIndex struct {
Name ID
Position Position // position of the "DROP" token
}
func (di *DropIndex) String() string { return fmt.Sprintf("%#v", di) }
func (*DropIndex) isDDLStmt() {}
func (di *DropIndex) Pos() Position { return di.Position }
func (di *DropIndex) clearOffset() { di.Position.Offset = 0 }
// DropView represents a DROP VIEW statement.
// https://cloud.google.com/spanner/docs/data-definition-language#drop-view
type DropView struct {
Name ID
Position Position // position of the "DROP" token
}
func (dv *DropView) String() string { return fmt.Sprintf("%#v", dv) }
func (*DropView) isDDLStmt() {}
func (dv *DropView) Pos() Position { return dv.Position }
func (dv *DropView) clearOffset() { dv.Position.Offset = 0 }
// AlterTable represents an ALTER TABLE statement.
// https://cloud.google.com/spanner/docs/data-definition-language#alter_table
type AlterTable struct {
Name ID
Alteration TableAlteration
Position Position // position of the "ALTER" token
}
func (at *AlterTable) String() string { return fmt.Sprintf("%#v", at) }
func (*AlterTable) isDDLStmt() {}
func (at *AlterTable) Pos() Position { return at.Position }
func (at *AlterTable) clearOffset() {
switch alt := at.Alteration.(type) {
case AddColumn:
alt.Def.clearOffset()
at.Alteration = alt
case AddConstraint:
alt.Constraint.clearOffset()
at.Alteration = alt
}
at.Position.Offset = 0
}
// TableAlteration is satisfied by AddColumn, DropColumn, AddConstraint,
// DropConstraint, SetOnDelete and AlterColumn,
// AddRowDeletionPolicy, ReplaceRowDeletionPolicy, DropRowDeletionPolicy.
type TableAlteration interface {
isTableAlteration()
SQL() string
}
func (AddColumn) isTableAlteration() {}
func (DropColumn) isTableAlteration() {}
func (AddConstraint) isTableAlteration() {}
func (DropConstraint) isTableAlteration() {}
func (SetOnDelete) isTableAlteration() {}
func (AlterColumn) isTableAlteration() {}
func (AddRowDeletionPolicy) isTableAlteration() {}
func (ReplaceRowDeletionPolicy) isTableAlteration() {}
func (DropRowDeletionPolicy) isTableAlteration() {}
type AddColumn struct{ Def ColumnDef }
type DropColumn struct{ Name ID }
type AddConstraint struct{ Constraint TableConstraint }
type DropConstraint struct{ Name ID }
type SetOnDelete struct{ Action OnDelete }
type AlterColumn struct {
Name ID
Alteration ColumnAlteration
}
type AddRowDeletionPolicy struct{ RowDeletionPolicy RowDeletionPolicy }
type ReplaceRowDeletionPolicy struct{ RowDeletionPolicy RowDeletionPolicy }
type DropRowDeletionPolicy struct{}
// ColumnAlteration is satisfied by SetColumnType and SetColumnOptions.
type ColumnAlteration interface {
isColumnAlteration()
SQL() string
}
func (SetColumnType) isColumnAlteration() {}
func (SetColumnOptions) isColumnAlteration() {}
func (SetDefault) isColumnAlteration() {}
func (DropDefault) isColumnAlteration() {}
type SetColumnType struct {
Type Type
NotNull bool
Default Expr
}
type SetColumnOptions struct{ Options ColumnOptions }
type SetDefault struct {
Default Expr
}
type DropDefault struct{}
type OnDelete int
const (
NoActionOnDelete OnDelete = iota
CascadeOnDelete
)
// AlterDatabase represents an ALTER DATABASE statement.
// https://cloud.google.com/spanner/docs/data-definition-language#alter-database
type AlterDatabase struct {
Name ID
Alteration DatabaseAlteration
Position Position // position of the "ALTER" token
}
func (ad *AlterDatabase) String() string { return fmt.Sprintf("%#v", ad) }
func (*AlterDatabase) isDDLStmt() {}
func (ad *AlterDatabase) Pos() Position { return ad.Position }
func (ad *AlterDatabase) clearOffset() { ad.Position.Offset = 0 }
type DatabaseAlteration interface {
isDatabaseAlteration()
SQL() string
}
type SetDatabaseOptions struct{ Options DatabaseOptions }
func (SetDatabaseOptions) isDatabaseAlteration() {}
// DatabaseOptions represents options on a database as part of a
// ALTER DATABASE statement.
type DatabaseOptions struct {
OptimizerVersion *int
VersionRetentionPeriod *string
EnableKeyVisualizer *bool
}
// Delete represents a DELETE statement.
// https://cloud.google.com/spanner/docs/dml-syntax#delete-statement
type Delete struct {
Table ID
Where BoolExpr
// TODO: Alias
}
func (d *Delete) String() string { return fmt.Sprintf("%#v", d) }
func (*Delete) isDMLStmt() {}
// Insert represents an INSERT statement.
// https://cloud.google.com/spanner/docs/dml-syntax#insert-statement
type Insert struct {
Table ID
Columns []ID
Input ValuesOrSelect
}
// Values represents one or more lists of expressions passed to an `INSERT` statement.
type Values [][]Expr
func (v Values) isValuesOrSelect() {}
func (v Values) String() string { return fmt.Sprintf("%#v", v) }
type ValuesOrSelect interface {
isValuesOrSelect()
SQL() string
}
func (Select) isValuesOrSelect() {}
func (i *Insert) String() string { return fmt.Sprintf("%#v", i) }
func (*Insert) isDMLStmt() {}
// Update represents an UPDATE statement.
// https://cloud.google.com/spanner/docs/dml-syntax#update-statement
type Update struct {
Table ID
Items []UpdateItem
Where BoolExpr
// TODO: Alias
}
func (u *Update) String() string { return fmt.Sprintf("%#v", u) }
func (*Update) isDMLStmt() {}
type UpdateItem struct {
Column ID
Value Expr // or nil for DEFAULT
}
// ColumnDef represents a column definition as part of a CREATE TABLE
// or ALTER TABLE statement.
type ColumnDef struct {
Name ID
Type Type
NotNull bool
Default Expr // set if this column has a default value
Generated Expr // set of this is a generated column
Options ColumnOptions
Position Position // position of the column name
}
func (cd ColumnDef) Pos() Position { return cd.Position }
func (cd *ColumnDef) clearOffset() { cd.Position.Offset = 0 }
// ColumnOptions represents options on a column as part of a
// CREATE TABLE or ALTER TABLE statement.
type ColumnOptions struct {
// AllowCommitTimestamp represents a column OPTIONS.
// `true` if query is `OPTIONS (allow_commit_timestamp = true)`
// `false` if query is `OPTIONS (allow_commit_timestamp = null)`
// `nil` if there are no OPTIONS
AllowCommitTimestamp *bool
}
// ForeignKey represents a foreign key definition as part of a CREATE TABLE
// or ALTER TABLE statement.
type ForeignKey struct {
Columns []ID
RefTable ID
RefColumns []ID
Position Position // position of the "FOREIGN" token
}
func (fk ForeignKey) Pos() Position { return fk.Position }
func (fk *ForeignKey) clearOffset() { fk.Position.Offset = 0 }
func (ForeignKey) isConstraint() {}
// Check represents a check constraint as part of a CREATE TABLE
// or ALTER TABLE statement.
type Check struct {
Expr BoolExpr
Position Position // position of the "CHECK" token
}
func (c Check) Pos() Position { return c.Position }
func (c *Check) clearOffset() { c.Position.Offset = 0 }
func (Check) isConstraint() {}
// Type represents a column type.
type Type struct {
Array bool
Base TypeBase // Bool, Int64, Float64, Numeric, String, Bytes, Date, Timestamp
Len int64 // if Base is String or Bytes; may be MaxLen
}
// MaxLen is a sentinel for Type's Len field, representing the MAX value.
const MaxLen = math.MaxInt64
type TypeBase int
const (
Bool TypeBase = iota
Int64
Float64
Numeric
String
Bytes
Date
Timestamp
JSON
)
// KeyPart represents a column specification as part of a primary key or index definition.
type KeyPart struct {
Column ID
Desc bool
}
// Query represents a query statement.
// https://cloud.google.com/spanner/docs/query-syntax#sql-syntax
type Query struct {
Select Select
Order []Order
Limit, Offset LiteralOrParam
}
// Select represents a SELECT statement.
// https://cloud.google.com/spanner/docs/query-syntax#select-list
type Select struct {
Distinct bool
List []Expr
From []SelectFrom
Where BoolExpr
GroupBy []Expr
// TODO: Having
// When the FROM clause has TABLESAMPLE operators,
// TableSamples will be populated 1:1 with From;
// FROM clauses without will have a nil value.
TableSamples []*TableSample
// If the SELECT list has explicit aliases ("AS alias"),
// ListAliases will be populated 1:1 with List;
// aliases that are present will be non-empty.
ListAliases []ID
}
// SelectFrom represents the FROM clause of a SELECT.
// https://cloud.google.com/spanner/docs/query-syntax#from_clause
type SelectFrom interface {
isSelectFrom()
SQL() string
}
// SelectFromTable is a SelectFrom that specifies a table to read from.
type SelectFromTable struct {
Table ID
Alias ID // empty if not aliased
Hints map[string]string
}
func (SelectFromTable) isSelectFrom() {}
// SelectFromJoin is a SelectFrom that joins two other SelectFroms.
// https://cloud.google.com/spanner/docs/query-syntax#join_types
type SelectFromJoin struct {
Type JoinType
LHS, RHS SelectFrom
// Join condition.
// At most one of {On,Using} may be set.
On BoolExpr
Using []ID
// Hints are suggestions for how to evaluate a join.
// https://cloud.google.com/spanner/docs/query-syntax#join-hints
Hints map[string]string
}
func (SelectFromJoin) isSelectFrom() {}
type JoinType int
const (
InnerJoin JoinType = iota
CrossJoin
FullJoin
LeftJoin
RightJoin
)
// SelectFromUnnest is a SelectFrom that yields a virtual table from an array.
// https://cloud.google.com/spanner/docs/query-syntax#unnest
type SelectFromUnnest struct {
Expr Expr
Alias ID // empty if not aliased
// TODO: Implicit
}
func (SelectFromUnnest) isSelectFrom() {}
// TODO: SelectFromSubquery, etc.
type Order struct {
Expr Expr
Desc bool
}
type TableSample struct {
Method TableSampleMethod
Size Expr
SizeType TableSampleSizeType
}
type TableSampleMethod int
const (
Bernoulli TableSampleMethod = iota
Reservoir
)
type TableSampleSizeType int
const (
PercentTableSample TableSampleSizeType = iota
RowsTableSample
)
type BoolExpr interface {
isBoolExpr()
Expr
}
type Expr interface {
isExpr()
SQL() string
addSQL(*strings.Builder)
}
// LiteralOrParam is implemented by integer literal and parameter values.
type LiteralOrParam interface {
isLiteralOrParam()
SQL() string
}
type ArithOp struct {
Op ArithOperator
LHS, RHS Expr // only RHS is set for Neg, Plus, BitNot
}
func (ArithOp) isExpr() {}
type ArithOperator int
const (
Neg ArithOperator = iota // unary -
Plus // unary +
BitNot // unary ~
Mul // *
Div // /
Concat // ||
Add // +
Sub // -
BitShl // <<
BitShr // >>
BitAnd // &
BitXor // ^
BitOr // |
)
type LogicalOp struct {
Op LogicalOperator
LHS, RHS BoolExpr // only RHS is set for Not
}
func (LogicalOp) isBoolExpr() {}
func (LogicalOp) isExpr() {}
type LogicalOperator int
const (
And LogicalOperator = iota
Or
Not
)
type ComparisonOp struct {
Op ComparisonOperator
LHS, RHS Expr
// RHS2 is the third operand for BETWEEN.
// "<LHS> BETWEEN <RHS> AND <RHS2>".
RHS2 Expr
}
func (ComparisonOp) isBoolExpr() {}
func (ComparisonOp) isExpr() {}
type ComparisonOperator int
const (
Lt ComparisonOperator = iota
Le
Gt
Ge
Eq
Ne // both "!=" and "<>"
Like
NotLike
Between
NotBetween
)
type InOp struct {
LHS Expr
Neg bool
RHS []Expr
Unnest bool
// TODO: support subquery form
}
func (InOp) isBoolExpr() {} // usually
func (InOp) isExpr() {}
type IsOp struct {
LHS Expr
Neg bool
RHS IsExpr
}
func (IsOp) isBoolExpr() {}
func (IsOp) isExpr() {}
type IsExpr interface {
isIsExpr()
Expr
}
// PathExp represents a path expression.
//
// The grammar for path expressions is not defined (see b/169017423 internally),
// so this captures the most common form only, namely a dotted sequence of identifiers.
type PathExp []ID
func (PathExp) isExpr() {}
// Func represents a function call.
type Func struct {
Name string // not ID
Args []Expr
// TODO: various functions permit as-expressions, which might warrant different types in here.
}
func (Func) isBoolExpr() {} // possibly bool
func (Func) isExpr() {}
// TypedExpr represents a typed expression in the form `expr AS type_name`, e.g. `'17' AS INT64`.
type TypedExpr struct {
Type Type
Expr Expr
}
func (TypedExpr) isBoolExpr() {} // possibly bool
func (TypedExpr) isExpr() {}
type ExtractExpr struct {
Part string
Type Type
Expr Expr
}
func (ExtractExpr) isBoolExpr() {} // possibly bool
func (ExtractExpr) isExpr() {}
type AtTimeZoneExpr struct {
Expr Expr
Type Type
Zone string
}
func (AtTimeZoneExpr) isBoolExpr() {} // possibly bool
func (AtTimeZoneExpr) isExpr() {}
// Paren represents a parenthesised expression.
type Paren struct {
Expr Expr
}
func (Paren) isBoolExpr() {} // possibly bool
func (Paren) isExpr() {}
// Array represents an array literal.
type Array []Expr
func (Array) isExpr() {}
// ID represents an identifier.
// https://cloud.google.com/spanner/docs/lexical#identifiers
type ID string
func (ID) isBoolExpr() {} // possibly bool
func (ID) isExpr() {}
// Param represents a query parameter.
type Param string
func (Param) isBoolExpr() {} // possibly bool
func (Param) isExpr() {}
func (Param) isLiteralOrParam() {}
type Case struct {
Expr Expr
WhenClauses []WhenClause
ElseResult Expr
}
func (Case) isBoolExpr() {} // possibly bool
func (Case) isExpr() {}
type WhenClause struct {
Cond Expr
Result Expr
}
type BoolLiteral bool
const (
True = BoolLiteral(true)
False = BoolLiteral(false)
)
func (BoolLiteral) isBoolExpr() {}
func (BoolLiteral) isIsExpr() {}
func (BoolLiteral) isExpr() {}
type NullLiteral int
const Null = NullLiteral(0)
func (NullLiteral) isIsExpr() {}
func (NullLiteral) isExpr() {}
// IntegerLiteral represents an integer literal.
// https://cloud.google.com/spanner/docs/lexical#integer-literals
type IntegerLiteral int64
func (IntegerLiteral) isLiteralOrParam() {}
func (IntegerLiteral) isExpr() {}
// FloatLiteral represents a floating point literal.
// https://cloud.google.com/spanner/docs/lexical#floating-point-literals
type FloatLiteral float64
func (FloatLiteral) isExpr() {}
// StringLiteral represents a string literal.
// https://cloud.google.com/spanner/docs/lexical#string-and-bytes-literals
type StringLiteral string
func (StringLiteral) isExpr() {}
// BytesLiteral represents a bytes literal.
// https://cloud.google.com/spanner/docs/lexical#string-and-bytes-literals
type BytesLiteral string
func (BytesLiteral) isExpr() {}
// DateLiteral represents a date literal.
// https://cloud.google.com/spanner/docs/lexical#date_literals
type DateLiteral civil.Date
func (DateLiteral) isExpr() {}
// TimestampLiteral represents a timestamp literal.
// https://cloud.google.com/spanner/docs/lexical#timestamp_literals
type TimestampLiteral time.Time
func (TimestampLiteral) isExpr() {}
// JSONLiteral represents a JSON literal
// https://cloud.google.com/spanner/docs/reference/standard-sql/lexical#json_literals
type JSONLiteral []byte
func (JSONLiteral) isExpr() {}
type StarExpr int
// Star represents a "*" in an expression.
const Star = StarExpr(0)
func (StarExpr) isExpr() {}
// DDL
// https://cloud.google.com/spanner/docs/data-definition-language#ddl_syntax
// DDL represents a Data Definition Language (DDL) file.
type DDL struct {
List []DDLStmt
Filename string // if known at parse time
Comments []*Comment // all comments, sorted by position
}
func (d *DDL) clearOffset() {
for _, stmt := range d.List {
stmt.clearOffset()
}
for _, c := range d.Comments {
c.clearOffset()
}
}
// DDLStmt is satisfied by a type that can appear in a DDL.
type DDLStmt interface {
isDDLStmt()
clearOffset()
SQL() string
Node
}
// DMLStmt is satisfied by a type that is a DML statement.
type DMLStmt interface {
isDMLStmt()
SQL() string
}
// Comment represents a comment.
type Comment struct {
Marker string // Opening marker; one of "#", "--", "/*".
Isolated bool // Whether this comment is on its own line.
// Start and End are the position of the opening and terminating marker.
Start, End Position
Text []string
}
func (c *Comment) String() string { return fmt.Sprintf("%#v", c) }
func (c *Comment) Pos() Position { return c.Start }
func (c *Comment) clearOffset() { c.Start.Offset, c.End.Offset = 0, 0 }
// Node is implemented by concrete types in this package that represent things
// appearing in a DDL file.
type Node interface {
Pos() Position
// clearOffset() is not included here because some types like ColumnDef
// have the method on their pointer type rather than their natural value type.
// This method is only invoked from within this package, so it isn't
// important to enforce such things.
}
// Position describes a source position in an input DDL file.
// It is only valid if the line number is positive.
type Position struct {
Line int // 1-based line number
Offset int // 0-based byte offset
}
func (pos Position) IsValid() bool { return pos.Line > 0 }
func (pos Position) String() string {
if pos.Line == 0 {
return ":<invalid>"
}
return fmt.Sprintf(":%d", pos.Line)
}
// LeadingComment returns the comment that immediately precedes a node,
// or nil if there's no such comment.
func (ddl *DDL) LeadingComment(n Node) *Comment {
// Get the comment whose End position is on the previous line.
lineEnd := n.Pos().Line - 1
ci := sort.Search(len(ddl.Comments), func(i int) bool {
return ddl.Comments[i].End.Line >= lineEnd
})
if ci >= len(ddl.Comments) || ddl.Comments[ci].End.Line != lineEnd {
return nil
}
if !ddl.Comments[ci].Isolated {
// This is an inline comment for a previous node.
return nil
}
return ddl.Comments[ci]
}
// InlineComment returns the comment on the same line as a node,
// or nil if there's no inline comment.
// The returned comment is guaranteed to be a single line.
func (ddl *DDL) InlineComment(n Node) *Comment {
// TODO: Do we care about comments like this?
// string name = 1; /* foo
// bar */
pos := n.Pos()
ci := sort.Search(len(ddl.Comments), func(i int) bool {
return ddl.Comments[i].Start.Line >= pos.Line
})
if ci >= len(ddl.Comments) {
return nil
}
c := ddl.Comments[ci]
if c.Start.Line != pos.Line {
return nil
}
if c.Start.Line != c.End.Line || len(c.Text) != 1 {
// Multi-line comment; don't return it.
return nil
}
return c
}