-
Notifications
You must be signed in to change notification settings - Fork 258
/
convert.go
572 lines (539 loc) · 15.9 KB
/
convert.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
// Copyright 2021-present The Atlas Authors. All rights reserved.
// This source code is licensed under the Apache 2.0 license found
// in the LICENSE file in the root directory of this source tree.
package specutil
import (
"errors"
"fmt"
"strconv"
"strings"
"ariga.io/atlas/schema/schemaspec"
"ariga.io/atlas/sql/internal/sqlx"
"ariga.io/atlas/sql/schema"
"ariga.io/atlas/sql/sqlspec"
)
// List of convert function types.
type (
ConvertTableFunc func(*sqlspec.Table, *schema.Schema) (*schema.Table, error)
ConvertColumnFunc func(*sqlspec.Column, *schema.Table) (*schema.Column, error)
ConvertTypeFunc func(*sqlspec.Column) (schema.Type, error)
ConvertPrimaryKeyFunc func(*sqlspec.PrimaryKey, *schema.Table) (*schema.Index, error)
ConvertIndexFunc func(*sqlspec.Index, *schema.Table) (*schema.Index, error)
ConvertCheckFunc func(*sqlspec.Check) (*schema.Check, error)
ColumnSpecFunc func(*schema.Column, *schema.Table) (*sqlspec.Column, error)
ColumnTypeSpecFunc func(schema.Type) (*sqlspec.Column, error)
TableSpecFunc func(*schema.Table) (*sqlspec.Table, error)
PrimaryKeySpecFunc func(*schema.Index) (*sqlspec.PrimaryKey, error)
IndexSpecFunc func(*schema.Index) (*sqlspec.Index, error)
ForeignKeySpecFunc func(*schema.ForeignKey) (*sqlspec.ForeignKey, error)
CheckSpecFunc func(*schema.Check) *sqlspec.Check
)
// Realm converts the schemas and tables into a schema.Realm.
func Realm(schemas []*sqlspec.Schema, tables []*sqlspec.Table, convertTable ConvertTableFunc) (*schema.Realm, error) {
r := &schema.Realm{}
for _, schemaSpec := range schemas {
var schemaTables []*sqlspec.Table
for _, tableSpec := range tables {
name, err := SchemaName(tableSpec.Schema)
if err != nil {
return nil, fmt.Errorf("specutil: cannot extract schema name for table %q: %w", tableSpec.Name, err)
}
if name == schemaSpec.Name {
schemaTables = append(schemaTables, tableSpec)
}
}
sch, err := Schema(schemaSpec, schemaTables, convertTable)
if err != nil {
return nil, err
}
r.Schemas = append(r.Schemas, sch)
}
return r, nil
}
// Schema converts a sqlspec.Schema with its relevant []sqlspec.Tables
// into a schema.Schema.
func Schema(spec *sqlspec.Schema, tables []*sqlspec.Table, convertTable ConvertTableFunc) (*schema.Schema, error) {
sch := &schema.Schema{
Name: spec.Name,
}
m := make(map[*schema.Table]*sqlspec.Table)
for _, ts := range tables {
table, err := convertTable(ts, sch)
if err != nil {
return nil, err
}
sch.Tables = append(sch.Tables, table)
m[table] = ts
}
for _, tbl := range sch.Tables {
if err := LinkForeignKeys(tbl, sch, m[tbl]); err != nil {
return nil, err
}
}
return sch, nil
}
// Table converts a sqlspec.Table to a schema.Table. Table conversion is done without converting
// ForeignKeySpecs into ForeignKeys, as the target tables do not necessarily exist in the schema
// at this point. Instead, the linking is done by the Schema function.
func Table(spec *sqlspec.Table, parent *schema.Schema, convertColumn ConvertColumnFunc,
convertPk ConvertPrimaryKeyFunc, convertIndex ConvertIndexFunc, convertCheck ConvertCheckFunc) (*schema.Table, error) {
tbl := &schema.Table{
Name: spec.Name,
Schema: parent,
}
for _, csp := range spec.Columns {
col, err := convertColumn(csp, tbl)
if err != nil {
return nil, err
}
tbl.Columns = append(tbl.Columns, col)
}
if spec.PrimaryKey != nil {
pk, err := convertPk(spec.PrimaryKey, tbl)
if err != nil {
return nil, err
}
tbl.PrimaryKey = pk
}
for _, idx := range spec.Indexes {
i, err := convertIndex(idx, tbl)
if err != nil {
return nil, err
}
tbl.Indexes = append(tbl.Indexes, i)
}
for _, c := range spec.Checks {
c, err := convertCheck(c)
if err != nil {
return nil, err
}
tbl.AddChecks(c)
}
if err := convertCommentFromSpec(spec, &tbl.Attrs); err != nil {
return nil, err
}
return tbl, nil
}
// Column converts a sqlspec.Column into a schema.Column.
func Column(spec *sqlspec.Column, conv ConvertTypeFunc) (*schema.Column, error) {
out := &schema.Column{
Name: spec.Name,
Type: &schema.ColumnType{
Null: spec.Null,
},
}
if spec.Default != nil {
switch d := spec.Default.(type) {
case *schemaspec.LiteralValue:
out.Default = &schema.Literal{V: d.V}
case *schemaspec.RawExpr:
out.Default = &schema.RawExpr{X: d.X}
default:
return nil, fmt.Errorf("unsupported value type for default: %T", d)
}
}
ct, err := conv(spec)
if err != nil {
return nil, err
}
out.Type.Type = ct
if err := convertCommentFromSpec(spec, &out.Attrs); err != nil {
return nil, err
}
return out, err
}
// Index converts a sqlspec.Index to a schema.Index.
func Index(spec *sqlspec.Index, parent *schema.Table) (*schema.Index, error) {
parts := make([]*schema.IndexPart, 0, len(spec.Columns)+len(spec.Parts))
switch n, m := len(spec.Columns), len(spec.Parts); {
case n == 0 && m == 0:
return nil, fmt.Errorf("missing definition for index %q", spec.Name)
case n > 0 && m > 0:
return nil, fmt.Errorf(`multiple definitions for index %q, use "columns" or "on"`, spec.Name)
case n > 0:
for i, c := range spec.Columns {
c, err := column(parent, c)
if err != nil {
return nil, err
}
parts = append(parts, &schema.IndexPart{
SeqNo: i,
C: c,
})
}
case m > 0:
for i, p := range spec.Parts {
part := &schema.IndexPart{SeqNo: i, Desc: p.Desc}
switch {
case p.Column == nil && p.Expr == "":
return nil, fmt.Errorf(`"column" or "expr" are required for index %q at position %d`, spec.Name, i)
case p.Column != nil && p.Expr != "":
return nil, fmt.Errorf(`cannot use both "column" and "expr" in index %q at position %d`, spec.Name, i)
case p.Expr != "":
part.X = &schema.RawExpr{X: p.Expr}
case p.Column != nil:
c, err := column(parent, p.Column)
if err != nil {
return nil, err
}
part.C = c
}
parts = append(parts, part)
}
}
i := &schema.Index{
Name: spec.Name,
Unique: spec.Unique,
Table: parent,
Parts: parts,
}
if err := convertCommentFromSpec(spec, &i.Attrs); err != nil {
return nil, err
}
return i, nil
}
// Check converts a sqlspec.Check to a schema.Check.
func Check(spec *sqlspec.Check) (*schema.Check, error) {
return &schema.Check{
Name: spec.Name,
Expr: spec.Expr,
}, nil
}
// PrimaryKey converts a sqlspec.PrimaryKey to a schema.Index.
func PrimaryKey(spec *sqlspec.PrimaryKey, parent *schema.Table) (*schema.Index, error) {
parts := make([]*schema.IndexPart, 0, len(spec.Columns))
for seqno, c := range spec.Columns {
c, err := column(parent, c)
if err != nil {
return nil, nil
}
parts = append(parts, &schema.IndexPart{
SeqNo: seqno,
C: c,
})
}
return &schema.Index{
Table: parent,
Parts: parts,
}, nil
}
// LinkForeignKeys creates the foreign keys defined in the Table's spec by creating references
// to column in the provided Schema. It is assumed that the schema contains all of the tables
// referenced by the FK definitions in the spec.
func LinkForeignKeys(tbl *schema.Table, sch *schema.Schema, table *sqlspec.Table) error {
for _, spec := range table.ForeignKeys {
fk := &schema.ForeignKey{
Symbol: spec.Symbol,
Table: tbl,
OnUpdate: spec.OnUpdate,
OnDelete: spec.OnDelete,
}
for _, ref := range spec.Columns {
col, err := resolveCol(ref, sch)
if err != nil {
return err
}
fk.Columns = append(fk.Columns, col)
}
if len(spec.RefColumns) == 0 {
return fmt.Errorf("sqlspec: missing reference (parent) columns for foreign key: %q", spec.Symbol)
}
name, err := tableName(spec.RefColumns[0])
if err != nil {
return err
}
t, ok := sch.Table(name)
if !ok {
return fmt.Errorf("sqlspec: undefined table %q for foreign key: %q", name, spec.Symbol)
}
fk.RefTable = t
for _, ref := range spec.RefColumns {
col, err := resolveCol(ref, sch)
if err != nil {
return err
}
fk.RefColumns = append(fk.RefColumns, col)
}
tbl.ForeignKeys = append(tbl.ForeignKeys, fk)
}
return nil
}
func resolveCol(ref *schemaspec.Ref, sch *schema.Schema) (*schema.Column, error) {
t, err := tableName(ref)
if err != nil {
return nil, fmt.Errorf("sqlspec: table %q not found", ref.V)
}
tbl, ok := sch.Table(t)
if !ok {
return nil, fmt.Errorf("sqlspec: table %q not found", t)
}
return column(tbl, ref)
}
// FromRealm converts a schema.Realm into []sqlspec.Schema and []sqlspec.Table.
func FromRealm(r *schema.Realm, fn TableSpecFunc) ([]*sqlspec.Schema, []*sqlspec.Table, error) {
var (
schemas []*sqlspec.Schema
tables []*sqlspec.Table
)
for _, sch := range r.Schemas {
schemaSpec, tableSpecs, err := FromSchema(sch, fn)
if err != nil {
return nil, nil, fmt.Errorf("specutil: cannot convert schema %q: %w", sch.Name, err)
}
schemas = append(schemas, schemaSpec)
tables = append(tables, tableSpecs...)
}
return schemas, tables, nil
}
// FromSchema converts a schema.Schema into sqlspec.Schema and []sqlspec.Table.
func FromSchema(s *schema.Schema, fn TableSpecFunc) (*sqlspec.Schema, []*sqlspec.Table, error) {
spec := &sqlspec.Schema{
Name: s.Name,
}
tables := make([]*sqlspec.Table, 0, len(s.Tables))
for _, t := range s.Tables {
table, err := fn(t)
if err != nil {
return nil, nil, err
}
if s.Name != "" {
table.Schema = SchemaRef(s.Name)
}
tables = append(tables, table)
}
return spec, tables, nil
}
// FromTable converts a schema.Table to a sqlspec.Table.
func FromTable(t *schema.Table, colFn ColumnSpecFunc, pkFn PrimaryKeySpecFunc, idxFn IndexSpecFunc,
fkFn ForeignKeySpecFunc, ckFn CheckSpecFunc) (*sqlspec.Table, error) {
spec := &sqlspec.Table{
Name: t.Name,
}
for _, c := range t.Columns {
col, err := colFn(c, t)
if err != nil {
return nil, err
}
spec.Columns = append(spec.Columns, col)
}
if t.PrimaryKey != nil {
pk, err := pkFn(t.PrimaryKey)
if err != nil {
return nil, err
}
spec.PrimaryKey = pk
}
for _, idx := range t.Indexes {
i, err := idxFn(idx)
if err != nil {
return nil, err
}
spec.Indexes = append(spec.Indexes, i)
}
for _, fk := range t.ForeignKeys {
f, err := fkFn(fk)
if err != nil {
return nil, err
}
spec.ForeignKeys = append(spec.ForeignKeys, f)
}
for _, attr := range t.Attrs {
if c, ok := attr.(*schema.Check); ok {
spec.Checks = append(spec.Checks, ckFn(c))
}
}
convertCommentFromSchema(t.Attrs, &spec.Extra.Attrs)
return spec, nil
}
// FromPrimaryKey converts schema.Index to a sqlspec.PrimaryKey.
func FromPrimaryKey(s *schema.Index) (*sqlspec.PrimaryKey, error) {
c := make([]*schemaspec.Ref, 0, len(s.Parts))
for _, v := range s.Parts {
c = append(c, colRef(v.C.Name, s.Table.Name))
}
return &sqlspec.PrimaryKey{
Columns: c,
}, nil
}
// FromColumn converts a *schema.Column into a *sqlspec.Column using the ColumnTypeSpecFunc.
func FromColumn(col *schema.Column, columnTypeSpec ColumnTypeSpecFunc) (*sqlspec.Column, error) {
ct, err := columnTypeSpec(col.Type.Type)
if err != nil {
return nil, err
}
spec := &sqlspec.Column{
Name: col.Name,
Type: ct.Type,
Null: col.Type.Null,
DefaultExtension: schemaspec.DefaultExtension{
Extra: schemaspec.Resource{Attrs: ct.DefaultExtension.Extra.Attrs},
},
}
if col.Default != nil {
lv, err := toValue(col.Default)
if err != nil {
return nil, err
}
spec.Default = lv
}
convertCommentFromSchema(col.Attrs, &spec.Extra.Attrs)
return spec, nil
}
func toValue(expr schema.Expr) (schemaspec.Value, error) {
var (
v string
err error
)
switch expr := expr.(type) {
case *schema.RawExpr:
return &schemaspec.RawExpr{X: expr.X}, nil
case *schema.Literal:
v, err = normalizeQuotes(expr.V)
if err != nil {
return nil, err
}
return &schemaspec.LiteralValue{V: v}, nil
default:
return nil, fmt.Errorf("converting expr %T to literal value", expr)
}
}
func normalizeQuotes(s string) (string, error) {
if len(s) < 2 {
return s, nil
}
// If string is quoted with single quotes:
if strings.HasPrefix(s, `'`) && strings.HasSuffix(s, `'`) {
uq := strings.ReplaceAll(s[1:len(s)-1], "''", "'")
return strconv.Quote(uq), nil
}
return s, nil
}
// FromIndex converts schema.Index to sqlspec.Index.
func FromIndex(idx *schema.Index) (*sqlspec.Index, error) {
spec := &sqlspec.Index{Name: idx.Name, Unique: idx.Unique}
convertCommentFromSchema(idx.Attrs, &spec.Extra.Attrs)
if parts, ok := columnsOnly(idx); ok {
spec.Columns = parts
return spec, nil
}
spec.Parts = make([]*sqlspec.IndexPart, len(idx.Parts))
for i, p := range idx.Parts {
part := &sqlspec.IndexPart{Desc: p.Desc}
switch {
case p.C == nil && p.X == nil:
return nil, fmt.Errorf("missing column or expression for key part of index %q", idx.Name)
case p.C != nil && p.X != nil:
return nil, fmt.Errorf("multiple key part definitions for index %q", idx.Name)
case p.C != nil:
part.Column = colRef(p.C.Name, idx.Table.Name)
case p.X != nil:
x, ok := p.X.(*schema.RawExpr)
if !ok {
return nil, fmt.Errorf("unexpected expression %T for index %q", p.X, idx.Name)
}
part.Expr = x.X
}
spec.Parts[i] = part
}
return spec, nil
}
func columnsOnly(idx *schema.Index) ([]*schemaspec.Ref, bool) {
parts := make([]*schemaspec.Ref, len(idx.Parts))
for i, p := range idx.Parts {
if p.C == nil || p.Desc {
return nil, false
}
parts[i] = colRef(p.C.Name, idx.Table.Name)
}
return parts, true
}
// FromForeignKey converts schema.ForeignKey to sqlspec.ForeignKey.
func FromForeignKey(s *schema.ForeignKey) (*sqlspec.ForeignKey, error) {
c := make([]*schemaspec.Ref, 0, len(s.Columns))
for _, v := range s.Columns {
c = append(c, colRef(v.Name, s.Table.Name))
}
r := make([]*schemaspec.Ref, 0, len(s.RefColumns))
for _, v := range s.RefColumns {
r = append(r, colRef(v.Name, s.RefTable.Name))
}
return &sqlspec.ForeignKey{
Symbol: s.Symbol,
Columns: c,
RefColumns: r,
OnDelete: s.OnDelete,
OnUpdate: s.OnUpdate,
}, nil
}
// FromCheck converts schema.Check to sqlspec.Check.
func FromCheck(s *schema.Check) *sqlspec.Check {
return &sqlspec.Check{
Name: s.Name,
Expr: s.Expr,
}
}
// SchemaName returns the name from a ref to a schema.
func SchemaName(ref *schemaspec.Ref) (string, error) {
if ref == nil {
return "", errors.New("unexpected nil reference")
}
parts := strings.Split(ref.V, ".")
if len(parts) < 2 || parts[0] != "$schema" {
return "", errors.New("expected ref format of $schema.name")
}
return parts[1], nil
}
func column(t *schema.Table, ref *schemaspec.Ref) (*schema.Column, error) {
s := strings.Split(ref.V, "$column.")
if len(s) != 2 {
return nil, fmt.Errorf("specutil: failed to extract column name from %q", ref)
}
c, ok := t.Column(s[1])
if !ok {
return nil, fmt.Errorf("specutil: unknown column %q in table %q", s[1], t.Name)
}
return c, nil
}
func tableName(ref *schemaspec.Ref) (string, error) {
s := strings.Split(ref.V, "$column.")
if len(s) != 2 {
return "", fmt.Errorf("sqlspec: failed to split by column name from %q", ref)
}
s = strings.Split(s[0], ".")
if len(s) != 3 {
return "", fmt.Errorf("sqlspec: failed to extract table name from %q", s)
}
return s[1], nil
}
func colRef(cName string, tName string) *schemaspec.Ref {
v := "$table." + tName + ".$column." + cName
return &schemaspec.Ref{
V: v,
}
}
// SchemaRef returns the schemaspec.Ref to the schema with the given name.
func SchemaRef(n string) *schemaspec.Ref {
return &schemaspec.Ref{V: "$schema." + n}
}
// Attrer is the interface that wraps the Attr method.
type Attrer interface {
Attr(string) (*schemaspec.Attr, bool)
}
// convertCommentFromSpec converts a spec comment attribute to a schema element attribute.
func convertCommentFromSpec(spec Attrer, attrs *[]schema.Attr) error {
if c, ok := spec.Attr("comment"); ok {
s, err := c.String()
if err != nil {
return err
}
*attrs = append(*attrs, &schema.Comment{Text: s})
}
return nil
}
// convertCommentFromSchema converts a schema element comment attribute to a spec comment attribute.
func convertCommentFromSchema(src []schema.Attr, trgt *[]*schemaspec.Attr) {
var c schema.Comment
if sqlx.Has(src, &c) {
*trgt = append(*trgt, StrAttr("comment", c.Text))
}
}