DragonFly On-Line Manual Pages

Search: Section:  

DBLINK_CLOSE(3)         PostgreSQL 9.5.0 Documentation         DBLINK_CLOSE(3)


NAME

       dblink_close - closes a cursor in a remote database


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 previously opened with dblink_open.


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.


RETURN VALUE

       Returns status, either OK or ERROR.


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.


EXAMPLES

           SELECT dblink_connect('dbname=postgres');
            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)

PostgreSQL 9.5.0                     2016                      DBLINK_CLOSE(3)

Search: Section: