File: sql-listen.html

package info (click to toggle)
mpsql 2.1-2
links: PTS
area: non-free
in suites: potato
size: 3,528 kB
ctags: 4,886
sloc: ansic: 35,184; makefile: 3,761; sh: 44
file content (345 lines) | stat: -rw-r--r-- 5,362 bytes
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML
><HEAD
><TITLE
>LISTEN</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet version 1.19"><LINK
REL="HOME"
TITLE="PostgreSQL User's Guide"
HREF="user.html"><LINK
REL="UP"
TITLE="SQL Commands"
HREF="sql-commands.html"><LINK
REL="PREVIOUS"
TITLE="INSERT"
HREF="sql-insert.html"><LINK
REL="NEXT"
TITLE="LOAD"
HREF="sql-load.html"></HEAD
><BODY
BGCOLOR="#FFFFFF"
TEXT="#000000"
><DIV
CLASS="NAVHEADER"
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>PostgreSQL User's Guide</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="sql-insert.html"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="sql-load.html"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
>LISTEN</H1
><DIV
CLASS="REFNAMEDIV"
><H2
>Name</H2
>LISTEN &#8212; Listen for notification on a notify condition</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><PRE
CLASS="SYNOPSIS"
>LISTEN <TT
CLASS="REPLACEABLE"
><I
>notifyname</I
></TT
></PRE
><DIV
CLASS="REFSECT2"
><H3
>Inputs</H3
><P
></P
><P
></P
><DL
><DT
><TT
CLASS="REPLACEABLE"
><I
>notifyname</I
></TT
></DT
><DD
><P
>Name of notify condition.&#13;</P
></DD
></DL
></DIV
><DIV
CLASS="REFSECT2"
><H3
>Outputs</H3
><P
>&#13;<P
></P
></P><DL
><DT
><SPAN
CLASS="RETURNVALUE"
>LISTEN</SPAN
></DT
><DD
><P
>Message returned upon successful completion of registration.</P
></DD
><DT
><SPAN
CLASS="RETURNVALUE"
>NOTICE Async_Listen: We are already listening on notifyname</SPAN
></DT
><DD
><P
>If this backend is already registered for that notify condition.</P
></DD
></DL
><P></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><H2
>Description</H2
><P
>LISTEN registers the current <SPAN
CLASS="PRODUCTNAME"
>Postgres</SPAN
> backend as a
listener on the notify condition
<TT
CLASS="REPLACEABLE"
><I
>notifyname</I
></TT
>.&#13;</P
><P
>Whenever the command 
<B
CLASS="COMMAND"
>NOTIFY <TT
CLASS="REPLACEABLE"
><I
>notifyname</I
></TT
></B
>
is invoked, either by this backend or another one connected to
the same database, all the backends currently listening on that notify
condition are notified, and each will in turn notify its connected
frontend application.  See the discussion of <B
CLASS="COMMAND"
>NOTIFY</B
>
for more information.&#13;</P
><P
>A backend can be deregistered for a given notify condition with the
<B
CLASS="COMMAND"
>UNLISTEN</B
> command.  Also, a backend's listen registrations
are automatically cleared when the backend process exits.&#13;</P
><P
>The method a frontend application must use to detect notify events depends on
which <SPAN
CLASS="PRODUCTNAME"
>Postgres</SPAN
> application programming interface it
uses.  With the basic libpq library, the application issues
<B
CLASS="COMMAND"
>LISTEN</B
> as an ordinary SQL command, and then must
periodically call the routine <TT
CLASS="FUNCTION"
>PQnotifies</TT
> to find out
whether any notify events have been received.  Other interfaces such as
libpgtcl provide higher-level methods for handling notify events; indeed,
with libpgtcl the application programmer should not even issue
<B
CLASS="COMMAND"
>LISTEN</B
> or <B
CLASS="COMMAND"
>UNLISTEN</B
> directly.  See the
documentation for the library you are using for more details.&#13;</P
><P
>The reference page for <B
CLASS="COMMAND"
>NOTIFY</B
> contains a more extensive
discussion of the use of <B
CLASS="COMMAND"
>LISTEN</B
> and
<B
CLASS="COMMAND"
>NOTIFY</B
>.&#13;</P
><DIV
CLASS="REFSECT2"
><H3
>Notes</H3
><P
><TT
CLASS="REPLACEABLE"
><I
>notifyname</I
></TT
>
can be any string valid as a name;
it need not correspond to the name of any actual table.  If
<TT
CLASS="REPLACEABLE"
><I
>notifyname</I
></TT
>
is enclosed in double-quotes, it need not even be a syntactically
valid name, but can be any string up to 31 characters long.&#13;</P
><P
>In some previous releases of
<SPAN
CLASS="PRODUCTNAME"
>Postgres</SPAN
>,
<TT
CLASS="REPLACEABLE"
><I
>notifyname</I
></TT
>
had to be enclosed in double-quotes when it did not correspond to any existing
table name, even if syntactically valid as a name.  That is no longer required.&#13;</P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><H2
>Usage</H2
><P
><PRE
CLASS="PROGRAMLISTING"
>-- Configure and execute a listen/notify sequence from psql
postgres=&#62; listen virtual;
LISTEN
postgres=&#62; notify virtual;
NOTIFY
ASYNC NOTIFY of 'virtual' from backend pid '11239' received</PRE
>&#13;</P
></DIV
><DIV
CLASS="REFSECT1"
><H2
>Compatibility</H2
><P
></P
><DIV
CLASS="REFSECT2"
><H3
>SQL92</H3
><P
>   There is no <B
CLASS="COMMAND"
>LISTEN</B
> in <SPAN
CLASS="ACRONYM"
>SQL92</SPAN
>.</P
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="sql-insert.html"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="user.html"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="sql-load.html"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>INSERT</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="sql-commands.html"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>LOAD</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>