← Back to branch summary

~ubuntu-branches/debian/sid/postgresql-9.3/sid

« back to all changes in this revision

Viewing changes to doc/src/sgml/html/sql-unlisten.html

  • Committer: Package Import Robot
  • Author(s): Martin Pitt
  • Date: 2013-05-08 05:39:52 UTC
  • Revision ID: package-import@ubuntu.com-20130508053952-1j7uilp7mjtrvq8q
Tags: upstream-9.3~beta1
Import upstream version 9.3~beta1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/src/sgml/html/sql-unlisten.html
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 
2
<HTML
 
3
><HEAD
 
4
><TITLE
 
5
>UNLISTEN</TITLE
 
6
><META
 
7
NAME="GENERATOR"
 
8
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
 
9
REV="MADE"
 
10
HREF="mailto:pgsql-docs@postgresql.org"><LINK
 
11
REL="HOME"
 
12
TITLE="PostgreSQL 9.3beta1 Documentation"
 
13
HREF="index.html"><LINK
 
14
REL="UP"
 
15
TITLE="SQL Commands"
 
16
HREF="sql-commands.html"><LINK
 
17
REL="PREVIOUS"
 
18
TITLE="TRUNCATE"
 
19
HREF="sql-truncate.html"><LINK
 
20
REL="NEXT"
 
21
TITLE="UPDATE"
 
22
HREF="sql-update.html"><LINK
 
23
REL="STYLESHEET"
 
24
TYPE="text/css"
 
25
HREF="stylesheet.css"><META
 
26
HTTP-EQUIV="Content-Type"
 
27
CONTENT="text/html; charset=ISO-8859-1"><META
 
28
NAME="creation"
 
29
CONTENT="2013-05-06T21:00:50"></HEAD
 
30
><BODY
 
31
CLASS="REFENTRY"
 
32
><DIV
 
33
CLASS="NAVHEADER"
 
34
><TABLE
 
35
SUMMARY="Header navigation table"
 
36
WIDTH="100%"
 
37
BORDER="0"
 
38
CELLPADDING="0"
 
39
CELLSPACING="0"
 
40
><TR
 
41
><TH
 
42
COLSPAN="5"
 
43
ALIGN="center"
 
44
VALIGN="bottom"
 
45
><A
 
46
HREF="index.html"
 
47
>PostgreSQL 9.3beta1 Documentation</A
 
48
></TH
 
49
></TR
 
50
><TR
 
51
><TD
 
52
WIDTH="10%"
 
53
ALIGN="left"
 
54
VALIGN="top"
 
55
><A
 
56
TITLE="TRUNCATE"
 
57
HREF="sql-truncate.html"
 
58
ACCESSKEY="P"
 
59
>Prev</A
 
60
></TD
 
61
><TD
 
62
WIDTH="10%"
 
63
ALIGN="left"
 
64
VALIGN="top"
 
65
><A
 
66
HREF="sql-commands.html"
 
67
ACCESSKEY="U"
 
68
>Up</A
 
69
></TD
 
70
><TD
 
71
WIDTH="60%"
 
72
ALIGN="center"
 
73
VALIGN="bottom"
 
74
></TD
 
75
><TD
 
76
WIDTH="20%"
 
77
ALIGN="right"
 
78
VALIGN="top"
 
79
><A
 
80
TITLE="UPDATE"
 
81
HREF="sql-update.html"
 
82
ACCESSKEY="N"
 
83
>Next</A
 
84
></TD
 
85
></TR
 
86
></TABLE
 
87
><HR
 
88
ALIGN="LEFT"
 
89
WIDTH="100%"></DIV
 
90
><H1
 
91
><A
 
92
NAME="SQL-UNLISTEN"
 
93
></A
 
94
>UNLISTEN</H1
 
95
><DIV
 
96
CLASS="REFNAMEDIV"
 
97
><A
 
98
NAME="AEN81573"
 
99
></A
 
