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.

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

Document the system database #10340

Closed
ericharmeling opened this issue Apr 15, 2021 · 1 comment
Closed

Document the system database #10340

ericharmeling opened this issue Apr 15, 2021 · 1 comment
Assignees
Labels
C-doc-improvement P-2 Normal priority; secondary task T-missing-info

Comments

@ericharmeling
Copy link
Contributor

ericharmeling commented Apr 15, 2021

Eric Harmeling (ericharmeling) commented:

We currently don't document the system database very well.

AFAICT, the only place we explicitly define the system database in our docs is on the SHOW DATABASES page. This is insufficient, especially if a simple SHOW statement surfaces the table.

The naming conventions for our preloaded schemas/databases (especially for the system database and the crdb_internal virtual schema) are misleading, which could add to the confusion around the purpose and contents of the system database.

We should do the following:

  • Define the system database in a dedicated section on preloaded databases. This would fit nicely under a new "Preloaded databases" section on the Name Resolution page.
  • Make a note on the System Catalogs page that the best way to query system metadata is through our system catalog tables and views, and not through the system database.

We should not do the following:

  • Define each table in the system database.
  • Create any new examples that query the system database.

Jira Issue: DOC-1102

@ericharmeling
Copy link
Contributor Author

@sheaffej

@ericharmeling ericharmeling added P-2 Normal priority; secondary task and removed P-1 High priority; must be done this release labels Aug 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-doc-improvement P-2 Normal priority; secondary task T-missing-info
Projects
None yet
Development

No branches or pull requests

5 participants