psql

現在のテーブルの出力形式が「揃えない」になっていれば、「揃える」に切り替えます。「揃えない」でない場合は、「揃えない」に設定します。このコマンドは下位互換性のためにあります。一般的な解決策は \pset を参照して下さい。

現在の作業ディレクトリを directory に変更します。引数がない場合は、現在のユーザのホームディレクトリに変更します。

問い合わせ結果として表示される全てのテーブルタイトルの設定、または、タイトルの設定の解除を行ないます。このコマンドは、\pset title title と同じです。(このコマンドの名前は "caption" に由来し、以前は HTML のテーブルの標題 (caption) を設定するためだけに使われていました。)

新しいデータベースへの接続または、指定ユーザ名での接続を行ないます。それまでの接続は閉じられます。dbname が - の場合、現在のデータベース名が使われます。

username が省略された場合、現在のユーザ名が使用されます。

特別な規則として、引数がない \connect の場合は、デフォルトのデータベースにデフォルトのユーザで接続します (何も引数なしで psql を起動した場合と同じことになります)。

接続の試行が (ユーザ名の間違いやアクセスが拒否された場合などの理由で) 失敗した場合、psql が対話式モードである場合に限って、それまでの接続が保持されます。非対話式スクリプトを実行している場合は、処理はエラーとなり、即座に停止します。この違いは、片方は入力ミスに対するユーザの簡便性を、もう片方は、スクリプトが間違ったデータベースを操作してしまう事故を防ぐ安全な機構を考慮して実装されています。

フロントエンド (クライアント) コピーを行ないます。 これは SQL COPY コマンドを実行する操作ですが、バックエンドで指定のファイルに対する読み込みまたは書き込みを行うのではなく、psql がこれを行い、バックエンドとローカルファイルシステム間でデータを送ります。 つまり、ファイルへのアクセス権限はサーバではなくローカルユーザのものを使用するので、SQL のスーパーユーザ権限は必要ありません。

このコマンドの構文は SQL COPY コマンドに似ています (詳細はその説明を参照して下さい)。このため、\copy コマンドには特別な解析ルールが適用されていることに注意して下さい。特に、変数の置換規則やバックスラッシュエスケープは適用されません。

PostgreSQL の著作権および配布条項を表示します。

pattern に一致する各リレーションについて、すべての列、それらの型、そして NOT NULL やデフォルトなどの特別な属性を表示します。 ビューリレーションの場合は、ビューの定義に従い、関連付けられているインデックス、制約、ルールおよびトリガも表示されます。 ("パターンのマッチング" は下記で説明します。)

\d+ という形のコマンドも同じですが、テーブルの列に関連付けられた全てのコメントも表示されます。

利用できる全ての集約関数と、その操作対象となるデータ型の一覧を表示します。pattern (正規表現) が指定された場合、一致する集約のみが表示されます。

pattern に一致するオブジェクトの説明を表示します。引数が指定されていない場合は、可視的なオブジェクトすべての説明を表示します。 どちらの場合でも、説明があるオブジェクトのみがリストされます。 ("オブジェクト" には、集約、関数、演算子、型、リレーション (テーブル、ビュー、インデックス、シーケンス、ラージオブジェクト) が含まれます)。例を下記に示します。

=> \dd version
                     Object descriptions
   Schema   |  Name   |  Object  |        Description
------------+---------+----------+---------------------------
 pg_catalog | version | function | PostgreSQL version string
(1 row )

オブジェクトの説明は COMMENT ON SQL コマンドを使用して作成することができます。

使用可能なドメイン (派生型) をすべて表示します。 pattern が指定されている場合は、一致するドメインのみが表示されます。

利用できる全ての関数と、その引数と戻り値の型の一覧を表示します。 pattern が指定されている場合は、一致する関数のみが表示されます。\df+ という形で使われた場合、各関数の言語や説明を含む付加的情報も表示されます。

