psql

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

PostgreSQL サーバへの新規の接続を確立します。 接続のパラメータは、位置の構文、あるいは conninfo 接続文字列で指定することができます。 後者の詳細は 項31.1.1 で説明します。

位置の構文を使うとき、 dbname 、 username 、 host 、 port のいずれかが省略、あるいは - と指定された場合、対応するパラメータの値はこれまでの接続の値が使用されます。 これまで接続されていない場合は、そのパラメータの値には libpq のデフォルト値が使用されます。 conninfo 接続文字列を使用する場合、これまでの接続の値は新しい接続に使用されません。

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

=> \c mydb myuser host.dom 6432
=> \c service=foo
=> \c "host=localhost port=5432 dbname=mydb connect_timeout=10 sslmode=disable"
=> \c postgresql://tom@localhost/mydb?application_name=myapp

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

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

現在のデータベース接続に関する情報を出力します。

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

program が指定された場合、 command が psql により実行され、 command から、または、 command へのデータはサーバとクライアント間を行き来します。 ここでも、実行権限はローカル側のユーザであり、サーバ側ではなく、SQLスーパーユーザ権限は必要とされません。

\copy ... from stdin では、データ行は、コマンドの発行源と同じところから、 \. を読み取るまで、あるいは、ストリームが EOF に達するまで読み続けます。 このオプションは、SQLスクリプトファイルの内部でテーブルにデータを投入する場合に便利です。 \copy ... to stdout では、出力は psql コマンドの出力と同じところに送られますが、 COPY count コマンドのステータスは表示されません(これはデータ行と混同してしまうかもしれないからです)。 コマンドの入力元や \o オプションに関わらず、 psql の標準入力や標準出力を読み書きするには、 from pstdin あるいは to pstdout と書いてください。

このコマンドの構文は SQL の COPY コマンドに似ています。 データの入力元と出力先以外のすべてのオプションは COPY と同じです。 このため \copy コマンドには特別な解析規則が適用されていることに注意してください。 特に、 psql の変数の置換規則やバックスラッシュエスケープは適用されません。

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

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

一部の種類のリレーションでは、 \d は各列について追加の情報を表示します。 例えば、シーケンスでは列の値、インデックスではインデックス式、外部テーブルでは外部データラッパのオプションです。

\d+ というコマンド形式も同一ですが、より多くの情報を表示します。 こちらでは、テーブルの列に関連付けられたコメントやテーブルにOIDが存在するかどうか、リレーションがビューの場合はビューの定義、デフォルトと異なる replica identity の設定も表示されます。

デフォルトではユーザが作成したオブジェクトのみが表示されます。 システムオブジェクトを含めるためには、パターンまたは S 修飾子を付与してください。

集約関数と、その戻り値のデータ型、演算対象となるデータ型の一覧を表示します。 pattern が指定された場合、そのパターンに名前がマッチする集約のみが表示されます。 デフォルトではユーザが作成したオブジェクトのみが表示されます。 システムオブジェクトを含めるためには、パターンまたは S 修飾子を付与してください。

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

文字セット符号化方式間の変換の一覧を表示します。 pattern が指定された場合、そのパターンに名前がマッチする変換のみが表示されます。 デフォルトではユーザが作成したオブジェクトのみが表示されます。 システムオブジェクトを含めるためには、パターンまたは S 修飾子を付与してください。 コマンド名に + を付与すると、各オブジェクトに関連する説明を付けて表示します。

型キャストの一覧を表示します。 pattern が指定された場合、そのパターンに元データ型または変換先データ型がマッチするキャストのみが表示されます。 コマンド名に + を付与すると、各オブジェクトに関連する説明を付けて表示します。

constraint 、 operator class 、 operator family 、 rule 、 trigger という種類のオブジェクトについての説明を表示します。 他のコメントはすべて、これらのオブジェクト種類用の対応するバックスラッシュコマンドによって表示されます。

\dd は pattern にマッチするオブジェクトの説明を表示します。 引数が指定されていない場合は、適切な種類の可視なオブジェクトの説明を表示します。 どちらの場合でも、一覧に表示されるのは説明を持つオブジェクトのみです デフォルトではユーザが作成したオブジェクトのみが表示されます。 システムオブジェクトを含めるためには、パターンまたは S 修飾子を付与してください。

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

