feat: add supporting COMMENT ON VIEW (#2249)

* feat: add supporting COMMENT ON VIEW

close #2241

* test: Add tests for COMMENT ON VIEW

---------

Co-authored-by: Kyle Conroy <kyle@conroy.org>

Author: orisano

internal/endtoend/testdata/comment_on/postgresql/pgx/v4/go/models.go

@@ -4,12 +4,18 @@ CREATE TABLE foo.bar (
         baz text NOT NULL 
 );
 
+CREATE VIEW foo.bat AS SELECT * FROM foo.bar;
+
 CREATE TYPE foo.mood AS ENUM ('sad', 'ok', 'happy');
 
 COMMENT ON SCHEMA foo IS 'this is the foo schema';
 COMMENT ON TYPE foo.mood IS 'this is the mood type';
 COMMENT ON TABLE foo.bar IS 'this is the bar table';
 COMMENT ON COLUMN foo.bar.baz IS 'this is the baz column';
+COMMENT ON VIEW foo.bat IS 'this is the bat view ';
 
 -- name: ListBar :many
 SELECT * FROM foo.bar;
+
+-- name: ListBat :many
+SELECT * FROM foo.bat;

internal/endtoend/testdata/comment_on/postgresql/pgx/v4/go/query.sql.go

@@ -4,12 +4,18 @@ CREATE TABLE foo.bar (
         baz text NOT NULL 
 );
 
+CREATE VIEW foo.bat AS SELECT * FROM foo.bar;
+
 CREATE TYPE foo.mood AS ENUM ('sad', 'ok', 'happy');
 
 COMMENT ON SCHEMA foo IS 'this is the foo schema';
 COMMENT ON TYPE foo.mood IS 'this is the mood type';
 COMMENT ON TABLE foo.bar IS 'this is the bar table';
 COMMENT ON COLUMN foo.bar.baz IS 'this is the baz column';
+COMMENT ON VIEW foo.bat IS 'this is the bat view ';
 
 -- name: ListBar :many
 SELECT * FROM foo.bar;
+
+-- name: ListBat :many
+SELECT * FROM foo.bat;

internal/endtoend/testdata/comment_on/postgresql/pgx/v4/query.sql

@@ -4,12 +4,18 @@ CREATE TABLE foo.bar (
         baz text NOT NULL 
 );
 
+CREATE VIEW foo.bat AS SELECT * FROM foo.bar;
+
 CREATE TYPE foo.mood AS ENUM ('sad', 'ok', 'happy');
 
 COMMENT ON SCHEMA foo IS 'this is the foo schema';
 COMMENT ON TYPE foo.mood IS 'this is the mood type';
 COMMENT ON TABLE foo.bar IS 'this is the bar table';
 COMMENT ON COLUMN foo.bar.baz IS 'this is the baz column';
+COMMENT ON VIEW foo.bat IS 'this is the bat view ';
 
 -- name: ListBar :many
 SELECT * FROM foo.bar;
+
+-- name: ListBat :many
+SELECT * FROM foo.bat;

internal/endtoend/testdata/comment_on/postgresql/pgx/v5/go/models.go

@@ -379,6 +379,16 @@ func translate(node *nodes.Node) (ast.Node, error) {
 				Comment: makeString(n.Comment),
 			}, nil
 
+		case nodes.ObjectType_OBJECT_VIEW:
+			rel, err := parseRelation(n.Object)
+			if err != nil {
+				return nil, fmt.Errorf("COMMENT ON VIEW: %w", err)
+			}
+			return &ast.CommentOnViewStmt{
+				View:    rel.TableName(),
+				Comment: makeString(n.Comment),
+			}, nil
+
 		}
 		return nil, errSkip
 

internal/endtoend/testdata/comment_on/postgresql/pgx/v5/go/query.sql.go

@@ -0,0 +1,10 @@
+package ast
+
+type CommentOnViewStmt struct {
+	View    *TableName
+	Comment *string
+}
+
+func (n *CommentOnViewStmt) Pos() int {
+	return 0
+}

internal/endtoend/testdata/comment_on/postgresql/pgx/v5/query.sql

@@ -164,6 +164,9 @@ func (a *application) apply(parent ast.Node, name string, iter *iterator, n ast.
 	case *ast.CommentOnTypeStmt:
 		a.apply(n, "Type", nil, n.Type)
 
+	case *ast.CommentOnViewStmt:
+		a.apply(n, "View", nil, n.View)
+
 	case *ast.CreateTableStmt:
 		a.apply(n, "Name", nil, n.Name)
 

internal/endtoend/testdata/comment_on/postgresql/stdlib/go/models.go

@@ -77,6 +77,11 @@ func Walk(f Visitor, node ast.Node) {
 			Walk(f, n.Type)
 		}
 
+	case *ast.CommentOnViewStmt:
+		if n.View != nil {
+			Walk(f, n.View)
+		}
+
 	case *ast.CompositeTypeStmt:
 		if n.TypeName != nil {
 			Walk(f, n.TypeName)

internal/endtoend/testdata/comment_on/postgresql/stdlib/go/query.sql.go

@@ -76,6 +76,9 @@ func (c *Catalog) Update(stmt ast.Statement, colGen columnGenerator) error {
 	case *ast.CommentOnTypeStmt:
 		err = c.commentOnType(n)
 
+	case *ast.CommentOnViewStmt:
+		err = c.commentOnView(n)
+
 	case *ast.CompositeTypeStmt:
 		err = c.createCompositeType(n)
 

internal/endtoend/testdata/comment_on/postgresql/stdlib/query.sql

@@ -61,3 +61,16 @@ func (c *Catalog) commentOnType(stmt *ast.CommentOnTypeStmt) error {
 	}
 	return nil
 }
+
+func (c *Catalog) commentOnView(stmt *ast.CommentOnViewStmt) error {
+	_, t, err := c.getTable(stmt.View)
+	if err != nil {
+		return err
+	}
+	if stmt.Comment != nil {
+		t.Comment = *stmt.Comment
+	} else {
+		t.Comment = ""
+	}
+	return nil
+}