pg-affected-rows.xml

<?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-affected-rows" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pg_affected_rows</refname>
  <refpurpose>Returns number of affected records (tuples)</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>pg_affected_rows</methodname>
   <methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>pg_affected_rows</function> returns the number of tuples
   (instances/records/rows) affected by <literal>INSERT</literal>, 
   <literal>UPDATE</literal>, and <literal>DELETE</literal>
   queries. 
  </para>
  <para>
   Since PostgreSQL 9.0 and above, the server returns the number of 
   SELECTed rows. Older PostgreSQL return 0 for SELECT.
  </para>
  <note>
   <para>
    This function used to be called <function>pg_cmdtuples</function>.
   </para>
  </note>
 </refsect1>

<refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>result</parameter></term>
     <listitem>
      &pgsql.parameter.result;
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   The number of rows affected by the query. If no tuple is
   affected, it will return <literal>0</literal>.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &pgsql.changelog.result-object;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>pg_affected_rows</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$result = pg_query($conn, "INSERT INTO authors VALUES ('Orwell', 2002, 'Animal Farm')");

$cmdtuples = pg_affected_rows($result);

echo $cmdtuples . " tuples are affected.\n";
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
1 tuples are affected.
]]>
    </screen>
   </example>
  </para>
 </refsect1>

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