100
><H2
 
101
>Name</H2
 
102
>UNLISTEN&nbsp;--&nbsp;stop listening for a notification</DIV
 
103
><DIV
 
104
CLASS="REFSYNOPSISDIV"
 
105
><A
 
106
NAME="AEN81578"
 
107
></A
 
108
><H2
 
109
>Synopsis</H2
 
110
><PRE
 
111
CLASS="SYNOPSIS"
 
112
>UNLISTEN { <TT
 
113
CLASS="REPLACEABLE"
 
114
><I
 
115
>channel</I
 
116
></TT
 
117
> | * }</PRE
 
118
></DIV
 
119
><DIV
 
120
CLASS="REFSECT1"
 
121
><A
 
122
NAME="AEN81581"
 
123
></A
 
124
><H2
 
125
>Description</H2
 
126
><P
 
127
>   <TT
 
128
CLASS="COMMAND"
 
129
>UNLISTEN</TT
 
130
> is used to remove an existing
 
131
   registration for <TT
 
132
CLASS="COMMAND"
 
133
>NOTIFY</TT
 
134
> events.
 
135
   <TT
 
136
CLASS="COMMAND"
 
137
>UNLISTEN</TT
 
138
> cancels any existing registration of
 
139
   the current <SPAN
 
140
CLASS="PRODUCTNAME"
 
141
>PostgreSQL</SPAN
 
142
> session as a
 
143
   listener on the notification channel named <TT
 
144
CLASS="REPLACEABLE"
 
145
><I
 
146
>channel</I
 
147
></TT
 
148
>.  The special wildcard
 
149
   <TT
 
150
CLASS="LITERAL"
 
151
>*</TT
 
152
> cancels all listener registrations for the
 
153
   current session.
 
154
  </P
 
155
><P
 
156
>   <A
 
157
HREF="sql-notify.html"
 
158
>NOTIFY</A
 
159
>
 
160
   contains a more extensive
 
161
   discussion of the use of <TT
 
162
CLASS="COMMAND"
 
163
>LISTEN</TT
 
164
> and
 
165
   <TT
 
166
CLASS="COMMAND"
 
167
>NOTIFY</TT
 
168
>.
 
169
  </P
 
170
></DIV
 
171
><DIV
 
172
CLASS="REFSECT1"
 
173
><A
 
174
NAME="AEN81594"
 
175
></A
 
176
><H2
 
177
>Parameters</H2
 
178
><P
 
179
></P
 
180
><DIV
 
181
CLASS="VARIABLELIST"
 
182
><DL
 
183
><DT
 
184
><TT
 
185
CLASS="REPLACEABLE"
 
186
><I
 
187
>channel</I
 
188
></TT
 
189
></DT
 
190
><DD
 
191
><P
 
192
>      Name of a notification channel (any identifier).
 
193
     </P
 
194
></DD
 
195
><DT
 
196
><TT
 
197
CLASS="LITERAL"
 
198
>*</TT
 
199
></DT
 
200
><DD
 
201
><P
 
202
>      All current listen registrations for this session are cleared.
 
203
     </P
 
204
></DD
 
205
></DL
 
206
></DIV
 
207
></DIV
 
208
><DIV
 
209
CLASS="REFSECT1"
 
210
><A
 
211
NAME="AEN81607"
 
212
></A
 
213
><H2
 
214
>Notes</H2
 
215
><P
 
216
>   You can unlisten something you were not listening for; no warning or error
 
217
   will appear.
 
218
  </P
 
219
><P
 
220
>   At the end of each session, <TT
 
221
CLASS="COMMAND"
 
222
>UNLISTEN *</TT
 
223
> is
 
224
   automatically executed.
 
225
  </P
 
226
><P
 
227
>   A transaction that has executed <TT
 
228
CLASS="COMMAND"
 
229
>UNLISTEN</TT
 
230
> cannot be
 
231
   prepared for two-phase commit.
 
232
  </P
 