デフォルトのアクセス権限設定を一覧表示します。 組み込みのデフォルトから権限設定が変更されたロール（および適切ならばスキーマも）ごとに1項目示されます。 pattern が指定された場合、パターンにマッチするロール名またはスキーマ名の項目のみが表示されます。

ALTER DEFAULT PRIVILEGES コマンドを使用して、デフォルトのアクセス権限を設定します。 権限表示の意味は GRANT で説明します。

ドメインを一覧表示します。 pattern が指定されている場合は、パターンに名前がマッチするドメインのみが表示されます。 デフォルトではユーザが作成したオブジェクトのみが表示されます。 システムオブジェクトを含めるためには、パターンまたは S 修飾子を付与してください。 コマンド名に + を付与すると、各オブジェクトに関連する権限と説明を付けて表示します。

このコマンド群において、 E 、 i 、 m 、 s 、 t 、 v という文字はそれぞれ、外部テーブル、インデックス、マテリアライズドビュー、シーケンス、テーブル、ビューを表します。 これらの種類のオブジェクトの一覧を表示するために、これらの文字の中の任意の文字またはすべてを任意の順番で指定することができます。 例えば、 \dit はインデックスとテーブルを列挙します。 + がコマンド名に付与された場合、各オブジェクトは、もしあればディスク上の物理容量と関連する説明をつけて表示されます。 pattern が指定されている場合は、パターンに名称がマッチする項目のみが表示されます。 デフォルトでは、ユーザが作成したオブジェクトのみが表示されます。 システムオブジェクトを含めるためにはパターンまたは S 修飾子を付与してください。

外部(foreign)サーバ（つまり "external servers" ）を一覧表示します。 pattern が指定されている場合は、名前がパターンにマッチするサーバのみが表示されます。 \des+ 構文が使用された場合、サーバのACL、型、バージョン、オプション、説明など各サーバの完全な説明が表示されます。

外部(foreign)テーブル（つまり "external tables" ）を一覧表示します。 pattern が指定された場合、パターンにテーブル名またはスキーマ名がマッチするもののみが表示されます。 \det+ が使用された場合、汎用オプションと外部テーブルの説明も表示されます。

ユーザマップ（つまり "external users" ）を一覧表示します。 pattern が指定されている場合は、名前がパターンにマッチするユーザのみが表示されます。 \deu+ 構文が使用された場合、各マップについて追加情報が表示されます。

外部データラッパ（つまり "external wrappers" ）を一覧表示します。 pattern が指定されている場合、名前がパターンにマッチする外部データラッパのみが表示されます。 \dew+ 構文が使用された場合、外部データラッパのACL、オプションおよび説明も表示されます。

関数とその引数と戻り値の型、および、 "agg" (集約)、 "normal" 、 "trigger" 、 "window" で分類される関数の種類の一覧を表示します。 特定種類の関数のみを表示させるには、対応する文字 a 、 n 、 t 、 w をコマンドに付けて下さい。 pattern が指定されている場合は、そのパターンに名前がマッチする関数のみが表示されます。 デフォルトではユーザが作成したオブジェクトのみが表示されます。 システムオブジェクトを含めるためには、パターンまたは S 修飾子を付与してください。 \df+ 構文が使われた場合、各関数の、セキュリティ分類、揮発性、所有者、言語、ソースコードや説明を含む付加的情報も表示されます。

全文検索設定を一覧表示します。 pattern が指定された場合、このパターンにマッチする名前の設定のみが表示されます。 \dF+ 形式が使用された場合、使用される全文検索パーサや各パーサトークン型についての辞書リストなど各設定の完全な説明が表示されます。

全文検索辞書を一覧表示します。 pattern が指定された場合、このパターンにマッチする名前の辞書のみが表示されます。 \dFd+ 形式が使用された場合、選択された辞書それぞれについて使用される全文検索テンプレートやオプション値など更なる情報が表示されます。

全文検索パーサを一覧表示します。 pattern が指定された場合、このパターンにマッチする名前のパーサのみが表示されます。 \dFp+ 形式が使用された場合、使用される関数や認知されるトークン型のリストなど各パーサの完全な説明が表示されます。

