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

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0d604bbc9d3b741d53e7fac26f5b24c306751e9a Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka -->
<refentry xml:id="function.sqlite-query" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>sqlite_query</refname>
  <refname>SQLiteDatabase::query</refname>
  <refpurpose>指定したデータベースに対してクエリを実行し、結果ハンドル
  を返す</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; (メソッド):</para>
  <methodsynopsis>
   <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>
   指定したデータベースにより <parameter>query</parameter> で指定した
   SQL ステートメントを実行します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>dbhandle</parameter></term>
     <listitem>
      <para>
       SQLite データベースリソース。手続きに従って、
       <function>sqlite_open</function> から返されます。
       このパラメータは、
       オブジェクト指向言語型メソッドを使用する場合は不要です。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>query</parameter></term>
     <listitem>
      <para>
       実行するクエリ
      </para>
      <para>
       クエリ内のデータは <link
       linkend="function.sqlite-escape-string">適切にエスケープ</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>
       もしエラーが発生した場合、ここに保存されます。SQL 構文のエラーは
       <function>sqlite_last_error</function> 関数で取得することが
       できないため、このパラメータが特に重要となります。
      </para>
     </listitem>
    </varlistentry>

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

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   この関数は結果ハンドルを返します。&return.falseforfailure;。
   レコードを返すクエリの場合、結果ハンドルは
   <function>sqlite_fetch_array</function> や
   <function>sqlite_seek</function> のような関数で使用することができます。
  </para>
  <para>
   クエリの型によらず、この関数はクエリが失敗した場合に&false; を返し
   ます。
  </para>
  <para>
   <function>sqlite_query</function> は、バッファリングされ、シーク可
   能な結果ハンドルを返します。これは、レコードにランダムにアクセスす
   る必要がある小さなクエリの場合に有用です。バッファリングされた結果
   ハンドルは、結果全体を保持するためのメモリを確保し、結果が取得され
   るまでは値を返しません。
   データに連続的にアクセスしたい場合、かわりにより高性能な
   <function>sqlite_unbuffered_query</function> を使用することが
   推奨されます。
  </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>
        <parameter>error_msg</parameter> パラメータが追加されました。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <warning>
   <simpara>
    SQLiteは、セミコロンで区切られた複数のクエリを実行します。
    これにより、ファイルからロードするかスクリプトに埋め込んだ SQL
    をバッチ実行することができます。
    しかしながら、これは関数の結果が使用されない場合のみ動作します。
    使用されない場合、最初の SQL ステートメントのみ実行されます。
    関数 <function>sqlite_exec</function> は常に複数の SQL
    ステートメントを実行します。
   </simpara>
   <simpara>
    複数のクエリを実行する際、この関数の返り値は、エラーの場合に
    &false;となります。しかし、それ以外の場合は不定となります。
    (成功した場合に&true;となるか、結果ハンドルを返す可能性があります)
   </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
 -->