squawk-parser 2.49.0

Linter for Postgres migrations & SQL
Documentation
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
---
source: crates/squawk_parser/tests/tests.rs
input_file: crates/squawk_parser/tests/data/err/create_table.sql
---
SOURCE_FILE
  CREATE_TABLE
    COMMENT "-- with missing table name"
    WHITESPACE "\n"
    CREATE_KW "create"
    WHITESPACE " "
    TABLE_KW "table"
    WHITESPACE " "
    TABLE_ARG_LIST
      L_PAREN "("
      WHITESPACE "\n  "
      COLUMN
        NAME
          IDENT "sensor_id"
        WHITESPACE " "
        PATH_TYPE
          PATH
            PATH_SEGMENT
              NAME_REF
                INTEGER_KW "INTEGER"
      WHITESPACE "\n"
      R_PAREN ")"
  SEMICOLON ";"
  WHITESPACE "\n\n"
  CREATE_TABLE
    COMMENT "-- missing type"
    WHITESPACE "\n"
    CREATE_KW "create"
    WHITESPACE " "
    TABLE_KW "table"
    WHITESPACE " "
    PATH
      PATH_SEGMENT
        NAME
          IDENT "t"
    WHITESPACE " "
    TABLE_ARG_LIST
      L_PAREN "("
      COLUMN
        NAME
          IDENT "a"
      R_PAREN ")"
  SEMICOLON ";"
  WHITESPACE "\n\n"
  CREATE_TABLE
    COMMENT "-- trailing comma"
    WHITESPACE "\n"
    CREATE_KW "create"
    WHITESPACE " "
    TABLE_KW "table"
    WHITESPACE " "
    PATH
      PATH_SEGMENT
        NAME
          IDENT "t"
    WHITESPACE " "
    TABLE_ARG_LIST
      L_PAREN "("
      COLUMN
        NAME
          IDENT "a"
        WHITESPACE " "
        PATH_TYPE
          PATH
            PATH_SEGMENT
              NAME_REF
                TEXT_KW "text"
      ERROR
        COMMA ","
      R_PAREN ")"
  SEMICOLON ";"
  WHITESPACE "\n\n"
  CREATE_TABLE
    COMMENT "-- missing columns / constraints"
    WHITESPACE "\n"
    CREATE_KW "create"
    WHITESPACE " "
    TABLE_KW "table"
    WHITESPACE " "
    PATH
      PATH_SEGMENT
        NAME
          IDENT "t"
    WHITESPACE " "
    TABLE_ARG_LIST
      L_PAREN "("
      ERROR
        COMMA ","
      ERROR
        COMMA ","
      ERROR
        COMMA ","
      ERROR
        COMMA ","
      ERROR
        COMMA ","
      R_PAREN ")"
  SEMICOLON ";"
  WHITESPACE "\n\n"
  CREATE_TABLE
    COMMENT "-- a column list with SET DEFAULT is only supported for ON DELETE actions"
    WHITESPACE "\n"
    CREATE_KW "create"
    WHITESPACE " "
    TABLE_KW "table"
    WHITESPACE " "
    PATH
      PATH_SEGMENT
        NAME
          IDENT "t"
    WHITESPACE " "
    TABLE_ARG_LIST
      L_PAREN "("
      WHITESPACE "\n  "
      COLUMN
        NAME
          IDENT "a"
        WHITESPACE " "
        PATH_TYPE
          PATH
            PATH_SEGMENT
              NAME_REF
                INT_KW "int"
      COMMA ","
      WHITESPACE "\n  "
      COLUMN
        NAME
          IDENT "b"
        WHITESPACE " "
        PATH_TYPE
          PATH
            PATH_SEGMENT
              NAME_REF
                INT_KW "int"
        WHITESPACE " "
        REFERENCES_CONSTRAINT
          REFERENCES_KW "references"
          WHITESPACE " "
          PATH
            PATH_SEGMENT
              NAME_REF
                IDENT "bar"
          WHITESPACE " "
          ON_UPDATE_ACTION
            ON_KW "on"
            WHITESPACE " "
            UPDATE_KW "update"
            WHITESPACE " "
            CASCADE_KW "cascade"
      COMMA ","
      WHITESPACE "\n  "
      COLUMN
        NAME
          IDENT "c"
        WHITESPACE " "
        PATH_TYPE
          PATH
            PATH_SEGMENT
              NAME_REF
                INT_KW "int"
        WHITESPACE " "
        REFERENCES_CONSTRAINT
          REFERENCES_KW "references"
          WHITESPACE " "
          PATH
            PATH_SEGMENT
              NAME_REF
                IDENT "bar"
          WHITESPACE " "
          ON_UPDATE_ACTION
            ON_KW "on"
            WHITESPACE " "
            UPDATE_KW "update"
            WHITESPACE " "
            SET_NULL_COLUMNS
              SET_KW "set"
              WHITESPACE " "
              NULL_KW "null"
      COMMA ","
      WHITESPACE "\n  "
      COLUMN
        NAME
          IDENT "d"
        WHITESPACE " "
        PATH_TYPE
          PATH
            PATH_SEGMENT
              NAME_REF
                INT_KW "int"
        WHITESPACE " "
        REFERENCES_CONSTRAINT
          REFERENCES_KW "references"
          WHITESPACE " "
          PATH
            PATH_SEGMENT
              NAME_REF
                IDENT "bar"
          WHITESPACE " "
          ON_UPDATE_ACTION
            ON_KW "on"
            WHITESPACE " "
            UPDATE_KW "update"
            WHITESPACE " "
            SET_DEFAULT_COLUMNS
              SET_KW "set"
              WHITESPACE " "
              DEFAULT_KW "default"
      COMMA ","
      WHITESPACE "\n  "
      COLUMN
        NAME
          IDENT "e"
        WHITESPACE " "
        PATH_TYPE
          PATH
            PATH_SEGMENT
              NAME_REF
                INT_KW "int"
        WHITESPACE " "
        REFERENCES_CONSTRAINT
          REFERENCES_KW "references"
          WHITESPACE " "
          PATH
            PATH_SEGMENT
              NAME_REF
                IDENT "bar"
          WHITESPACE " "
          ON_UPDATE_ACTION
            ON_KW "on"
            WHITESPACE " "
            UPDATE_KW "update"
            WHITESPACE " "
            SET_DEFAULT_COLUMNS
              SET_KW "set"
              WHITESPACE " "
              DEFAULT_KW "default"
              WHITESPACE " "
              COLUMN_LIST
                L_PAREN "("
                COLUMN
                  NAME_REF
                    IDENT "a"
                COMMA ","
                WHITESPACE " "
                COLUMN
                  NAME_REF
                    IDENT "b"
                COMMA ","
                WHITESPACE " "
                COLUMN
                  NAME_REF
                    IDENT "c"
                R_PAREN ")"
      WHITESPACE "\n"
      R_PAREN ")"
  SEMICOLON ";"
  WHITESPACE "\n\n"
  CREATE_TABLE
    COMMENT "-- conflicting options"
    WHITESPACE "\n"
    CREATE_KW "create"
    WHITESPACE " "
    UNLOGGED
      UNLOGGED_KW "unlogged"
    WHITESPACE " "
    TABLE_KW "table"
    WHITESPACE " "
    PATH
      PATH_SEGMENT
        NAME
          IDENT "t"
    WHITESPACE " "
    TABLE_ARG_LIST
      L_PAREN "("
      WHITESPACE "\n  "
      COLUMN
        NAME
          IDENT "a"
        WHITESPACE " "
        PATH_TYPE
          PATH
            PATH_SEGMENT
              NAME_REF
                INT_KW "int"
        WHITESPACE " "
        GENERATED_CONSTRAINT
          GENERATED_KW "generated"
          WHITESPACE " "
          ALWAYS_KW "always"
          WHITESPACE " "
          AS_KW "as"
          WHITESPACE " "
          IDENTITY_KW "identity"
      COMMA ","
      WHITESPACE "\n  "
      COLUMN
        NAME
          IDENT "b"
        WHITESPACE " "
        PATH_TYPE
          PATH
            PATH_SEGMENT
              NAME_REF
                INT_KW "int"
        WHITESPACE " "
        GENERATED_CONSTRAINT
          GENERATED_KW "generated"
          WHITESPACE " "
          ALWAYS_KW "always"
          WHITESPACE " "
          AS_KW "as"
          WHITESPACE " "
          IDENTITY_KW "identity"
          WHITESPACE " "
          SEQUENCE_OPTION_LIST
            L_PAREN "("
            WHITESPACE "\n    "
            SEQUENCE_OPTION
              AS_KW "as"
              WHITESPACE " "
              PATH_TYPE
                PATH
                  PATH_SEGMENT
                    NAME_REF
                      BIGINT_KW "bigint"
            WHITESPACE "\n    "
            SEQUENCE_OPTION
              CACHE_KW "cache"
              WHITESPACE " "
              LITERAL
                INT_NUMBER "100"
            WHITESPACE "\n    "
            SEQUENCE_OPTION
              INCREMENT_KW "increment"
              WHITESPACE " "
              BY_KW "by"
              WHITESPACE " "
              LITERAL
                INT_NUMBER "10"
            WHITESPACE "\n    "
            SEQUENCE_OPTION
              INCREMENT_KW "increment"
              WHITESPACE " "
              LITERAL
                INT_NUMBER "10"
            WHITESPACE "\n    "
            SEQUENCE_OPTION
              SEQUENCE_KW "sequence"
              WHITESPACE " "
              NAME_KW "name"
              WHITESPACE " "
              NAME_REF
                IDENT "foo"
            WHITESPACE "\n    "
            SEQUENCE_OPTION
              RESTART_KW "restart"
              WHITESPACE " "
              WITH_KW "with"
              WHITESPACE " "
              LITERAL
                INT_NUMBER "500"
            WHITESPACE "\n    "
            SEQUENCE_OPTION
              LOGGED_KW "logged"
            WHITESPACE "\n    "
            SEQUENCE_OPTION
              UNLOGGED_KW "unlogged"
            WHITESPACE "\n    "
            SEQUENCE_OPTION
              START_KW "start"
              WHITESPACE " "
              WITH_KW "with"
              WHITESPACE " "
              LITERAL
                INT_NUMBER "10"
            WHITESPACE "\n    "
            SEQUENCE_OPTION
              START_KW "start"
              WHITESPACE " "
              LITERAL
                INT_NUMBER "25"
            WHITESPACE "\n    "
            SEQUENCE_OPTION
              OWNED_KW "owned"
              WHITESPACE " "
              BY_KW "by"
              WHITESPACE " "
              NONE_KW "none"
            WHITESPACE "\n    "
            SEQUENCE_OPTION
              OWNED_KW "owned"
              WHITESPACE " "
              BY_KW "by"
              WHITESPACE " "
              PATH
                PATH
                  PATH_SEGMENT
                    NAME_REF
                      IDENT "fooo"
                DOT "."
                PATH_SEGMENT
                  NAME_REF
                    IDENT "bar"
            WHITESPACE "\n    "
            SEQUENCE_OPTION
              MAXVALUE_KW "maxvalue"
              WHITESPACE " "
              LITERAL
                INT_NUMBER "70"
            WHITESPACE "\n    "
            SEQUENCE_OPTION
              MINVALUE_KW "minvalue"
              WHITESPACE " "
              LITERAL
                INT_NUMBER "150"
            WHITESPACE "\n    "
            SEQUENCE_OPTION
              NO_KW "no"
              WHITESPACE " "
              MINVALUE_KW "minvalue"
            WHITESPACE "\n    "
            SEQUENCE_OPTION
              NO_KW "no"
              WHITESPACE " "
              CYCLE_KW "cycle"
            WHITESPACE "\n    "
            SEQUENCE_OPTION
              NO_KW "no"
              WHITESPACE " "
              MAXVALUE_KW "maxvalue"
            WHITESPACE "\n    "
            SEQUENCE_OPTION
              CYCLE_KW "cycle"
            WHITESPACE "\n  "
            R_PAREN ")"
      WHITESPACE "\n"
      R_PAREN ")"
  SEMICOLON ";"
  WHITESPACE "\n\n"
  CREATE_TABLE
    CREATE_KW "create"
    WHITESPACE " "
    TABLE_KW "table"
    WHITESPACE " "
    PATH
      PATH_SEGMENT
        NAME
          IDENT "t"
    WHITESPACE " "
    PARTITION_OF
      PARTITION_KW "partition"
      WHITESPACE " "
      OF_KW "of"
      WHITESPACE " "
      PATH
        PATH_SEGMENT
          NAME_REF
            IDENT "u"
    WHITESPACE "\n    "
    COMMENT "-- missing some commas"
    WHITESPACE "\n    "
    PARTITION_FOR_VALUES_FROM
      FOR_KW "for"
      WHITESPACE " "
      VALUES_KW "values"
      WHITESPACE " "
      FROM_KW "from"
      WHITESPACE " "
      L_PAREN "("
      LITERAL
        STRING "'2024-01-01'"
      WHITESPACE "  "
      LITERAL
        INT_NUMBER "1"
      R_PAREN ")"
      WHITESPACE " "
      TO_KW "to"
      WHITESPACE " "
      L_PAREN "("
      LITERAL
        STRING "'2024-04-01'"
      WHITESPACE "  "
      LITERAL
        INT_NUMBER "5"
      R_PAREN ")"
  SEMICOLON ";"
  WHITESPACE "\n\n"
  CREATE_TABLE
    CREATE_KW "create"
    WHITESPACE " "
    TABLE_KW "table"
    WHITESPACE " "
    PATH
      PATH_SEGMENT
        NAME
          IDENT "t"
    WHITESPACE " "
    PARTITION_OF
      PARTITION_KW "partition"
      WHITESPACE " "
      OF_KW "of"
      WHITESPACE " "
      PATH
        PATH_SEGMENT
          NAME_REF
            IDENT "u"
    WHITESPACE "\n    "
    COMMENT "-- missing some commas"
    WHITESPACE "\n    "
    PARTITION_FOR_VALUES_IN
      FOR_KW "for"
      WHITESPACE " "
      VALUES_KW "values"
      WHITESPACE " "
      IN_KW "in"
      WHITESPACE " "
      L_PAREN "("
      LITERAL
        INT_NUMBER "1"
      WHITESPACE "  "
      LITERAL
        INT_NUMBER "2"
      WHITESPACE "  "
      LITERAL
        INT_NUMBER "3"
      R_PAREN ")"
  SEMICOLON ";"
  WHITESPACE "\n\n"
  CREATE_TABLE
    COMMENT "-- exclude missing a comma"
    WHITESPACE "\n"
    CREATE_KW "create"
    WHITESPACE " "
    TABLE_KW "table"
    WHITESPACE " "
    PATH
      PATH_SEGMENT
        NAME
          IDENT "t"
    WHITESPACE " "
    TABLE_ARG_LIST
      L_PAREN "("
      WHITESPACE "\n  "
      COLUMN
        NAME
          IDENT "a"
        WHITESPACE " "
        PATH_TYPE
          PATH
            PATH_SEGMENT
              NAME_REF
                INT_KW "int"
      COMMA ","
      WHITESPACE "\n  "
      COLUMN
        NAME
          IDENT "b"
        WHITESPACE " "
        PATH_TYPE
          PATH
            PATH_SEGMENT
              NAME_REF
                TEXT_KW "text"
      COMMA ","
      WHITESPACE "\n  "
      EXCLUDE_CONSTRAINT
        EXCLUDE_KW "exclude"
        WHITESPACE " "
        CONSTRAINT_INDEX_METHOD
          USING_KW "using"
          WHITESPACE " "
          NAME_REF
            IDENT "btree"
        WHITESPACE " "
        CONSTRAINT_EXCLUSION_LIST
          L_PAREN "("
          WHITESPACE " "
          CONSTRAINT_EXCLUSION
            NAME_REF
              IDENT "a"
            WHITESPACE " "
            WITH_KW "with"
            WHITESPACE " "
            OP
              PATH
                PATH
                  PATH_SEGMENT
                    NAME_REF
                      IDENT "buzz"
                DOT "."
                PATH_SEGMENT
              R_ANGLE ">"
          WHITESPACE " "
          CONSTRAINT_EXCLUSION
            NAME_REF
              IDENT "b"
            WHITESPACE " "
            WITH_KW "with"
            WHITESPACE " "
            OP
              L_ANGLE "<"
          R_PAREN ")"
      WHITESPACE " \n"
      R_PAREN ")"
  SEMICOLON ";"
  WHITESPACE "\n\n"
  CREATE_TABLE
    CREATE_KW "create"
    WHITESPACE " "
    TABLE_KW "table"
    WHITESPACE " "
    PATH
      PATH_SEGMENT
        NAME
          IDENT "z"
    WHITESPACE " "
    TABLE_ARG_LIST
      L_PAREN "("
      WHITESPACE "\n  "
      COLUMN
        NAME
          IDENT "a"
        WHITESPACE " "
        PATH_TYPE
          PATH
            PATH_SEGMENT
              NAME_REF
                INT_KW "int"
      WHITESPACE "\n"
      R_PAREN ")"
  WHITESPACE "\n"
  COMMENT "-- ^ missing semi"
  WHITESPACE "\n\n"
  SELECT
    WITH_CLAUSE
      WITH_KW "with"
      WHITESPACE " "
      WITH_TABLE
        NAME
          IDENT "t"
        WHITESPACE " "
        AS_KW "as"
        WHITESPACE " "
        L_PAREN "("
        WHITESPACE "\n  "
        SELECT
          SELECT_CLAUSE
            SELECT_KW "select"
            WHITESPACE " "
            TARGET_LIST
              TARGET
                LITERAL
                  INT_NUMBER "1"
        WHITESPACE "\n"
        R_PAREN ")"
    WHITESPACE "\n"
    SELECT_CLAUSE
      SELECT_KW "select"
      WHITESPACE " "
      TARGET_LIST
        TARGET
          STAR "*"
    WHITESPACE " "
    FROM_CLAUSE
      FROM_KW "from"
      WHITESPACE " "
      FROM_ITEM
        NAME_REF
          IDENT "t"
  SEMICOLON ";"
  WHITESPACE "\n"
