DBLINK_CANCEL_QUERY(3)

πŸ“¦ version 16.15, in opensuse-leap 16.0

πŸ’– NAME πŸ’–

okay bestie, welcome to the DBLINK_CANCEL_QUERY(3) page from the PostgreSQL 16.15 Documentation β€” manual name folded in right at the top like a little name tag πŸŽ€. dblink_cancel_query is the function that cancels any active query on the named connection. slay.


✨ 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. It's giving β€œtry to stop it” energy, but bestie, it is not certain to succeed β€” 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. no cap.

⚠️ lowkey important: this cancel request is a nudge, not a guaranteed kill. you still have to finish the normal query protocol, okay? 🫢

πŸ¦‹ ARGUMENTS πŸ¦‹

  • connname β€” name of the connection to use. that's the whole argument, bestie πŸ’…

🌸 RETURN VALUE 🌸

Returns OK if the cancel request has been sent, or the text of an error message on failure. so: either the sweet little OK, or an error message telling you what went wrong 😭


πŸ‘‘ EXAMPLES πŸ‘‘

SELECT dblink_cancel_query('dtest1');

xoxo bestie πŸ’– β€” source/version: PostgreSQL 16.15, date: 2026, periodt ✨

πŸ“¦ where this page comes from