|Linux & Unix Commands - Search Man Pages
CLUSTERDB(1) PostgreSQL Client Applications CLUSTERDB(1)
clusterdb - cluster a PostgreSQL database
clusterdb [ connection-options... ] [ --table | -t table ] [ dbname ]
clusterdb [ connection-options... ] [ --all | -a ]
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 touched.
clusterdb is a shell script wrapper around the backend command CLUSTER [cluster(7)] via
the PostgreSQL interactive terminal psql(1). There is no effective difference between
clustering databases via this or other methods. psql must be found by the script and a
database server must be running at the targeted host. Also, any default settings and envi-
ronment variables available to psql and the libpq front-end library do apply.
clusterdb might need to connect several times to the PostgreSQL server, asking for a pass-
word each time. It is convenient to have a $HOME/.pgpass file in such cases.
clusterdb accepts the following command-line arguments:
--all Cluster all databases.
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.
--echo Echo the commands that clusterdb generates and sends to the server.
Do not display a response.
Clusters table only.
clusterdb also accepts the following command-line arguments for connection parameters:
Specifies the host name of the machine on which the server is running. If host
begins with a slash, it is used as the directory for the Unix domain socket.
Specifies the Internet TCP/IP port or local Unix domain socket file extension on
which the server is listening for connections.
User name to connect as
Force password prompt.
Everything went well.
clusterdb: Cluster failed.
Something went wrong. clusterdb is only a wrapper script. See CLUSTER [cluster(7)]
and psql(1) for a detailed discussion of error messages and potential problems.
Note that this message may appear once per table to be clustered.
PGUSER Default connection parameters.
To cluster the database test:
$ clusterdb test
To cluster a single table foo in a database named xyzzy:
$ clusterdb --table foo xyzzy
Application 2002-11-22 CLUSTERDB(1)
All times are GMT -4. The time now is 05:03 AM.