233
></DIV
 
234
><DIV
 
235
CLASS="REFSECT1"
 
236
><A
 
237
NAME="AEN81614"
 
238
></A
 
239
><H2
 
240
>Examples</H2
 
241
><P
 
242
>   To make a registration:
 
243
 
 
244
</P><PRE
 
245
CLASS="PROGRAMLISTING"
 
246
>LISTEN virtual;
 
247
NOTIFY virtual;
 
248
Asynchronous notification "virtual" received from server process with PID 8448.</PRE
 
249
><P>
 
250
  </P
 
251
><P
 
252
>   Once <TT
 
253
CLASS="COMMAND"
 
254
>UNLISTEN</TT
 
255
> has been executed, further <TT
 
256
CLASS="COMMAND"
 
257
>NOTIFY</TT
 
258
>
 
259
   messages will be ignored:
 
260
 
 
261
</P><PRE
 
262
CLASS="PROGRAMLISTING"
 
263
>UNLISTEN virtual;
 
264
NOTIFY virtual;
 
265
-- no NOTIFY event is received</PRE
 
266
><P></P
 
267
></DIV
 
268
><DIV
 
269
CLASS="REFSECT1"
 
270
><A
 
271
NAME="AEN81622"
 
272
></A
 
273
><H2
 
274
>Compatibility</H2
 
275
><P
 
276
>   There is no <TT
 
277
CLASS="COMMAND"
 
278
>UNLISTEN</TT
 
279
> command in the SQL standard.
 
280
  </P
 
281
></DIV
 
282
><DIV
 
283
CLASS="REFSECT1"
 
284
><A
 
285
NAME="AEN81626"
 
286
></A
 
287
><H2
 
288
>See Also</H2
 
289
><A
 
290
HREF="sql-listen.html"
 
291
>LISTEN</A
 
292
>, <A
 
293
HREF="sql-notify.html"
 
294
>NOTIFY</A
 
295
></DIV
 
296
><DIV
 
297
CLASS="NAVFOOTER"
 
298
><HR
 
299
ALIGN="LEFT"
 
300
WIDTH="100%"><TABLE
 
301
SUMMARY="Footer navigation table"
 
302
WIDTH="100%"
 
303
BORDER="0"
 
304
CELLPADDING="0"
 
305
CELLSPACING="0"
 
306
><TR
 
307
><TD
 
308
WIDTH="33%"
 
309
ALIGN="left"
 
310
VALIGN="top"
 
311
><A
 
312
HREF="sql-truncate.html"
 
313
ACCESSKEY="P"
 
314
>Prev</A
 
315
></TD
 
316
><TD
 
317
WIDTH="34%"
 
318
ALIGN="center"
 
319
VALIGN="top"
 
320
><A
 
321
HREF="index.html"
 
322
ACCESSKEY="H"
 
323
>Home</A
 
324
></TD
 
325
><TD
 
326
WIDTH="33%"
 
327
ALIGN="right"
 
328
VALIGN="top"
 
329
><A
 
330
HREF="sql-update.html"
 
331
ACCESSKEY="N"
 
332
>Next</A
 
333
></TD
 
334
></TR
 
335
><TR
 
336
><TD
 
337
WIDTH="33%"
 
338
ALIGN="left"
 
339
VALIGN="top"
 
340
>TRUNCATE</TD
 
341
><TD
 
342
WIDTH="34%"
 
343
ALIGN="center"
 
344
VALIGN="top"
 
345
><A
 
346
HREF="sql-commands.html"
 
347
ACCESSKEY="U"
 
348
>Up</A
 
349
></TD
 
350
><TD
 
351
WIDTH="33%"
 
352
ALIGN="right"
 
353
VALIGN="top"
 
354
>UPDATE</TD
 
355
></TR
 
356
></TABLE
 
357
></DIV
 
358
></BODY
 
359
></HTML
 
360
>
 
 
b'\\ No newline at end of file'