MAINHACK

Viewing / Editing File: contrib-dblink-cancel-query.html

File is not writable. Editing disabled.
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>dblink_cancel_query</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REV="MADE"
HREF="mailto:pgsql-docs@postgresql.org"><LINK
REL="HOME"
TITLE="PostgreSQL 9.2.24 Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="dblink"
HREF="dblink.html"><LINK
REL="PREVIOUS"
TITLE="dblink_get_result"
HREF="contrib-dblink-get-result.html"><LINK
REL="NEXT"
TITLE="dblink_get_pkey"
HREF="contrib-dblink-get-pkey.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
HREF="stylesheet.css"><META
HTTP-EQUIV="Content-Type"
CONTENT="text/html; charset=ISO-8859-1"><META
NAME="creation"
CONTENT="2017-11-06T22:43:11"></HEAD
><BODY
CLASS="REFENTRY"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="5"
ALIGN="center"
VALIGN="bottom"
><A
HREF="index.html"
>PostgreSQL 9.2.24 Documentation</A
></TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
TITLE="dblink_get_result"
HREF="contrib-dblink-get-result.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
HREF="dblink.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="60%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="20%"
ALIGN="right"
VALIGN="top"
><A
TITLE="dblink_get_pkey"
HREF="contrib-dblink-get-pkey.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="CONTRIB-DBLINK-CANCEL-QUERY"
></A
>dblink_cancel_query</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN147713"
></A
><H2
>Name</H2
>dblink_cancel_query&nbsp;--&nbsp;cancels any active query on the named connection</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN147716"
></A
><H2
>Synopsis</H2
><PRE
CLASS="SYNOPSIS"
>dblink_cancel_query(text connname) returns text</PRE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN147718"
></A
><H2
>Description</H2
><P
>    <CODE
CLASS="FUNCTION"
>dblink_cancel_query</CODE
> attempts to cancel any query that
    is in progress on the named connection.  Note that this is not
    certain to succeed (since, for example, the remote query might
    already have finished).  A cancel request simply improves the
    odds that the query will fail soon.  You must still complete the
    normal query protocol, for example by calling
    <CODE
CLASS="FUNCTION"
>dblink_get_result</CODE
>.
   </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN147723"
></A
><H2
>Arguments</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><TT
CLASS="PARAMETER"
>connname</TT
></DT
><DD
><P
>       Name of the connection to use.
      </P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN147731"
></A
><H2
>Return Value</H2
><P
>    Returns <TT
CLASS="LITERAL"
>OK</TT
> if the cancel request has been sent, or
    the text of an error message on failure.
   </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN147735"
></A
><H2
>Examples</H2
><PRE
CLASS="PROGRAMLISTING"
>SELECT dblink_cancel_query('dtest1');</PRE
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="contrib-dblink-get-result.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="contrib-dblink-get-pkey.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>dblink_get_result</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="dblink.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>dblink_get_pkey</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
Cancel / Back
[ MAINHACK ]

Viewing / Editing File: contrib-dblink-cancel-query.html

Server Info

System Features

User Info
