VACUUMDB(1)

NAME
vacuumdb - PostgreSQL データベースの不要領域の回収と解析

SYNOPSIS

vacuumdb [ connection-options... ] [ [ --full ] [ -f ] ] [ [ --verbose ] [ -v ] ] [ [ --analyze ] [ -z ] ] [ --table | -t 'table
 [ ( column [,...] ) ] ' ] [ dbname ] vacuumdb [ connection-options... ] [ [ --all ] [ -a ] ] [ [ --full ] [ -f ] ] [ [ --verbose ] [ -v ] ] [ [ --analyze ] [ -z ] ]

説明

vacuumdb は、PostgreSQL データベースの不要領域の掃除 (クリーニング) を行うユーティリティです。 また、vacuumdb は PostgreSQL 問い合わせオプティマイザで使用される内部的な統計情報も生成します。

vacuumdb は、PostgreSQL の対話的ターミナル psql(1) 経由で実行されるバックエンドコマンド VACUUM [vacuum(l)] のシェルスクリプトラッパーです。これ以外の方法でデータベースの掃除を行っても特別な違いはありません。 スクリプトから psql を参照することができ、かつデータベースサーバが指定したホストで稼働している必要があります。また、psql と libpq のフロントエンドライブラリの、あらゆるデフォルトの設定や環境変数が適応されます。

vacuumdb は、PostgreSQL に何度も接続しなければならない場合があり、その度にパスワードが必要になります。 そのような場合には $HOME/.pgpass ファイルを用意しておくと便利です。

オプション

vacuumdb では、下記のコマンドライン引数を指定できます。

[-d] dbname

[--dbname] dbname
    不要領域の掃除または解析の対象となるデータベース名を指定します。 データベース名が指定されておらず、-a (または --all) も使用されていない場合、データベース名は環境変数 PGDATABASE から読み取られます。 この変数も設定されていない場合は、接続のために指定されたユーザ名が使用されます。

-a

--all
    すべてのデータベースをバキュームします。

-e

--echo
    vacuumdb が生成し、サーバに送るコマンドをエコー表示します。

-f

--full
    ``完全な (full)'' バキュームを行ないます。

-q

--quiet
    返答を表示させないようにします。

-t table [ (column [,...]) ]

--table table [ (column [,...]) ]
    table のみの掃除または解析を行ないます。列名は --analyze オプションがある場合にのみ設定できます。

    Tip: バキュームする列を指定する場合は、シェルから括弧をエスケープさせる必要があるでしょう。

-v

--verbose
    処理実行中に詳細な情報を表示します。

-z

--analyze
    オプティマイザで使用される、データベースの統計情報を計算します。

vacuumdb には、以下に記す接続パラメータ用のコマンドライン引数も指定することもできます。

-h host

--host host
    サーバが稼働しているマシンのホスト名を指定します。ホスト名がスラッシュから始まる場合、Unix ドメインソケット用のディレクトリとして使用されます。

-p port

--port port
    サーバが接続を監視するインターネット TCP/IP ポートもしくは Unix ドメインソケットファイルの拡張子を指定します。

-U username

--username username
    接続するためのユーザ名を指定します。

-W

--password
    強制的にパスワードのプロンプトを表示します。

診断

VACUUM
    すべて正常に終了しました。

vacuumdb: Vacuum failed.
    異常が発生しました。 vacuumdb は単にラッパースクリプトです。エラーメッセージ、および考えられる問題についての詳細情報については VACUUM [vacuum(l)] と psql(1) を参照して下さい。

環境

PGDATABASE

PGHOST

PGPORT

PGUSER
    デフォルトの接続パラメータです。

例

test というデータベースを掃除するには、下記のコマンドを実行します。

$ vacuumdb test

bigdb という名前のデータベースの掃除とオブティマイザ用の解析を行なう場合には、下記のコマンドを実行します。

$ vacuumdb --analyze bigdb

xyzzy という名前のデータベースの foo という 1 つのテーブルだけの掃除と、そのテーブルの bar という 1 つの列にだけ対してオブティマイザ用の解析を行なう場合には、下記のコマンドを実行します。

$ vacuumdb --analyze --verbose --table 'foo(bar)' xyzzy

関連項目
VACUUM [vacuum(l)]