POSTGRESQL_AUTODOC(1)

📦
version 1.41+20200921 · 2 versions
  • 1.41+20200921 · debian bookworm, debian trixie, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking (latest)
  • 1.41+20200921 · ubuntu jammy
, in debian bookworm, debian trixie, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 POSTGRESQL_AUTODOC 💖

okay bestie, gather round, because this is the postgresql_autodoc(1) page from the General Commands Manual and it's literally about to make your database look ✨documented✨. no cap.

🌸 NAME 🌸

postgresql_autodoc — creates postgresql tables overview

🦋 SYNOPSIS 🦋

postgresql_autodoc [options]

✨ DESCRIPTION ✨

so here's the vibe: this utility runs through your PostgreSQL system tables and hands you back HTML, DOT, and 2 styles of XML that describe the database. it's giving "your schema but make it readable". 💅

The HTML is human readable (via webbrowser). 🫶

The first style of XML is actually the fileformat of Dia, a UML diagram tool.

The second type of XML is similar to the HTML but in the Docbook 4 format. It enables yous to mix in other docbook documentation via the XREFs, generating PDFs, HTML, RTF, or other formatted documents. Between these tools and JavaDoc with the appropriate XREFs, documentation about a project can be generated quickly and be easily updatable yet have a very professional look with some DSSSL work. 😭 iconic behavior honestly.

💅 OPTIONS 💅

  • -d <dbname> — Specify database name to connect to (default: current user)
  • -f <file> — Specify output file prefix (default: current user)
  • -h <host> — Specify database server host (default: localhost)
  • -p <port> — Specify database server port (default: 5432)
  • -u <username> — Specify database username (default: current user)
  • --password=<pw> — Specify database password (default: blank)
    • If no password is specified, one is prompted for. 👀
  • -w — Use ~/.pgpass for authentication (overrides all other password options)
  • -l <path> — Path to the templates (default: /usr/share/postgresql-autodoc)
  • -t <output> — Type of output wanted (default: All in template library)
  • -s <schema> — Specify a specific schema to match. Technically this is a regular expression but anything other than a specific name may have unusual results. ⚠️
  • -m <regexp> — Show only tables/objects with names matching the specified regular expression.
  • --table=<args> — Tables to export. Multiple tables may be provided using a comma-separated list, i.e. table,table2,table3.
  • --statistics — In 7.4 and later, with the contrib module pgstattuple installed we can gather statistics on the tables in the database (average size, free space, disk space used, dead tuple counts, etc.)
🚨 bestie, heads up: --statistics is disk intensive on large databases because all pages must be visited. no shortcuts, the pages are getting read. plan accordingly. 💀

👑 AUTHOR 👑

Rod Taylor <autodoc@rbt.ca>

and that's the whole page, bestie. 🌈 this one's from the General Commands Manual, dated 19 July 2009 — yes it's old, and yes it still eats. 🎀 postgresql_autodoc(1) out. mwah. 💖✨🦋

📦 where this page comes from