clusterdb1Applicationclusterdbcluster a PostgreSQL databaseclusterdbconnection-options--table | -t tabledbnameclusterdbconnection-options--all-aDescriptionclusterdb 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 shell script wrapper around the
backend command
via
the PostgreSQL interactive terminal
. 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 environment variables available to psql
and the libpq front-end library do apply.
Optionsclusterdb accepts the following command-line arguments:
Cluster all databases.
Specifies the name of the database to be clustered.
If this is not specified and (or
) 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 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.
DiagnosticsCLUSTER
Everything went well.
clusterdb: Cluster failed.
Something went wrong. clusterdb is only a wrapper
script. See
and for a detailed
discussion of error messages and potential problems.
EnvironmentPGDATABASEPGHOSTPGPORTPGUSER
Default connection parameters.
Examples
To cluster the database test:
$ clusterdb test
To cluster a single table
foo in a database named
xyzzy:
$ clusterdb --table foo xyzzySee Also