t
Title: UNLISTEN
Author: The PostgreSQL Global Development Group
Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
Date: 2021
Manual: PostgreSQL 10.19 Documentation
Source: PostgreSQL 10.19
Language: English

"UNLISTEN" "7" "2021" "PostgreSQL 10.19" "PostgreSQL 10.19 Documentation"
-----------------------------------------------------------------
* Define some portability stuff
-----------------------------------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
http://bugs.debian.org/507673
http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-----------------------------------------------------------------
* set default formatting
-----------------------------------------------------------------
disable hyphenation
disable justification (adjust text to left margin only)
-----------------------------------------------------------------
* MAIN CONTENT STARTS HERE *
-----------------------------------------------------------------
"NAME"
UNLISTEN - stop listening for a notification
"SYNOPSIS"
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(7) 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.

"SEE ALSO"
LISTEN(7), NOTIFY(7)