rdelaage
/
postgresql
mirror of https://git.postgresql.org/git/postgresql.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix documentation for dblink_error_message() return value 

The dblink documentation claims that an empty string is returned if there
has been no error, however OK is actually returned in that case. Also,
clarify that an async error may not be seen unless dblink_is_busy() or
dblink_get_result() have been called first.

Backpatch to all supported branches.

Reported-by: realyota
Backpatch-through: 9.4
Discussion: https://postgr.es/m/153371978486.1298.2091761143788088262@wrigleys.postgresql.org
This commit is contained in:
Joe Conway 2019-02-17 13:15:14 -05:00
parent a32ca78836
commit bc6d7eb689
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/src/sgml/dblink.sgml
View File

@ -1165,11 +1165,25 @@ dblink_error_message(text connname) returns text
<title>Return Value</title>
<para>
Returns last error message, or an empty string if there has been
Returns last error message, or <literal>OK</literal> if there has been
no error in this connection.
</para>
</refsect1>
<refsect1>
<title>Notes</title>
<para>
When asynchronous queries are initiated by
<function>dblink_send_query</function>, the error message associated with
the connection might not get updated until the server's response message
is consumed. This typically means that <function>dblink_is_busy</function>
or <function>dblink_get_result</function> should be called prior to
<function>dblink_error_message</function>, so that any error generated by
the asynchronous query will be visible.
</para>
</refsect1>
<refsect1>
<title>Examples</title>