PolarDB:pg_dump

パラメーター

説明

connection-option

データベース接続パラメーターを制御するコマンドラインオプション。 詳細については、「接続オプション」をご参照ください。

option

出力内容とフォーマットを制御するコマンドラインオプション。 詳細については、「ダンプオプション」をご参照ください。

dbname

バックアップするデータベースの名前。

コマンドラインオプション

説明

-d dbname または --dbname=dbname

接続するデータベースの名前を指定します。

-h host または --host=host

サーバーが実行されているマシンのホスト名を指定します。 この値がスラッシュで始まる場合、UNIX ドメインソケットのディレクトリとして使用されます。 デフォルト値は PGHOST 環境変数です。

-p port または --port=port

サーバーが接続をリッスンする TCP ポート、またはローカル UNIX ドメインソケットのファイル拡張子を指定します。デフォルト値は PGPORT 環境変数から取得され、この変数が設定されていない場合はコンパイル時に組み込まれたデフォルトが使用されます。

-U username または --username=username

接続に使用するユーザー名。

-w は --no-password のエイリアスです

パスワードのプロンプトを一切表示しません。

-W は --password の短縮形です。

pg_dump がデータベースに接続する前にパスワードの入力を強制的に要求します。

--role=rolename

バックアップの作成に使用するロール名を指定します。

コマンドラインオプション

説明

dbname

バックアップするデータベースの名前。 指定しない場合は、PGDATABASE 環境変数が使用されます。

-a は --data-only のエイリアスです

スキーマ (データ定義) ではなく、データのみをバックアップします。

-b は --blobs のエイリアスです

BLOB はデフォルトでバックアップに含まれます。 --schema、--table、または --schema-only オプションが指定されている場合、BLOB はバックアップに含まれません。

-B は --no-blobs のエイリアスです

バックアップからBLOBを除外します。

-c は --clean のエイリアスです

データベースオブジェクトを作成するコマンドを実行する前に、そのオブジェクトを削除します。 データベースを復元するときのエラーメッセージを回避するために、--if-exists を指定することを推奨します。

-C または --create

データベースを作成し、新しく作成されたデータベースに再接続します。 --clean が指定されている場合、スクリプトはターゲットデータベースを削除して再作成し、そのデータベースに再接続します。

--create オプションが指定され、--no-acl オプションが指定されていない場合、バックアップデータにはデータベースのコメント、設定情報、およびアクセス権限が含まれます。

-E encoding または --encoding=encoding

指定された文字エンコーディングを使用してバックアップを作成します。 デフォルトでは、バックアップはバックアップ対象のデータベースの文字エンコーディングを使用して作成されます。 PGCLIENTENCODING 環境変数の値を目的のバックアップエンコーディングに設定することもできます。

-F format または --format=format

出力のフォーマットを指定します。 フォーマットは次のいずれかです。

• p または plain：スクリプトファイルを出力します (デフォルト)。

• c、custom：pg_restore で使用できるカスタムフォーマットのアーカイブファイルを出力します。 デフォルトでは、このフォーマットのアーカイブファイルは圧縮されます。

• d (directory)：pg_restore で使用できるディレクトリフォーマットのアーカイブファイルを出力します。 デフォルトでは、このフォーマットのアーカイブファイルは圧縮され、並列バックアップをサポートします。

• t または tar：pg_restore で使用できる tar フォーマットのアーカイブファイルを出力します。 tar フォーマットは圧縮をサポートしていません。 さらに、tar フォーマットを使用する場合、復元中にテーブルデータ項目の相対的な順序を変更することはできません。

-f file または --file=file

指定されたファイルに出力を送信します。

• ディレクトリフォーマットの場合、このパラメーターは必須であり、ファイルではなくターゲットディレクトリを指定します。

• 他のファイルベースのフォーマットの場合、このパラメーターを省略すると、出力は標準出力に送信されます。

-j njobs または --jobs=njobs

このオプションは、njobs 個のテーブルを同時にバックアップすることで、バックアップ処理を並列実行します。このオプションはディレクトリフォーマットと併用する必要があります。

-n pattern は --schema=pattern の短縮形です。

pattern に一致するスキーマのみをバックアップします。 このオプションが指定されていない場合、ターゲットデータベース内のすべての非システムスキーマがバックアップされます。

-N pattern は --exclude-schema=pattern のエイリアスです

pattern 以外のスキーマをバックアップします。

-o または --oids

すべてのテーブルのデータの一部としてオブジェクト識別子 (OID) をバックアップします。 アプリケーションが OID 列を参照する場合 (たとえば、外部キー制約内など) は、このオプションを使用します。 それ以外の場合は、このオプションを使用しないでください。

-O は --no-owner の短縮形です

元のデータベースと一致するようにオブジェクトの所有権を設定するコマンドは含まれません。

-s は --schema-only の短縮形です

データではなく、オブジェクト定義 (スキーマ) のみをバックアップします。

-S username は --superuser=username と同じです

トリガーを無効にするときに使用されるスーパーユーザーのユーザー名。 このオプションは --disable-triggers と併用する場合にのみ有効です。

-t pattern、または --table=pattern

pattern に一致するテーブルのみをバックアップします。 -t オプションを複数回指定するか、パターンにワイルドカードを使用することで、複数のテーブルを選択できます。

-T pattern は --exclude-table=pattern のエイリアスです

pattern に一致するテーブルをバックアップしません。 -T オプションを複数回指定して、複数のパターンに一致するテーブルを除外できます。

-v または --verbose

冗長モードを指定します。

-V は --version のエイリアスです

pg_dump のバージョンを表示して終了します。

-x は --no-privileges または --no-acl のエイリアスです

アクセス権限 (grant/revoke コマンド) のバックアップは含めません。

-Z 0..9 は --compress=0..9 と同じです

使用する圧縮レベルを指定します。 値 0 は圧縮なしを意味します。

--column-inserts および --attribute-inserts

明示的な列名を持つ INSERT コマンドとしてデータをバックアップします。

INSERT INTO table (column, ...) VALUES ...

--disable-dollar-quoting

関数本体でのドル引用符の使用を無効にします。

--disable-triggers

ターゲットテーブルのトリガーを一時的に無効にします。 このオプションは、データバックアップを作成する場合にのみ有効です。 このオプションを使用する場合は、-S を使用してスーパーユーザーを指定する必要があります。

--enable-row-security

アクセス権限のあるテーブルの行のみをバックアップします。 このオプションは、行単位セキュリティーが有効になっているテーブルのデータをバックアップする場合にのみ有効です。

--exclude-table-data=pattern

pattern に一致するテーブルのデータをバックアップしません。 --exclude-table-data を複数回指定して、複数のパターンに一致するテーブルを除外できます。

--if-exists

IF EXISTS 句を追加するなど、条件付きコマンドを使用してデータベースオブジェクトをクリーンアップします。 --clean オプションも指定する必要があります。そうしないと、このオプションは効果がありません。

--inserts

データを INSERT コマンドとしてバックアップします。

--load-via-partition-root

COPY または INSERT コマンドを使用して、テーブルパーティションからデータをバックアップします。

--lock-wait-timeout=timeout

共有ロックを取得するための待機時間を指定します。

--no-comments

コメントをバックアップしません。

--no-publications

パブリケーションをバックアップしません。

--no-security-labels

セキュリティラベルをバックアップしません。

--no-subscriptions

サブスクリプションをバックアップしません。

--no-sync

すべてのファイルをディスクに安全に書き込むのを待たずに処理を返します。

--no-synchronized-snapshots

サーバー上で pg_dump -j を実行できることを示します。

--no-tablespaces

デフォルトのテーブル空間にすべてのオブジェクトを作成します。

--no-unlogged-table-data

ログに記録されないテーブルのデータをバックアップしません。

--quote-all-identifiers

すべての識別子を強制的にクォートします。

--rows-per-insert=nrows

データベースバックアップ内の INSERT ステートメントあたりの最大行数を制御します。

--section=sectionname

指定されたセクションのみがバックアップされるように指定します。 セクションの名前は pre-data、data、または post-data です。 このオプションを複数回指定して、複数のセクションを選択できます。 デフォルトでは、すべてのセクションがバックアップされます。

--serializable-deferrable

バックアップにシリアライザブルトランザクションを使用します。

--snapshot=snapshotname

データベースをバックアップする際に、指定された同期スナップショットを使用します。

--strict-names

各スキーマ (-n または --schema) およびテーブル (-t または --table) パターンが、ソースデータベース内の少なくとも 1 つのスキーマまたはテーブルに一致する必要があります。

--use-set-session-authorization

ALTER OWNER コマンドの代わりに、SQL 標準の SET SESSION AUTHORIZATION コマンドを出力します。

-? または --help

pg_dump のコマンドライン引数に関するヘルプを表示して終了します。