begriffs open source - ai-pg/blob - full-docs/src/sgml/man3/dblink_cancel_query.3

   1 '\" t
   2 .\"     Title: dblink_cancel_query
   3 .\"    Author: The PostgreSQL Global Development Group
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2025
   6 .\"    Manual: PostgreSQL 18.0 Documentation
   7 .\"    Source: PostgreSQL 18.0
   8 .\"  Language: English
   9 .\"
  10 .TH "DBLINK_CANCEL_QUERY" "3" "2025" "PostgreSQL 18.0" "PostgreSQL 18.0 Documentation"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 dblink_cancel_query \- cancels any active query on the named connection
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 dblink_cancel_query(text connname) returns text
  36 .fi
  37 .SH "DESCRIPTION"
  38 .PP
  39 \fBdblink_cancel_query\fR
  40 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
  41 \fBdblink_get_result\fR\&.
  42 .SH "ARGUMENTS"
  43 .PP
  44 \fIconnname\fR
  45 .RS 4
  46 Name of the connection to use\&.
  47 .RE
  48 .SH "RETURN VALUE"
  49 .PP
  50 Returns
  51 OK
  52 if the cancel request has been sent, or the text of an error message on failure\&.
  53 .SH "EXAMPLES"
  54 .sp
  55 .if n \{\
  56 .RS 4
  57 .\}
  58 .nf
  59 SELECT dblink_cancel_query(\*(Aqdtest1\*(Aq);
  60 .fi
  61 .if n \{\
  62 .RE
  63 .\}