Pgunconf14 pg13-psql

細かすぎて伝わらない
PostgreSQL 13 の psql 改善項目

自己紹介
● ぬこ＠横浜 (@nuko_yokohama)
● にゃーん
● 趣味でポスグレをやってる者だ

今日のお題
● psql のプロンプトに関する改善
– デフォルトのプロンプトで (%x) 表示
– PROMPT2 の桁揃え
● psql メタコマンドに関する改善
– gx, g のオプション指定追加
– 演算子クラス / 演算子族の表示
– d メタコマンドの Persistence 表示
– TOAST テーブルの d 表示の改善
– e メタコマンド終了時のクエリ表示
– 標準エラー出力指定
● その他
– --help のメッセージ変更
– ファイルパスの TAB 補完改善
– 結果出力中のエラーをキャッチして報告する
（今回未検証）
PostgreSQL 13 では psql の改善もいろいろ入った

psql のプロンプトに関する改善

デフォルトのプロンプトで (%x) 表示

● PostgreSQL 12 まで
testdb=# BEGIN;
BEGIN
testdb=# INSERT INTO test VALUES (1, 'abc');
INSERT 0 1
testdb=# ERROR;
ERROR: syntax error at or near "ERROR"
LINE 1: ERROR;
^
testdb=# ROLLBACK;
ROLLBACK
testdb=#
testdb=# BEGIN;
BEGIN
testdb=*# INSERT INTO test VALUES (1, 'abc');
INSERT 0 1
testdb=*# ERROR;
LINE 1: ERROR;
^
testdb=!# ROLLBACK;
ROLLBACK
testdb=#
● PostgreSQL 13

testdb=# BEGIN;
BEGIN
INSERT 0 1
testdb=# ERROR;
LINE 1: ERROR;
^
testdb=# ROLLBACK;
ROLLBACK
testdb=#
おわかりいただけたであろうか・・・
testdb=# BEGIN;
BEGIN
INSERT 0 1
testdb=*# ERROR;
LINE 1: ERROR;
^
testdb=!# ROLLBACK;
ROLLBACK
testdb=#
● PostgreSQL 13

testdb=# BEGIN;
BEGIN
INSERT 0 1
testdb=# ERROR;
LINE 1: ERROR;
^
testdb=# ROLLBACK;
ROLLBACK
testdb=#
testdb=# BEGIN;
BEGIN
INSERT 0 1
testdb=*# ERROR;
LINE 1: ERROR;
^
testdb=!# ROLLBACK;
ROLLBACK
testdb=#
● PostgreSQL 12 まで ● PostgreSQL 13
# の左になんかついている！

● プロンプトでトランザクション状態がわかるようになった。
トランザクションの状態 state プロンプト
トランザクション外
（セッション開始直後）
idle
#
トランザクション内 Idel in transaction
*#
トランザクション内で
異常発生時
Idle in transaction (abort)
!#

● トランザクション状態をプロンプトに展開する機能自体
は、 PostgreSQL 7.4 の頃から実装されていたりする。
● ただ、デフォルトの PROMPT1, PROMPT2 の設定が、 %x が
つかない設定値になっているため、この機能自体に気づいてい
ない人もいるかも（自分も今回、初めて知った）
● PostgreSQL 13 では、この PROMPT1, PROMPT2 のデフォル
ト値に %x が設定された。

PROMPT2 の桁揃え
testdb=# set PROMPT1 ' にゃーんにゃーん # '
にゃーんにゃーん # SELECT 'foo
testdb'# bar
testdb'# baz';
?column?
----------
foo +
bar +
baz
(1 row)
にゃーんにゃーん #
estdb=# set PROMPT1 ' にゃーんにゃーん # '
にゃーんにゃーん # set PROMPT2 %w
bar
baz';
?column?
----------
foo +
bar +
baz
(1 row)
● PostgreSQL 13

testdb=# set PROMPT1 ' にゃーんにゃーん # '
testdb'# bar
testdb'# baz';
?column?
----------
foo +
bar +
baz
(1 row)
estdb=# set PROMPT1 ' にゃーんにゃーん # '
にゃーんにゃーん # set PROMPT2 %w
bar
baz';
?column?
----------
foo +
bar +
baz
(1 row)
● PostgreSQL 13

● PostgreSQL 13 からは、 PROMPT2 （ SQL 入力が継続中のプ
ロンプト）に %w を設定すると、自動的に継続行先頭の列を
PROMPT1 のところに合わせてくれるようになった。
● この形が見やすい、という人なら、 .psqlrc に
set PROMPT2 %w
を設定しておくと良いかと。
● なお、自分の環境では設定してない。

psql メタコマンドに関する改善

gx, g のオプション指定追加

● psql を普段使ってない人にはこのメタコマンド自体が馴染みな
いかもしれないので、まずそこから説明。
● すごく雑にいうと、 psql 内で直前に実行したコマンドを再度実
行するというもの。
● g と gx の違い
– g は expanded 設定に従った結果表示をする。
– gx は必ず「拡張形式」で結果表示する。

