1POSTGRESQL_AUTODOC(1)       General Commands Manual      POSTGRESQL_AUTODOC(1)
2
3
4

NAME

6       postgresql_autodoc - creates postgresql tables overview
7

SYNOPSIS

9       postgresql_autodoc [options]
10

DESCRIPTION

12       This  is  a utility which will run through PostgreSQL system tables and
13       returns HTML, DOT, and 2 styles of XML which describes the database.
14
15       The HTML is human readable (via webbrowser). The first style of XML  is
16       actually  the fileformat of Dia, a UML diagram tool. The second type of
17       XML is similar to the HTML but in the Docbook 4 format. It enables yous
18       to  mix  in other docbook documentation via the XREFs, generating PDFs,
19       HTML, RTF, or  other  formatted  documents.  Between  these  tools  and
20       JavaDoc  with  the appropriate XREFs, documentation about a project can
21       be generated quickly and be easily updatable yet have  a  very  profes‐
22       sional look with some DSSSL work.
23

OPTIONS

25       -d <dbname>
26              Specify database name to connect to (default: current user)
27
28       -f <file>
29              Specify output file prefix (default: current user)
30
31       -h <host>
32              Specify database server host (default: localhost)
33
34       -p <port>
35              Specify database server port (default: 5432)
36
37       -u <username>
38              Specify database username (default: current user)
39
40       --password=<pw>
41              Specify database password (default: blank)
42
43              If no password is specified, one is prompted for.
44
45       -l <path>
46              Path   to   the   templates   (default:   /usr/local/share/post‐
47              gresql_autodoc)
48
49       -t <output>
50              Type of output wanted (default: All in template library)
51
52       -s <schema>
53              Specify a specific schema to match. Technically this is a  regu‐
54              lar  expression but anything other than a specific name may have
55              unusual results.
56
57       -m <regexp>
58              Show only tables/objects with names matching the specified regu‐
59              lar expression.
60
61       --table=<args>
62              Tables to export. Multiple tables may be provided using a comma-
63              separated list, i.e. table,table2,table3.
64
65       --statistics
66              In 7.4 and later, with the contrib module pgstattuple  installed
67              we  can gather statistics on the tables in the database (average
68              size, free space, disk space  used,  dead  tuple  counts,  etc.)
69              This  is  disk intensive on large databases as all pages must be
70              visited.
71

AUTHOR

73       Rod Taylor <autodoc@rbt.ca>
74
75
76
77                                 19 July 2009            POSTGRESQL_AUTODOC(1)
Impressum