File: mysqli-stmt-affected-rows.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 (165 lines) | stat: -rw-r--r-- 4,580 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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
  <refentry id="function.mysqli-stmt-affected-rows">
   <refnamediv>
    <refname>mysqli_stmt_affected_rows</refname>
    <refname>mysqli_stmt->affected_rows</refname>
    <refpurpose>Returns the total number of rows changed, deleted, or
    inserted by the last executed statement
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <para>Procedural style :</para>
    <methodsynopsis>
     <type>int</type><methodname>mysqli_stmt_affected_rows</methodname>
     <methodparam><type>mysqli_stmt</type><parameter>stmt</parameter></methodparam>
    </methodsynopsis>
    <para>Object oriented style (property):</para>
    <classsynopsis>
     <ooclass><classname>mysqli_stmt</classname></ooclass>
     <fieldsynopsis><type>int</type><varname>affected_rows</varname></fieldsynopsis>
    </classsynopsis>
    <para>
     <function>mysqli_stmt_affected_rows</function> returns the number of rows affected
     by INSERT, UPDATE, or DELETE query. If the last query was invalid, this function will return -1.
    </para>
    <para>
     The <function>mysqli_stmt_affected_rows</function> function only works with queries
     which update a table. In order to return the number of rows from a SELECT query, use
     the <function>mysqli_stmt_num_rows</function> function instead.
    </para>
   </refsect1>
   <refsect1>
    &reftitle.returnvalues;
    <para>
      An integer greater than zero indicates the number of rows affected or retrieved. 
      Zero indicates that no records where updated for an UPDATE/DELETE statement, no
      rows matched the WHERE clause in the query or that no query has yet been executed.
      -1 indicates that the query has returned an error.
    </para>
    <note> 
     <para>
      If the number of affected rows is greater than maximal PHP int value, the number of
      affected rows will be returned as a string value.
     </para>
    </note>
   </refsect1>
   <refsect1>
    &reftitle.seealso;
    <para>
     <function>mysqli_stmt_num_rows</function>&listendand;
     <function>mysqli_prepare</function>.
    </para>
   </refsect1>
   <refsect1>
   &reftitle.examples;
    <example>
     <title>Object oriented style</title>
     <programlisting role="php">
<![CDATA[
<?php
$mysqli = new mysqli("localhost", "my_user", "my_password", "world");

/* check connection */
if (mysqli_connect_errno()) {
    printf("Connect failed: %s\n", mysqli_connect_error());
    exit();
}

/* create temp table */
$mysqli->query("CREATE TEMPORARY TABLE myCountry LIKE Country");

$query = "INSERT INTO myCountry SELECT * FROM Country WHERE Code LIKE ?";

/* prepare statement */
if ($stmt = $mysqli->prepare($query)) {

    /* Bind variable for placeholder */
    $code = 'A%';
    $stmt->bind_param("s", $code);
    
    /* execute statement */
    $stmt->execute();

    printf("rows inserted: %d\n", $stmt->affected_rows);

    /* close statement */
    $stmt->close();
}

/* close connection */
$mysqli->close();
?>
]]>
    </programlisting>
    </example>
    <example>
     <title>Procedural style</title>
     <programlisting role="php">
<![CDATA[
<?php
$link = mysqli_connect("localhost", "my_user", "my_password", "world");

/* check connection */
if (mysqli_connect_errno()) {
    printf("Connect failed: %s\n", mysqli_connect_error());
    exit();
}

/* create temp table */
mysqli_query($link, "CREATE TEMPORARY TABLE myCountry LIKE Country");

$query = "INSERT INTO myCountry SELECT * FROM Country WHERE Code LIKE ?";

/* prepare statement */
if ($stmt = mysqli_prepare($link, $query)) {

    /* Bind variable for placeholder */
    $code = 'A%';
    mysqli_stmt_bind_param($stmt, "s", $code);
    
    /* execute statement */
    mysqli_stmt_execute($stmt);

    printf("rows inserted: %d\n", mysqli_stmt_affected_rows($stmt));

    /* close statement */
    mysqli_stmt_close($stmt);
}

/* close connection */
mysqli_close($link);
?>
]]>
     </programlisting>
    </example>
    &example.outputs;
    <screen>
<![CDATA[
rows inserted: 17
]]>
    </screen>
   </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
-->