psqlのオプションの使い方とオプション一覧

psql を実行する時には接続に使用するロール名やデータベースを指定するオプション以外にもいくつかのオプションが用意されています。ここでは PostgreSQL にて psql を実行する時に指定できるオプションの使い方とオプションの一覧について解説します。

(Last modified: 2023年01月07日)

psqlオプションの使い方

コマンドプロンプトから psql を実行する時にはいくつかのオプションが用意されています。よく使用するのは PostgreSQL に接続する時に使用する -h や -U のオプションですが、例えば -V のように PostgreSQL のバージョンを表示してすぐに終了するものもあります。

また -? はオプションの一覧を表示するオプションです。(オプションの一覧はこのページの最後に掲載しています)。

また psql を使って PostgreSQL に接続したあとの表示方法に関するものもあります。例えば PostgreSQL に接続した後でデータベースの一覧を表示すると次のように表示されます。

オプションの一つである -H オプションを付けて psql を実行し PostgreSQL に接続すると、同じデータベースの一覧を取得すると HTML のテーブルタグを使って形式で出力されるようになります。

このように psql のオプションには色々な機能が用意されていますので、このあとのオプション一覧を一度確認しどんなことができるのかを確認されておくと便利に使うことができるのではないかと思います。

オプション一覧

オプションの一覧は次の通りです。

一般的なオプション:

オプション	説明
-c, --command=コマンド	単一の（SQLまたは内部）コマンドを一つだけ実行して終了
-d, --dbname=DB名	接続するデータベース名 (デフォルト: "xxxx")
-f, --file=FILENAME	ファイルからコマンドを読み込んで実行後、終了
-l(エル), --list	使用可能なデータベース一覧を表示して終了
-v, --set=, --variable=名前=値	psql 変数 '名前' に '値' をセット(例: -v ON_ERROR_STOP=1)
-V, --version	バージョン情報を表示して終了
-X, --no-psqlrc	初期化ファイル (~/.psqlrc) を読み込まない
-1 (数字の1), --single-transaction	(対話形式でない場合)単一のトランザクションとして実行
-?, --help[=options]	このヘルプを表示して終了
--help=commands	バックスラッシュコマンドの一覧を表示して終了
--help=variables	特殊変数の一覧を表示して終了

入出力オプション:

オプション	説明
-a, --echo-all	スクリプトから読み込んだ入力をすべて表示
-b, --echo-errors	失敗したコマンドを表示
-e, --echo-queries	サーバへ送信したコマンドを表示
-E, --echo-hidden	内部コマンドが生成した問い合わせを表示
-L, --log-file=FILENAME	セッションログをファイルに書き込む
-n, --no-readline	拡張コマンドライン編集機能(readline)を無効にする
-o, --output=FILENAME	問い合わせの結果をファイル (または |パイプ)に送る
-q, --quiet	静かに実行 (メッセージなしで、問い合わせの出力のみ)
-s, --single-step	シングルステップモード (各問い合わせごとに確認)
-S, --single-line	単一行モード (行末で SQL コマンドを終端)

出力フォーマットのオプション:

オプション	説明
-A, --no-align	桁揃えなしのテーブル出力モード
-F, --field-separator=文字列	桁揃えなし出力時のフィールド区切り文字(デフォルト: "|")
-H, --html	HTML テーブル出力モード
-P, --pset=変数[=値]	表示オプション '変数' を '値' にセット(\pset コマンドを参照)
-R, --record-separator=文字列	桁揃えなし出力におけるレコード区切り文字(デフォルト: 改行)
-t, --tuples-only	行のみを表示
-T, --table-attr=TEXT	HTMLテーブルのタグ属性をセット (width, border等)
-x, --expanded	拡張テーブル出力に切り替える
-z, --field-separator-zero	桁揃えなし出力のフィールド区切りをバイト値の0に設定
-0, --record-separator-zero	桁揃えなし出力のレコード区切りをバイト値の0に設定
aaa	bbb

接続オプション:

オプション	説明
-h, --host=HOSTNAME	データベースサーバのホストまたはソケットのディレクトリ(デフォルト: "ローカルソケット")
-p, --port=PORT	データベースサーバのポート番号(デフォルト： "5432")
-U, --username=USERNAME	データベースのユーザ名 (デフォルト: "xxxx")
-w, --no-password	パスワード入力を要求しない
-W, --password	パスワードプロンプトの強制表示(本来は自動的に表示)

-- --

psql のオプションの使い方とオプションの一覧について解説しました。