-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This change adds support for SCHEMA commenting. Release note (sql change): This change adds associating comment to SQL schema using PostgreSQL's COMMENT ON SCHEMA syntax.
- Loading branch information
Showing
18 changed files
with
229 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| comment_stmt ::= | ||
| 'COMMENT' 'ON' 'DATABASE' database_name 'IS' comment_text | ||
| | 'COMMENT' 'ON' 'SCHEMA' schema_name 'IS' comment_text | ||
| | 'COMMENT' 'ON' 'TABLE' table_name 'IS' comment_text | ||
| | 'COMMENT' 'ON' 'COLUMN' column_name 'IS' comment_text | ||
| | 'COMMENT' 'ON' 'INDEX' table_index_name 'IS' comment_text |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| // Copyright 2021 The Cockroach Authors. | ||
| // | ||
| // Use of this software is governed by the Business Source License | ||
| // included in the file licenses/BSL.txt. | ||
| // | ||
| // As of the Change Date specified in that file, in accordance with | ||
| // the Business Source License, use of this software will be governed | ||
| // by the Apache License, Version 2.0, included in the file | ||
| // licenses/APL.txt. | ||
|
|
||
| package sql | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/cockroachdb/cockroach/pkg/keys" | ||
| "github.com/cockroachdb/cockroach/pkg/security" | ||
| "github.com/cockroachdb/cockroach/pkg/sql/catalog" | ||
| "github.com/cockroachdb/cockroach/pkg/sql/pgwire/pgcode" | ||
| "github.com/cockroachdb/cockroach/pkg/sql/pgwire/pgerror" | ||
| "github.com/cockroachdb/cockroach/pkg/sql/privilege" | ||
| "github.com/cockroachdb/cockroach/pkg/sql/sem/tree" | ||
| "github.com/cockroachdb/cockroach/pkg/sql/sessiondata" | ||
| ) | ||
|
|
||
| type commentOnSchemaNode struct { | ||
| n *tree.CommentOnSchema | ||
| schemaDesc catalog.SchemaDescriptor | ||
| } | ||
|
|
||
| // CommentOnSchema add comment on a schema. | ||
| // Privileges: CREATE on scheme. | ||
| // notes: postgres requires CREATE on the scheme. | ||
| func (p *planner) CommentOnSchema(ctx context.Context, n *tree.CommentOnSchema) (planNode, error) { | ||
| if err := checkSchemaChangeEnabled( | ||
| ctx, | ||
| p.ExecCfg(), | ||
| "COMMENT ON SCHEMA", | ||
| ); err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| // Users can't create a schema without being connected to a DB. | ||
| dbName := p.CurrentDatabase() | ||
| if dbName == "" { | ||
| return nil, pgerror.New(pgcode.UndefinedDatabase, | ||
| "cannot comment schema without being connected to a database") | ||
| } | ||
|
|
||
| db, err := p.Descriptors().GetImmutableDatabaseByName(ctx, p.txn, | ||
| dbName, tree.DatabaseLookupFlags{Required: true}) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| schemaDesc, err := p.Descriptors().GetImmutableSchemaByID(ctx, p.txn, | ||
| db.GetSchemaID(string(n.Name)), tree.DatabaseLookupFlags{Required: true}) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| if err := p.CheckPrivilege(ctx, db, privilege.CREATE); err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return &commentOnSchemaNode{n: n, schemaDesc: schemaDesc}, nil | ||
| } | ||
|
|
||
| func (n *commentOnSchemaNode) startExec(params runParams) error { | ||
| if n.n.Comment != nil { | ||
| _, err := params.p.extendedEvalCtx.ExecCfg.InternalExecutor.ExecEx( | ||
| params.ctx, | ||
| "set-schema-comment", | ||
| params.p.Txn(), | ||
| sessiondata.InternalExecutorOverride{User: security.RootUserName()}, | ||
| "UPSERT INTO system.comments VALUES ($1, $2, 0, $3)", | ||
| keys.SchemaCommentType, | ||
| n.schemaDesc.GetID(), | ||
| *n.n.Comment) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } else { | ||
| err := params.p.removeSchemaComment(params.ctx, n.schemaDesc.GetID()) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func (n *commentOnSchemaNode) Next(runParams) (bool, error) { return false, nil } | ||
| func (n *commentOnSchemaNode) Values() tree.Datums { return tree.Datums{} } | ||
| func (n *commentOnSchemaNode) Close(context.Context) {} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| // Copyright 2021 The Cockroach Authors. | ||
| // | ||
| // Use of this software is governed by the Business Source License | ||
| // included in the file licenses/BSL.txt. | ||
| // | ||
| // As of the Change Date specified in that file, in accordance with | ||
| // the Business Source License, use of this software will be governed | ||
| // by the Apache License, Version 2.0, included in the file | ||
| // licenses/APL.txt. | ||
|
|
||
| package tree | ||
|
|
||
| import "github.com/cockroachdb/cockroach/pkg/sql/lexbase" | ||
|
|
||
| // CommentOnSchema represents an COMMENT ON SCHEMA statement. | ||
| type CommentOnSchema struct { | ||
| Name Name | ||
| Comment *string | ||
| } | ||
|
|
||
| // Format implements the NodeFormatter interface. | ||
| func (n *CommentOnSchema) Format(ctx *FmtCtx) { | ||
| ctx.WriteString("COMMENT ON SCHEMA ") | ||
| ctx.FormatNode(&n.Name) | ||
| ctx.WriteString(" IS ") | ||
| if n.Comment != nil { | ||
| // TODO(knz): Replace all this with ctx.FormatNode | ||
| // when COMMENT supports expressions. | ||
| if ctx.flags.HasFlags(FmtHideConstants) { | ||
| ctx.WriteByte('_') | ||
| } else { | ||
| lexbase.EncodeSQLStringWithFlags(&ctx.Buffer, *n.Comment, ctx.flags.EncodeFlags()) | ||
| } | ||
| } else { | ||
| ctx.WriteString("NULL") | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters