Skip to content

Commit 53786d7

Browse files
rafissrafiss
committed
sql: add back argument-level comments
Commit 282a83e accidentally removed comments that were on some function arguments. This adds them back. This also adjusts the name of a local variable. It used to be a const called `allowLeased`, but that same commit changed it to be an opts struct. Finally, this standardizes spelling of "MetaData" to "Metadata". Release note: None
1 parent 1c3e1bb commit 53786d7

File tree

4 files changed

+17
-17
lines changed

4 files changed

+17
-17
lines changed

‎pkg/sql/catalog/descs/collection.go‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,7 @@ func WithOnlyVersionBump() WriteDescOption {
368368

369369
type getAllOptions struct {
370370
allowLeased bool
371-
withMetaData bool
371+
withMetadata bool
372372
}
373373

374374
// GetAllOption defines functional options for GetAll* methods.
@@ -385,7 +385,7 @@ func (c allowLeasedOption) apply(opts *getAllOptions) {
385385
type withMetaDataOption bool
386386

387387
func (c withMetaDataOption) apply(opts *getAllOptions) {
388-
opts.withMetaData = bool(c)
388+
opts.withMetadata = bool(c)
389389
}
390390

391391
// WithAllowLeased configures GetAll* methods to allow leased descriptors.
@@ -967,8 +967,8 @@ func (tc *Collection) GetAllComments(
967967
if err != nil {
968968
return nil, err
969969
}
970-
var allowLeased = getAllOptions{}
971-
comments, err := tc.aggregateAllLayers(ctx, txn, allowLeased, kvComments)
970+
var options = getAllOptions{}
971+
comments, err := tc.aggregateAllLayers(ctx, txn, options, kvComments)
972972
if err != nil {
973973
return nil, err
974974
}
@@ -1284,7 +1284,7 @@ func (tc *Collection) aggregateAllLayers(
12841284
if getAllOptions.allowLeased {
12851285
flags.layerFilters.withoutLeased = false
12861286
}
1287-
if getAllOptions.withMetaData {
1287+
if getAllOptions.withMetadata {
12881288
flags.layerFilters.withMetadata = true
12891289
}
12901290
if err := getDescriptorsByID(

‎pkg/sql/crdb_internal.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3278,7 +3278,7 @@ CREATE TABLE crdb_internal.create_schema_statements (
32783278
dbDescs = append(dbDescs, db)
32793279
}
32803280
for _, db := range dbDescs {
3281-
return forEachSchema(ctx, p, db, true, true /* includeMetadata */, func(ctx context.Context, schemaDesc catalog.SchemaDescriptor) error {
3281+
return forEachSchema(ctx, p, db, true /* requiresPrivileges */, true /* includeMetadata */, func(ctx context.Context, schemaDesc catalog.SchemaDescriptor) error {
32823282
switch schemaDesc.SchemaKind() {
32833283
case catalog.SchemaUserDefined:
32843284
node := &tree.CreateSchema{
@@ -3333,7 +3333,7 @@ func createRoutinePopulate(
33333333
fnIDToDBName := make(map[descpb.ID]string)
33343334
fnIDToDBID := make(map[descpb.ID]descpb.ID)
33353335
for _, curDB := range dbDescs {
3336-
err := forEachSchema(ctx, p, curDB, true, false, func(ctx context.Context, sc catalog.SchemaDescriptor) error {
3336+
err := forEachSchema(ctx, p, curDB, true /* requiresPrivileges */, false /* includeMetadata */, func(ctx context.Context, sc catalog.SchemaDescriptor) error {
33373337
return sc.ForEachFunctionSignature(func(sig descpb.SchemaDescriptor_FunctionSignature) error {
33383338
fnIDs = append(fnIDs, sig.ID)
33393339
fnIDToScName[sig.ID] = sc.GetName()
@@ -6868,7 +6868,7 @@ CREATE TABLE crdb_internal.default_privileges (
68686868
return err
68696869
}
68706870

6871-
return forEachSchema(ctx, p, databaseDesc, true, false /* includeMetadata */, func(ctx context.Context, schema catalog.SchemaDescriptor) error {
6871+
return forEachSchema(ctx, p, databaseDesc, true /* requiresPrivileges */, false /* includeMetadata */, func(ctx context.Context, schema catalog.SchemaDescriptor) error {
68726872
return addRowsForSchema(schema.GetDefaultPrivilegeDescriptor(), tree.NewDString(schema.GetName()))
68736873
})
68746874
})

‎pkg/sql/information_schema.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1139,7 +1139,7 @@ https://www.postgresql.org/docs/9.5/infoschema-schemata.html`,
11391139
populate: func(ctx context.Context, p *planner, dbContext catalog.DatabaseDescriptor, addRow func(...tree.Datum) error) error {
11401140
return forEachDatabaseDesc(ctx, p, dbContext, true, /* requiresPrivileges */
11411141
func(ctx context.Context, db catalog.DatabaseDescriptor) error {
1142-
return forEachSchema(ctx, p, db, true, false /* includeMetadata */, func(ctx context.Context, sc catalog.SchemaDescriptor) error {
1142+
return forEachSchema(ctx, p, db, true /* requiresPrivileges */, false /* includeMetadata */, func(ctx context.Context, sc catalog.SchemaDescriptor) error {
11431143
return addRow(
11441144
tree.NewDString(db.GetName()), // catalog_name
11451145
tree.NewDString(sc.GetName()), // schema_name
@@ -1237,7 +1237,7 @@ var informationSchemaSchemataTablePrivileges = virtualSchemaTable{
12371237
populate: func(ctx context.Context, p *planner, dbContext catalog.DatabaseDescriptor, addRow func(...tree.Datum) error) error {
12381238
return forEachDatabaseDesc(ctx, p, dbContext, true, /* requiresPrivileges */
12391239
func(ctx context.Context, db catalog.DatabaseDescriptor) error {
1240-
return forEachSchema(ctx, p, db, true, false /* includeMetadata */, func(ctx context.Context, sc catalog.SchemaDescriptor) error {
1240+
return forEachSchema(ctx, p, db, true /* requiresPrivileges */, false /* includeMetadata */, func(ctx context.Context, sc catalog.SchemaDescriptor) error {
12411241
privs, err := sc.GetPrivileges().Show(privilege.Schema, true /* showImplicitOwnerPrivs */)
12421242
if err != nil {
12431243
return err
@@ -2835,7 +2835,7 @@ func forEachTableDescFromDescriptors(
28352835
// missing temporary schema name. Temporary schemas have namespace
28362836
// entries. The below code will go and lookup schema names from the
28372837
// namespace table if needed to qualify the name of a temporary table.
2838-
if err := forEachSchema(ctx, p, dbDesc, false, false, func(ctx context.Context, schema catalog.SchemaDescriptor) error {
2838+
if err := forEachSchema(ctx, p, dbDesc, false /* requiresPrivileges */, false /* includeMetadata */, func(ctx context.Context, schema catalog.SchemaDescriptor) error {
28392839
if schema.GetID() != table.GetParentSchemaID() {
28402840
return nil
28412841
}

‎pkg/sql/pg_catalog.go‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1250,7 +1250,7 @@ func makeAllRelationsVirtualTableWithDescriptorIDIndex(
12501250
ctx,
12511251
p,
12521252
dbContext,
1253-
false,
1253+
false, /* includeMetadata */
12541254
func(ctx context.Context, _ catalog.DatabaseDescriptor, sc catalog.SchemaDescriptor, typeDesc catalog.TypeDescriptor) error {
12551255
nspOid := schemaOid(sc.GetID())
12561256
tn := tree.NewQualifiedTypeName(dbContext.GetName(), sc.GetName(), typeDesc.GetName())
@@ -1803,7 +1803,7 @@ https://www.postgresql.org/docs/9.5/catalog-pg-depend.html`,
18031803
if err != nil {
18041804
return err
18051805
}
1806-
return forEachSchema(ctx, p, dbContext, true, false /* includeMetadata */, func(ctx context.Context, sc catalog.SchemaDescriptor) error {
1806+
return forEachSchema(ctx, p, dbContext, true /* requiresPrivileges */, false /* includeMetadata */, func(ctx context.Context, sc catalog.SchemaDescriptor) error {
18071807
pgProcTableOid := tableOid(pgProcDesc.GetID())
18081808
return sc.ForEachFunctionSignature(func(sig descpb.SchemaDescriptor_FunctionSignature) error {
18091809
funcDesc, err := descs.GetCatalogDescriptorGetter(p.Descriptors(), p.txn, &p.EvalContext().Settings.SV).Get().Function(ctx, sig.ID)
@@ -2303,7 +2303,7 @@ https://www.postgresql.org/docs/9.5/catalog-pg-namespace.html`,
23032303
populate: func(ctx context.Context, p *planner, dbContext catalog.DatabaseDescriptor, addRow func(...tree.Datum) error) error {
23042304
return forEachDatabaseDesc(ctx, p, dbContext, true, /* requiresPrivileges */
23052305
func(ctx context.Context, db catalog.DatabaseDescriptor) error {
2306-
return forEachSchema(ctx, p, db, true, false /* includeMetadata */, func(ctx context.Context, sc catalog.SchemaDescriptor) error {
2306+
return forEachSchema(ctx, p, db, true /* requiresPrivileges */, false /* includeMetadata */, func(ctx context.Context, sc catalog.SchemaDescriptor) error {
23072307
ownerOID := tree.DNull
23082308
if sc.SchemaKind() == catalog.SchemaUserDefined {
23092309
var err error
@@ -2348,7 +2348,7 @@ https://www.postgresql.org/docs/9.5/catalog-pg-namespace.html`,
23482348
}
23492349
// Fallback to looking for temporary schemas.
23502350
var tempSchema catalog.SchemaDescriptor
2351-
if err := forEachSchema(ctx, p, db, false, false /* includeMetadata */, func(ctx context.Context, schema catalog.SchemaDescriptor) error {
2351+
if err := forEachSchema(ctx, p, db, false /* requiresPrivileges */, false /* includeMetadata */, func(ctx context.Context, schema catalog.SchemaDescriptor) error {
23522352
if schema.GetID() != descpb.ID(ooid) {
23532353
return nil
23542354
}
@@ -2891,7 +2891,7 @@ https://www.postgresql.org/docs/16/catalog-pg-proc.html`,
28912891
}
28922892
return forEachDatabaseDesc(ctx, p, dbContext, false, /* requiresPrivileges */
28932893
func(ctx context.Context, dbDesc catalog.DatabaseDescriptor) error {
2894-
return forEachSchema(ctx, p, dbDesc, true, false /* includeMetadata */, func(ctx context.Context, scDesc catalog.SchemaDescriptor) error {
2894+
return forEachSchema(ctx, p, dbDesc, true /* requiresPrivileges */, false /* includeMetadata */, func(ctx context.Context, scDesc catalog.SchemaDescriptor) error {
28952895
return scDesc.ForEachFunctionSignature(func(sig descpb.SchemaDescriptor_FunctionSignature) error {
28962896
fnDesc, err := descs.GetCatalogDescriptorGetter(p.Descriptors(), p.Txn(), &p.EvalContext().Settings.SV).WithoutNonPublic().Get().Function(ctx, sig.ID)
28972897
if err != nil {
@@ -5676,7 +5676,7 @@ func populateVirtualIndexForTable(
56765676
// Ideally, the catalog API would be able to return the temporary
56775677
// schemas from other sessions, but it cannot right now. See
56785678
// https://github.com/cockroachdb/cockroach/issues/97822.
5679-
if err := forEachSchema(ctx, p, dbContext, false, false, func(ctx context.Context, schema catalog.SchemaDescriptor) error {
5679+
if err := forEachSchema(ctx, p, dbContext, false /* requiresPrivileges */, false /* includeMetadata */, func(ctx context.Context, schema catalog.SchemaDescriptor) error {
56805680
if schema.GetID() == tableDesc.GetParentSchemaID() {
56815681
sc = schema
56825682
}

0 commit comments

Comments
 (0)