clusterdb
Name
clusterdb -- cluster a PostgreSQL database
Synopsis
clusterdb [_connection-option_...] [--verbose | -v] [ --table | -t _table_ ] ... [_dbname_]
clusterdb [_connection-option_...] [--verbose | -v] --all | -a
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. 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. Multiple tables can be clustered by writing multiple -t switches.
-v
--verbose
Print detailed information during processing.
-V
--version
Print the clusterdb version and exit.
-?
--help
Show help about clusterdb command line arguments, and exit.
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 authentication. 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.
--maintenance-db=``_dbname_
Specifies the name of the database to connect to discover what other databases should be clustered. If not specified, the postgres database will be used, and if that does not exist, template1 will be used.
Environment
PGDATABASE
PGHOST
PGPORT
PGUSER
Default connection parameters
This utility, like most other PostgreSQL utilities, also uses the environment variables supported by libpq (see Section 31.14).
Diagnostics
In case of difficulty, see CLUSTER and psql 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:
<samp class="literal">$</samp> <kbd class="literal">clusterdb test</kbd>
To cluster a single table foo in a database named xyzzy:
<samp class="literal">$</samp> <kbd class="literal">clusterdb --table foo xyzzy</kbd>