sql: provide table comments for virtual tables #32964
Labels
A-docs
A-sql-vtables
Virtual tables - pg_catalog, information_schema etc
C-enhancement
Solution expected to add code/behavior + preserve backward-compat (pg compat issues are exception)
E-easy
Easy issue to tackle, requires little or no CockroachDB experience
help wanted
Help is requested / needed by the one who filed the issue to fix it.
Comments
knz
added
help wanted
knz
added
the
C-enhancement
craig bot
pushed a commit
that referenced
this issue
Feb 8, 2019
33697: sql: make pg_catalog OIDs stable and refer to the descriptor IDs directly r=knz a=hueypark Fixes #32940 Fixes #32963 Fixes #34710 Enables #32964 This patch changes the definition of vtables to assign a unique table ID to every virtual table. Moreover, it also extends vtable descriptors to assign proper column IDs to virtual table columns. This aims to support the logical planning code, the table and plan caches, and simplify+fix the introspection tables. Incidentally it also makes it possible to use COMMENT ON on virtual tables and their columns too. The table IDs are picked descending from MaxUint32 although this may be refined in future PRs to accommodate the numbering of virtual schema descriptors. Incidentally `pg_catalog.pg_attribute` is fixed to properly use the column ID in column `attnum`, so that `attnum` remains stable across column drops. Release note (sql change): Virtual tables in `pg_catalog`, `information_schema` etc now support `COMMENT ON` like regular tables. Co-authored-by: Jaewan Park <jaewan.huey.park@gmail.com>
craig bot
pushed a commit
that referenced
this issue
Mar 9, 2019
34764: sql: provide table comments for virtual tables r=knz a=hueypark Fixes #32964 Fixes #35581 Release note (sql change): CockroachDB now provides usable comments with optional documentation URLs for the virtual tables in `pg_catalog`, `information_schema` and `crdb_internal`. Use `SHOW TABLES [FROM ...] WITH COMMENT` to read. Note that `crdb_internal` tables remain an experimental feature subject to change without notice. Co-authored-by: Jaewan Park <jaewan.huey.park@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
This is pursuant of #32442 towards #19472.
During interactive sessions or troubleshooting it would be convenient to be able to inspect the description of vtables, especially
crdb_internaltables which do not have public doc.The new support for COMMENT ON would enable this, supposing that comments are populated statically for all vtables.
This improvement requires completion of #32963 as prerequisite.
The text was updated successfully, but these errors were encountered: