PostgreSQL 9.2のpsqlで確認できるヘルプなど

PostgreSQL 8の時と同様に、PostgreSQL 9でも、WindowsのコマンドプロンプトからpsqlでPostgreSQLに接続後、コマンドラインでヘルプなどを確認できる。

以下に、確認した時のメモを記載する。

(1)psql -U postgresでPostgreSQL 9に接続する。

《psqlでの接続例》
c:\Program Files\PostgreSQL\9.2\bin>psql -U postgres
ユーザ postgres のパスワード:
psql (9.2.1)
"help" でヘルプを表示します.

(2)psqlのコマンドラインで「help」とコマンド入力し、[Enter]キー押下でコマンドを実行する。

→ヘルプが表示される。

psqlでPostgreSQLに接続直後のコマンドライン上の画面では「"help" でヘルプを表示します.」というメッセージが表示されているので、

help

と入力し、[Enter]キーを押下する。

postgres=# help

《コマンド実行結果》
PostgreSQL へのコマンドライン・インターフェース、psql へようこそ。
\copyright とタイプすると、配布条件を表示します。
\h とタイプすると、SQL コマンドのヘルプを表示します。
\? とタイプすると、psql コマンドのヘルプを表示します。
\g と打つかセミコロンで閉じると、問い合わせを実行します。
\q で終了します。

(3)psqlのコマンドラインで「\copyright」とコマンド入力し、[Enter]キー押下でコマンドを実行する。

→「コピーライト」が表示される。

postgres=# \copyright

《コマンド実行結果》
PostgreSQL Database Management System
(formerly known as Postgres, then as Postgres95)

Portions Copyright (c) 1996-2012, PostgreSQL Global Development Group

Portions Copyright (c) 1994, The Regents of the University of California

Permission to use, copy, modify, and distribute this software and its
documentation for any purpose, without fee, and without a written agreement
is hereby granted, provided that the above copyright notice and this
paragraph and the following two paragraphs appear in all copies.

IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR
DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING
LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS
DOCUMENTATION, EVEN IF THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.

THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATIONS TO
PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

(4)psqlのコマンドラインで「\h」とコマンド入力し、[Enter]キー押下でコマンドを実行する。

→SQLコマンドのヘルプが表示される。

postgres=# \h

