codekingpro/portable-devtools

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_send_query</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-error-message.html" title="dblink_error_message" /><link rel="next" href="contrib-dblink-is-busy.html" title="dblink_is_busy" /></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_send_query</th></tr><tr><td width="10%" align="left"><a accesskey="p" href="contrib-dblink-error-message.html" title="dblink_error_message">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="dblink.html" title="F.12. dblink — connect to other PostgreSQL databases">Up</a></td><th width="60%" align="center">F.12. dblink — connect to other PostgreSQL databases</th><td width="10%" align="right"><a accesskey="h" href="index.html" title="PostgreSQL 16.3 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="contrib-dblink-is-busy.html" title="dblink_is_busy">Next</a></td></tr></table><hr /></div><div class="refentry" id="CONTRIB-DBLINK-SEND-QUERY"><div class="titlepage"></div><a id="id-1.11.7.22.15.1" class="indexterm"></a><div class="refnamediv"><h2><span class="refentrytitle">dblink_send_query</span></h2><p>dblink_send_query — sends an async query to a remote database</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">3dblink_send_query(text connname, text sql) returns int4</pre></div><div class="refsect1" id="id-1.11.7.22.15.5"><h2>Description</h2><p>5    <code class="function">dblink_send_query</code> sends a query to be executed6    asynchronously, that is, without immediately waiting for the result.7    There must not be an async query already in progress on the8    connection.9   </p><p>10    After successfully dispatching an async query, completion status11    can be checked with <code class="function">dblink_is_busy</code>, and the results12    are ultimately collected with <code class="function">dblink_get_result</code>.13    It is also possible to attempt to cancel an active async query14    using <code class="function">dblink_cancel_query</code>.15   </p></div><div class="refsect1" id="id-1.11.7.22.15.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>16       Name of the connection to use.17      </p></dd><dt><span class="term"><em class="parameter"><code>sql</code></em></span></dt><dd><p>18       The SQL statement that you wish to execute in the remote database,19       for example <code class="literal">select * from pg_class</code>.20      </p></dd></dl></div></div><div class="refsect1" id="id-1.11.7.22.15.7"><h2>Return Value</h2><p>21    Returns 1 if the query was successfully dispatched, 0 otherwise.22   </p></div><div class="refsect1" id="id-1.11.7.22.15.8"><h2>Examples</h2><pre class="programlisting">23SELECT dblink_send_query('dtest1', 'SELECT * FROM foo WHERE f1 &lt; 3');24</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-error-message.html" title="dblink_error_message">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="dblink.html" title="F.12. dblink — connect to other PostgreSQL databases">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="contrib-dblink-is-busy.html" title="dblink_is_busy">Next</a></td></tr><tr><td width="40%" align="left" valign="top">dblink_error_message </td><td width="20%" align="center"><a accesskey="h" href="index.html" title="PostgreSQL 16.3 Documentation">Home</a></td><td width="40%" align="right" valign="top"> dblink_is_busy</td></tr></table></div></body></html>