## Name

gfdump.postgresql — Gfarmメタデータのダンプ/リストア

## Synopsis

`gfdump.postgresql` -d [`オプション`]

`gfdump.postgresql` -r [`オプション`]

## DESCRIPTION

gfdump.postgresqlは、 バックエンドDBとして動作しているPostgreSQLにより管理された、 Gfarmのメタデータをダンプ、またはリストアすることができます。 このコマンドを実行する場合は、 バックエンドDBであるPostgreSQLが起動しているホスト上でなければいけません。 このコマンドは、実行時にバックエンドDBのアクセス情報を取得するため、 gfmdの設定ファイル `gfmd.conf`を読み込みます。 gfmdがプライベートモードではない状態で 設定された場合、このファイルを読み込むためには、ルート権限が必要となります。

gfdump.postgresqlが `-d`オプション付きで実行された際は、 カレントディレクトリにdb.outファイルを作成し、 データベースをそのファイルにダンプします。

gfdump.postgresqlが `-r`オプション付きで実行された際は、 カレントディレクトリに置かれた`db.out`から データベースをリストアします。 さらに具体的な説明を下記に示します。

1. gfmdが起動している場合は停止します。

2. データベースを削除します。

3. データベースを作成します。

4. ダンプファイルからデータベースをリストアします。

5. gfmdのジャーナルファイルが存在している 場合は、そのファイルを削除します。

6. gfmdを起動します。

## OPTIONS

`--prefix` `パス`

  このオプションを付与した場合、 gfdump.postgresqlは、 gfmdの設定ファイル `PREFIX/etc/gfmd.conf`を読み込みます。 デフォルトでは、`%%SYSCONFDIR%%/etc/gfmd.conf` が読み込まれます。

`-P` `インストール先のディレクトリ`

  バックエンドDBに対するインストール先のディレクトリ (例えば、/usr/local)を指定することができます。 gfdump.postgresqlが pg_dumpといったPostgreSQLコマンドを 実行する際は、指定したディレクトリの下にこのコマンドが インストールされていることを前提としています。 このオプションを省略した場合、 gfdump.postgresqlは、 環境変数`PATH`のリストからそのコマンドへのディレクトリ を探し出します。

`-l`

  バックエンドDBがGfarmのメタデータを記録したファイルを置く ディレクトリへのパスを指定することができます。

  バックエンドDBがPostgreSQLである場合、 そのディレクトリは一般にPGDATAと呼ばれています。 デフォルトでは、 `PREFIX/var/gfarm-pgsql`が設定されており、 このPREFIXは`--prefix`オプションで与えられた値となります。

`-f` `ダンプファイル`

  ダンプファイルの名前を指定することができます。 デフォルトでは、カレントディレクトリパスに ファイル名`db.out`を加えた値が設定されます。

`--help`

  このコマンドの使用法を表示して、終了します。

`-t`

  このオプションを付与した場合、 人間が読みやすい形式で全ての設定パラメータの値を表示した後、 すぐに終了します。

`-d`

  このオプションを付与した場合、 ダンプモードで起動します。

`-n`

  このオプションを付与した場合、 gfmdを起動/停止しません。

`-r`

  このオプションを付与した場合、 リストアモードで起動します。

## FILES

`%%SYSCONFDIR%%/gfmd.conf`

  gfmdが参照する設定ファイル

## SEE ALSO

pg_dump(1), dropdb(1), createdb(1), psql(1), gfmd(8)