《コマンド実行結果》
利用可能なヘルプ:
ABORT DECLARE
ALTER AGGREGATE DELETE
ALTER COLLATION DISCARD
ALTER CONVERSION DO
ALTER DATABASE DROP AGGREGATE
ALTER DEFAULT PRIVILEGES DROP CAST
ALTER DOMAIN DROP COLLATION
ALTER EXTENSION DROP CONVERSION
ALTER FOREIGN DATA WRAPPER DROP DATABASE
ALTER FOREIGN TABLE DROP DOMAIN
ALTER FUNCTION DROP EXTENSION
ALTER GROUP DROP FOREIGN DATA WRAPPER
ALTER INDEX DROP FOREIGN TABLE
ALTER LANGUAGE DROP FUNCTION
ALTER LARGE OBJECT DROP GROUP
ALTER OPERATOR DROP INDEX
ALTER OPERATOR CLASS DROP LANGUAGE
ALTER OPERATOR FAMILY DROP OPERATOR
ALTER ROLE DROP OPERATOR CLASS
ALTER SCHEMA DROP OPERATOR FAMILY
ALTER SEQUENCE DROP OWNED
ALTER SERVER DROP ROLE
ALTER TABLE DROP RULE
ALTER TABLESPACE DROP SCHEMA
ALTER TEXT SEARCH CONFIGURATION DROP SEQUENCE
ALTER TEXT SEARCH DICTIONARY DROP SERVER
ALTER TEXT SEARCH PARSER DROP TABLE
ALTER TEXT SEARCH TEMPLATE DROP TABLESPACE
ALTER TRIGGER DROP TEXT SEARCH CONFIGURATION
ALTER TYPE DROP TEXT SEARCH DICTIONARY
ALTER USER DROP TEXT SEARCH PARSER
ALTER USER MAPPING DROP TEXT SEARCH TEMPLATE
ALTER VIEW DROP TRIGGER
ANALYZE DROP TYPE
BEGIN DROP USER
CHECKPOINT DROP USER MAPPING
CLOSE DROP VIEW
CLUSTER END
COMMENT EXECUTE
COMMIT EXPLAIN
COMMIT PREPARED FETCH
COPY GRANT
CREATE AGGREGATE INSERT
CREATE CAST LISTEN
CREATE COLLATION LOAD
CREATE CONVERSION LOCK
CREATE DATABASE MOVE
CREATE DOMAIN NOTIFY
CREATE EXTENSION PREPARE
CREATE FOREIGN DATA WRAPPER PREPARE TRANSACTION
CREATE FOREIGN TABLE REASSIGN OWNED
CREATE FUNCTION REINDEX
CREATE GROUP RELEASE SAVEPOINT
CREATE INDEX RESET
CREATE LANGUAGE REVOKE
CREATE OPERATOR ROLLBACK
CREATE OPERATOR CLASS ROLLBACK PREPARED
CREATE OPERATOR FAMILY ROLLBACK TO SAVEPOINT
CREATE ROLE SAVEPOINT
CREATE RULE SECURITY LABEL
CREATE SCHEMA SELECT
CREATE SEQUENCE SELECT INTO
CREATE SERVER SET
CREATE TABLE SET CONSTRAINTS
CREATE TABLE AS SET ROLE
CREATE TABLESPACE SET SESSION AUTHORIZATION
CREATE TEXT SEARCH CONFIGURATION SET TRANSACTION
CREATE TEXT SEARCH DICTIONARY SHOW
CREATE TEXT SEARCH PARSER START TRANSACTION
CREATE TEXT SEARCH TEMPLATE TABLE
CREATE TRIGGER TRUNCATE
CREATE TYPE UNLISTEN
CREATE USER UPDATE
CREATE USER MAPPING VACUUM
CREATE VIEW VALUES
DEALLOCATE WITH

(5)psqlのコマンドラインで「\?」とコマンド入力し、[Enter]キー押下でコマンドを実行する。

→psqlコマンドのヘルプが表示される。

postgres=# \?

《コマンド実行結果》
一般
\copyright PostgreSQL の使い方と配布条件を表示
\g [ファイル] または ';' 問い合わせを実行(し、結果をファイルまたは |パイプへ書き出す)
\h [名前] SQL コマンドの文法ヘルプ、* で全コマンド
\q psql を終了する

問い合わせバッファ
\e [ファイル] [行番号] 現在の問い合わせバッファ(やファイル)を外部エディタで編集する
\e [関数名 [行番号]] 関数定義を外部エディタで編集する
\p 問い合わせバッファの内容を表示する
\r 問い合わせバッファをリセット(クリア)する
\w ファイル 問い合わせバッファの内容をファイルに書き出す

入出力
\copy ... クライアントホストに対し、データストリームを使ってSQLコピーを行う
\echo [文字列] 文字列を標準出力に書き出す
\i ファイル ファイルからコマンドを読み込んで実行する
\ir ファイル \iと同じ。ただし現在のスクリプトの場所からの相対パス
\o [ファイル] すべての問い合わせの結果をファイルまたは |パイプ へ送る
\qecho [文字列] 文字列を問い合わせ出力ストリームに出力(\o を参照)

