begriffs open source - ai-pg/blob - full-docs/man7/NOTIFY.7

   1 '\" t
   2 .\"     Title: NOTIFY
   3 .\"    Author: The PostgreSQL Global Development Group
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2025
   6 .\"    Manual: PostgreSQL 18.0 Documentation
   7 .\"    Source: PostgreSQL 18.0
   8 .\"  Language: English
   9 .\"
  10 .TH "NOTIFY" "7" "2025" "PostgreSQL 18.0" "PostgreSQL 18.0 Documentation"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 NOTIFY \- generate a notification
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 NOTIFY \fIchannel\fR [ , \fIpayload\fR ]
  36 .fi
  37 .SH "DESCRIPTION"
  38 .PP
  39 The
  40 \fBNOTIFY\fR
  41 command sends a notification event together with an optional
  42 \(lqpayload\(rq
  43 string to each client application that has previously executed
  44 \fBLISTEN \fR\fB\fIchannel\fR\fR
  45 for the specified channel name in the current database\&. Notifications are visible to all users\&.
  46 .PP
  47 \fBNOTIFY\fR
  48 provides a simple interprocess communication mechanism for a collection of processes accessing the same
  49 PostgreSQL
  50 database\&. A payload string can be sent along with the notification, and higher\-level mechanisms for passing structured data can be built by using tables in the database to pass additional data from notifier to listener(s)\&.
  51 .PP
  52 The information passed to the client for a notification event includes the notification channel name, the notifying session\*(Aqs server process
  53 PID, and the payload string, which is an empty string if it has not been specified\&.
  54 .PP
  55 It is up to the database designer to define the channel names that will be used in a given database and what each one means\&. Commonly, the channel name is the same as the name of some table in the database, and the notify event essentially means,
  56 \(lqI changed this table, take a look at it to see what\*(Aqs new\(rq\&. But no such association is enforced by the
  57 \fBNOTIFY\fR
  58 and
  59 \fBLISTEN\fR
  60 commands\&. For example, a database designer could use several different channel names to signal different sorts of changes to a single table\&. Alternatively, the payload string could be used to differentiate various cases\&.
  61 .PP
  62 When
  63 \fBNOTIFY\fR
  64 is used to signal the occurrence of changes to a particular table, a useful programming technique is to put the
  65 \fBNOTIFY\fR
  66 in a statement trigger that is triggered by table updates\&. In this way, notification happens automatically when the table is changed, and the application programmer cannot accidentally forget to do it\&.
  67 .PP
  68 \fBNOTIFY\fR
  69 interacts with SQL transactions in some important ways\&. Firstly, if a
  70 \fBNOTIFY\fR
  71 is executed inside a transaction, the notify events are not delivered until and unless the transaction is committed\&. This is appropriate, since if the transaction is aborted, all the commands within it have had no effect, including
  72 \fBNOTIFY\fR\&. But it can be disconcerting if one is expecting the notification events to be delivered immediately\&. Secondly, if a listening session receives a notification signal while it is within a transaction, the notification event will not be delivered to its connected client until just after the transaction is completed (either committed or aborted)\&. Again, the reasoning is that if a notification were delivered within a transaction that was later aborted, one would want the notification to be undone somehow \(em but the server cannot
  73 \(lqtake back\(rq
  74 a notification once it has sent it to the client\&. So notification events are only delivered between transactions\&. The upshot of this is that applications using
  75 \fBNOTIFY\fR
  76 for real\-time signaling should try to keep their transactions short\&.
  77 .PP
  78 If the same channel name is signaled multiple times with identical payload strings within the same transaction, only one instance of the notification event is delivered to listeners\&. On the other hand, notifications with distinct payload strings will always be delivered as distinct notifications\&. Similarly, notifications from different transactions will never get folded into one notification\&. Except for dropping later instances of duplicate notifications,
  79 \fBNOTIFY\fR
  80 guarantees that notifications from the same transaction get delivered in the order they were sent\&. It is also guaranteed that messages from different transactions are delivered in the order in which the transactions committed\&.
  81 .PP
  82 It is common for a client that executes
  83 \fBNOTIFY\fR
  84 to be listening on the same notification channel itself\&. In that case it will get back a notification event, just like all the other listening sessions\&. Depending on the application logic, this could result in useless work, for example, reading a database table to find the same updates that that session just wrote out\&. It is possible to avoid such extra work by noticing whether the notifying session\*(Aqs server process
  85 PID
  86 (supplied in the notification event message) is the same as one\*(Aqs own session\*(Aqs
  87 PID
  88 (available from
  89 libpq)\&. When they are the same, the notification event is one\*(Aqs own work bouncing back, and can be ignored\&.
  90 .SH "PARAMETERS"
  91 .PP
  92 \fIchannel\fR
  93 .RS 4
  94 Name of the notification channel to be signaled (any identifier)\&.
  95 .RE
  96 .PP
  97 \fIpayload\fR
  98 .RS 4
  99 The
 100 \(lqpayload\(rq
 101 string to be communicated along with the notification\&. This must be specified as a simple string literal\&. In the default configuration it must be shorter than 8000 bytes\&. (If binary data or large amounts of information need to be communicated, it\*(Aqs best to put it in a database table and send the key of the record\&.)
 102 .RE
 103 .SH "NOTES"
 104 .PP
 105 There is a queue that holds notifications that have been sent but not yet processed by all listening sessions\&. If this queue becomes full, transactions calling
 106 \fBNOTIFY\fR
 107 will fail at commit\&. The queue is quite large (8GB in a standard installation) and should be sufficiently sized for almost every use case\&. However, no cleanup can take place if a session executes
 108 \fBLISTEN\fR
 109 and then enters a transaction for a very long time\&. Once the queue is half full you will see warnings in the log file pointing you to the session that is preventing cleanup\&. In this case you should make sure that this session ends its current transaction so that cleanup can proceed\&.
 110 .PP
 111 The function
 112 \fBpg_notification_queue_usage\fR
 113 returns the fraction of the queue that is currently occupied by pending notifications\&. See
 114 Section\ \&9.27
 115 for more information\&.
 116 .PP
 117 A transaction that has executed
 118 \fBNOTIFY\fR
 119 cannot be prepared for two\-phase commit\&.
 120 .SS "pg_notify"
 121 .PP
 122 To send a notification you can also use the function
 123 \fBpg_notify\fR(text, text)\&. The function takes the channel name as the first argument and the payload as the second\&. The function is much easier to use than the
 124 \fBNOTIFY\fR
 125 command if you need to work with non\-constant channel names and payloads\&.
 126 .SH "EXAMPLES"
 127 .PP
 128 Configure and execute a listen/notify sequence from
 129 psql:
 130 .sp
 131 .if n \{\
 132 .RS 4
 133 .\}
 134 .nf
 135 LISTEN virtual;
 136 NOTIFY virtual;
 137 Asynchronous notification "virtual" received from server process with PID 8448\&.
 138 NOTIFY virtual, \*(AqThis is the payload\*(Aq;
 139 Asynchronous notification "virtual" with payload "This is the payload" received from server process with PID 8448\&.
 140
 141 LISTEN foo;
 142 SELECT pg_notify(\*(Aqfo\*(Aq || \*(Aqo\*(Aq, \*(Aqpay\*(Aq || \*(Aqload\*(Aq);
 143 Asynchronous notification "foo" with payload "payload" received from server process with PID 14728\&.
 144 .fi
 145 .if n \{\
 146 .RE
 147 .\}
 148 .SH "COMPATIBILITY"
 149 .PP
 150 There is no
 151 \fBNOTIFY\fR
 152 statement in the SQL standard\&.
 153 .SH "SEE ALSO"
 154 \fBLISTEN\fR(7), \fBUNLISTEN\fR(7), max_notify_queue_pages