DBLINK_CLOSE(3)

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

✨ NAME ✨

okay so bestie, this is dblink_close(3) from the PostgreSQL 15.19 documentation, and it's literally the function that closes a cursor in a remote database. no cap, it's giving "clean up your remote cursor situation" energy πŸ’….

🌸 SYNOPSIS 🌸

dblink_close(text cursorname [, bool fail_on_error]) returns text
dblink_close(text connname, text cursorname [, bool fail_on_error]) returns text

πŸ¦‹ DESCRIPTION πŸ¦‹

dblink_close closes a cursor that was previously opened with dblink_open. That's it, that's the vibe ✨.

πŸŽ€ ARGUMENTS πŸŽ€

  • connname β€” name of the connection to use; omit this parameter to use the unnamed connection 🫢
  • cursorname β€” the name of the cursor to close
  • fail_on_error β€” if true (the default when omitted) then an error thrown on the remote side of the connection causes an error to also be thrown locally. If false, the remote error is locally reported as a NOTICE, and the function's return value is set to ERROR. highkey important πŸ’–

πŸ’œ RETURN VALUE πŸ’œ

Returns status, either OK or ERROR. slay βœ…

πŸ”₯ NOTES πŸ”₯

If dblink_open started an explicit transaction block, and this is the last remaining open cursor in this connection, dblink_close will issue the matching COMMIT. iykyk, that's the little detail with main character energy πŸ‘‘.

🌈 EXAMPLES 🌈

           SELECT dblink_connect('dbname=postgres options=-csearch_path=');
            dblink_connect
           ----------------
            OK
           (1 row)

           SELECT dblink_open('foo', 'select proname, prosrc from pg_proc');
            dblink_open
           -------------
            OK
           (1 row)

           SELECT dblink_close('foo');
            dblink_close
           --------------
            OK
           (1 row)

πŸ’– and that's the whole page, bestie: from PostgreSQL 15.19, dated 2026, and yes it's DBLINK_CLOSE(3) β€” mwah πŸ’‹

πŸ“¦ where this page comes from