DBLINK_OPEN(3)

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

okay bestie, welcome to the PostgreSQL 16.15 Documentation page for DBLINK_OPEN(3) β€” aka your girl dblink_open, who is literally all about opening cursors in a remote database. πŸ’…


πŸ’– NAME πŸ’–

dblink_open β€” opens a cursor in a remote database


🌸 SYNOPSIS 🌸

dblink_open(text cursorname, text sql [, bool fail_on_error]) returns text
dblink_open(text connname, text cursorname, text sql [, bool fail_on_error]) returns text

πŸ¦‹ DESCRIPTION πŸ¦‹

dblink_open() opens a cursor in a remote database. After that, the cursor can be manipulated with dblink_fetch() and dblink_close(). It’s giving β€œopen the door, then fetch and close like a responsible icon.” ✨


πŸŽ€ ARGUMENTS πŸŽ€

  • connname β€” the name of the connection to use. Omit this parameter to use the unnamed connection, bestie.
  • cursorname β€” the name you want to assign to this cursor.
  • sql β€” the SELECT statement you wish to execute in the remote database, for example select * from pg_class.
  • 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.

πŸ‘‘ RETURN VALUE πŸ‘‘

Returns status, either OK or ERROR. That’s the whole mood. πŸ’«


🌈 NOTES 🌈

Since a cursor can only persist within a transaction, dblink_open starts an explicit transaction block (BEGIN) on the remote side, if the remote side was not already within a transaction. This transaction will be closed again when the matching dblink_close is executed.

⚠️ okay important note, bestie: if you use dblink_exec to change data between dblink_open and dblink_close, and then an error occurs or you use dblink_disconnect before dblink_close, your change will be lost because the transaction will be aborted. no cap, that part matters. 😭

πŸ“ 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)

πŸ’– okay that’s the whole page, bestie β€” it’s from PostgreSQL 16.15, dated 2026, and yes it’s the DBLINK_OPEN(3) manual page. slay and stay caffeinated ✨🫢

πŸ“¦ where this page comes from