これは実際のコマンドの名前ではなく、i、s、t、v、S という文字はそれぞれ、インデックス、シーケンス、テーブル、ビュー、システムテーブルを意味します。 これらの文字のうち任意のものまたはすべてを、任意の順番で指定して、一致するすべてのオブジェクトの一覧を表示することができます。 文字 S を指定すると、システムオブジェクトのみが表示されます。 S を指定しなければ、システムオブジェクト以外のオブジェクトのみが表示されます。 コマンド名の後に "+" を付加すると、各オブジェクトに関連付けられている説明も (存在すれば) 表示されます。

pattern を指定すると、パターンに名前が一致するオブジェクトのみが表示されます。

これは \lo_list の別名で、ラージオブジェクトの一覧を表示します。

利用できる演算子と、その演算項目 (オペランド) と戻り値を一覧表示します。 pattern を指定すると、パターンに名前が一致する演算子のみが表示されます。

使用可能なすべてのテーブルを、関連付けられているアクセス権限とともに表示します。 pattern を指定すると、パターンに名前が一致するテーブルのみが表示されます。

GRANT コマンドと REVOKE コマンドは、アクセス権限の設定に使われます。 詳細については GRANT を参照して下さい。

全てのデータ型、または、pattern に一致する型のみを一覧表示します。 \dT+ という形式のコマンドは補足情報も表示します。

すべてのデータベースユーザ、もしくは、pattern に一致するユーザのみを一覧表示します。

filename が指定された場合、このファイルが編集されます。 エディタの終了後、その内容は問い合わせバッファにコピーされます。引数なしの場合、現在の問い合わせバッファは一時ファイルにコピーされ、そして同様に編集されます。

次に、新しい問い合わせバッファは、通常の psql のルールに従い、バッファ全体を 1 行として再解析されます。(このため、この方法では "スクリプト" を作成できません。この目的のためには \i を使用して下さい。) これはまた、問い合わせの終端がセミコロンである (もしくは問い合わせがセミコロンを含む) 場合、すぐに実行されることを意味しています。これ以外の場合は、単に問い合わせバッファ内に保持されるだけです。

引数をスペースで区切り、標準出力に出力し、改行します。スクリプトの出力に、情報を点在させる場合に有用です。例を下記に示します。

=> \echo `date`
Tue Oct 26 21:40:57 CEST 1999

最初の引数が引用符で括られていない -n である場合、最後の改行は出力されません。

マルチバイトエンコーディングを使用している場合、クライアント側のコーディングを設定します。引数なしの場合、このコマンドは現在のエンコーディング方式を表示します。

位置揃えされていない問い合わせの出力用のフィールドの区切り文字を設定します。デフォルトは、"|" ("パイプ" 記号) です。一般的な出力オプションの設定方法については、\pset を参照して下さい。

現在の問い合わせ入力バッファをバックエンドに送ります。 また、オプションでその出力を filename に保存したり、その出力を別の Unix シェルに渡し、command を実行したりすることもできます。単なる \g はセミコロンと実質的に同じです。引数がある \g は、\o コマンドの "一度限りの" 代替手段です。

指定した SQL コマンドの構文に関するヘルプを表示します。command が指定されていない場合は、psql は構文ヘルプが存在する全てのコマンドの一覧を表示します。 command をアスタリスク ("*") にすると、すべての SQL コマンドの構文ヘルプが表示されます。

HTML 問い合わせ出力形式を有効にします。既に HTML 形式が有効であった場合、デフォルトの位置揃えされたテキスト形式に戻します。このコマンドは互換性と簡便性のために存在します。 他の出力オプションについては、\pset を参照して下さい。

filename ファイルから入力を読みとり、キーボードから入力された場合と同じように実行します。

サーバ上のすべてのデータベースとその所有者の一覧を表示します。このコマンドに "+" を追加することで、そのデータベースに関する全ての説明も表示することができます。PostgreSQL のインストール時にマルチバイトコーディングをサポートするようにコンパイルしていた場合、各データベースのエンコード方式の名称も表示されます。

データベースから loid という OID を持つラージオブジェクトを読み取り、filename に書き出します。これは lo_export サーバ関数とは微妙に異なります。 こちらの関数はデータベースサーバを実行しているユーザ権限で、サーバ上のファイルシステムに対して動作します。

