blob: 75403fda63513dfb69494fa3a01a119b34a364ad (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
'\" t
.\" Title: dblink_get_notify
.\" Author: The PostgreSQL Global Development Group
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 2024
.\" Manual: PostgreSQL 16.2 Documentation
.\" Source: PostgreSQL 16.2
.\" Language: English
.\"
.TH "DBLINK_GET_NOTIFY" "3" "2024" "PostgreSQL 16.2" "PostgreSQL 16.2 Documentation"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
dblink_get_notify \- retrieve async notifications on a connection
.SH "SYNOPSIS"
.sp
.nf
dblink_get_notify() returns setof (notify_name text, be_pid int, extra text)
dblink_get_notify(text connname) returns setof (notify_name text, be_pid int, extra text)
.fi
.SH "DESCRIPTION"
.PP
\fBdblink_get_notify\fR
retrieves notifications on either the unnamed connection, or on a named connection if specified\&. To receive notifications via dblink,
\fBLISTEN\fR
must first be issued, using
\fBdblink_exec\fR\&. For details see
\fBLISTEN\fR(7)
and
\fBNOTIFY\fR(7)\&.
.SH "ARGUMENTS"
.PP
\fIconnname\fR
.RS 4
The name of a named connection to get notifications on\&.
.RE
.SH "RETURN VALUE"
.PP
Returns
setof (notify_name text, be_pid int, extra text), or an empty set if none\&.
.SH "EXAMPLES"
.sp
.if n \{\
.RS 4
.\}
.nf
SELECT dblink_exec(\*(AqLISTEN virtual\*(Aq);
dblink_exec
\-\-\-\-\-\-\-\-\-\-\-\-\-
LISTEN
(1 row)
SELECT * FROM dblink_get_notify();
notify_name | be_pid | extra
\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-
(0 rows)
NOTIFY virtual;
NOTIFY
SELECT * FROM dblink_get_notify();
notify_name | be_pid | extra
\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-
virtual | 1229 |
(1 row)
.fi
.if n \{\
.RE
.\}
|
