↑↓ select ↵ open ⌫ change scope Open full search

PG.CENTER connects PostgreSQL documentation, reference, and ecosystem knowledge. Maintained by Pigsty.

Supported versions: Current (18) / 17 / 16 / 15 / 14
Development versions: 19 / devel
Unsupported versions: 13 / 12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4 / 8.3
Historical version. PostgreSQL 8.4 reached end of support in July 2014. See the current version for supported releases.
PostgreSQL 8.4.22 Documentation
Prev Fast Backward Fast Forward Next

dblink_cancel_query

Name

dblink_cancel_query -- cancels any active query on the named connection

Synopsis

    dblink_cancel_query(text connname) returns text

Description

dblink_cancel_query 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 dblink_get_result.

Arguments

conname

Name of the connection to use.

Return Value

Returns OK if the cancel request has been sent, or the text of an error message on failure.

Example

    SELECT dblink_cancel_query('dtest1');
Prev Home Next
dblink_get_result Up dblink_get_pkey

Report a documentation issue

Read the upstream documentation. For corrections, first check the current version.