● PostgreSQL 13 では、この g, gx に (option) が指定でき
るようになった。
● でも、 option って何を指定すればいいんだ？
→たとえば、 NULL を表す特殊な文字列を指定しておくとか。

演算子クラス / 演算子族の表示

testdb=# ?
（中略）
Informational
(options: S = show system objects, + = additional detail)
d[S+] list tables, views, and sequences
d[S+] NAME describe table, view, sequence, or index
da[S] [PATTERN] list aggregates
dA[+] [PATTERN] list access methods
db[+] [PATTERN] list tablespaces
testdb-# ?
（中略）
Informational
dAc[+] [AMPTRN [TYPEPTRN]] list operator classes
dAf[+] [AMPTRN [TYPEPTRN]] list operator families
dAo[+] [AMPTRN [OPFPTRN]] list operators of operator families
dAp [AMPTRN [OPFPTRN]] list procedures of operator families
● PostgreSQL 13

testdb=# ?
（中略）
Informational
testdb-# ?
（中略）
Informational
● PostgreSQL 13

testdb=# ?
（中略）
Informational
なんかめっさ増えてない？
testdb-# ?
（中略）
Informational
● PostgreSQL 13

● 演算子クラス / 演算子族 is 何？
● 雑に言うと、インデックス組み込みのためのなんか。
– https://www.postgresql.jp/document/12/html/xindex.html#XINDEX-OPFAMILY
● 自作の型をインデックス検索可能にしたり、全文検索用イン
デックスを使えるようにするためのなんか。

● PostgreSQL 13 で増えた psql の情報表示メタコマンド
メタコマンド内容
dAc 演算子クラスを表示する。
dAf 演算子族を表示する。
dAo 演算族に含まれる演算子を表示する。
dAp 演算子族を実装するプロシージャを表示する。
● 引数なしだと全てのなんかをリスト表示。
● 引数を指定するとパターンマッチするものだけ表示。

● こんな使い方の例もある。
● pg_bigm で全文インデックス設定するときに opclass の名前を忘れちまっ
て設定できない・・・
testdb=# CREATE INDEX data_bigm_idx ON test USING gin (data);
ERROR: data type text has no default operator class for access method "gin"
HINT: You must specify an operator class for the index or define a default operator class for the data type.
testdb=#
testdb=# dAc gin text
List of operator classes
AM | Input type | Storage type | Operator class | Default?
-----+------------+--------------+----------------+----------
gin | text | | gin_bigm_ops | no
(1 row)
testdb=# CREATE INDEX data_bigm_idx ON test USING gin (data gin_bigm_ops);
CREATE INDEX
testdb=#
● そんなときには dAc を叩いて Operator class を参照しよう。
にゃーん

d メタコマンドの Persistence 表示

testdb=# d+
List of relations
-----------+----------+-------+----------+------------+-------------
(3 rows)
testdb=# d+
List of relations
-----------+----------+-------+----------+-------------+------------+-------------
(3 rows)
● PostgreSQL 13

testdb=# d+
List of relations
-----------+----------+-------+----------+------------+-------------
(3 rows)
testdb=# d+
List of relations
-----------+----------+-------+----------+-------------+------------+-------------
(3 rows)
● PostgreSQL 13
UNLOGGED TABLE かどうか d+ でわかるようになった！

● （本題じゃないけど） UNLOGGED TABLE って生成直後は 8kB じゃなくて 16kB
なんだね・・・
● PostgreSQL 12 までであっても、 d テーブル名指定で、指定したテーブルが
unlogged や temporary かどうかは見分けられたが、一覧表示のときには、それが
表示されなかった。
Persistence 列の値意味
permanent WAL を出力する通常のテーブルを示す。
unlogged WAL を出力しない UNLOGGED テーブルを示す。
temporary 中間テーブルを示す。

TOAST テーブルの d 表示の改善

testdb=# d pg_toast.pg_toast_1262
TOAST table "pg_toast.pg_toast_1262"
Column | Type
------------+---------
chunk_id | oid
chunk_seq | integer
chunk_data | bytea
estdb=# d pg_toast.pg_toast_1262
Column | Type
------------+---------
chunk_id | oid
chunk_seq | integer
chunk_data | bytea
Owning table: "pg_catalog.pg_database"
Indexes:
"pg_toast_1262_index" PRIMARY KEY, btree (chunk_id, chunk_seq), tablespace "pg_global"
Tablespace: "pg_global"
● PostgreSQL 13

● PostgreSQL 13 では TOAST テーブル (pg_toast.pg_toast*)
を d コマンドで参照するときに、以下の情報が追加された。
追加された行内容
Owning: TOAST 元のテーブルが何か
Indexes: その TOAST テーブルのインデックス
Tablespace: どのテーブル空間に割り当てられているか
● 普段使う機能ではないだろうけど・・・。

e メタコマンド終了時のクエリ表示

$ psql testdb
psql (13beta1)
Type "help" for help.
testdb=# e
$ psql testdb
psql (13beta1)
testdb=# e
● PostgreSQL 13
VALUES (1, ' '),
(2, NULL)
~
:x
VALUES (1, ' '),
(2, NULL)
~
:x
testdb=# e
testdb-#
testdb=# e
testdb=# VALUES (1, ' '),
(2, NULL)
testdb-#

