begriffs open source - ai-pg/blob - full-docs/txt/contrib-dblink-cancel-query.txt

   1
   2 dblink_cancel_query
   3
   4    dblink_cancel_query — cancels any active query on the named connection
   5
   6 Synopsis
   7
   8 dblink_cancel_query(text connname) returns text
   9
  10 Description
  11
  12    dblink_cancel_query attempts to cancel any query that is in progress on
  13    the named connection. Note that this is not certain to succeed (since,
  14    for example, the remote query might already have finished). A cancel
  15    request simply improves the odds that the query will fail soon. You
  16    must still complete the normal query protocol, for example by calling
  17    dblink_get_result.
  18
  19 Arguments
  20
  21    connname
  22           Name of the connection to use.
  23
  24 Return Value
  25
  26    Returns OK if the cancel request has been sent, or the text of an error
  27    message on failure.
  28
  29 Examples
  30
  31 SELECT dblink_cancel_query('dtest1');