フックを使ったPostgreSQLの拡張機能を作ってみよう！ （第33回PostgreSQLアンカンファレンス@オンライン 発表資料） 2022年5月31日 NTTデータ 技術開発本部 先進コンピューティング技術センタ 加藤 慎也

1. © 2022 NTT DATA Corporation
フックを使ったPostgreSQLの拡張機能を作ってみよう！
2022年5月31日 第33回PostgreSQLアンカンファレンス@オンライン
株式会社NTTデータ 技術開発本部
加藤 慎也

2. © 2022 NTT DATA Corporation 2
自己紹介
• 名前
• 加藤 慎也 @ShinyaKato_
• 所属
• 株式会社NTTデータ 技術開発本部
• 業務
• PostgreSQLの研究開発やサポート業務に従事
• これまでのPostgreSQLアンカンファレンス
• 第20回
「PostgreSQL初心者がパッチを提案してからコミットされるまで」
• 第25回
「VSCodeで作るPostgreSQL開発環境」
• 第27回
「PostgreSQLのCREATEROLE権限強すぎ問題」

3. © 2022 NTT DATA Corporation 3
本講演について
• 講演資料
• NTTデータのSlideShareアカウントで公開予定（https://www.slideshare.net/nttdata-tech）
• 作成した拡張機能のソースコードはGitHubに公開中
（https://github.com/shinyaaa/pg_prohibit_truncate）
• 動作環境
• CentOS Stream 8.3
• PostgreSQL 14.2
• 前提条件
• PostgreSQL 14がインストールされていること
• PostgreSQLをコンパイルできる環境があること
• https://www.slideshare.net/nttdata-tech/postgresql-global-development-group-
postgresql-conference-japan-2021-nttdata
• https://qiita.com/sawada_masahiko/items/2fa99e422ec0eb35245c

4. © 2022 NTT DATA Corporation 4
作成する拡張機能
• PostgreSQLでTRUNCATEコマンドを実行しようとするとエラーを出力して終了する、
という拡張機能を作ります
• C言語で作成します
• フックを使います
• プログラム作成→コンパイル→リグレッションテスト
の順に紹介します

5. © 2022 NTT DATA Corporation 5
フック
• フック（英: hook）は、プログラム中の特定の箇所に、利用者が独自の処理を追加でき
るようにする仕組みである
• https://ja.wikipedia.org/wiki/%E3%83%95%E3%83%83%E3%82%AF_(%E3%8
3%97%E3%83%AD%E3%82%B0%E3%83%A9%E3%83%9F%E3%83%B3%E3
%82%B0)
• PostgreSQLのフック
• Planner Hook、Executor HookなどPostgreSQL 14には26個のフックがあります
• 公式ドキュメントではないですが、以下のドキュメントが役立ちます
• https://github.com/taminomara/psql-hooks

6. © 2022 NTT DATA Corporation 6
使用するフック
• ProcessUtility_hook
• PostgreSQLがユーティリティコマンドを処理する部分
main
PostmasterMain
ServerLoop
BackendStartup
BackendRun
PostgresMain
exec_simple_query
PortalRun
PortalRunMulti
PortalRunUtility
ProcessUtility
standard_ProcessUtility
ExecuteTruncate
TRUNCATEコマンド
実行時のコールスタック
フックがロード
されていたら実行する。
この部分を作る！！

7. © 2022 NTT DATA Corporation 7
ProcessUtility_hookはどのように使われているか
• pg_stat_statements
• SQL実行時の統計情報を記録するための拡張機能
• SQLコマンドが実行されるときに統計情報を取得する処理を差し込んでいる
• pgAudit
• 監査ログを取得するための拡張機能
• SQLコマンドが実行されるときに監査ログを出力する処理を差し込んでいる
• supautils
• 指定したロールの定義変更/付与を防ぐための拡張機能
• 特定のロールに対するSQLコマンドが実行されるときに、そのSQLの実行を終了する処理を差し込んでいる
特定の処理を差し込みたい場合や、PostgreSQLの権限やパラメータで
制御できない、より細やかな制御を行いたい場合などに有用

8. © 2021 NTT DATA Corporation 8
今回作るファイルの構成
ファイル 内容
.github/workflow/test.yaml GitHub Actionsのワークフロー
expected/pg_prohibit_truncate.out テスト実行時の期待される出力結果を記述
sql/pg_prohibit_truncate.sql テスト用SQLスクリプト
.gitignore Git管理対象外のファイルを記述
Makefile コンパイル用ファイル
README.md ドキュメント
pg_prohibit_truncate.c C言語ソースファイル
※太字のものを中心に紹介します

9. © 2022 NTT DATA Corporation 9
pg_prohibit_truncate.c
必要になる多くのものが宣言されているヘッダファイル。
ソースファイルの中で必ず初めにこのファイルをインクルード
する必要がある。
https://www.postgresql.org/docs/14/xfunc-c.html

10. © 2022 NTT DATA Corporation 10
pg_prohibit_truncate.c
関数管理インタフェースが宣言されているヘッダファイル。
ほとんどの場合でこのファイルをインクルードする必要がある。
https://www.postgresql.org/docs/14/xfunc-c.html

11. © 2022 NTT DATA Corporation 11
pg_prohibit_truncate.c
ProcessUtility_hookを使うために必要なヘッダファイル。
https://www.postgresql.org/docs/14/xfunc-c.html

12. © 2022 NTT DATA Corporation 12
pg_prohibit_truncate.c
メジャーバージョンが異なるPostgreSQL用にコンパイル
されたモジュールがサーバにロードされないために必要
https://www.postgresql.org/docs/14/xfunc-c.html

13. © 2022 NTT DATA Corporation 13
pg_prohibit_truncate.c
ファイルのロード直後に呼び出される関数。初期化処理を
記述。GUCパラメータの定義やフックのインストールなどを
行う。
https://www.postgresql.org/docs/14/xfunc-c.html

14. © 2022 NTT DATA Corporation 14
pg_prohibit_truncate.c
ファイルのアンロード時に呼び出される関数。
（現在のPostgreSQLではアンロードは無効になっている
ので、決して発生はしない）
https://www.postgresql.org/docs/14/xfunc-c.html

15. © 2022 NTT DATA Corporation 15
pg_prohibit_truncate.c
ファイルのアンロード時に、元のフックを再ロードするために
元のフックを保存しておく変数
https://www.postgresql.org/docs/14/xfunc-c.html

16. © 2022 NTT DATA Corporation 16
pg_prohibit_truncate.c
メインロジック。
引数はProcessUtility_hookと同じものを指定。
src/backend/tcop/utility.c

17. © 2022 NTT DATA Corporation 17
pg_prohibit_truncate.c
プランナが作成したプランツリーから、
どんなSQLコマンドが実行されるかを抽出

18. © 2022 NTT DATA Corporation 18
pg_prohibit_truncate.c
TRUNCATEコマンドなら、エラーを出力して、終了する。
※第一引数にエラーレベル（DEBUG1...DEBUG5,
INFO, NOTICE, WARNING, ERROR, LOG,
FATAL, PANIC）を指定でき、 ERROR、FATAL、
PANICの場合、その行以降のコードは実行されない。

19. © 2022 NTT DATA Corporation 19
pg_prohibit_truncate.c
TRUNCATEコマンド以外なら、元の処理を実行する。
src/backend/tcop/utility.c

20. © 2022 NTT DATA Corporation 20
pg_prohibit_truncate.c
定義したフックをProcessUtility_hookに
設定する。

21. © 2022 NTT DATA Corporation 21
pg_prohibit_truncate.c
アンロード時に元のフックに戻す処理を行う。

22. © 2022 NTT DATA Corporation 22
Makefile
共有ライブラリオブジェクトのリスト
https://www.postgresql.org/docs/14/extend-pgxs.html

23. © 2022 NTT DATA Corporation 23
Makefile
リグレッションテストケースのリスト
https://www.postgresql.org/docs/14/extend-pgxs.html

24. © 2022 NTT DATA Corporation 24
Makefile
PostgreSQLソースツリー内で
コンパイルしない場合の設定
https://www.postgresql.org/docs/14/extend-pgxs.html

25. © 2022 NTT DATA Corporation 25
Makefile
PostgreSQLソースツリー内で
コンパイルする場合の設定
https://www.postgresql.org/docs/14/extend-pgxs.html

26. © 2022 NTT DATA Corporation 26
sql/pg_prohibit_truncate.sql
• リグレッションテスト時に実行するSQLを記述する
• sqlというサブディレクトリ内に.sqlという拡張子をもつ必要がある

27. © 2022 NTT DATA Corporation 27
expected/pg_prohibit_truncate.out
• リグレッションテスト時の想定出力を記述する
• expectedというサブディレクトリ内に.outという拡張子をもつ必要がある

28. © 2022 NTT DATA Corporation 28
コンパイル
• コンパイル
$ make USE_PGXS=1 PG_CONFIG=/opt/pgsql-X.Y.Z/bin/pg_config
$ su
# make USE_PGXS=1 PG_CONFIG=/opt/pgsql-X.Y.Z/bin/pg_config install
# exit
PostgreSQLソースツリー内で
コンパイルしない場合に必要
pg_configプログラムへの
パスを指定

29. © 2022 NTT DATA Corporation 29
設定
• postgresql.conf
• PostgreSQL再起動
shared_preload_libraries='pg_prohibit_truncate'
$ pg_ctl restart

30. © 2022 NTT DATA Corporation 30
動作確認
$ psql
=# CREATE TABLE t (i INT);
CREATE TABLE
=# INSERT INTO t VALUES (1), (2);
INSERT 0 2
=# SELECT * FROM t;
i
---
1
2
(2 rows)
=# TRUNCATE t;
ERROR: do not use truncate
=# SELECT * FROM t;
i
---
1
2
(2 rows)

31. © 2022 NTT DATA Corporation 31
リグレッションテスト
• postgresql.confの設定をした状態で、PostgreSQL起動中に実行
$ make USE_PGXS=1 PG_CONFIG=/home/shinya/pgsql/14/bin/pg_config
installcheck
/home/shinya/pgsql/14/lib/pgxs/src/makefiles/../../src/test/regres
s/pg_regress --inputdir=./ --bindir='/home/shinya/pgsql/14/bin'
--dbname=contrib_regression pg_prohibit_truncate
(using postmaster on Unix socket, default port)
============== dropping database "contrib_regression"
==============
DROP DATABASE
============== creating database "contrib_regression"
==============
CREATE DATABASE
ALTER DATABASE
============== running regression test queries
==============
test pg_prohibit_truncate ... ok 16 ms

32. © 2022 NTT DATA Corporation
デモ
32

33. © 2022 NTT DATA Corporation 33
まとめ
• ProcessUtility_hookを使った拡張機能の開発を行いました
• PostgreSQLの高い拡張性を活かすために、ぜひ活用してください

34. © 2022 NTT DATA Corporation
その他、記載されている会社名、商品名、又はサービス名は、
各社の登録商標又は商標です。