archived-doc-es/reference/pgsql/functions/pg-delete.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: c2eca73ef79ebe78cebb34053e41b565af504c4f Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.pg-delete" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pg_delete</refname>
  <refpurpose>
   Elimina filas de PostgreSQL
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>bool</type></type><methodname>pg_delete</methodname>
   <methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
   <methodparam><type>string</type><parameter>table_name</parameter></methodparam>
   <methodparam><type>array</type><parameter>conditions</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>PGSQL_DML_EXEC</constant></initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>pg_delete</function> elimina las filas de una tabla especificadas por
   las claves y valores del array asociativo <parameter>conditions</parameter>.
  </para>
  <para>
   Si <parameter>flags</parameter> es proporcionado,
   <function>pg_convert</function> es aplicado a
   <parameter>conditions</parameter> con los flags proporcionados.
  </para>
  <para>
   Por omisión <function>pg_delete</function> pasa valores sin tratar.
   Los valores deben ser escapados o el flag <constant>PGSQL_DML_ESCAPE</constant>
   debe ser especificado en <parameter>flags</parameter>.
   <constant>PGSQL_DML_ESCAPE</constant> añade comillas y escapa los parámetros/identificadores.
   Por lo tanto, los nombres de tablas/columnas se vuelven sensibles a mayúsculas/minúsculas.
  </para>
  <para>
   Tenga en cuenta que ni el escape ni las consultas preparadas pueden proteger
   consultas LIKE, JSON, arrays, Regex, etc. Estos parámetros deben ser
   tratados según su contexto. Es decir, escapar/validar los valores.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection</parameter></term>
     <listitem>
      &pgsql.parameter.connection;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>table_name</parameter></term>
     <listitem>
      <para>
       Nombre de la tabla desde la cual las filas serán eliminadas.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>conditions</parameter></term>
     <listitem>
      <para>
       Un &array; donde las claves son los nombres de los campos de la tabla
       <parameter>table_name</parameter> y donde los valores son los valores
       de estos campos que deben ser eliminados.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Cualquier combinación de los siguientes valores:
       <constant>PGSQL_CONV_FORCE_NULL</constant>,
       <constant>PGSQL_DML_NO_CONV</constant>,
       <constant>PGSQL_DML_ESCAPE</constant>,
       <constant>PGSQL_DML_EXEC</constant>,
       <constant>PGSQL_DML_ASYNC</constant> o
       <constant>PGSQL_DML_STRING</constant>.
       Si <constant>PGSQL_DML_STRING</constant> forma parte del parámetro
       <parameter>flags</parameter> entonces, la consulta será devuelta.
       Cuando la constante <constant>PGSQL_DML_NO_CONV</constant> o la constante
       <constant>PGSQL_DML_ESCAPE</constant> están definidas, ninguna llamada a la función
       <function>pg_convert</function> será realizada internamente.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;  Devuelve un &string; si <constant>PGSQL_DML_STRING</constant>
   es pasado en el parámetro <parameter>flags</parameter>.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &pgsql.changelog.connection-object;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo con <function>pg_delete</function></title>
    <programlisting role="php">
<![CDATA[
<?php
 $db = pg_connect ('dbname=foo');
// Esto es seguro en cierta medida, ya que todos los valores son escapados
// Sin embargo PostgreSSQL soporta JSON/arrays. Estos no son
// seguros ni por escape ni por consultas preparadas.
 $res = pg_delete($db, 'post_log', $_POST, PG_DML_ESCAPE);
 if ($res) {
     echo "Los datos POST han sido eliminados: $res\n";
 } else {
     echo "Los datos de entrada son incorrectos.\n";
 }
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

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