begriffs open source - ai-pg/blob - full-docs/src/sgml/html/contrib-dblink-error-message.html

   1 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>dblink_error_message</title><link rel="stylesheet" type="text/css" href="stylesheet.css" /><link rev="made" href="pgsql-docs@lists.postgresql.org" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /><link rel="prev" href="contrib-dblink-get-connections.html" title="dblink_get_connections" /><link rel="next" href="contrib-dblink-send-query.html" title="dblink_send_query" /></head><body id="docContent" class="container-fluid col-10"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center">dblink_error_message</th></tr><tr><td width="10%" align="left"><a accesskey="p" href="contrib-dblink-get-connections.html" title="dblink_get_connections">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="dblink.html" title="F.11. dblink — connect to other PostgreSQL databases">Up</a></td><th width="60%" align="center">F.11. dblink — connect to other PostgreSQL databases</th><td width="10%" align="right"><a accesskey="h" href="index.html" title="PostgreSQL 18.0 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="contrib-dblink-send-query.html" title="dblink_send_query">Next</a></td></tr></table><hr /></div><div class="refentry" id="CONTRIB-DBLINK-ERROR-MESSAGE"><div class="titlepage"></div><a id="id-1.11.7.21.16.1" class="indexterm"></a><div class="refnamediv"><h2><span class="refentrytitle">dblink_error_message</span></h2><p>dblink_error_message — gets last error message on the named connection</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
   3 dblink_error_message(text connname) returns text
   4 </pre></div><div class="refsect1" id="id-1.11.7.21.16.5"><h2>Description</h2><p>
   5     <code class="function">dblink_error_message</code> fetches the most recent remote
   6     error message for a given connection.
   7    </p></div><div class="refsect1" id="id-1.11.7.21.16.6"><h2>Arguments</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>connname</code></em></span></dt><dd><p>
   8        Name of the connection to use.
   9       </p></dd></dl></div></div><div class="refsect1" id="id-1.11.7.21.16.7"><h2>Return Value</h2><p>
  10     Returns last error message, or <code class="literal">OK</code> if there has been
  11     no error in this connection.
  12    </p></div><div class="refsect1" id="id-1.11.7.21.16.8"><h2>Notes</h2><p>
  13     When asynchronous queries are initiated by
  14     <code class="function">dblink_send_query</code>, the error message associated with
  15     the connection might not get updated until the server's response message
  16     is consumed. This typically means that <code class="function">dblink_is_busy</code>
  17     or <code class="function">dblink_get_result</code> should be called prior to
  18     <code class="function">dblink_error_message</code>, so that any error generated by
  19     the asynchronous query will be visible.
  20    </p></div><div class="refsect1" id="id-1.11.7.21.16.9"><h2>Examples</h2><pre class="programlisting">
  21 SELECT dblink_error_message('dtest1');
  22 </pre></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="contrib-dblink-get-connections.html" title="dblink_get_connections">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="dblink.html" title="F.11. dblink — connect to other PostgreSQL databases">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="contrib-dblink-send-query.html" title="dblink_send_query">Next</a></td></tr><tr><td width="40%" align="left" valign="top">dblink_get_connections </td><td width="20%" align="center"><a accesskey="h" href="index.html" title="PostgreSQL 18.0 Documentation">Home</a></td><td width="40%" align="right" valign="top"> dblink_send_query</td></tr></table></div></body></html>