LISTEN/NOTIFY

PostgreSQLには、接続どうしで通知を送り合うLISTEN/NOTIFYが組み込まれている。 チャネル名を決めてLISTENで購読し、NOTIFYで通知を送る、シンプルなpub/subの仕組みである。

  • LISTEN [チャネル名]: チャネルを購読する
  • NOTIFY [チャネル名], '[ペイロード]': チャネルに通知を送る

通知は、同じデータベースでそのチャネルを購読しているすべての接続に届く。

使い方

psqlを2つ開いて試す。

1つ目のpsqlで、order_createdチャネルを購読する。

LISTEN order_created;

2つ目のpsqlで、order_createdチャネルに通知を送る。

NOTIFY order_created, 'order_id=42';

1つ目のpsqlに戻って、何かSQLを実行すると通知が表示される。 psqlは、SQLを実行したタイミングで届いた通知を確認して表示するためである。

postgres=# SELECT 1;
 ?column?
----------
        1
(1 row)

Asynchronous notification "order_created" with payload "order_id=42" received from server process with PID 86.

PIDは、通知を送った接続のバックエンドプロセスのIDである。

pg_notify関数で送る

NOTIFYのチャネル名とペイロードには固定の値しか書けない。 変数やカラムの値から組み立てる場合はpg_notify関数を使う。

SELECT pg_notify('order_created', 'order_id=43');

通知の注意点

通知はコミット時に届く

トランザクションの中で送った通知は、コミットした時点で届く。 ロールバックした場合は届かない。

BEGIN;
NOTIFY order_created, 'rolled back';
ROLLBACK;

上記の通知は、購読している接続に届かない。 データの変更と通知が食い違わないので、テーブルを更新したときの通知に向いている。

同じトランザクションの中で、同じチャネルに同じペイロードを複数回送ると、通知は1つにまとめられる。

BEGIN;
NOTIFY order_created, 'order_id=44';
NOTIFY order_created, 'order_id=44';
NOTIFY order_created, 'order_id=45';
COMMIT;

購読している接続には、2件だけ届く。

Asynchronous notification "order_created" with payload "order_id=44" received from server process with PID 100.
Asynchronous notification "order_created" with payload "order_id=45" received from server process with PID 100.

購読していない間の通知は受け取れない

通知は、その時点で購読している接続にだけ届く。 LISTENを実行する前に送られた通知は、あとから購読しても受け取れない。 接続が切れている間の通知も失われる。

取りこぼしが困る場合は、再接続したときにテーブルを確認し直す設計にする。

ペイロードは8000バイト未満

ペイロードは文字列で、8000バイト未満にする必要がある。 長すぎる場合はエラーになる。

postgres=# SELECT pg_notify('order_created', repeat('x', 8000));
ERROR:  payload string too long

大きなデータを渡したい場合は、ペイロードにIDだけを入れて、本体はテーブルから読む。

購読の確認と解除

pg_listening_channels関数で、現在の接続が購読しているチャネルを確認できる。

postgres=# SELECT pg_listening_channels();
 pg_listening_channels
-----------------------
 order_created
(1 row)

UNLISTENで購読を解除する。 UNLISTEN *を実行すると、すべてのチャネルの購読を解除する。

UNLISTEN order_created;

動作確認した環境

PostgreSQL 17.10のDockerコンテナで動作を確認した。

参考