Seth Woolley's Man Viewer

clusterdb(1) - clusterdb - cluster a PostgreSQL database - man 1 clusterdb

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

CLUSTERDB(1)            PostgreSQL Client Applications            CLUSTERDB(1)



NAME
       clusterdb - cluster a PostgreSQL database


SYNOPSIS
       clusterdb [ connection-option... ] [ --table | -t table  ] [ dbname ]

       clusterdb [ connection-option... ] [ --all | -a ]

DESCRIPTION
       clusterdb  is  a  utility for reclustering tables in(1,8) a PostgreSQL data-
       base. 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(2,n,1 builtins) from the environment variable PGDATABASE. If that is not
              set(7,n,1 builtins), 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 a response.

       -t table

       --table table
              Cluster table only.


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

       -h host(1,5)

       --host host(1,5)
              Specifies  the  host(1,5)  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(2,7,n) file(1,n) exten-
              sion on which the server is listening for connections.

       -U username

       --username username
              User name to connect as.

       -W

       --password
              Force password prompt.


ENVIRONMENT
       PGDATABASE

       PGHOST

       PGPORT

       PGUSER Default connection parameters

DIAGNOSTICS
       In case of difficulty, see CLUSTER [cluster(7)] and psql(1) for discus-
       sions  of  potential  problems and error(8,n) messages.  The database server
       must be running at the targeted host. Also, any default connection set-
       tings  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(1,8) a database named(5,8) xyzzy:

       $ clusterdb --table foo xyzzy


SEE ALSO
       CLUSTER [cluster(7)]




Application                       2003-11-02                      CLUSTERDB(1)

References for this manual (incoming links)