cubrid-affected-rows.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="function.cubrid-affected-rows" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>cubrid_affected_rows</refname>
  <refpurpose>Return the number of rows affected by the last SQL statement</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>cubrid_affected_rows</methodname>
   <methodparam choice="opt"><type>resource</type><parameter>conn_identifier</parameter></methodparam>
  </methodsynopsis>
  <methodsynopsis>
   <type>int</type><methodname>cubrid_affected_rows</methodname>
   <methodparam choice="opt"><type>resource</type><parameter>req_identifier</parameter></methodparam>
  </methodsynopsis>
  <para>
    The <function>cubrid_affected_rows</function> function is used to get the
    number of rows affected by the SQL statement (INSERT, DELETE, UPDATE).
  </para>
 </refsect1>

 <refsect1 role="parameters">
 &reftitle.parameters;
 <para>
  <variablelist>
   <varlistentry>
    <term><parameter>conn_identifier</parameter></term>
    <listitem><para>The CUBRID connection. If the connection identifier is not
      specified, the last link opend by <function>cubrid_connect</function> is
    assumed.</para></listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>req_identifier</parameter></term>
    <listitem>
      <para>
        Request Identifier, could be returned from either <function>cubrid_prepare</function> or <function>cubrid_execute</function>. 
        If the request identifier is not specified, the last identifier requested by 
        <function>cubrid_prepare</function> or <function>cubrid_execute</function> is assumed.
      </para>
    </listitem>
   </varlistentry>
  </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
    Number of rows affected by the SQL statement, when process is successful.
  </para>
   <para>
    -1, when SQL statement is not INSERT, DELETE or UPDATE.
  </para>
  <para>
   &false;, when the request identifier is not specified, and there is no last
   request.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><function>cubrid_affected_rows</function> example</title>
   <programlisting role="php">
<![CDATA[
<?php
$conn = cubrid_connect('localhost', 33000, 'demodb', 'dba', '');
cubrid_execute($conn, "DROP TABLE IF EXISTS cubrid_test");
cubrid_execute($conn, "CREATE TABLE cubrid_test (d varchar)");
$sql_stmt = "INSERT INTO cubrid_test(d) VALUES('php-test')";
$req = cubrid_prepare($conn, $sql_stmt);

for ($i = 0; $i < 10; $i++) {
    cubrid_execute($req);
}
cubrid_commit($conn);

$req = cubrid_execute($conn, "DELETE FROM cubrid_test WHERE d='php-test'", CUBRID_ASYNC);
var_dump(cubrid_affected_rows());
var_dump(cubrid_affected_rows($conn));
var_dump(cubrid_affected_rows($req));

cubrid_disconnect($conn);

print "done!";
?>
]]>
   </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
int(10)
int(10)
int(10)
done!
]]>
   </screen>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>cubrid_execute</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
-->