<?xml version="1.0" encoding="utf-8"?> <!-- $Revision$ --> <!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 --> <refentry xml:id="function.pg-send-prepare" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>pg_send_prepare</refname> <refpurpose>Sends a request to create a prepared statement with the given parameters, without waiting for completion</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pg_send_prepare</methodname> <methodparam><type>resource</type><parameter>connection</parameter></methodparam> <methodparam><type>string</type><parameter>stmtname</parameter></methodparam> <methodparam><type>string</type><parameter>query</parameter></methodparam> </methodsynopsis> <para> Sends a request to create a prepared statement with the given parameters, without waiting for completion. </para> <para> This is an asynchronous version of <function>pg_prepare</function>: it returns &true; if it was able to dispatch the request, and &false; if not. After a successful call, call <function>pg_get_result</function> to determine whether the server successfully created the prepared statement. The function's parameters are handled identically to <function>pg_prepare</function>. Like <function>pg_prepare</function>, it will not work on pre-7.4 versions of PostgreSQL. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>connection</parameter></term> <listitem> <para> PostgreSQL database connection resource. When <parameter>connection</parameter> is not present, the default connection is used. The default connection is the last connection made by <function>pg_connect</function> or <function>pg_pconnect</function>. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>stmtname</parameter></term> <listitem> <para> The name to give the prepared statement. Must be unique per-connection. If "" is specified, then an unnamed statement is created, overwriting any previously defined unnamed statement. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>query</parameter></term> <listitem> <para> The parameterized SQL statement. Must contain only a single statement. (multiple statements separated by semi-colons are not allowed.) If any parameters are used, they are referred to as $1, $2, etc. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para>Returns &true; on success, &false; on failure. Use <function>pg_get_result</function> to determine the query result.</para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>Using <function>pg_send_prepare</function></title> <programlisting role="php"> <![CDATA[ <?php $dbconn = pg_connect("dbname=publisher") or die("Could not connect"); // Prepare a query for execution if (!pg_connection_busy($dbconn)) { pg_send_prepare($dbconn, "my_query", 'SELECT * FROM shops WHERE name = $1'); $res1 = pg_get_result($dbconn); } // Execute the prepared query. Note that it is not necessary to escape // the string "Joe's Widgets" in any way if (!pg_connection_busy($dbconn)) { pg_send_execute($dbconn, "my_query", array("Joe's Widgets")); $res2 = pg_get_result($dbconn); } // Execute the same prepared query, this time with a different parameter if (!pg_connection_busy($dbconn)) { pg_send_execute($dbconn, "my_query", array("Clothes Clothes Clothes")); $res3 = pg_get_result($dbconn); } ?> ]]> </programlisting> </example> </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function>pg_connect</function></member> <member><function>pg_pconnect</function></member> <member><function>pg_execute</function></member> <member><function>pg_send_execute</function></member> <member><function>pg_send_query_params</function></member> </simplelist> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"~/.phpdoc/manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 -->