clusterdb1Applicationclusterdbcluster a PostgreSQL databaseclusterdbconnection-options--table | -t 'tabledbnameclusterdbconnection-options--all-aDescriptionclusterdb is a utility for clustering tables inside a
PostgreSQL database.
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.
clusterdb will need to connect several times to the
PostgreSQL server, asking for the password each
time. It will probably be very convenient to have a PGPASSWORDFILE in that case.
Optionsclusterdb accepts the following command line arguments:
-d dbname--dbname dbname
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.
-a--all
Cluster all databases.
-t table--table table
Clusters table only.
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 host begins with a slash, it is used
as the directory for the Unix domain socket.
-p port--port port
Specifies the Internet TCP/IP 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--password
Force password prompt.
-e--echo
Echo the commands that clusterdb generates
and sends to the server.
-q--quiet
Do not display a response.
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. Note that this message
may appear once per table to be clustered.
EnvironmentPGDATABASEPGHOSTPGPORTPGUSER
Default connection parameters.
Examples
To cluster the database test:
$ clusterdb test
To cluster a single table
foo in a database named
xyzzy:
$ clusterdb --verbose --table foo xyzzySee Also