forked from cockroachdb/cockroach
/
information_schema.go
802 lines (745 loc) · 25.9 KB
/
information_schema.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
// Copyright 2016 The Cockroach Authors.
//
// 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.
//
// Author: Nathan VanBenschoten (nvanbenschoten@gmail.com)
package sql
import (
"sort"
"github.com/pkg/errors"
"golang.org/x/net/context"
"github.com/cockroachdb/cockroach/pkg/security"
"github.com/cockroachdb/cockroach/pkg/sql/parser"
"github.com/cockroachdb/cockroach/pkg/sql/sqlbase"
)
const (
informationSchemaName = "information_schema"
pgCatalogName = "pg_catalog"
)
var informationSchema = virtualSchema{
name: informationSchemaName,
tables: []virtualSchemaTable{
informationSchemaColumnsTable,
informationSchemaKeyColumnUsageTable,
informationSchemaSchemataTable,
informationSchemaSchemataTablePrivileges,
informationSchemaStatisticsTable,
informationSchemaTableConstraintTable,
informationSchemaTablePrivileges,
informationSchemaTablesTable,
informationSchemaViewsTable,
},
}
var (
// defString is used as the value for columns included in the sql standard
// of information_schema that don't make sense for CockroachDB. This is
// identical to the behavior of MySQL.
defString = parser.NewDString("def")
// information_schema was defined before the BOOLEAN data type was added to
// the SQL specification. Because of this, boolean values are represented
// as strings.
yesString = parser.NewDString("YES")
noString = parser.NewDString("NO")
)
func yesOrNoDatum(b bool) parser.Datum {
if b {
return yesString
}
return noString
}
func dStringOrNull(s string) parser.Datum {
if s == "" {
return parser.DNull
}
return parser.NewDString(s)
}
func dNameOrNull(s string) parser.Datum {
if s == "" {
return parser.DNull
}
return parser.NewDName(s)
}
func dStringPtrOrNull(s *string) parser.Datum {
if s == nil {
return parser.DNull
}
return parser.NewDString(*s)
}
func dIntFnOrNull(fn func() (int32, bool)) parser.Datum {
if n, ok := fn(); ok {
return parser.NewDInt(parser.DInt(n))
}
return parser.DNull
}
var informationSchemaColumnsTable = virtualSchemaTable{
schema: `
CREATE TABLE information_schema.columns (
TABLE_CATALOG STRING NOT NULL DEFAULT '',
TABLE_SCHEMA STRING NOT NULL DEFAULT '',
TABLE_NAME STRING NOT NULL DEFAULT '',
COLUMN_NAME STRING NOT NULL DEFAULT '',
ORDINAL_POSITION INT NOT NULL DEFAULT 0,
COLUMN_DEFAULT STRING,
IS_NULLABLE STRING NOT NULL DEFAULT '',
DATA_TYPE STRING NOT NULL DEFAULT '',
CHARACTER_MAXIMUM_LENGTH INT,
CHARACTER_OCTET_LENGTH INT,
NUMERIC_PRECISION INT,
NUMERIC_SCALE INT,
DATETIME_PRECISION INT
);
`,
populate: func(ctx context.Context, p *planner, addRow func(...parser.Datum) error) error {
return forEachTableDesc(ctx, p, func(db *sqlbase.DatabaseDescriptor, table *sqlbase.TableDescriptor) error {
// Table descriptors already holds columns in-order.
visible := 0
return forEachColumnInTable(table, func(column *sqlbase.ColumnDescriptor) error {
visible++
return addRow(
defString, // table_catalog
parser.NewDString(db.Name), // table_schema
parser.NewDString(table.Name), // table_name
parser.NewDString(column.Name), // column_name
parser.NewDInt(parser.DInt(visible)), // ordinal_position, 1-indexed
dStringPtrOrNull(column.DefaultExpr), // column_default
yesOrNoDatum(column.Nullable), // is_nullable
parser.NewDString(column.Type.SQLString()), // data_type
characterMaximumLength(column.Type), // character_maximum_length
characterOctetLength(column.Type), // character_octet_length
numericPrecision(column.Type), // numeric_precision
numericScale(column.Type), // numeric_scale
datetimePrecision(column.Type), // datetime_precision
)
})
})
},
}
func characterMaximumLength(colType sqlbase.ColumnType) parser.Datum {
return dIntFnOrNull(colType.MaxCharacterLength)
}
func characterOctetLength(colType sqlbase.ColumnType) parser.Datum {
return dIntFnOrNull(colType.MaxOctetLength)
}
func numericPrecision(colType sqlbase.ColumnType) parser.Datum {
return dIntFnOrNull(colType.NumericPrecision)
}
func numericScale(colType sqlbase.ColumnType) parser.Datum {
return dIntFnOrNull(colType.NumericScale)
}
func datetimePrecision(colType sqlbase.ColumnType) parser.Datum {
// We currently do not support a datetime precision.
return parser.DNull
}
var informationSchemaKeyColumnUsageTable = virtualSchemaTable{
schema: `
CREATE TABLE information_schema.key_column_usage (
CONSTRAINT_CATALOG STRING DEFAULT '',
CONSTRAINT_SCHEMA STRING DEFAULT '',
CONSTRAINT_NAME STRING DEFAULT '',
TABLE_CATALOG STRING NOT NULL DEFAULT '',
TABLE_SCHEMA STRING NOT NULL DEFAULT '',
TABLE_NAME STRING NOT NULL DEFAULT '',
COLUMN_NAME STRING NOT NULL DEFAULT '',
ORDINAL_POSITION INT NOT NULL DEFAULT 0,
POSITION_IN_UNIQUE_CONSTRAINT INT
);`,
populate: func(ctx context.Context, p *planner, addRow func(...parser.Datum) error) error {
return forEachTableDescWithTableLookup(ctx, p, func(
db *sqlbase.DatabaseDescriptor,
table *sqlbase.TableDescriptor,
tableLookup tableLookupFn,
) error {
info, err := table.GetConstraintInfoWithLookup(tableLookup.tableOrErr)
if err != nil {
return err
}
for name, c := range info {
// Only Primary Key, Foreign Key, and Unique constraints are included.
switch c.Kind {
case sqlbase.ConstraintTypePK:
case sqlbase.ConstraintTypeFK:
case sqlbase.ConstraintTypeUnique:
default:
continue
}
for pos, column := range c.Columns {
ordinalPos := parser.NewDInt(parser.DInt(pos + 1))
uniquePos := parser.DNull
if c.Kind == sqlbase.ConstraintTypeFK {
uniquePos = ordinalPos
}
if err := addRow(
defString, // constraint_catalog
parser.NewDString(db.Name), // constraint_schema
dStringOrNull(name), // constraint_name
defString, // table_catalog
parser.NewDString(db.Name), // table_schema
parser.NewDString(table.Name), // table_name
parser.NewDString(column), // column_name
ordinalPos, // ordinal_position, 1-indexed
uniquePos, // position_in_unique_constraint
); err != nil {
return err
}
}
}
return nil
})
},
}
var informationSchemaSchemataTable = virtualSchemaTable{
schema: `
CREATE TABLE information_schema.schemata (
CATALOG_NAME STRING NOT NULL DEFAULT '',
SCHEMA_NAME STRING NOT NULL DEFAULT '',
DEFAULT_CHARACTER_SET_NAME STRING NOT NULL DEFAULT '',
SQL_PATH STRING
);`,
populate: func(ctx context.Context, p *planner, addRow func(...parser.Datum) error) error {
return forEachDatabaseDesc(ctx, p, func(db *sqlbase.DatabaseDescriptor) error {
return addRow(
defString, // catalog_name
parser.NewDString(db.Name), // schema_name
parser.DNull, // default_character_set_name
parser.DNull, // sql_path
)
})
},
}
var informationSchemaSchemataTablePrivileges = virtualSchemaTable{
schema: `
CREATE TABLE information_schema.schema_privileges (
GRANTEE STRING NOT NULL DEFAULT '',
TABLE_CATALOG STRING NOT NULL DEFAULT '',
TABLE_SCHEMA STRING NOT NULL DEFAULT '',
PRIVILEGE_TYPE STRING NOT NULL DEFAULT '',
IS_GRANTABLE BOOL NOT NULL DEFAULT FALSE
);
`,
populate: func(ctx context.Context, p *planner, addRow func(...parser.Datum) error) error {
return forEachDatabaseDesc(ctx, p, func(db *sqlbase.DatabaseDescriptor) error {
for _, u := range db.Privileges.Show() {
for _, privilege := range u.Privileges {
if err := addRow(
parser.NewDString(u.User), // grantee
defString, // table_catalog,
parser.NewDString(db.Name), // table_schema
parser.NewDString(privilege), // privilege_type
parser.DNull, // is_grantable
); err != nil {
return err
}
}
}
return nil
})
},
}
var (
indexDirectionNA = parser.NewDString("N/A")
indexDirectionAsc = parser.NewDString(sqlbase.IndexDescriptor_ASC.String())
indexDirectionDesc = parser.NewDString(sqlbase.IndexDescriptor_DESC.String())
)
func dStringForIndexDirection(dir sqlbase.IndexDescriptor_Direction) parser.Datum {
switch dir {
case sqlbase.IndexDescriptor_ASC:
return indexDirectionAsc
case sqlbase.IndexDescriptor_DESC:
return indexDirectionDesc
}
panic("unreachable")
}
var informationSchemaStatisticsTable = virtualSchemaTable{
schema: `
CREATE TABLE information_schema.statistics (
TABLE_CATALOG STRING NOT NULL DEFAULT '',
TABLE_SCHEMA STRING NOT NULL DEFAULT '',
TABLE_NAME STRING NOT NULL DEFAULT '',
NON_UNIQUE BOOL NOT NULL DEFAULT FALSE,
INDEX_SCHEMA STRING NOT NULL DEFAULT '',
INDEX_NAME STRING NOT NULL DEFAULT '',
SEQ_IN_INDEX INT NOT NULL DEFAULT 0,
COLUMN_NAME STRING NOT NULL DEFAULT '',
"COLLATION" STRING NOT NULL DEFAULT '',
CARDINALITY INT NOT NULL DEFAULT 0,
DIRECTION STRING NOT NULL DEFAULT '',
STORING BOOL NOT NULL DEFAULT FALSE,
IMPLICIT BOOL NOT NULL DEFAULT FALSE
);`,
populate: func(ctx context.Context, p *planner, addRow func(...parser.Datum) error) error {
return forEachTableDesc(ctx, p, func(db *sqlbase.DatabaseDescriptor, table *sqlbase.TableDescriptor) error {
appendRow := func(index *sqlbase.IndexDescriptor, colName string, sequence int,
direction parser.Datum, isStored, isImplicit bool,
) error {
return addRow(
defString, // table_catalog
parser.NewDString(db.GetName()), // table_schema
parser.NewDString(table.GetName()), // table_name
parser.MakeDBool(parser.DBool(!index.Unique)), // non_unique
parser.NewDString(db.GetName()), // index_schema
parser.NewDString(index.Name), // index_name
parser.NewDInt(parser.DInt(sequence)), // seq_in_index
parser.NewDString(colName), // column_name
parser.DNull, // collation
parser.DNull, // cardinality
direction, // direction
parser.MakeDBool(parser.DBool(isStored)), // storing
parser.MakeDBool(parser.DBool(isImplicit)), // implicit
)
}
return forEachIndexInTable(table, func(index *sqlbase.IndexDescriptor) error {
// Columns in the primary key that aren't in index.ColumnNames or
// index.StoreColumnNames are implicit columns in the index.
var implicitCols map[string]struct{}
var hasImplicitCols bool
if index.HasOldStoredColumns() {
// Old STORING format: implicit columns are extra columns minus stored
// columns.
hasImplicitCols = len(index.ExtraColumnIDs) > len(index.StoreColumnNames)
} else {
// New STORING format: implicit columns are extra columns.
hasImplicitCols = len(index.ExtraColumnIDs) > 0
}
if hasImplicitCols {
implicitCols = make(map[string]struct{})
for _, col := range table.PrimaryIndex.ColumnNames {
implicitCols[col] = struct{}{}
}
}
sequence := 1
for i, col := range index.ColumnNames {
// We add a row for each column of index.
dir := dStringForIndexDirection(index.ColumnDirections[i])
if err := appendRow(index, col, sequence, dir, false, false); err != nil {
return err
}
sequence++
delete(implicitCols, col)
}
for _, col := range index.StoreColumnNames {
// We add a row for each stored column of index.
if err := appendRow(index, col, sequence,
indexDirectionNA, true, false); err != nil {
return err
}
sequence++
delete(implicitCols, col)
}
for col := range implicitCols {
// We add a row for each implicit column of index.
if err := appendRow(index, col, sequence,
indexDirectionAsc, false, true); err != nil {
return err
}
sequence++
}
return nil
})
})
},
}
var informationSchemaTableConstraintTable = virtualSchemaTable{
schema: `
CREATE TABLE information_schema.table_constraints (
CONSTRAINT_CATALOG STRING NOT NULL DEFAULT '',
CONSTRAINT_SCHEMA STRING NOT NULL DEFAULT '',
CONSTRAINT_NAME STRING NOT NULL DEFAULT '',
TABLE_SCHEMA STRING NOT NULL DEFAULT '',
TABLE_NAME STRING NOT NULL DEFAULT '',
CONSTRAINT_TYPE STRING NOT NULL DEFAULT ''
);`,
populate: func(ctx context.Context, p *planner, addRow func(...parser.Datum) error) error {
return forEachTableDescWithTableLookup(ctx, p, func(
db *sqlbase.DatabaseDescriptor,
table *sqlbase.TableDescriptor,
tableLookup tableLookupFn,
) error {
info, err := table.GetConstraintInfoWithLookup(tableLookup.tableOrErr)
if err != nil {
return err
}
for name, c := range info {
if err := addRow(
defString, // constraint_catalog
parser.NewDString(db.Name), // constraint_schema
dStringOrNull(name), // constraint_name
parser.NewDString(db.Name), // table_schema
parser.NewDString(table.Name), // table_name
parser.NewDString(string(c.Kind)), // constraint_type
); err != nil {
return err
}
}
return nil
})
},
}
var informationSchemaTablePrivileges = virtualSchemaTable{
schema: `
CREATE TABLE information_schema.table_privileges (
GRANTOR STRING NOT NULL DEFAULT '',
GRANTEE STRING NOT NULL DEFAULT '',
TABLE_CATALOG STRING NOT NULL DEFAULT '',
TABLE_SCHEMA STRING NOT NULL DEFAULT '',
TABLE_NAME STRING NOT NULL DEFAULT '',
PRIVILEGE_TYPE STRING NOT NULL DEFAULT '',
IS_GRANTABLE BOOL NOT NULL DEFAULT FALSE,
WITH_HIERARCHY BOOL NOT NULL DEFAULT FALSE
);
`,
populate: func(ctx context.Context, p *planner, addRow func(...parser.Datum) error) error {
return forEachTableDesc(ctx, p, func(db *sqlbase.DatabaseDescriptor, table *sqlbase.TableDescriptor) error {
for _, u := range table.Privileges.Show() {
for _, privilege := range u.Privileges {
if err := addRow(
parser.DNull, // grantor
parser.NewDString(u.User), // grantee
defString, // table_catalog,
parser.NewDString(db.Name), // table_schema
parser.NewDString(table.Name), // table_name
parser.NewDString(privilege), // privilege_type
parser.DNull, // is_grantable
parser.DNull, // with_hierarchy
); err != nil {
return err
}
}
}
return nil
})
},
}
var (
tableTypeSystemView = parser.NewDString("SYSTEM VIEW")
tableTypeBaseTable = parser.NewDString("BASE TABLE")
tableTypeView = parser.NewDString("VIEW")
)
var informationSchemaTablesTable = virtualSchemaTable{
schema: `
CREATE TABLE information_schema.tables (
TABLE_CATALOG STRING NOT NULL DEFAULT '',
TABLE_SCHEMA STRING NOT NULL DEFAULT '',
TABLE_NAME STRING NOT NULL DEFAULT '',
TABLE_TYPE STRING NOT NULL DEFAULT '',
VERSION INT
);`,
populate: func(ctx context.Context, p *planner, addRow func(...parser.Datum) error) error {
return forEachTableDesc(ctx, p, func(db *sqlbase.DatabaseDescriptor, table *sqlbase.TableDescriptor) error {
tableType := tableTypeBaseTable
if isVirtualDescriptor(table) {
tableType = tableTypeSystemView
} else if table.IsView() {
tableType = tableTypeView
}
return addRow(
defString, // table_catalog
parser.NewDString(db.Name), // table_schema
parser.NewDString(table.Name), // table_name
tableType, // table_type
parser.NewDInt(parser.DInt(table.Version)), // version
)
})
},
}
var informationSchemaViewsTable = virtualSchemaTable{
schema: `
CREATE TABLE information_schema.views (
TABLE_CATALOG STRING NOT NULL DEFAULT '',
TABLE_SCHEMA STRING NOT NULL DEFAULT '',
TABLE_NAME STRING NOT NULL DEFAULT '',
VIEW_DEFINITION STRING NOT NULL DEFAULT '',
CHECK_OPTION STRING NOT NULL DEFAULT '',
IS_UPDATABLE BOOL NOT NULL DEFAULT FALSE,
IS_INSERTABLE_INTO BOOL NOT NULL DEFAULT FALSE,
IS_TRIGGER_UPDATABLE BOOL NOT NULL DEFAULT FALSE,
IS_TRIGGER_DELETABLE BOOL NOT NULL DEFAULT FALSE,
IS_TRIGGER_INSERTABLE_INTO BOOL NOT NULL DEFAULT FALSE
);`,
populate: func(ctx context.Context, p *planner, addRow func(...parser.Datum) error) error {
return forEachTableDesc(ctx, p, func(db *sqlbase.DatabaseDescriptor, table *sqlbase.TableDescriptor) error {
if !table.IsView() {
return nil
}
// Note that the view query printed will not include any column aliases
// specified outside the initial view query into the definition returned,
// unlike Postgres. For example, for the view created via
// `CREATE VIEW (a) AS SELECT b FROM foo`
// we'll only print `SELECT b FROM foo` as the view definition here,
// while Postgres would more accurately print `SELECT b AS a FROM foo`.
// TODO(a-robinson): Insert column aliases into view query once we
// have a semantic query representation to work with (#10083).
return addRow(
defString, // table_catalog
parser.NewDString(db.Name), // table_schema
parser.NewDString(table.Name), // table_name
parser.NewDString(table.ViewQuery), // view_definition
parser.DNull, // check_option
parser.DNull, // is_updatable
parser.DNull, // is_insertable_into
parser.DNull, // is_trigger_updatable
parser.DNull, // is_trigger_deletable
parser.DNull, // is_trigger_insertable_into
)
})
},
}
type sortedDBDescs []*sqlbase.DatabaseDescriptor
// sortedDBDescs implements sort.Interface. It sorts a slice of DatabaseDescriptors
// by the database name.
func (dbs sortedDBDescs) Len() int { return len(dbs) }
func (dbs sortedDBDescs) Swap(i, j int) { dbs[i], dbs[j] = dbs[j], dbs[i] }
func (dbs sortedDBDescs) Less(i, j int) bool { return dbs[i].Name < dbs[j].Name }
// forEachTableDesc retrieves all database descriptors and iterates through them in
// lexicographical order with respect to their name. For each database, the function
// will call fn with its descriptor.
func forEachDatabaseDesc(
ctx context.Context, p *planner, fn func(*sqlbase.DatabaseDescriptor) error,
) error {
// Handle real schemas
dbDescs, err := getAllDatabaseDescs(ctx, p.txn)
if err != nil {
return err
}
// Handle virtual schemas.
for _, schema := range p.session.virtualSchemas.entries {
dbDescs = append(dbDescs, schema.desc)
}
sort.Sort(sortedDBDescs(dbDescs))
for _, db := range dbDescs {
if userCanSeeDatabase(db, p.session.User) {
if err := fn(db); err != nil {
return err
}
}
}
return nil
}
// forEachTableDesc retrieves all table descriptors from the current database
// and all system databases and iterates through them in lexicographical order
// with respect primarily to database name and secondarily to table name. For
// each table, the function will call fn with its respective database and table
// descriptor.
func forEachTableDesc(
ctx context.Context,
p *planner,
fn func(*sqlbase.DatabaseDescriptor, *sqlbase.TableDescriptor) error,
) error {
return forEachTableDescWithTableLookup(ctx, p, func(
db *sqlbase.DatabaseDescriptor,
table *sqlbase.TableDescriptor,
_ tableLookupFn,
) error {
return fn(db, table)
})
}
// tableLookupFn can be used to retrieve a table descriptor and its corresponding
// database descriptor using the table's ID. Both descriptors will be nil if a
// table with the provided ID was not found.
type tableLookupFn func(tableID sqlbase.ID) (*sqlbase.DatabaseDescriptor, *sqlbase.TableDescriptor)
func (fn tableLookupFn) tableOrErr(id sqlbase.ID) (*sqlbase.TableDescriptor, error) {
if _, t := fn(id); t != nil {
return t, nil
}
return nil, errors.Errorf("could not find referenced table with ID %v", id)
}
// isSystemDatabaseName returns true if the input name is not a user db name.
func isSystemDatabaseName(name string) bool {
switch name {
case informationSchemaName:
case pgCatalogName:
case sqlbase.SystemDB.Name:
default:
return false
}
return true
}
// forEachTableDescWithTableLookup acts like forEachTableDesc, except it also provides a
// tableLookupFn when calling fn to allow callers to lookup fetched table descriptors
// on demand. This is important for callers dealing with objects like foreign keys, where
// the metadata for each object must be augmented by looking at the referenced table.
func forEachTableDescWithTableLookup(
ctx context.Context,
p *planner,
fn func(*sqlbase.DatabaseDescriptor, *sqlbase.TableDescriptor, tableLookupFn) error,
) error {
type dbDescTables struct {
desc *sqlbase.DatabaseDescriptor
tables map[string]*sqlbase.TableDescriptor
tablesByID map[sqlbase.ID]*sqlbase.TableDescriptor
}
databases := make(map[string]dbDescTables)
// Handle real schemas.
descs, err := getAllDescriptors(ctx, p.txn)
if err != nil {
return err
}
dbIDsToName := make(map[sqlbase.ID]string)
// First, iterate through all database descriptors, constructing dbDescTables
// objects and populating a mapping from sqlbase.ID to database name.
for _, desc := range descs {
if db, ok := desc.(*sqlbase.DatabaseDescriptor); ok {
dbIDsToName[db.GetID()] = db.GetName()
databases[db.GetName()] = dbDescTables{
desc: db,
tables: make(map[string]*sqlbase.TableDescriptor),
tablesByID: make(map[sqlbase.ID]*sqlbase.TableDescriptor),
}
}
}
// Next, iterate through all table descriptors, using the mapping from sqlbase.ID
// to database name to add descriptors to a dbDescTables' tables map.
for _, desc := range descs {
if table, ok := desc.(*sqlbase.TableDescriptor); ok && !table.Dropped() {
dbName, ok := dbIDsToName[table.GetParentID()]
if !ok {
return errors.Errorf("no database with ID %d found", table.GetParentID())
}
dbTables := databases[dbName]
dbTables.tables[table.Name] = table
dbTables.tablesByID[table.ID] = table
}
}
// Handle virtual schemas.
for dbName, schema := range p.session.virtualSchemas.entries {
dbTables := make(map[string]*sqlbase.TableDescriptor, len(schema.tables))
for tableName, entry := range schema.tables {
dbTables[tableName] = entry.desc
}
databases[dbName] = dbDescTables{
desc: schema.desc,
tables: dbTables,
}
}
// Create table lookup function, which some callers of this function, like those
// dealing with foreign keys, will need.
tableLookup := func(id sqlbase.ID) (*sqlbase.DatabaseDescriptor, *sqlbase.TableDescriptor) {
for _, db := range databases {
table, ok := db.tablesByID[id]
if ok {
return db.desc, table
}
}
return nil, nil
}
// Below we use the same trick twice of sorting a slice of strings lexicographically
// and iterating through these strings to index into a map. Effectively, this allows
// us to iterate through a map in sorted order.
dbNames := make([]string, 0, len(databases))
for dbName := range databases {
dbNames = append(dbNames, dbName)
}
sort.Strings(dbNames)
for _, dbName := range dbNames {
if !p.isDatabaseVisible(dbName) {
continue
}
db := databases[dbName]
dbTableNames := make([]string, 0, len(db.tables))
for tableName := range db.tables {
dbTableNames = append(dbTableNames, tableName)
}
sort.Strings(dbTableNames)
for _, tableName := range dbTableNames {
tableDesc := db.tables[tableName]
if userCanSeeTable(tableDesc, p.session.User) {
if err := fn(db.desc, tableDesc, tableLookup); err != nil {
return err
}
}
}
}
return nil
}
func forEachIndexInTable(
table *sqlbase.TableDescriptor, fn func(*sqlbase.IndexDescriptor) error,
) error {
if table.IsPhysicalTable() {
if err := fn(&table.PrimaryIndex); err != nil {
return err
}
}
for i := range table.Indexes {
if err := fn(&table.Indexes[i]); err != nil {
return err
}
}
return nil
}
func forEachColumnInTable(
table *sqlbase.TableDescriptor, fn func(*sqlbase.ColumnDescriptor) error,
) error {
// Table descriptors already hold columns in-order.
for i := range table.Columns {
if !table.Columns[i].Hidden {
if err := fn(&table.Columns[i]); err != nil {
return err
}
}
}
return nil
}
func forEachColumnInIndex(
table *sqlbase.TableDescriptor,
index *sqlbase.IndexDescriptor,
fn func(*sqlbase.ColumnDescriptor) error,
) error {
colMap := make(map[sqlbase.ColumnID]*sqlbase.ColumnDescriptor, len(table.Columns))
for i, column := range table.Columns {
colMap[column.ID] = &table.Columns[i]
}
for _, columnID := range index.ColumnIDs {
if column := colMap[columnID]; !column.Hidden {
if err := fn(column); err != nil {
return err
}
}
}
return nil
}
func forEachUser(ctx context.Context, p *planner, fn func(username string) error) error {
query := `SELECT username FROM system.users`
plan, err := p.query(ctx, query)
if err != nil {
return nil
}
defer plan.Close(ctx)
if err := p.startPlan(ctx, plan); err != nil {
return err
}
// TODO(cuongdo/asubiotto): Get rid of root user special-casing if/when a row
// for "root" exists in system.user.
if err := fn(security.RootUser); err != nil {
return err
}
for {
next, err := plan.Next(ctx)
if err != nil {
return err
}
if !next {
break
}
row := plan.Values()
username := parser.MustBeDString(row[0])
if err := fn(string(username)); err != nil {
return err
}
}
return nil
}
func userCanSeeDatabase(db *sqlbase.DatabaseDescriptor, user string) bool {
return userCanSeeDescriptor(db, user)
}
func userCanSeeTable(table *sqlbase.TableDescriptor, user string) bool {
return userCanSeeDescriptor(table, user) && table.State == sqlbase.TableDescriptor_PUBLIC
}