GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  DBLINK_CLOSE (3)

.ds Aq ’

NAME

dblink_close - closes a cursor in a remote database

CONTENTS

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 functions 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)

Search for    or go to Top of page |  Section 3 |  Main Index


PostgreSQL 9.5.2 DBLINK_CLOSE (3) 2016

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.