Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

sql: implement database object comments #26617

Closed
knz opened this issue Jun 12, 2018 · 3 comments
Closed

sql: implement database object comments #26617

knz opened this issue Jun 12, 2018 · 3 comments
Labels
A-schema-descriptors Relating to SQL table/db descriptor handling. A-sql-pgcompat Semantic compatibility with PostgreSQL C-enhancement Solution expected to add code/behavior + preserve backward-compat (pg compat issues are exception)

Comments

@knz
Copy link
Contributor

knz commented Jun 12, 2018

PostgreSQL supports adding descriptive comments on arbitrary database objects: https://www.postgresql.org/docs/10/static/sql-comment.html

This is commonly used in UI tools to show a descriptive message to the user about the purpose of a table, column, etc.

Besides compatibility with pg, adding this feature to CockroachDB would enable us to produce contextual help for the various virtual tables in crdb_internal.

/cc @tschottdorf
@knz knz added C-enhancement Solution expected to add code/behavior + preserve backward-compat (pg compat issues are exception) A-sql-pgcompat Semantic compatibility with PostgreSQL A-schema-descriptors Relating to SQL table/db descriptor handling. labels Jun 12, 2018
@BramGruneir BramGruneir mentioned this issue Jun 12, 2018
Open
@knz knz added this to the 2.1 milestone Jul 23, 2018
@knz knz modified the milestones: 2.1, 2.2 Aug 30, 2018
@BramGruneir
Copy link
Member

Are comments actually used? I've never seen them in production deployments.

This seems like a nice to have, but I don't think it should be prioritized over stability, performance, compatibility or even new features.
Furthermore, it would have to be supported by the Admin UI team as well.

@knz
Copy link
Contributor Author

knz commented Sep 12, 2018

Actually yes 1) they are used 2) we have internal demand. So I would like to push this to the roadmap for 2.2.

@petermattis petermattis removed this from the 2.2 milestone Oct 5, 2018
@jordanlewis
Copy link
Member

Thanks to @hueypark for taking care of this one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-schema-descriptors Relating to SQL table/db descriptor handling. A-sql-pgcompat Semantic compatibility with PostgreSQL C-enhancement Solution expected to add code/behavior + preserve backward-compat (pg compat issues are exception)
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@jordanlewis @knz @BramGruneir @petermattis