ファイルを PostgreSQL の "ラージオブジェクト" に保存します。オプションとして、指定したコメントをそのオブジェクトに関連づけます。下記に例を示します。

foo=> \lo_import '/home/peter/pictures/photo.xcf' 'a picture of me'
lo_import 152801

上の応答は、そのラージオブジェクトをオブジェクト ID 152801 として受け付けられたことを示します。 今後再びそのラージオブジェクトにアクセスしたい場合はこの番号を記憶しておかなければなりません。このため、全てのオブジェクトに人間がわかるようなコメントを常に関連づけることを推奨します。このコメントは \lo_list コマンドを使用して参照することができます。

このコマンドは、ローカルなユーザによってローカルなファイルシステムに対して動作しますが、サーバ側の lo_import は、サーバのユーザによりサーバ上のファイルシステムに対して動作します。 このため、このコマンドはサーバ側の lo_import とは微妙に異なります。

現在データベースに保存されている全ての PostgreSQL "ラージオブジェクト" の一覧を、そのオブジェクトに付けられたコメントと一緒に表示します。

loid という OID が示すラージオブジェクトをデータベースから削除します。

以降の問い合わせの結果を filename ファイルに保存、もしくは、以降の問い合わせの結果を別個の Unix シェルに渡し、command を実行します。引数がない場合、問い合わせの出力は stdout にリセットされます。

"問い合わせの結果" には全てのテーブル、コマンドの応答、データベースサーバからの注意はもちろん、データベースに問い合わせを行なう (\d のような) 各種バックスラッシュコマンドの出力が含まれますが、エラーメッセージは含まれません。

現在の問い合わせバッファを標準出力に書き出します。

このコマンドは問い合わせ結果のテーブル出力に影響するオプションを設定します。 parameter には、どのオプションを設定するのかを記述します。value の意味はこの parameter に依存します。

下記は、表示の調整に関するオプションです。

例 節に、これらの形式の違いがどのように見えるかについての図があります。

psql プログラムを終了します。

このコマンドは、\echo と同じです。 ただし、\o による設定と同様に、全ての出力が問い合わせ出力チャネルに書き出される点が異なります。

問い合わせバッファをリセット (クリア) します。

コマンドラインの履歴の表示、または、filename への保存を行ないます。filename が省略された場合、履歴は標準出力に書き出されます。このオプションは、psql が GNU 履歴ライブラリを使用するようにコンパイル時に設定されていた場合にのみ使用可能です。

value を、もしくは、複数の value が与えられた場合は、それらを連結したものを name 内部変数に設定します。2 番目の引数が無い場合は、変数は単に値が無いものとして設定されます。変数を未設定とするには、\unset コマンドを使用して下さい。

変数名には、文字、数字、アンダースコアを使用することができます。詳細については、psql の変数に関する節を参照して下さい。

必要ならばどのようなものでも任意の変数に設定できますが、psql はいくつかの変数を特別なものとして扱っています。これらについては変数に関する節にて説明されています。

出力列名ヘッダと行数フッタの表示を切替えます。このコマンドは \pset tuples_only と同じで、簡便性のために用意されたものです。

HTML 表形式出力モードにおける table タグ内部に記述するオプションを指定できます。このコマンドは \pset tableattr table_options と同じです。

各 SQL 文にかかる時間 (ミリ秒) の表示を切り替えます。

現在の問い合わせバッファを filename ファイルに出力、もしくは、command Unix コマンドにパイプで渡します。

拡張行形式モードを切替えます。このコマンドは \pset expanded と同じものです。

使用可能なすべてのテーブルを、関連付けられているアクセス権限とともに表示します。 pattern を指定すると、パターンに名前が一致するテーブルのみが表示されます。

GRANT コマンドと REVOKE コマンドは、アクセス権限の設定に使われます。 詳細については GRANT を参照して下さい。

これは \dp ("display permissions") の別名です。

別のシェルの起動、もしくは、command Unix コマンドを実行します。引数はこれ以上解釈されず、そのままシェルに渡されます。

バックスラッシュ ("\") コマンドに関するヘルプ情報を表示します。