---
error[syntax-error]: expected path name
  ╭▸ 
2 │ create table (
  ╰╴            ━
error[syntax-error]: unexpected trailing comma
   ╭▸ 
10 │ create table t (a text,);
   ╰╴                      ━
error[syntax-error]: unexpected comma
   ╭▸ 
13 │ create table t (,,,,,);
   ╰╴                ━
error[syntax-error]: unexpected comma
   ╭▸ 
13 │ create table t (,,,,,);
   ╰╴                 ━
error[syntax-error]: unexpected comma
   ╭▸ 
13 │ create table t (,,,,,);
   ╰╴                  ━
error[syntax-error]: unexpected comma
   ╭▸ 
13 │ create table t (,,,,,);
   ╰╴                   ━
error[syntax-error]: unexpected comma
   ╭▸ 
13 │ create table t (,,,,,);
   ╰╴                    ━
error[syntax-error]: expected COMMA
   ╭▸ 
51 │     for values from ('2024-01-01'  1) to ('2024-04-01'  5);
   ╰╴                                 ━
error[syntax-error]: expected COMMA
   ╭▸ 
51 │     for values from ('2024-01-01'  1) to ('2024-04-01'  5);
   ╰╴                                                      ━
error[syntax-error]: expected COMMA
   ╭▸ 
55 │     for values in (1  2  3);
   ╰╴                    ━
error[syntax-error]: expected COMMA
   ╭▸ 
55 │     for values in (1  2  3);
   ╰╴                       ━
error[syntax-error]: expected COMMA
   ╭▸ 
61 │   exclude using btree ( a with buzz.> b with <) 
   ╰╴                                     ━
error[syntax-error]: expected SEMICOLON
   ╭▸ 
66 │   )
   │ ┏━━┛
67 │ ┃ -- ^ missing semi
   ╰╴┗━┛