php-doc-en/reference/pdo/functions/PDOStatement-rowCount.xml
2007-01-07 21:19:57 +00:00

153 lines
4 KiB
XML

<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.12 $ -->
<refentry id="function.PDOStatement-rowCount">
<refnamediv>
<refname>PDOStatement->rowCount()</refname>
<refpurpose>
Returns the number of rows affected by the last SQL statement
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>PDOStatement</classname></ooclass>
<methodsynopsis>
<type>int</type><methodname>rowCount</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<para>
<xref linkend="function.PDOStatement-rowCount" /> returns the number of
rows affected by the last DELETE, INSERT, or UPDATE statement
executed by the corresponding <literal>PDOStatement</literal> object.
</para>
<para>
If the last SQL statement executed by the associated
<literal>PDOStatement</literal> was a SELECT statement, some databases
may return the number of rows returned by that statement. However, this
behaviour is not guaranteed for all databases and should not be relied
on for portable applications.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the number of rows.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Return the number of deleted rows</title>
<para>
<xref linkend="function.PDOStatement-rowCount" /> returns the number of
rows affected by a DELETE, INSERT, or UPDATE statement.
</para>
<programlisting role="php">
<![CDATA[
<?php
/* Delete all rows from the FRUIT table */
$del = $dbh->prepare('DELETE FROM fruit');
$del->execute();
/* Return number of rows that were deleted */
print("Return number of rows that were deleted:\n");
$count = $del->rowCount();
print("Deleted $count rows.\n");
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Deleted 9 rows.
]]>
</screen>
</example>
<example>
<title>Counting rows returned by a SELECT statement</title>
<para>
For most databases, <xref linkend="function.PDOStatement-rowCount" /> does not
return the number of rows affected by a SELECT statement. Instead, use
<xref linkend="function.PDO-query" /> to issue a SELECT COUNT(*) statement
with the same predicates as your intended SELECT statement, then use
<xref linkend="function.PDOStatement-fetchColumn" /> to retrieve the number
of rows that will be returned. Your application can then perform the
correct action.
</para>
<programlisting role="php">
<![CDATA[
<?php
$sql = "SELECT COUNT(*) FROM fruit WHERE calories > 100";
if ($res = $conn->query($sql)) {
/* Check the number of rows that match the SELECT statement */
if ($res->fetchColumn() > 0) {
/* Issue the real SELECT statement and work with the results */
$sql = "SELECT name FROM fruit WHERE calories > 100";
foreach ($conn->query($sql) as $row) {
print "Name: " . $row['NAME'] . "\n";
}
}
/* No rows matched -- do something else */
else {
print "No rows matched the query.";
}
}
$res = null;
$conn = null;
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
apple
banana
orange
pear
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.PDOStatement-columnCount" /></member>
<member><xref linkend="function.PDOStatement-fetchColumn" /></member>
<member><xref linkend="function.PDO-query" /></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:"../../../../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
-->