$ psql testdb
psql (13beta1)
testdb=# e
$ psql testdb
psql (13beta1)
testdb=# e
● PostgreSQL 13
VALUES (1, ' '),
(2, NULL)
~
:x
VALUES (1, ' '),
(2, NULL)
~
:x
testdb=# e
testdb-#
testdb=# e
(2, NULL)
testdb-#

$ psql testdb
psql (13beta1)
testdb=# e
$ psql testdb
psql (13beta1)
testdb=# e
● PostgreSQL 13
VALUES (1, ' '),
(2, NULL)
~
:x
VALUES (1, ' '),
(2, NULL)
~
:x
testdb=# e
testdb-#
testdb=# e
(2, NULL)
testdb-#
編集中のコマンドが e 終了時に表示されるようになった！

標準エラー出力指定
$ cat /tmp/q.txt
qecho stdout
warn stderr
$ ~/pgsql/pgsql-12/bin/psql -f /tmp/q.txt 1> /tmp/out.txt 2> /tmp/err.txt
$ cat /tmp/out.txt
stdout
$ cat /tmp/err.txt
psql:/tmp/q.txt:2: error: invalid command warn
$
cat /tmp/q.txt
qecho stdout
warn stderr
$ ~/pgsql/pgsql-13beta1/bin/psql -f /tmp/q.txt 1> /tmp/out.txt 2> /tmp/err.txt
$ cat /tmp/out.txt
stdout
$ cat /tmp/err.txt
stderr
$
● PostgreSQL 13

$ cat /tmp/q.txt
qecho stdout
warn stderr
$ cat /tmp/out.txt
stdout
$ cat /tmp/err.txt
$
cat /tmp/q.txt
qecho stdout
warn stderr
$ cat /tmp/out.txt
stdout
$ cat /tmp/err.txt
stderr
$
● PostgreSQL 13

$ cat /tmp/q.txt
qecho stdout
warn stderr
$ cat /tmp/out.txt
stdout
$ cat /tmp/err.txt
$
cat /tmp/q.txt
qecho stdout
warn stderr
$ cat /tmp/out.txt
stdout
$ cat /tmp/err.txt
stderr
$
● PostgreSQL 13
PostgreSQL 12 ではエラーになる・・・

● psql には任意のメッセージを出力するメタコマンドがある。
メタコマンド名機能サポートバージョン
qecho text [...] 任意のメッセージを標準出力に
出力する。
PostgreSQL 7.0
warn text [...] 任意のメッセージを標準エラー
出力に出力する。
PostgreSQL 13
● 標準出力への出力コマンドは遥か昔（西暦 2000 年！）からあったのに、
標準エラー出力への出力コマンドは、これまで対応していなかったらしい・・・

--help のメッセージ変更

$ ~/pgsql/pgsql-12/bin/psql --help
psql is the PostgreSQL interactive terminal.
（中略）
Report bugs to <pgsql-bugs@lists.postgresql.org>.
$
$ ~/pgsql/pgsql-13beta1/bin/psql --help
（中略）
PostgreSQL home page: <https://www.postgresql.org/>
$
● PostgreSQL 13

（中略）
$
（中略）
$
● PostgreSQL 13

（中略）
$
本家サイトの URL が出力されている！
（中略）
$
● PostgreSQL 13

● 実は他のユーティリティ (createdb, pg_basebackup, initdb
等）については、 PostgreSQL 12 でも、本家サイトの URL は
表示されていた。
● なぜか psql だけ PostgreSQL 12 までは表示されていなかった
らしい・・・。

ファイルパスの TAB 補完改善

testdb=# COPY test FROM '/tmp/t testdb=# COPY test FROM '/tmp/t
● PostgreSQL 13
ここで水平タブを入力すると・・・
testdb=# COPY test FROM /tmp/test.dat testdb=# COPY test FROM '/tmp/test.dat'

● PostgreSQL 13

● PostgreSQL 13
消える！シングルクォート！
にゃーん
改善っていうか Bug-Fix に近いような気がする。
残る！シングルクォート！

今日のお題（再掲）
● psql のプロンプトに関する改善
– デフォルトのプロンプトで (%x) 表示
– PROMPT2 の桁揃え
● psql メタコマンドに関する改善
– gx, g のオプション指定追加
– 演算子クラス / 演算子族の表示
– d メタコマンドの Persistence 表示
– TOAST テーブルの d 表示の改善
– e メタコマンド終了時のクエリ表示
– 標準エラー出力指定
● その他
– --help のメッセージ変更
– ファイルパスの TAB 補完改善
– 結果出力中のエラーをキャッチして報告する
（今回未検証）
PostgreSQL 13 では psql の改善もいろいろ入った
やはり
psql は
いいぞ

Pgunconf14 pg13-psql

Recommended

Recommended

More Related Content

What's hot

What's hot (12)

Similar to Pgunconf14 pg13-psql

Similar to Pgunconf14 pg13-psql (20)

More from Toshi Harada

More from Toshi Harada (20)

Recently uploaded

Recently uploaded (15)

Pgunconf14 pg13-psql