情報
(修飾子: S = システムオブジェクトを表示 + = 付加情報)
\d[S+] テーブル、ビュー、シーケンスの一覧を表示する
\d[S+] 名前 テーブル、ビュー、シーケンス、インデックスの説明を表示する
\da[S] [パターン] 集約関数の一覧を表示する
\db[+] [パターン] テーブルスペースの一覧を表示する
\dc[S+] [パターン] 変換ルールの一覧を表示する
\dC[+] [パターン] キャストの一覧を表示する
\dd[S] [パターン] 他では表示されないオブジェクトの説明を表示する
\ddp [パターン] デフォルト権限の一覧を表示する
\dD[S+] [パターン] ドメインの一覧を表示する
\det[+] [パターン] 外部テーブルの一覧を表示する
\des[+] [パターン] 外部サーバーの一覧を表示する
\deu[+] [パターン] ユーザマッピングの一覧を表示する
\dew[+] [パターン] 外部データラッパーの一覧を表示する
\df[antw][S+] [パターン] 関数(集約/通常/トリガー/ウィンドウのみ)の一覧を表示する
\dF[+] [パターン] テキスト検索設定の一覧を表示する
\dFd[+] [パターン] テキスト検索用辞書の一覧を表示する
\dFp[+] [パターン] テキスト検索用パーサーの一覧を表示する
\dFt[+] [パターン] テキスト検索用テンプレートの一覧を表示する
\dg[+] [パターン] ロールの一覧を表示する
\di[S+] [パターン] インデックスの一覧を表示する
\dl ラージオブジェクトの一覧を表示する。\lo_list と同じ。
\dL[S+] [パターン] 手続き言語の一覧を表示する
\dn[S+] [パターン] スキーマの一覧を表示する
\do[S] [名前] 演算子の一覧を表示する
\dD[S+] [パターン] 照合順序の一覧を表示する
\dp [パターン] テーブル、ビュー、シーケンスのアクセス権一覧を表示する
\drds [パターン1 [パターン2]] データベース毎のロール(ユーザー)設定の一覧を表示する
\ds[S+] [パターン] シーケンスの一覧を表示する
\dt[S+] [パターン] テーブルの一覧を表示する
\dT[S+] [パターン] データ型の一覧を表示する
\du[+] [パターン] ロールの一覧を表示する
\dv[S+] [パターン] ビューの一覧を表示する
\dE[S+] [パターン] 外部テーブルの一覧を表示する
\dx[+] [パターン] 拡張の一覧を表示する
\l[+] データベースの一覧を表示する
\sf[+] 関数名 関数定義を表示する
\z [パターン] \dp と同じ

書式設定
\a 出力モードの 'unaligned' / 'aligned' を切り替える
\C タイトル テーブルのタイトルを設定する。指定がなければ解除
\f [文字列] 桁揃えを行わない(unaligned)問い合わせ出力におけるフィールド区切り文字を表示または設定
\H HTML の出力モードを切り替える(現在: オフ)
\pset 名前 [値] テーブル出力のオプションを設定する
(名前 := {format|border|expanded|fieldsep|fieldsep_zero|footer|null|
numericlocale|recordsep|recordsep_zero|tuples_only|title|tableattr|pager})
\t [on|off] 行のみを表示するか? (現在: オフ)
\T [文字列] HTML の <table> タグの属性をセット。引数がなければ解除
\x [on|off|auto] 拡張出力の切り替え(現在: オフ)

接続
\c[onnect] [DB名|- ユーザ名|- ホスト名|- ポート番号|-]
新しいデータベースに接続する (現在: "postgres")
\encoding [エンコーディング]
クライアントのエンコーディングを表示またはセット
\password [ユーザ名] ユーザのパスワードを安全に変更する
\conninfo 現在の接続に関する情報を表示する

オペレーティングシステム
\cd [DIR] カレントディレクトリを変更
\setenv NAME [VALUE] 環境変数の設定、設定解除を行う
\timing [on|off] コマンドのタイミングを切り替える(現在: オフ)
\! [コマンド] シェルでコマンドを実行、もしくは会話型シェルを起動

変数
\prompt [テキスト] 変数名 ユーザに内部変数をセットするよう促す
\set [変数名 [値]]
内部変数の値をセット。引数がない場合は一覧表示。
\unset 変数名 内部変数を削除する

ラージオブジェクト
\lo_export LOBOID ファイル名
\lo_import ファイル名 [コメント]
\lo_list
\lo_unlink LOBOID ラージオブジェクトの操作

前へ

コマンドプロンプトでWindows版PostgreSQL 9.2のデータベース一覧を表示した結果

次へ

萩の茶屋で「かけそば」と「玉子丼」を食べた