-
Notifications
You must be signed in to change notification settings - Fork 360
/
Copy pathmetadata.go
1163 lines (1022 loc) · 21.4 KB
/
metadata.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
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package metadata
import (
"strings"
"github.com/xo/dburl"
"github.com/xo/usql/text"
)
// ExtendedReader of all database metadata in a structured format.
type ExtendedReader interface {
CatalogReader
SchemaReader
TableReader
ColumnReader
ColumnStatReader
IndexReader
IndexColumnReader
TriggerReader
ConstraintReader
ConstraintColumnReader
FunctionReader
FunctionColumnReader
SequenceReader
PrivilegeSummaryReader
}
// BasicReader of common database metadata like schemas, tables and columns.
type BasicReader interface {
SchemaReader
TableReader
ColumnReader
}
// CatalogReader lists database schemas.
type CatalogReader interface {
Reader
Catalogs(Filter) (*CatalogSet, error)
}
// SchemaReader lists database schemas.
type SchemaReader interface {
Reader
Schemas(Filter) (*SchemaSet, error)
}
// TableReader lists database tables.
type TableReader interface {
Reader
Tables(Filter) (*TableSet, error)
}
// ColumnReader lists table columns.
type ColumnReader interface {
Reader
Columns(Filter) (*ColumnSet, error)
}
// ColumnStatsReader lists table column statistics.
type ColumnStatReader interface {
Reader
ColumnStats(Filter) (*ColumnStatSet, error)
}
// IndexReader lists table indexes.
type IndexReader interface {
Reader
Indexes(Filter) (*IndexSet, error)
}
// IndexColumnReader lists index columns.
type IndexColumnReader interface {
Reader
IndexColumns(Filter) (*IndexColumnSet, error)
}
// TriggerReader lists table triggers.
type TriggerReader interface {
Reader
Triggers(Filter) (*TriggerSet, error)
}
// ConstraintReader lists table constraints.
type ConstraintReader interface {
Reader
Constraints(Filter) (*ConstraintSet, error)
}
// ConstraintColumnReader lists constraint columns.
type ConstraintColumnReader interface {
Reader
ConstraintColumns(Filter) (*ConstraintColumnSet, error)
}
// FunctionReader lists database functions.
type FunctionReader interface {
Reader
Functions(Filter) (*FunctionSet, error)
}
// FunctionColumnReader lists function parameters.
type FunctionColumnReader interface {
Reader
FunctionColumns(Filter) (*FunctionColumnSet, error)
}
// SequenceReader lists sequences.
type SequenceReader interface {
Reader
Sequences(Filter) (*SequenceSet, error)
}
// PrivilegeSummaryReader lists summaries of privileges granted on tables, views and sequences.
type PrivilegeSummaryReader interface {
Reader
PrivilegeSummaries(Filter) (*PrivilegeSummarySet, error)
}
// Reader of any database metadata in a structured format.
type Reader interface{}
// Filter objects returned by Readers
type Filter struct {
// Catalog name pattern that objects must belong to;
// use Name to filter catalogs by name
Catalog string
// Schema name pattern that objects must belong to;
// use Name to filter schemas by name
Schema string
// Parent name pattern that objects must belong to;
// does not apply to schema and catalog containing matching objects
Parent string
// Reference name pattern of other objects referencing this one,
Reference string
// Name pattern that object name must match
Name string
// Types of the object
Types []string
// WithSystem objects
WithSystem bool
// OnlyVisible objects
OnlyVisible bool
}
// Writer of database metadata in a human readable format.
type Writer interface {
// DescribeFunctions \df, \dfa, \dfn, \dft, \dfw, etc.
DescribeFunctions(*dburl.URL, string, string, bool, bool) error
// DescribeTableDetails \d foo
DescribeTableDetails(*dburl.URL, string, bool, bool) error
// ListAllDbs \l
ListAllDbs(*dburl.URL, string, bool) error
// ListTables \dt, \dv, \dm, etc.
ListTables(*dburl.URL, string, string, bool, bool) error
// ListSchemas \dn
ListSchemas(*dburl.URL, string, bool, bool) error
// ListIndexes \di
ListIndexes(*dburl.URL, string, bool, bool) error
// ShowStats \ss
ShowStats(*dburl.URL, string, string, bool, int) error
// ListPrivilegeSummaries \dp
ListPrivilegeSummaries(*dburl.URL, string, bool) error
}
type CatalogSet struct {
resultSet
}
func NewCatalogSet(v []Catalog) *CatalogSet {
r := make([]Result, len(v))
for i := range v {
r[i] = &v[i]
}
return &CatalogSet{
resultSet: resultSet{
results: r,
columns: []string{"Catalog"},
},
}
}
func NewCatalogSetWithColumns(v []Result, cols []string) *CatalogSet {
return &CatalogSet{
resultSet: resultSet{
results: v,
columns: cols,
},
}
}
type CatalogProvider interface {
GetCatalog() Catalog
}
func (s CatalogSet) Get() Catalog {
r := s.results[s.current-1]
return r.(CatalogProvider).GetCatalog()
}
type Catalog struct {
Catalog string
}
func (s Catalog) Values() []interface{} {
return []interface{}{s.Catalog}
}
func (s Catalog) GetCatalog() Catalog {
return s
}
type SchemaSet struct {
resultSet
}
func NewSchemaSet(v []Schema) *SchemaSet {
r := make([]Result, len(v))
for i := range v {
r[i] = &v[i]
}
return &SchemaSet{
resultSet: resultSet{
results: r,
columns: []string{"Schema", "Catalog"},
},
}
}
func (s SchemaSet) Get() *Schema {
return s.results[s.current-1].(*Schema)
}
type Schema struct {
Schema string
Catalog string
}
func (s Schema) Values() []interface{} {
return []interface{}{s.Schema, s.Catalog}
}
type TableSet struct {
resultSet
}
func NewTableSet(v []Table) *TableSet {
r := make([]Result, len(v))
for i := range v {
r[i] = &v[i]
}
return &TableSet{
resultSet: resultSet{
results: r,
columns: []string{
"Catalog",
"Schema",
"Name",
"Type",
"Rows",
"Size",
"Comment",
},
},
}
}
func (t TableSet) Get() *Table {
return t.results[t.current-1].(*Table)
}
type Table struct {
Catalog string
Schema string
Name string
Type string
Rows int64
Size string
Comment string
}
func (t Table) Values() []interface{} {
return []interface{}{
t.Catalog,
t.Schema,
t.Name,
t.Type,
t.Rows,
t.Size,
t.Comment,
}
}
type ColumnSet struct {
resultSet
}
func NewColumnSet(v []Column) *ColumnSet {
r := make([]Result, len(v))
for i := range v {
r[i] = &v[i]
}
return &ColumnSet{
resultSet: resultSet{
results: r,
columns: []string{
"Catalog",
"Schema",
"Table",
"Name",
"Type",
"Nullable",
"Default",
"Size",
"Decimal Digits",
"Precision Radix",
"Octet Length",
},
},
}
}
func (c ColumnSet) Get() *Column {
return c.results[c.current-1].(*Column)
}
type Column struct {
Catalog string
Schema string
Table string
Name string
OrdinalPosition int
DataType string
// ScanType reflect.Type
Default string
ColumnSize int
DecimalDigits int
NumPrecRadix int
CharOctetLength int
IsNullable Bool
}
type Bool string
var (
UNKNOWN Bool = ""
YES Bool = "YES"
NO Bool = "NO"
)
func (c Column) Values() []interface{} {
return []interface{}{
c.Catalog,
c.Schema,
c.Table,
c.Name,
c.DataType,
c.IsNullable,
c.Default,
c.ColumnSize,
c.DecimalDigits,
c.NumPrecRadix,
c.CharOctetLength,
}
}
type ColumnStatSet struct {
resultSet
}
func NewColumnStatSet(v []ColumnStat) *ColumnStatSet {
r := make([]Result, len(v))
for i := range v {
r[i] = &v[i]
}
return &ColumnStatSet{
resultSet: resultSet{
results: r,
columns: []string{
"Catalog",
"Schema",
"Table",
"Name",
"Average width",
"Nulls fraction",
"Distinct values",
"Minimum value",
"Maximum value",
"Mean value",
"Top N common values",
"Top N values freqs",
},
},
}
}
func (c ColumnStatSet) Get() *ColumnStat {
return c.results[c.current-1].(*ColumnStat)
}
type ColumnStat struct {
Catalog string
Schema string
Table string
Name string
AvgWidth int
NullFrac float64
NumDistinct int64
Min string
Max string
Mean string
TopN []string
TopNFreqs []float64
}
func (c ColumnStat) Values() []interface{} {
return []interface{}{
c.Catalog,
c.Schema,
c.Table,
c.Name,
c.AvgWidth,
c.NullFrac,
c.NumDistinct,
c.Min,
c.Max,
c.Mean,
c.TopN,
c.TopNFreqs,
}
}
type IndexSet struct {
resultSet
}
func NewIndexSet(v []Index) *IndexSet {
r := make([]Result, len(v))
for i := range v {
r[i] = &v[i]
}
return &IndexSet{
resultSet: resultSet{
results: r,
columns: []string{
"Catalog",
"Schema",
"Name",
"Table",
"Is primary",
"Is unique",
"Type",
},
},
}
}
func (i IndexSet) Get() *Index {
return i.results[i.current-1].(*Index)
}
type Index struct {
Catalog string
Schema string
Table string
Name string
IsPrimary Bool
IsUnique Bool
Type string
Columns string
}
func (i Index) Values() []interface{} {
return []interface{}{
i.Catalog,
i.Schema,
i.Name,
i.Table,
i.IsPrimary,
i.IsUnique,
i.Type,
}
}
type IndexColumnSet struct {
resultSet
}
func NewIndexColumnSet(v []IndexColumn) *IndexColumnSet {
r := make([]Result, len(v))
for i := range v {
r[i] = &v[i]
}
return &IndexColumnSet{
resultSet: resultSet{
results: r,
columns: []string{
"Catalog",
"Schema",
"Table",
"Index name",
"Name",
"Data type",
},
},
}
}
func (c IndexColumnSet) Get() *IndexColumn {
return c.results[c.current-1].(*IndexColumn)
}
type IndexColumn struct {
Catalog string
Schema string
Table string
IndexName string
Name string
DataType string
OrdinalPosition int
}
func (c IndexColumn) Values() []interface{} {
return []interface{}{
c.Catalog,
c.Schema,
c.Table,
c.IndexName,
c.Name,
c.DataType,
}
}
type ConstraintSet struct {
resultSet
}
func NewConstraintSet(v []Constraint) *ConstraintSet {
r := make([]Result, len(v))
for i := range v {
r[i] = &v[i]
}
return &ConstraintSet{
resultSet: resultSet{
results: r,
columns: []string{
"Catalog",
"Schema",
"Table",
"Name",
"Type",
"Is deferrable",
"Initially deferred",
"Foreign catalog",
"Foreign schema",
"Foreign table",
"Foreign name",
"Match type",
"Update rule",
"Delete rule",
"Check Clause",
},
},
}
}
func (i ConstraintSet) Get() *Constraint {
return i.results[i.current-1].(*Constraint)
}
type Constraint struct {
Catalog string
Schema string
Table string
Name string
Type string
IsDeferrable Bool
IsInitiallyDeferred Bool
ForeignCatalog string
ForeignSchema string
ForeignTable string
ForeignName string
MatchType string
UpdateRule string
DeleteRule string
CheckClause string
}
func (i Constraint) Values() []interface{} {
return []interface{}{
i.Catalog,
i.Schema,
i.Table,
i.Name,
i.Type,
i.IsDeferrable,
i.IsInitiallyDeferred,
i.ForeignCatalog,
i.ForeignSchema,
i.ForeignTable,
i.ForeignName,
i.MatchType,
i.UpdateRule,
i.DeleteRule,
}
}
type ConstraintColumnSet struct {
resultSet
}
func NewConstraintColumnSet(v []ConstraintColumn) *ConstraintColumnSet {
r := make([]Result, len(v))
for i := range v {
r[i] = &v[i]
}
return &ConstraintColumnSet{
resultSet: resultSet{
results: r,
columns: []string{
"Catalog",
"Schema",
"Table",
"Constraint",
"Name",
"Foreign Catalog",
"Foreign Schema",
"Foreign Table",
"Foreign Constraint",
"Foreign Name",
},
},
}
}
func (c ConstraintColumnSet) Get() *ConstraintColumn {
return c.results[c.current-1].(*ConstraintColumn)
}
type ConstraintColumn struct {
Catalog string
Schema string
Table string
Constraint string
Name string
OrdinalPosition int
ForeignCatalog string
ForeignSchema string
ForeignTable string
ForeignConstraint string
ForeignName string
}
func (c ConstraintColumn) Values() []interface{} {
return []interface{}{
c.Catalog,
c.Schema,
c.Table,
c.Constraint,
c.Name,
c.ForeignCatalog,
c.ForeignSchema,
c.ForeignTable,
c.ForeignConstraint,
c.ForeignName,
}
}
type FunctionSet struct {
resultSet
}
func NewFunctionSet(v []Function) *FunctionSet {
r := make([]Result, len(v))
for i := range v {
r[i] = &v[i]
}
return &FunctionSet{
resultSet: resultSet{
results: r,
columns: []string{
"Catalog",
"Schema",
"Name",
"Result data type",
"Argument data types",
"Type",
"Volatility",
"Security",
"Language",
"Source code",
},
},
}
}
func (f FunctionSet) Get() *Function {
return f.results[f.current-1].(*Function)
}
type Function struct {
Catalog string
Schema string
Name string
ResultType string
ArgTypes string
Type string
Volatility string
Security string
Language string
Source string
SpecificName string
}
func (f Function) Values() []interface{} {
return []interface{}{
f.Catalog,
f.Schema,
f.Name,
f.ResultType,
f.ArgTypes,
f.Type,
f.Volatility,
f.Security,
f.Language,
f.Source,
}
}
type FunctionColumnSet struct {
resultSet
}
func NewFunctionColumnSet(v []FunctionColumn) *FunctionColumnSet {
r := make([]Result, len(v))
for i := range v {
r[i] = &v[i]
}
return &FunctionColumnSet{
resultSet: resultSet{
results: r,
columns: []string{
"Catalog",
"Schema",
"Function name",
"Name",
"Type",
"Data type",
"Size",
"Decimal Digits",
"Precision Radix",
"Octet Length",
},
},
}
}
func (c FunctionColumnSet) Get() *FunctionColumn {
return c.results[c.current-1].(*FunctionColumn)
}
type FunctionColumn struct {
Catalog string
Schema string
Table string
Name string
FunctionName string
OrdinalPosition int
Type string
DataType string
// ScanType reflect.Type
ColumnSize int
DecimalDigits int
NumPrecRadix int
CharOctetLength int
}
func (c FunctionColumn) Values() []interface{} {
return []interface{}{
c.Catalog,
c.Schema,
c.FunctionName,
c.Name,
c.Type,
c.DataType,
c.ColumnSize,
c.DecimalDigits,
c.NumPrecRadix,
c.CharOctetLength,
}
}
type SequenceSet struct {
resultSet
}
func NewSequenceSet(v []Sequence) *SequenceSet {
r := make([]Result, len(v))
for i := range v {
r[i] = &v[i]
}
return &SequenceSet{
resultSet: resultSet{
results: r,
columns: []string{
"Type",
"Start",
"Min",
"Max",
"Increment",
"Cycles?",
},
},
}
}
func (s SequenceSet) Get() *Sequence {
return s.results[s.current-1].(*Sequence)
}
type Sequence struct {
Catalog string
Schema string
Name string
DataType string
Start string
Min string
Max string
Increment string
Cycles Bool
}
func (s Sequence) Values() []interface{} {
return []interface{}{
s.DataType,
s.Start,
s.Min,
s.Max,
s.Increment,
s.Cycles,
}
}
type PrivilegeSummarySet struct {
resultSet
}
func NewPrivilegeSummarySet(v []PrivilegeSummary) *PrivilegeSummarySet {
r := make([]Result, len(v))
for i := range v {
r[i] = &v[i]
}
return &PrivilegeSummarySet{
resultSet: resultSet{
results: r,
columns: []string{
"Schema",
"Name",
"Type",
"Access privileges",
"Column privileges",
},
},
}
}
func (s PrivilegeSummarySet) Get() *PrivilegeSummary {
return s.results[s.current-1].(*PrivilegeSummary)
}
// PrivilegeSummary summarizes the privileges granted on a database object
type PrivilegeSummary struct {
Catalog string
Schema string
Name string
ObjectType string
ObjectPrivileges ObjectPrivileges
ColumnPrivileges ColumnPrivileges
}
func (s PrivilegeSummary) Values() []interface{} {
return []interface{}{
s.Catalog,
s.Schema,
s.Name,
s.ObjectType,
s.ObjectPrivileges,
s.ColumnPrivileges,
}
}
// ObjectPrivilege represents a privilege granted on a database object.
type ObjectPrivilege struct {
Grantee string
Grantor string
PrivilegeType string
IsGrantable bool
}
// ColumnPrivilege represents a privilege granted on a column.
type ColumnPrivilege struct {
Column string
Grantee string
Grantor string
PrivilegeType string
IsGrantable bool
}
// ObjectPrivileges represents privileges granted on a database object.
// The privileges are assumed to be sorted. Otherwise the
// String() method will fail.
type ObjectPrivileges []ObjectPrivilege
// ColumnPrivileges represents privileges granted on a column.
// The privileges are assumed to be sorted. Otherwise the
// String() method will fail.
type ColumnPrivileges []ColumnPrivilege
func (p ObjectPrivileges) Len() int { return len(p) }
func (p ObjectPrivileges) Swap(i, j int) { p[i], p[j] = p[j], p[i] }
func (p ObjectPrivileges) Less(i, j int) bool {
switch {
case p[i].Grantee != p[j].Grantee:
return p[i].Grantee < p[j].Grantee
case p[i].Grantor != p[j].Grantor:
return p[i].Grantor < p[j].Grantor
}
return p[i].PrivilegeType < p[j].PrivilegeType
}
// String returns a string representation of ObjectPrivileges.
// Assumes the ObjectPrivileges to be sorted.
func (p ObjectPrivileges) String() string {
if len(p) == 0 {
return ""
}
lines := []string{}
types := []string{}
for i := range p {
switch {
// Is last privilege or next privilege has new grantee or grantor; finalize line
case i == len(p)-1 || p[i].Grantee != p[i+1].Grantee || p[i].Grantor != p[i+1].Grantor:
types = append(types, typeStr(p[i].PrivilegeType, p[i].IsGrantable))
lines = append(lines, lineStr(p[i].Grantee, p[i].Grantor, types))
types = types[:0]
default:
types = append(types, typeStr(p[i].PrivilegeType, p[i].IsGrantable))
}
}
return strings.Join(lines, "\n")
}
func (p ColumnPrivileges) Len() int { return len(p) }
func (p ColumnPrivileges) Swap(i, j int) { p[i], p[j] = p[j], p[i] }
func (p ColumnPrivileges) Less(i, j int) bool {
switch {
case p[i].Column != p[j].Column:
return p[i].Column < p[j].Column
case p[i].Grantee != p[j].Grantee:
return p[i].Grantee < p[j].Grantee
case p[i].Grantor != p[j].Grantor:
return p[i].Grantor < p[j].Grantor
}
return p[i].PrivilegeType < p[j].PrivilegeType
}
// String returns a string representation of ColumnPrivileges.
// Assumes the ColumnPrivileges to be sorted.
func (p ColumnPrivileges) String() string {
if len(p) == 0 {
return ""
}
colBlocks := []string{}
lines := []string{}
types := []string{}
for i := range p {
switch {
// Is last privilege or next privilege has new column; finalize column block
case i == len(p)-1 || p[i].Column != p[i+1].Column: