mysql-affected-rows.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 65e697ff671608989432a6e6bf8ae8128b2be2c7 Maintainer: jesus_cova Status: ready -->
<!-- Reviewed: yes Maintainer: seros -->
<refentry xml:id="function.mysql-affected-rows" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mysql_affected_rows</refname>
  <refpurpose>Obtiene el número de filas afectadas en la anterior operación de MySQL</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>
   Obtiene el número de filas afectadas por la última consulta INSERT, UPDATE, REPLACE
   o DELETE asociada con <parameter>link_identifier</parameter>.  
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &mysql.linkid.description;
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve el número de filas afectadas en caso de éxito, y -1 si la última consulta
   falló.
  </para>
  <para>
   Si la consulta anterior fue DELETE con ninguna cláusula WHERE, todos
   los registros habrán sido borrados de la tabla, aunque ésta función
   devolverá cero con una versión anterior a MySQL 4.1.2.
  </para>
  <para>
   Al utilizar UPDATE, MySQL no actualiza las columnas donde el nuevo valor es el
   mismo que el anterior. Esto crea la posibilidad de que  
   <function>mysql_affected_rows</function> no pueda equivaler en realidad al número
   de filas encontradas, solamente el número de filas que estuvieron literalmente afectadas por
   la consulta.
  </para>
  <para>
   La sentencia REPLACE primero borra el registro con la misma clave primaria
   y luego inserta el nuevo registro. Esta función devuelve el número de
   registros borrados más el número de registros insertados.
  </para>
  <para>
   En el caso de consultas "INSERT ... ON DUPLICATE KEY UPDATE", el 
   valor devuelto será <literal>1</literal> si se realizó una inserción,
   o <literal>2</literal> para una actualización de una fila existente.
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo de <function>mysql_affected_rows</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$enlace = mysql_connect('localhost', 'usuario_mysql', 'contraseña_mysql');
if (!$enlace) {
    die('No se pudo conectar: ' . mysql_error());
}
mysql_select_db('mibd');

/* Esto debería devolver el número correcto de registros borrados */
mysql_query('DELETE FROM mitabla WHERE id < 10');
printf("Registros borrados: %d\n", mysql_affected_rows());

/* con una clausula WHERE que nunca es verdad, debería devolver 0 */
mysql_query('DELETE FROM mitabla WHERE 0');
printf("Registros borrados: %d\n", mysql_affected_rows());
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
Registros borrados: 10
Registros borrados: 0
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title>Ejemplo de <function>mysql_affected_rows</function> al utilizar transacciones</title>
    <programlisting role="php">
<![CDATA[
<?php
$enlace = mysql_connect('localhost', 'usuario_mysql', 'contraseña_mysql');
if (!$enlace) {
    die('No se pudo conectar: ' . mysql_error());
}
mysql_select_db('mibd');

/* Actualizar registros */
mysql_query("UPDATE mitabla SET usado=1 WHERE id < 10");
printf ("Registros actualizados: %d\n", mysql_affected_rows());
mysql_query("COMMIT");
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
Registros actualizados: 10
]]>
    </screen>
   </example>
  </para>
 </refsect1>
 
 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <title>Transacciones</title>
   <para>
    Si se usan transacciones, es necesario llamar a
    <function>mysql_affected_rows</function> después de una consulta INSERT, UPDATE, o
    DELETE, no después del COMMIT.
   </para>
  </note>
  <note>
   <title>Sentencias SELECT</title>
   <para>
    Para conocer el número de filas devueltas por un SELECT, es posible
    usar <function>mysql_num_rows</function>.
   </para>
  </note>
  <note>
   <title>Claves Foráneas en Cascada</title>
   <para>
    <function>mysql_affected_rows</function> no cuenta la filas afectadas
    implícitamente a través del uso de ON DELETE CASCADE y/o ON UPDATE CASCADE
    en las restricciones de las claves foráneas.
   </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
-->