psql

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

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

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

PostgreSQLサーバへの接続を新規に確立します。 新規接続に成功した場合、以前の接続は閉ざされます。 dbname、username、host、portのいずれかが省略、あるいは -と指定された場合、対応するパラメータの値はこれまでの接続の値が使用されます。 これまで接続されていない場合は、そのパラメータの値にはlibpqのデフォルト値が使用されます。

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

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

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

\copy ... from stdin | to stdoutはそれぞれコマンドの入力と出力を元に読み書きを行います。 コマンドの発行源と同じところから、\.を読み取るまで、あるいは、ストリームがEOFに達するまで全ての行を読み続けます。 出力はコマンドの出力と同じところに送られます。 psqlの標準入力や標準出力を使用するには、pstdinやpstdoutを使用してください。 これは、SQLスクリプトファイルの内部でテーブルにデータを投入する場合に便利です。

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

patternに一致する各リレーション（テーブル、ビュー、インデックス、シーケンス）について、全ての列、列の型、テーブル空間（デフォルト以外を使用している場合）、NOT NULLやデフォルトなどの特別な属性を表示します。 ビューの場合は、ビューの定義に従い、関連付けられているインデックス、制約、ルールおよびトリガも表示されます（"パターンのマッチング"については後述します）。

\d+という形式も同一のコマンドを表しますが、より多くの情報を表示します。 こちらでは、テーブルの列に関連付けられたコメントやテーブルにOIDが存在するかどうかも表示されます。

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

利用可能なテーブル空間を一覧表示します。 patternが指定された場合、そのパターンに名前が一致するテーブル空間のみが表示されます。 コマンド名に+が付与された場合、各オブジェクトに関連付けされた権限についても表示します。

利用できる全ての変換と文字セット符号化方式の一覧を表示します。 patternが指定された場合、そのパターンに名前が一致する変換のみが表示されます。

利用できる型キャストの一覧を表示します。

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

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

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

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

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

全てのデータベースロールを一覧表示します。 patternが指定されている場合は、そのパターンに名前が一致するロールのみが表示されます。 （このコマンドは実質\duと同じになりました。）

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

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

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

利用できる全てのスキーマ（名前空間）の一覧を表示します。 pattern（正規表現）を指定すると、パターンに名前が一致するスキーマのみが表示されます。 ローカルではない一時スキーマは表示されません。 コマンド名の後に+を付加すると、各オブジェクトに関連付けられている説明が（存在すれば）表示されます。

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

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

GRANTコマンドとREVOKEコマンドは、アクセス権限の設定に使われます。

全てのデータ型を一覧表示します。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ファイルから入力を読み取り、キーボードから入力された場合と同じように実行します。

サーバ上の全てのデータベースの名前、所有者、文字セット符号化方式の一覧を表示します。 このコマンドに+を付けると、上記に加えデータベースの説明も表示します。

データベースからloidというOIDを持つラージオブジェクトを読み取り、filenameに書き出します。 これはlo_exportサーバ関数とは微妙に異なります。 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を実行します。 引数がない場合、問い合わせの出力は標準出力にリセットされます。

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

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

指定したユーザ（デフォルトは現在のユーザ）のパスワードを変更します。 このコマンドは、新しいパスワード、暗号化するかどうかを問い合わせ、それをALTER ROLEコマンドとしてサーバに送信します。 これによりコマンド履歴やサーバログなどどこにも新しいパスワードが平文で残りません。

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

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

例節に、これらの形式がどのように見えるかを示した図があります。

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

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

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

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

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

変数名には、文字、数字、アンダースコアを使用することができます。 詳細は、後述の変数を参照してください。 変数名は大文字小文字を区別します。

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

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

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

各SQL文にかかる時間（ミリ秒単位）の表示の有無を切り替えます。

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

拡張テーブル形式モードを切り替えます。 このコマンドは\pset expandedと同じ効力を持ちます。

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

GRANTコマンドとREVOKEコマンドは、アクセス権限の設定に使われます。

これは\dp（"権限の表示（display privileges）"）の別名です。

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

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