mysql-affected-rows.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 65e697ff671608989432a6e6bf8ae8128b2be2c7 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi -->
<refentry xml:id="function.mysql-affected-rows" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mysql_affected_rows</refname>
  <refpurpose>一番最近の操作で変更された行の数を得る</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
  <warning>
   &mysql.alternative.note;
   <simplelist role="alternatives">
    <member><function>mysqli_affected_rows</function></member>
    <member><methodname>PDOStatement::rowCount</methodname></member>
   </simplelist>
  </warning>
 </refsynopsisdiv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>mysql_affected_rows</methodname>
   <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter><initializer>NULL</initializer></methodparam>
  </methodsynopsis>
  <para>
   <parameter>link_identifier</parameter> と関連付けられた直近の
   INSERT、UPDATE、REPLACE、DELETE クエリによって変更された行の数を取得します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &mysql.linkid.description;
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   成功した場合に変更された行の数を、直近のクエリが失敗した場合に
   -1 を返します。
  </para>
  <para>
   直近のクエリが WHERE 句を含まない DELETE だった場合、テーブルから
   すべてのレコードが削除されますが、MySQL 4.1.2 以前のバージョンでは
   この関数はゼロを返します。
  </para>
  <para>
   UPDATE を使用する場合、MySQL では新旧の値が同じときには更新処理を行いません。
   このことから、必ずしも <function>mysql_affected_rows</function> の返す値が
   マッチする行の数と一致するとは限りません。返す値は実際に更新処理が行われた
   行の数です。
  </para>
  <para>
   REPLACE ステートメントは、まず最初に同じ主キーのレコードを削除した後に
   新しいレコードを挿入します。この関数は、削除された行の数と
   挿入された行の数を足したものを返します。
  </para> 
  <para>
   "INSERT ... ON DUPLICATE KEY UPDATE" クエリの場合の戻り値は、
   新しい行を追加した場合が <literal>1</literal>
   で既存の行を更新した場合が <literal>2</literal> となります。
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>mysql_affected_rows</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$link = mysql_connect('localhost', 'mysql_user', 'mysql_password');
if (!$link) {
    die('Could not connect: ' . mysql_error());
}
mysql_select_db('mydb');

/* これは、削除されたレコードの正しい数をかえずはず */
mysql_query('DELETE FROM mytable WHERE id < 10');
printf("Records deleted: %d\n", mysql_affected_rows());

/* 決して真にはならない where 条件なので、結果は 0 となるはず */
mysql_query('DELETE FROM mytable WHERE 0');
printf("Records deleted: %d\n", mysql_affected_rows());
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
Records deleted: 10
Records deleted: 0
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title>トランザクションを利用した <function>mysql_affected_rows</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$link = mysql_connect('localhost', 'mysql_user', 'mysql_password');
if (!$link) {
    die('Could not connect: ' . mysql_error());
}
mysql_select_db('mydb');

/* レコードの更新 */
mysql_query("UPDATE mytable SET used=1 WHERE id < 10");
printf ("Updated records: %d\n", mysql_affected_rows());
mysql_query("COMMIT");
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
Updated Records: 10
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <title>トランザクション</title>
   <para>
    トランザクションを使用する場合には、コミット後ではなく
    INSERT, UPDATE, DELETE クエリの後に
    <function>mysql_affected_rows</function> をコールする必要があります。
   </para>
  </note>
  <note>
   <title>SELECT ステートメント</title>
   <para>
    SELECT から返される行の数を得る際には、
    <function>mysql_num_rows</function> が利用できます。
   </para>
  </note>
  <note>
   <title>外部キーによる連鎖</title>
   <para>
     <function>mysql_affected_rows</function> は、外部キー制約の
     ON DELETE CASCADE や ON UPDATE CASCADE
     で暗黙のうちに変更された行については数えません。
   </para>
  </note>
 </refsect1>

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