UNLISTEN

stop listening for a notification

English manual coverage begins with PostgreSQL 6.4. Source history and runtime observations have their own recorded version boundaries.

Reading PG 18·Select a recorded version

6.4 6.5 7.0 7.1 7.2 7.3 7.4 8.0 8.1 8.2 8.3 8.4 9.0 9.1 9.2 9.3 9.4 9.5 9.6 10 11 12 13 14 15 16 17 18 19 20

anchor: SQL-UNLISTEN
file: sql-unlisten.html
lang: en
name: UNLISTEN
purpose: stop listening for a notification
purpose zh: 停止监听通知
sections same as: Unknown
slug: 18
synopsis html: UNLISTEN { <em class="replaceable"><code>channel</code></em> | * }
synopsis text: UNLISTEN { channel | * }

Syntax

UNLISTEN { channel | * }

Syntax diagrams

Read left to right. Branches are choices, bypasses are optional, loops repeat. Select an underlined parameter to open its rule.

Definition PG 18

UNLISTEN { channel | * }

Description

UNLISTEN is used to remove an existing registration for NOTIFY events. UNLISTEN cancels any existing registration of the current PostgreSQL session as a listener on the notification channel named channel. The special wildcard * cancels all listener registrations for the current session.

NOTIFY contains a more extensive discussion of the use of LISTEN and NOTIFY.

Parameters

channel: Name of a notification channel (any identifier).
*: All current listen registrations for this session are cleared.

Notes

You can unlisten something you were not listening for; no warning or error will appear.

At the end of each session, UNLISTEN * is automatically executed.

A transaction that has executed UNLISTEN cannot be prepared for two-phase commit.

Examples

To make a registration:

LISTEN virtual;
NOTIFY virtual;
Asynchronous notification "virtual" received from server process with PID 8448.

Once UNLISTEN has been executed, further NOTIFY messages will be ignored:

UNLISTEN virtual;
NOTIFY virtual;
-- no NOTIFY event is received

Compatibility

There is no UNLISTEN command in the SQL standard.

Compare versions

Source references

Full definition and evidence JSON

Definition sources

center · PostgreSQL 18 · wiki-repair-20261023:243203e2799d289d8e247ac170a5e2e58092eb98bb5b683b755a3f4d183d94e5

Text language: en · wiki-repair-20261023:243203e2799d289d8e247ac170a5e2e58092eb98bb5b683b755a3f4d183d94e5