<title>Arguments</title>
<variablelist>
<varlistentry>
<term><parameter>connname</parameter></term>
<listitem>
<para>
Name of the connection to use; omit this parameter to use the
unnamed connection.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>cursorname</parameter></term>
<listitem>
<para>
The name of the cursor to close.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fail_on_error</parameter></term>
<listitem>
<para>
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 <literal>ERROR</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Return Value</title>
<para>
Returns status, either <literal>OK</literal> or <literal>ERROR</literal>.
</para>
</refsect1>
<refsect1>
<title>Notes</title>
<para>
If <function>dblink_open</function> started an explicit transaction block,
and this is the last remaining open cursor in this connection,
<function>dblink_close</function> will issue the matching <command>COMMIT</command>.
</para>
</refsect1>
<refsect1>
<title>Examples</title>
<screen>
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)
</screen>
</refsect1>
</refentry>
<refentry id="contrib-dblink-get-connections">
<indexterm>
<primary>dblink_get_connections</primary>
</indexterm>
<refmeta>
<refentrytitle>dblink_get_connections</refentrytitle>
<manvolnum>3</manvolnum>
</refmeta>
<refnamediv>
<refname>dblink_get_connections</refname>
<refpurpose>returns the names of all open named dblink connections</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis>
dblink_get_connections() returns text[]
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
<function>dblink_get_connections</function> returns an array of the names
of all open named <filename>dblink</filename> connections.
</para>
</refsect1>
<refsect1>
<title>Return Value</title>
<para>Returns a text array of connection names, or NULL if none.</para>
</refsect1>
<refsect1>
<title>Examples</title>
<programlisting>
SELECT dblink_get_connections();
</programlisting>
</refsect1>
</refentry>
<refentry id="contrib-dblink-error-message">
<indexterm>
<primary>dblink_error_message</primary>
</indexterm>
<refmeta>
<refentrytitle>dblink_error_message</refentrytitle>
<manvolnum>3</manvolnum>
</refmeta>
<refnamediv>
<refname>dblink_error_message</refname>
<refpurpose>gets last error message on the named connection</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis>
dblink_error_message(text connname) returns text
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
<function>dblink_error_message</function> fetches the most recent remote
error message for a given connection.
</para>
</refsect1>
<refsect1>
<title>Arguments</title>
<variablelist>
<varlistentry>
<term><parameter>connname</parameter></term>
<listitem>
<para>
Name of the connection to use.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Return Value</title>
<para>
Returns last error message, or <literal>OK</literal> if there has been
no error in this connection.
</para>
</refsect1>
<refsect1>
<title>Notes</title>
<para>