summaryrefslogtreecommitdiffstats
path: root/doc/src/sgml/man3/dblink_cancel_query.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/sgml/man3/dblink_cancel_query.3')
-rw-r--r--doc/src/sgml/man3/dblink_cancel_query.363
1 files changed, 63 insertions, 0 deletions
diff --git a/doc/src/sgml/man3/dblink_cancel_query.3 b/doc/src/sgml/man3/dblink_cancel_query.3
new file mode 100644
index 0000000..2ae393c
--- /dev/null
+++ b/doc/src/sgml/man3/dblink_cancel_query.3
@@ -0,0 +1,63 @@
+'\" t
+.\" Title: dblink_cancel_query
+.\" Author: The PostgreSQL Global Development Group
+.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
+.\" Date: 2023
+.\" Manual: PostgreSQL 15.5 Documentation
+.\" Source: PostgreSQL 15.5
+.\" Language: English
+.\"
+.TH "DBLINK_CANCEL_QUERY" "3" "2023" "PostgreSQL 15.5" "PostgreSQL 15.5 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_cancel_query \- cancels any active query on the named connection
+.SH "SYNOPSIS"
+.sp
+.nf
+dblink_cancel_query(text connname) returns text
+.fi
+.SH "DESCRIPTION"
+.PP
+\fBdblink_cancel_query\fR
+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
+\fBdblink_get_result\fR\&.
+.SH "ARGUMENTS"
+.PP
+\fIconnname\fR
+.RS 4
+Name of the connection to use\&.
+.RE
+.SH "RETURN VALUE"
+.PP
+Returns
+OK
+if the cancel request has been sent, or the text of an error message on failure\&.
+.SH "EXAMPLES"
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+SELECT dblink_cancel_query(\*(Aqdtest1\*(Aq);
+.fi
+.if n \{\
+.RE
+.\}