テキスト検索テンプレートを一覧表示します。 pattern が指定された場合、このパターンにマッチする名前のテンプレートのみが表示されます。 \dFt+ 形式が使用された場合、テンプレートそれぞれについて使用される関数名など更なる情報が表示されます。

データベースロールを一覧表示します。 ( "ユーザ" と "グループ" という概念は "ロール" に統合されましたので、このコマンドは \du と同じものになりました。) pattern が指定されている場合は、そのパターンに名前がマッチするロールのみが表示されます。 \dg+ 構文が使用された場合、ロールそれぞれについて更なる情報が表示されます。 現時点では各ロールのコメントが追加されます。

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

手続き言語を一覧表示します。 pattern を指定すると、パターンに名前がマッチする言語のみが表示されます。 デフォルトではユーザが作成した言語のみが表示されます。 システムオブジェクトを含めるためには、パターンまたは S 修飾子を付与してください。 + をコマンド名に追加すると、呼び出しハンドラ、有効性検証関数、アクセス権限、システムオブジェクトか否かという情報を付けて各言語が表示されます。

スキーマ（名前空間）の一覧を表示します。 pattern を指定すると、パターンに名前がマッチするスキーマのみが表示されます。 デフォルトではユーザが作成したオブジェクトのみが表示されます。 パターンまたは S 修飾子を追加すると、システムオブジェクトが表示に追加されます。 コマンド名の後に + を付加すると、各オブジェクトに関連付けられている権限と説明が（存在すれば）表示されます。

演算子と、その演算項目と結果の型を一覧表示します。 pattern を指定すると、パターンに名前がマッチする演算子のみが表示されます。 デフォルトではユーザが作成したオブジェクトのみが表示されます。 システムオブジェクトを含めるためには、パターンまたは S 修飾子を付与してください。 コマンド名に + を付加すると、各演算子についての追加情報が表示されますが、現在はその元になっている関数の名前だけです。

照合順序を一覧表示します。 pattern を指定すると、パターンに名前がマッチする照合順序のみが表示されます。 デフォルトではユーザが作成したオブジェクトのみが表示されます。 システムオブジェクトを含めるためには、パターンまたは S 修飾子を付与してください。 コマンド名の後に + を付加すると、各照合順序に関連付けられている説明が（存在すれば）表示されます。 現在のデータベースの符号化方式で使用できる照合順序のみが表示されることに注意してください。 このため同じインストレーションであってもデータベースによって結果が異なる可能性があります。

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

アクセス権限の設定には GRANT コマンドと REVOKE コマンドが使われます。 権限の表示に関する意味は GRANT で説明します。

定義済み設定に関する設定を一覧表示します。 これらの設定はロール固有、データベース固有、またはその両方です。 role-pattern および database-pattern はそれぞれ特定のロールやデータベースを選択するために使用します。 パターンが省略された場合、または * が指定された場合、ロール固有ではない、または、データベース固有ではない設定を含め、すべての設定を表示します。

ロール単位およびデータベース単位の設定を定義するには ALTER ROLE および ALTER DATABASE コマンドを使用します。

データ型を一覧表示します。 pattern を指定すると、パターンにマッチする名前を持つ型のみを表示します。 + をコマンド名に付けると、型ごとに、型の内部名、サイズ、 enum 型では許される値、関連する権限も表示されます。 デフォルトではユーザが作成したオブジェクトのみが表示されます。 システムオブジェクトを含めるためには、パターンまたは S 修飾子を付与してください。

データベースロールを一覧表示します。 ( "ユーザ" と "グループ" という概念は "ロール" に統合されましたので、このコマンドは \dg と同じものになりました。) pattern が指定されている場合は、そのパターンに名前がマッチするロールのみが表示されます。 \du+ 構文が使用された場合、ロールそれぞれについて更なる情報が表示されます。 現時点では各ロールのコメントが追加されます。

インストールされた拡張を一覧表示します。 pattern を指定すると、パターンにマッチする名前の拡張のみを表示します。 \dx+ 形式が使用された場合、マッチする拡張それぞれについて拡張に属するすべてのオブジェクトが表示されます。

