clusterdb [connection-options...] [--table | -t table ] [dbname]
clusterdb [connection-options...] [--all | -a]
clusterdb は、PostgreSQL データベース内のテーブルを再クラスタ化するためのユーティリティです。 すでにクラスタ化されているテーブルを検索し、前回と同じインデックスを使用して再度クラスタ化します。 一度もクラスタ化されていないテーブルは処理されません。
clusterdb は、PostgreSQL の対話的ターミナル psql 経由で実行されるバックエンドコマンド CLUSTER のシェルスクリプトラッパーです。 これ以外の方法でデータベースのクラスタ化を行っても特別な違いはありません。このスクリプトから psql を呼び出すことができ、かつデータベースサーバがターゲットのホストで稼働している必要があります。また、psql と libpq のフロントエンドライブラリの、あらゆるデフォルトの設定や環境変数が適応されます。
clusterdb は、 PostgreSQL サーバに何度も接続しなければならない場合がありますが、その度にパスワードが要求されます。 そのような場合には $HOME/.pgpass ファイルを用意しておくと便利です。
clusterdb では、下記のコマンドライン引数を指定できます。
すべてのデータベースをクラスタ化します。
クラスタ化するデータベースの名前を指定します。 データベース名が指定されておらず、-a (または --all) も使用されていない場合、データベース名は環境変数 PGDATABASE から読み取られます。 この変数も設定されていない場合は、接続のために指定されたユーザ名が使用されます。
clusterdb が生成し、サーバに送るコマンドをエコー表示します。
返答を表示させないようにします。
table のみをクラスタ化します。
clusterdb は更に、下記のコマンドライン引数を接続パラメータとして受けつけます。
サーバが稼働しているマシンのホスト名を指定します。ホスト名がスラッシュから始まる場合、Unix ドメインソケット用のディレクトリとして使用されます。
サーバが接続を監視するインターネット TCP/IP ポートもしくは Unix ドメインソケットファイルの拡張子を指定します。
接続するためのユーザ名を指定します。
強制的にパスワードのプロンプトを表示します。