← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/postgresql-9.1/oneiric-security

« back to all changes in this revision

Viewing changes to doc/src/sgml/man3/dblink_get_notify.3

  • Committer: Bazaar Package Importer
  • Author(s): Martin Pitt
  • Date: 2011-05-11 10:41:53 UTC
  • Revision ID: james.westby@ubuntu.com-20110511104153-psbh2o58553fv1m0
Tags: upstream-9.1~beta1
Import upstream version 9.1~beta1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/src/sgml/man3/dblink_get_notify.3
 
1
'\" t
 
2
.\"     Title: dblink_get_notify
 
3
.\"    Author: The PostgreSQL Global Development Group
 
4
.\" Generator: DocBook XSL Stylesheets v1.75.1 <http://docbook.sf.net/>
 
5
.\"      Date: 2011-04-27
 
6
.\"    Manual: PostgreSQL 9.1beta1 Documentation
 
7
.\"    Source: PostgreSQL 9.1beta1
 
8
.\"  Language: English
 
9
.\"
 
10
.TH "DBLINK_GET_NOTIFY" "3" "2011-04-27" "PostgreSQL 9.1beta1" "PostgreSQL 9.1beta1 Documentation"
 
11
.\" -----------------------------------------------------------------
 
12
.\" * set default formatting
 
13
.\" -----------------------------------------------------------------
 
14
.\" disable hyphenation
 
15
.nh
 
16
.\" disable justification (adjust text to left margin only)
 
17
.ad l
 
18
.\" -----------------------------------------------------------------
 
19
.\" * MAIN CONTENT STARTS HERE *
 
20
.\" -----------------------------------------------------------------
 
21
.SH "NAME"
 
22
dblink_get_notify \- retrieve async notifications on a connection
 
23
.SH "SYNOPSIS"
 
24
.sp
 
25
.nf
 
26
dblink_get_notify() returns setof (notify_name text, be_pid int, extra text)
 
27
dblink_get_notify(text connname) returns setof (notify_name text, be_pid int, extra text)
 
28
.fi
 
29
.SH "DESCRIPTION"
 
30
.PP
 
31
\fBdblink_get_notify\fR
 
32
retrieves notifications on either the unnamed connection, or on a named connection if specified\&. To receive notifications via dblink,
 
33
\fBLISTEN\fR
 
34
must first be issued, using
 
35
\fBdblink_exec\fR\&. For details see
 
36
\fBLISTEN\fR(7)
 
37
and
 
38
\fBNOTIFY\fR(7)\&.
 
39
.SH "ARGUMENTS"
 
40
.PP
 
41
\fIconname\fR
 
42
.RS 4
 
43
The name of a named connection to get notifications on\&.
 
44
.RE
 
45
.SH "RETURN VALUE"
 
46
.PP
 
47
Returns
 
48
setof (notify_name text, be_pid int, extra text), or an empty set if none\&.
 
49
.SH "EXAMPLE"
 
50
.sp
 
51
.if n \{\
 
52
.RS 4
 
53
.\}
 
54
.nf
 
55
SELECT dblink_exec(\(aqLISTEN virtual\(aq);
 
56
 dblink_exec 
 
57
\-\-\-\-\-\-\-\-\-\-\-\-\-
 
58
 LISTEN
 
59
(1 row)
 
60
 
 
61
SELECT * FROM dblink_get_notify();
 
62
 notify_name | be_pid | extra
 
63
\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-
 
64
(0 rows)
 
65
 
 
66
NOTIFY virtual;
 
67
NOTIFY
 
68
 
 
69
SELECT * FROM dblink_get_notify();
 
70
 notify_name | be_pid | extra
 
71
\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-
 
72
 virtual     |   1229 |
 
73
(1 row)
 
74
.fi
 
75
.if n \{\
 
76
.RE
 
77
.\}