イベントトリガを一覧表示します。 pattern を指定すると、パターンにマッチする名前のイベントトリガのみを表示します。 + をコマンド名に追記すると、関連する説明を付けて各オブジェクトを表示します。

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

次に、新しい問い合わせバッファは、 psql の通常の規則に従い、全体を1行として再解析されます （このため、この方法では "スクリプト" を作成できません。 この目的のためには \i を使用してください）。 これは問い合わせの終端がセミコロンである（もしくは問い合わせがセミコロンを含む）場合、すぐに実行されることを意味しています。 セミコロンを含まない場合は、問い合わせバッファ内に保持されて入力を待ちます。 セミコロンまたは \g を入力して送信するか、 \r を入力してキャンセルしてください。

行番号(line_number)が指定された場合、 psql はファイルまたは問い合わせバッファ内の指定行にカーソルを位置づけます。 すべてが数字の引数が1つだけ指定された場合、 psql はそれをファイル名ではなく行番号であるとみなすことに注意してください。

引数を空白で区切り、標準出力に出力し、改行します。 スクリプトが出力するところどころに情報を記載する場合に有用です。 使用例を次に示します。

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

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

このコマンドは指定された関数の定義を CREATE OR REPLACE FUNCTION コマンド構文で取り出し、編集します。 編集は \edit と同様の方法で行われます。 エディタ終了後、更新されたコマンドは問い合わせバッファ内で待機しています。 セミコロンか \g を入力して送信するか、 \r を入力して取り消すかしてください。

対象の関数は名前だけ、または、たとえば foo(integer, text) のように名前と引数で指定することができます。 同じ名前の関数が複数存在する場合、引数の型を指定しなければなりません。

関数が指定されなかった場合、空の CREATE FUNCTION のテンプレートが編集用に表示されます。

行番号が指定された場合、 psql は関数本体における指定行にカーソルを移動します。 （関数本体は通常、ファイルの先頭から始まらないことに注意してください。）

クライアント側の文字セット符号化方式を設定します。 引数を指定しない場合、このコマンドは現在の符号化方式を表示します。

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

現在の問い合わせ入力バッファをサーバに送ります。 オプションを指定すれば、問い合わせ出力を filename に格納したり、その出力をシェルコマンド command にパイプで渡すこともできます。 問い合わせが成功しゼロ以上のタプルが返る場合にのみファイルまたはコマンドに書き出されます。 問い合わせが失敗する場合やデータを返さないSQLコマンドでは書き出されません。

\g だけを指定した場合は、セミコロンと実質的に同じです。 \g に引数を指定した場合は、 \o コマンドの "一度限りの" 代替手段として使用できます。

現在の問い合わせ入力バッファをサーバに送信し、問い合わせの出力を psql 変数（ 変数 参照）に格納します。 実行される問い合わせは正確に１行を返さなければなりません。 行の各列は、列と同じ名前を持つ別々の変数に格納されます。 例えば、以下のようになります。

=> SELECT 'hello' AS var1, 10 AS var2
-> \gset
=> \echo :var1 :var2
hello 10

prefix を指定した場合、使用する変数の名前を作成する時にその文字列が問い合わせの列名の前に付けられ、次のようになります。

=> SELECT 'hello' AS var1, 10 AS var2
-> \gset result_
=> \echo :result_var1 :result_var2
hello 10

列の結果がNULLである場合、対応する変数は設定されず未設定状態となります。

問い合わせが失敗、または１行を返さない場合、変数は変更されません。

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

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

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

\ir コマンドは \i と似ていますが、相対ファイル名の解決方法が異なります。 対話モードで実行している場合は２つのコマンドの動作は同一です。 しかし、スクリプトから呼び出す場合、 \ir は、現在の作業ディレクトリではなく、そのスクリプトの格納ディレクトリから見た相対ファイル名として解釈します。

サーバ内のデータベースについて、その名前、所有者、文字セット符号化方式、アクセス権限を一覧表示します。 pattern を指定すると、パターンにマッチする名前を持つデータベースのみを表示します。 コマンド名に + を付けると、データベースのサイズ、デフォルトのテーブル空間、説明も表示します。 （サイズ情報は現在のユーザが接続可能なデータベースでのみ表示されます。）

データベースから OID が loid であるラージオブジェクトを読み取り、 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 コマンドではOIDとコメントの両方が表示されます。

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

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

OID が loid であるラージオブジェクトをデータベースから削除します。

以降の問い合わせの結果を、 filename で指定されたファイルに保存するか、またはシェルコマンド command にパイプで渡すようにします。 引数がない場合、問い合わせの出力はリセットされて標準出力になります。

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

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

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

変数 name に代入するテキストを入力するようにユーザを促します。 プロンプト text をオプションで指定することができます。 （複数の単語をプロンプトで使用する場合はそのテキストを単一引用符でくくってください。）

デフォルトでは \prompt は入出力に端末を使用します。 しかし、 -f コマンドラインスイッチが使用されている場合、 \prompt は標準入力、標準出力を使用します。

このコマンドは問い合わせ結果のテーブル出力に影響するオプションを設定します。 option には、どのオプションを設定するのかを記述します。 value の意味は選択したオプションにより変わります。 以下のオプション別の説明の通り、オプションの中には value を省略することでトグルや設定解除を行うものがあります。 こうした動作の記載がなければ、 value を省略すると、単に現在の設定値が表示されることになります。

何も引数をつけずに \pset を実行すると、すべての表示オプションの現在の状態を表示します。

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

testdb=> \set foo bar

testdb=> \echo :foo
これは通常のSQLコマンド内とメタコマンド内の両方で動作します。
後述のSQL差し替えで詳しく説明します。
    
第二引数なしで\setを呼び出すと、空文字列を値として持つ変数が設定されます。
変数を未設定状態にする(つまり削除する)ためには、\unsetコマンドを使用してください。
すべての変数の値を表示するためには、引数なしで\setを呼び出してください。
    
注意: \setの引数は他のコマンドと同じ置換規則に従います。
このため、\set :foo 'something'のような参照を作成して、Perlにおける"ソフトリンク"やPHPにおける"可変変数"に当たるものを得られます。
しかし、残念ながら（あるいは幸運にも）、このような構成をうまく使用する方法はありません。
一方、\set bar :fooのようにして変数をコピーするのは、完全に有効な方法です。
    
これらの変数の多くは、psqlに特別扱いされています。
これらは、変数の値を変更することにより、実行時に変更可能なオプションの設定を表現します。
またpsqlの変更可能な状態を表現しているものもあります。
これらの変数を別の目的で使用することもできますが、即座にプログラムの動作がおかしくなる可能性があるため、推奨されません。
慣習上、特別視される変数の名前はすべてASCII大文字（と数字とアンダースコア）からなります。
将来的な互換性を最大限考慮するために、自分で作成した変数にはこのような変数名を使用しないでください。
以下に特別に取り扱われる変数の一覧を示します。
   
AUTOCOMMIT
       
この変数の値がonの場合（これがデフォルトです）、各SQLコマンドの実行が成功すると、自動的にコミットされます。
コミットを延期するには、BEGINもしくはSQLのSTART TRANSACTIONコマンドを入力する必要があります。
値がoffもしくは未設定の場合、明示的にCOMMITもしくはENDを発行するまで、SQLコマンドはコミットされません。
自動コミット無効モードでは、トランザクションブロック以外でコマンドが発行されると、そのコマンドを実行する前に、自動的にBEGINコマンドが発行されます（ただし、そのコマンド自体がBEGINコマンドやその他のトランザクション制御コマンドである場合、トランザクションブロック内で実行することができないコマンド（VACUUMなど）である場合は除きます）
        
注意: 自動コミット無効モードでは、ABORTやROLLBACKを発行して、明示的に失敗したトランザクションを放棄しなければなりません。
また、コミットせずにセッションを終了した場合は、作業が失われてしまうので注意してください。
        
注意: PostgreSQLは、伝統的に自動コミット有効モードで動作していましたが、自動コミット無効モードの方がよりSQLの仕様に近いものです。
自動コミット無効モードは、システム全体に対するpsqlrcファイル、もしくは、個人用の.psqlrcファイルで設定すれば実現できます。
        
COMP_KEYWORD_CASE
SQLキーワードを補完する時に大文字小文字のどちらを使用するかを決定します。
lowerまたはupperが設定された場合、補完された単語はそれぞれ小文字または大文字になります。
preserve-lowerまたはpreserve-upper（デフォルト）が設定された場合、
補完された単語は入力済みの文字の大文字小文字を引き継ぎますが、何も入力されていない場合はそれぞれ小文字または大文字に補完されます。
        
DBNAME
現在接続しているデータベース名です。
この変数は（プログラム起動時も含め）データベースに接続する度に設定されますが、これを未設定にすることもできます。
        
ECHO
allに設定された場合、空でない全ての入力行は、標準出力に書き出されます。
(これは対話式に読み込まれる行には適用されません。)
この動作をプログラム起動時に設定するには、-aスイッチを使用してください。
queriesに設定された場合、psqlは各問い合わせがサーバに送信されるときに表示します。
これに対応するオプションは-eです。
        
ECHO_HIDDEN
この変数がonに設定されている場合、バックスラッシュコマンドがデータベースに問い合わせを行う時、最初にその問い合わせが表示されます。
この機能は、PostgreSQL内部動作について調べたり、自作プログラム内で同様の関数機能を用意したりするのに役立つでしょう。
（この動作をプログラム起動時に選択するには-Eスイッチを使用してください）。
この変数をnoexecという値に設定した場合、問い合わせは実際にサーバに送信、実行されずに、単に表示されるだけになります。
        
ENCODING
現在のクライアント側の文字セット符号化方式です。
        
FETCH_COUNT
この変数が0より大きな整数値に設定されている場合、SELECT問い合わせの結果は、指定した行数の集合として取り出され、表示されます。
デフォルトの動作では、表示する前にすべての結果が取り出されます。
したがって、結果セットの大きさに関係なくメモリの使用量が限定されます。
この機能を有効とする場合に100から1000までの値がよく使用されます。
この機能を使用する際には、既に一部の行が表示されている場合、問い合わせが失敗する可能性があることに注意してください。
        
ティップ: 任意の出力書式でこの機能を使用することができますが、デフォルトのaligned書式は適していません。
FETCH_COUNT行のグループそれぞれが別々に整形されてしまい、行のグループによって列幅が異なることになるためです。
他の出力書式は適切に動作します。
        
HISTCONTROL
この変数をignorespaceに設定した場合、空白文字から始まる行は履歴リストには入りません。
ignoredupsに設定した場合、直前の履歴と同じ行は履歴リストに入りません。
ignorebothに設定した場合は、上記の2つを組み合わせたものになります。
この変数を設定しない場合、または上記以外の値を設定する場合は、対話モードで読まれる全ての行が履歴リストに保存されます。
        
注意: この機能はBashの機能を真似たものです。
        
HISTFILE
履歴を格納するために使用されるファイルの名前です。
デフォルトは~/.psql_historyです。
例えば、~/.psqlrcで以下を記述すると、psqlはデータベース毎に分けて履歴を管理します。
\set HISTFILE ~/.psql_history- :DBNAME

        
注意: この機能はBashの機能を真似たものです。
        
HISTSIZE
コマンド履歴に保存するコマンド数です。
デフォルト値は500です。
        
注意: この機能はBashの機能を真似たものです。
        
HOST
接続中のデータベースサーバホストです。
この変数は（プログラム起動時も含め）データベースに接続する度に設定されますが、未設定にすることもできます。
        
IGNOREEOF
この変数を未設定にすると、対話式セッションにEOF文字（通常Control+D）が送信された時、psqlが終了します。
数値を設定すると、指定された数だけ、送信されたEOF文字を無視してから終了します。
数値以外を設定した場合は、デフォルトの10になります。
        
注意: この機能はBashの機能を真似たものです。
        
LASTOID
INSERTや\lo_insertコマンドによって返された、最後に影響を受けたOIDの値です。
この変数は、次のSQLコマンドの結果が表示されるまでの間のみ保証されています。
        
ON_ERROR_ROLLBACK
       
