postgresql_autodoc(1) [debian man page]

POSTGRESQL_AUTODOC(1)					      General Commands Manual					     POSTGRESQL_AUTODOC(1)

NAME

       postgresql_autodoc - creates postgresql tables overview

SYNOPSIS

       postgresql_autodoc [options]

DESCRIPTION

       This is a utility which will run through PostgreSQL system tables and returns HTML, DOT, and 2 styles of XML which describes the database.

       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.

OPTIONS

       -d <dbname>
	      Specify database name to connect to (default: $database)

       -f <file>
	      Specify output file prefix (default: $database)

       -h <host>
	      Specify database server host (default: localhost)

       -p <port>
	      Specify database server port (default: 5432)

       -u <username>
	      Specify database username (default: $dbuser)

       --password=<pw>
	      Specify database password (default: blank)

       -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.

       --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.)  This is disk intensive on large databases as all pages must be visited.

AUTHOR

       Rod Taylor <autodoc@rbt.ca>

								    21/01/2005						     POSTGRESQL_AUTODOC(1)

CLUSTERDB(1)						  PostgreSQL Client Applications					      CLUSTERDB(1)

NAME

       clusterdb - cluster a PostgreSQL database

SYNOPSIS

       clusterdb [ connection-option... ]  [  [ --verbose ]  [ -v ]  ]	[ --table | -t table  ]  [ dbname ]

       clusterdb [ connection-option... ]  [  [ --all ]  [ -a ]  ]  [  [ --verbose ]  [ -v ]  ]

DESCRIPTION

       clusterdb  is a utility for reclustering tables in a PostgreSQL database. It finds tables that have previously been clustered, and clusters
       them again on the same index that was last used. Tables that have never been clustered are not affected.

       clusterdb is a wrapper around the SQL command CLUSTER [cluster(7)].  There is no effective difference between clustering databases via this
       utility and via other methods for accessing the server.

OPTIONS

       clusterdb accepts the following command-line arguments:

       -a

       --all  Cluster all databases.

       [-d] dbname

       [--dbname] dbname
	      Specifies  the  name  of the database to be clustered.  If this is not specified and -a (or --all) is not used, the database name is
	      read from the environment variable PGDATABASE. If that is not set, the user name specified for the connection is used.

       -e

       --echo Echo the commands that clusterdb generates and sends to the server.

       -q

       --quiet
	      Do not display progress messages.

       -t table

       --table table
	      Cluster table only.

       -v

       --verbose
	      Print detailed information during processing.

       clusterdb also accepts the following command-line arguments for connection parameters:

       -h host

       --host host
	      Specifies the host name of the machine on which the server is running. If the value begins with a slash, it is used as the directory
	      for the Unix domain socket.

       -p port

       --port port
	      Specifies the TCP port or local Unix domain socket file extension on which the server is listening for connections.

       -U username

       --username username
	      User name to connect as.

       -w

       --no-password
	      Never issue a password prompt. If the server requires password authentication and a password is not available by other means such as
	      a .pgpass file, the connection attempt will fail. This option can be useful in batch jobs and scripts where no user  is  present	to
	      enter a password.

       -W

       --password
	      Force clusterdb to prompt for a password before connecting to a database.

	      This  option is never essential, since clusterdb will automatically prompt for a password if the server demands password authentica-
	      tion.  However, clusterdb will waste a connection attempt finding out that the server wants a password.  In some cases it  is  worth
	      typing -W to avoid the extra connection attempt.

ENVIRONMENT

       PGDATABASE

       PGHOST

       PGPORT

       PGUSER Default connection parameters

       This utility, like most other PostgreSQL utilities, also uses the environment variables supported by libpq (see in the documentation).

DIAGNOSTICS

       In  case of difficulty, see CLUSTER [cluster(7)] and psql(1) for discussions of potential problems and error messages.  The database server
       must be running at the targeted host. Also, any default connection settings and environment variables used by the libpq	front-end  library
       will apply.

EXAMPLES

       To cluster the database test:

       $ clusterdb test

       To cluster a single table foo in a database named xyzzy:

       $ clusterdb --table foo xyzzy

SEE ALSO

       CLUSTER [cluster(7)]

Application							    2010-05-14							      CLUSTERDB(1)