【PostgreSQL】メタコマンド〜\?〜

初めに

Qiita Engineer Festa 2024に参加中。完走目指してます。

他のメタコマンドについては以下から読んでください。

?とは

ヘルプ情報を表示します。 オプションのtopicパラメータ（デフォルトはcommands）はpsqlのどの部分を説明するかを選択します。 commandsはpsqlのバックスラッシュコマンドについて、optionsはpsqlに渡すことができるコマンド行オプションについて、variablesはpsqlの設定変数についてのヘルプを表示します。

?について

試してみた

postgres=# \?
一般
  \copyright             PostgreSQL の使い方と配布条件を表示
  \crosstabview [列リスト] 問い合わせを実行し、結果をクロス表形式で出力
  \errverbose            最後のエラーメッセージを最大の冗長性で表示
  \g [(OPTIONS)] [FILE]  問い合わせ実行 (結果はファイルまたは |パイプへ出力);
                         引数なしの\gはセミコロンと同義
  \gdesc                 問い合わせを実行せずに結果の説明を行う
  \gexec                 問い合わせを実行し、結果の中の個々の値を実行
  \gset [PREFIX]         問い合わせを実行して結果を psql 変数に格納
  \gx [ファイル名]       \g と同じ、ただし拡張出力モードを強制
  \q                     psql を終了する
  \watch [秒数]          指定した秒数ごとに問い合わせを実行

ヘルプ
  \? [コマンド]          バックスラッシュコマンドのヘルプを表示
  \? オプション          psql のコマンドライン・オプションのヘルプを表示
  \? 変数名              特殊変数のヘルプを表示
  \h [名前]              SQLコマンドの文法ヘルプの表示。* で全コマンドを表示
  
~~~~ 省略 ~~~~

postgres=# \? variables
特別に扱われる変数の一覧

psql変数:
使い方:
  psql --set=名前=値
  またはpsql内で \set 名前 値

  AUTOCOMMIT
    セットされている場合、SQLコマンドが成功した際に自動的にコミット
~~~~ 省略 ~~~~

postgres=# \? options
psql は PostgreSQL の対話型ターミナルです。

使い方:
  psql [オプション]... [データベース名 [ユーザー名]]

一般的なオプション:
  -c, --command=コマンド   単一の(SQLまたは内部)コマンドを一つだけ実行して終了
  -d, --dbname=DB名        接続するデータベース名(デフォルト: "daichi-ito")
  -f, --file=FILENAME      ファイルからコマンドを読み込んで実行した後に終了
  -l(エル), --list         使用可能なデータベース一覧を表示して終了
  -v, --set=, --variable=名前=値
~~~~ 省略 ~~~~

まとめ

便利なメタコマンドは多くあるので、忘れた時の確認に利用していこう。