Skip to content

Add COMMENT ON support for views #2241

Closed
#2249
Closed
Add COMMENT ON support for views#2241
#2249
Labels
📚 postgresqlenhancementNew feature or requestquestionFurther information is requested

Description

@mdigger
mdigger
opened on Apr 28, 2023

What do you want to change?

Use comment to generate model by view.

create view test_view as
    select * from table
    where title is not null;

comment on view test_view is 'Test view';

The generated struct should have a comment before it like so:

// Test view
type TestView struct {
	ID   int64
	Name string
	Bio  sql.NullString
}

No comment currently shows up.

What database engines need to be changed?

PostgreSQL

What programming language backends need to be changed?

Go

Activity

  1. mdigger
    added
    enhancementNew feature or request
    triageNew issues that hasn't been reviewed
    on Apr 28, 2023
  2. kyleconroy
    removed
    triageNew issues that hasn't been reviewed
    on Apr 28, 2023

  3. kyleconroy commented on Apr 28, 2023

    @kyleconroy
    kyleconroy
    on Apr 28, 2023
    Collaborator

    @mdigger What exactly would you like to change about how sqlc currently handles this?

    Here's what the code outputs today https://play.sqlc.dev/p/502f584a2eda264a3f28e8e54c206bfe29306d873d8bfdce1c8a91622d0a7f0d

  4. kyleconroy
    added
    questionFurther information is requested
    on Apr 28, 2023

  5. mdigger commented on Apr 28, 2023

    @mdigger
    mdigger
    on Apr 28, 2023
    Author
    // Test view
type TestView struct {
	ID   int64
	Name string
	Bio  sql.NullString
}

    How is it done for tables... :)

  6. kyleconroy commented on Apr 28, 2023

    @kyleconroy
    kyleconroy
    on Apr 28, 2023
    Collaborator

    Please take a look at the link I shared, as sqlc does exactly this.

  7. kyleconroy
    closed this as completedon Apr 28, 2023

  8. mdigger commented on Apr 28, 2023

    @mdigger
    mdigger
    on Apr 28, 2023
    Author

    https://play.sqlc.dev/p/47cebd466b443ee4bb73a1986990c5a6a30780c2b2b8903d27e3e51624bbd8df

    // Author table comment
type Author struct {...}

type TestView struct {...}

    There is no comment on structure TestView in models.go.

  9. kyleconroy commented on Apr 28, 2023

    @kyleconroy
    kyleconroy
    on Apr 28, 2023
    Collaborator

    Indeed there isn't!

  10. kyleconroy
    reopened this on Apr 28, 2023
  11. kyleconroy
    changed the title [-]Use comment on view[/-] [+]Add COMMENT ON support for views[/+] on Apr 28, 2023
  12. kyleconroy
    added
    📚 postgresql
    on Apr 28, 2023
  13. orisano
    added a commit that references this issue on May 2, 2023

    feat: add supporting COMMENT ON VIEW

    c97e9a9
  14. kyleconroy
    closed this as completedin #2249on Jun 6, 2023
  15. kyleconroy
    added a commit that references this issue on Jun 6, 2023

    feat: add supporting COMMENT ON VIEW (#2249)

    fcfa8a4
  16. alfonsodev
    added a commit that references this issue on Oct 13, 2025

    feat: add supporting COMMENT ON VIEW (sqlc-dev#2249)

    dbc2133
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    📚 postgresqlenhancementNew feature or requestquestionFurther information is requested

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions