index.md 1.19 KB

6. Auto-Catalog

Machine-generated, exhaustive reference for every database object in the deployed schema.

This chapter is regenerated by scripts/gen_catalog.py, which queries the live database directly through ~/.my.cnf. Do not hand-edit pages under this chapter — they will be overwritten on the next regeneration. Hand-written narrative belongs in Reference or Vertical Slices, with cross-links from here.

  • Tables — every base table.
  • Views — every view, with its CREATE VIEW body.
  • Procedures — every stored procedure, with its parameter list.
  • Functions — every stored function, with its parameter list and return type.

Each entry includes name, comment, columns / parameters, indexes (for tables), the CREATE VIEW body (for views), and a narrative slot for any human-written prose that covers it.

To regenerate: python scripts/gen_catalog.py. The script reads connection parameters from ~/.my.cnf and the schema name from the same file's database = ... entry; override either via the DB_DEFAULTS_FILE or DB_NAME environment variables.