archived-doc-es/reference/sqlite/functions/sqlite-query.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 656d1610af1a960d87c8b7056e54d0d4c75fb123 Maintainer: seros Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.sqlite-query" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>sqlite_query</refname>
  <refname>SQLiteDatabase::query</refname>
  <refpurpose>Ejecutar una consulta en una base de datos dada y devolver un gestor de resultados</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>sqlite_query</methodname>
   <methodparam><type>resource</type><parameter>dbhandle</parameter></methodparam>
   <methodparam><type>string</type><parameter>query</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>result_type</parameter><initializer>SQLITE_BOTH</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter role="reference">error_msg</parameter></methodparam>
  </methodsynopsis>
  <methodsynopsis>
   <type>resource</type><methodname>sqlite_query</methodname>
   <methodparam><type>string</type><parameter>query</parameter></methodparam>
   <methodparam><type>resource</type><parameter>dbhandle</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>result_type</parameter><initializer>SQLITE_BOTH</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter role="reference">error_msg</parameter></methodparam>
  </methodsynopsis>
  <para>&style.oop; (método):</para>
  <methodsynopsis>
   <modifier>public</modifier> <type>SQLiteResult</type><methodname>SQLiteDatabase::query</methodname>
   <methodparam><type>string</type><parameter>query</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>result_type</parameter><initializer>SQLITE_BOTH</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter role="reference">error_msg</parameter></methodparam>
  </methodsynopsis>
  <para>
   Ejecuta una sentencia SQL dada por <parameter>query</parameter> en
   un gestor de base de datos daod.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>dbhandle</parameter></term>
     <listitem>
      <para>
       El recurso de Base de datos de SQLite; devuelto por <function>sqlite_open</function>
       cuando se usa procedimentalmente. Este parámetro no es necesario
       cuando se usa el método orientado a objetos.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>query</parameter></term>
     <listitem>
      <para>
       La consulta a ejectuar.
      </para>
      <para>
       Los datos dentro de la consulta deberían ser <link
       linkend="function.sqlite-escape-string">apropiadamente escapados</link>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>result_type</parameter></term>
     <listitem>
      &sqlite.result-type;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>error_msg</parameter></term>
     <listitem>
      <para>
       La variable especificada será rellenada si ocurre un error. Esto es
       especialmente importante ya que los errores de sintaxis de SQL no se pueden recoger usando
       la función <function>sqlite_last_error</function>.
      </para>
     </listitem>
    </varlistentry>

   </variablelist>
  </para>
  &sqlite.param-compat;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Esta función devolverá un gestor de resultados &return.falseforfailure;.
   Para consultas que devuelven filas, el gestor de resultados se puede usar con
   funciones como <function>sqlite_fetch_array</function> y
   <function>sqlite_seek</function>.
  </para>
  <para>
   Sin tener en cuenta el tipo de consulta, esta función devolverá &false; si la
   consulta falla.
  </para>
  <para>
   <function>sqlite_query</function> devuelve un gestor de resultados almacenado en buffer y
   rasteable. Esto es útil para consultas razonablemente pequeñas donde se necesite
   la capacidad de acceso a filas aleatorio. Los gestores de resultados almacenados en buffer
   asignarán memoria para contener el resultado completo y no devolverán hasta que se
   haya recuperado. Si sólo se necesita acceso secuencial a los datos, se
   recomienda usar la función con más alto rendimiento
   <function>sqlite_unbuffered_query</function> en su lugar.
  </para>
 </refsect1>

<refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>5.1.0</entry>
       <entry>
        Se añadió el parámetro <parameter>error_msg</parameter>
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <warning>
   <simpara>
    SQLite <emphasis>ejecutará</emphasis> múltiples consultas separadas por
    puntos y comas, por lo que se puede usar esta función para ejecutar un lote de SQL que se haya
    cargado desde un fichero o embebido en un script. Sin embargo, esto sólo funcionará
    cuando el resultado de la función no se use - si se usara,
    se ejecutaría solamente la primera sentencia SQL. La función
    <function>sqlite_exec</function> siempre ejecutará múltiple sentencias
    SQL.
   </simpara>
   <simpara>
    Cuando se ejecutan múltiples consultas, el valor devuleto por esta función
    será &false; si hubiera un error, pero será indefinido de otro modo (podría
    ser &true; en caso de éxito o podría devolver un gestor de resultados).
   </simpara>
  </warning>
 </refsect1>

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