File: PDOStatement-rowCount.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (143 lines) | stat: -rw-r--r-- 4,109 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.9 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
  <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;
    <methodsynopsis>
     <type>int</type><methodname>PDOStatement::rowCount</methodname>
     <void/>
    </methodsynopsis>

    <para>
     <function>PDOStatement::rowCount</function> 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="examples">
    &reftitle.examples;
    <para>
     <example>
      <title>Return the number of deleted rows</title>
      <para>
       <function>PDOStatement::rowCount</function> 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, <function>PDOStatement::rowCount</function> does not
       return the number of rows affected by a SELECT statement. Instead, use
       <function>PDO::query</function> to issue a SELECT COUNT(*) statement
       with the same predicates as your intended SELECT statement, then use
       <function>PDOStatement::fetchColumn</function> 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><function>PDOStatement::columnCount</function></member>
      <member><function>PDOStatement::fetchColumn</function></member>
      <member><function>PDOStatement::query</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:"../../../../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
-->