onに設定されている場合、トランザクションブロック内である文がエラーとなった時に、そのエラーは無視され、トランザクションは継続します。
interactiveに設定されている場合、対話式セッション内の場合にのみエラーは無視されます。スクリプトファイルを読み込んでいる場合は無視されません。
設定されていないか、またはoffに設定されている場合、トランザクションブロック内の文がエラーになると、トランザクション全体をアボートします。
エラーロールバックのモードは、トランザクションブロック内で各コマンドの実行直前に暗黙的なSAVEPOINTを行い、コマンドが失敗した時にこのセーブポイントにロールバックすることで実現されています。
        
ON_ERROR_STOP
デフォルトではエラーの後もコマンド処理は続行されます。
この変数がonに設定されていると、代わりに即座に停止します。
対話モードではpsqlはコマンドプロンプトに戻ります。
これ以外ではpsqlは終了し、エラーコード1を返す致命的エラー条件と区別できるように、エラーコード3を返します。
どちらの場合でも、現在実行中のスクリプト（トップレベルのスクリプト、もしあれば関連性を持つ他のスクリプトすべて）は即座に終了します。
トップレベルのコマンド文字列が複数のSQLコマンドを含む場合、その時点のコマンドで処理は終了します。
        
PORT
接続中のデータベースサーバのポートです。
この変数は（プログラム起動時も含め）データベースに接続する度に設定されますが、未設定にすることもできます。
        
PROMPT1
PROMPT2
PROMPT3
これらの変数は、psqlが発行するプロンプトの見た目を指定します。
後述のプロンプトを参照してください。
        
QUIET
この変数をonに設定することはコマンドラインオプション-qと同じ効力を持ちます。
対話式モードではあまり役立ちません。
        
SINGLELINE
この変数をonに設定することはコマンドラインオプション-Sと同じ効力を持ちます。
        
SINGLESTEP
この変数をonに設定することはコマンドラインオプション-sと同じ効力を持ちます。
        
USER
接続中のデータベースユーザです。
この変数は（プログラム起動時も含め）データベースに接続する度に設定されますが、未設定にすることもできます。
        
VERBOSITY
この変数をdefault、verbose、terseのいずれかに設定することで、エラー報告の冗長性を制御できます。
        




    

testdb=> \set foo 'my_table'
testdb=> SELECT * FROM :foo;

testdb=> \set foo 'my_table'
testdb=> SELECT * FROM :"foo";

testdb=> \set content `cat my_file.txt`
testdb=> INSERT INTO my_table VALUES (:'content');

testdb=> \set content '''' `sed -e "s/'/''/g" -e 's/\\/\\\\/g' < my_file.txt` ''''

$if psql
set disable-completion on
$endif

testdb=> CREATE TABLE my_table (
testdb(>  first integer not null default 0,
testdb(>  second text)
testdb-> ;
CREATE TABLE

testdb=> \d my_table
             Table "my_table"
 Attribute |  Type   |      Modifier
-----------+---------+--------------------
 first     | integer | not null default 0
 second    | text    |

testdb=> \set PROMPT1 '%n@%m %~%R%# '
peter@localhost testdb=>

peter@localhost testdb=> SELECT * FROM my_table;
 first | second
-------+--------
     1 | one
     2 | two
     3 | three
     4 | four
(4 rows)

peter@localhost testdb=> \pset border 2
Border style is 2.
peter@localhost testdb=> SELECT * FROM my_table;
+-------+--------+
| first | second |
+-------+--------+
|     1 | one    |
|     2 | two    |
|     3 | three  |
|     4 | four   |
+-------+--------+
(4 rows)
peter@localhost testdb=> \pset border 0
Border style is 0.
peter@localhost testdb=> SELECT * FROM my_table;
first second
----- ------
    1 one
    2 two
    3 three
    4 four
(4 rows)
peter@localhost testdb=> \pset border 1
Border style is 1.
peter@localhost testdb=> \pset format unaligned
Output format is unaligned.
peter@localhost testdb=> \pset fieldsep ","
Field separator is ",".
peter@localhost testdb=> \pset tuples_only
Showing only tuples.
peter@localhost testdb=> SELECT second, first FROM my_table;
one,1
two,2
three,3
four,4

peter@localhost testdb=> \a \t \x
Output format is aligned.
Tuples only is off.
Expanded display is on.
peter@localhost testdb=> SELECT * FROM my_table;
-[ RECORD 1 ]-
first  | 1
second | one
-[ RECORD 2 ]-
first  | 2
second | two