mysql-unbuffered-query.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e41806c30bf6975e452c0d4ce35ab0984c2fa68c Maintainer: takagi Status: ready -->
<refentry xml:id="function.mysql-unbuffered-query" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mysql_unbuffered_query</refname>
  <refpurpose>MySQL に SQL クエリを送信するが、結果に対してのフェッチやバッファリングは行わない</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
  <warning>
   &mysql.alternative.note;
   <simplelist role="alternatives">
    <member><link linkend="mysqlinfo.concepts.buffering">Buffered and Unbuffered queries</link> を参照</member>
   </simplelist>
  </warning>
 </refsynopsisdiv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>mysql_unbuffered_query</methodname>
   <methodparam><type>string</type><parameter>query</parameter></methodparam>
   <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter><initializer>NULL</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>mysql_unbuffered_query</function> は SQL クエリ
   <parameter>query</parameter> を MySQL に送信します。その際、
   <function>mysql_query</function> が行っているような自動バッファリングを
   行いません。一方、この挙動により SQL クエリが消費するメモリの量を
   おさえられます。また、最初の 1 行目が取得されたらすぐに処理を
   はじめることができます。SQL の処理が完全に終わるまで待つ必要がありません。
   複数の DB 接続を利用する場合には、オプションのパラメータ
   <parameter>link_identifier</parameter> を指定する必要があります。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>query</parameter></term>
     <listitem>
      <para>
       実行する SQL クエリ。
      </para>
      <para>
       クエリ内のデータは <link
       linkend="function.mysql-real-escape-string">適切にエスケープ</link>
       する必要があります。
      </para>
     </listitem>
    </varlistentry>
    &mysql.linkid.description;
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   SELECT, SHOW, DESCRIBE あるいは EXPLAIN では、
   <function>mysql_unbuffered_query</function> は
   成功した場合に <type>resource</type> 、エラー時に &false; を返します。
  </para>
  <para>
   UPDATE, DELETE, DROP, などその他の SQL 文では、
   <function>mysql_unbuffered_query</function> は
   成功した場合に &true; 、エラー時に &false; を返します。
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    <function>mysql_unbuffered_query</function> の利点には、以下のような
    代償があります:
    <function>mysql_unbuffered_query</function> から返される結果セットには、
    すべての行をフェッチするまでは
    <function>mysql_num_rows</function> や <function>mysql_data_seek</function>
    を使用できません。また、結果の行をすべてフェッチするまで、
    同じ <parameter>link_identifier</parameter>
    を使って MySQL に新しいクエリを送信することができません。
   </para>
  </note>
 </refsect1>

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