pdo-mysql.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 70ef72d94f4d5c7d7ec7492e97563d2463d56d14 Maintainer: KentarouTakeda Status: ready -->
<!-- CREDITS: takagi,mumumu,KentarouTakeda -->
<reference xml:id="class.pdo-mysql" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 <title>Pdo\Mysql クラス</title>
 <titleabbrev>Pdo\Mysql</titleabbrev>

 <partintro>

  <!-- {{{ ClassName intro -->
  <section xml:id="pdo-mysql.intro">
   &reftitle.intro;
   <simpara>
    MySQL PDO ドライバによる接続を示す <classname>PDO</classname> サブクラスです。
   </simpara>
   <para>
    このドライバは MySQL 方言向けに専用の SQL クエリパーサーをサポートしています。
    次のものを処理可能です:
    <itemizedlist>
     <listitem>
      <simpara>
       シングルクオートやダブルクオートで囲まれたリテラルでのクオートの二重化やバックスラッシュによるエスケープ
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       バッククオートで囲まれたリテラルでのクオートの二重化によるエスケープ
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       2 つのハイフンによるコメント、C 言語形式のコメント、<literal>#</literal> によるコメント
      </simpara>
     </listitem>
    </itemizedlist>
   </para>
  </section>
  <!-- }}} -->

  <section xml:id="pdo-mysql.synopsis">
   &reftitle.classsynopsis;

   <!-- {{{ Synopsis -->
   <classsynopsis class="class">
    <ooclass>
     <classname>Pdo\Mysql</classname>
    </ooclass>

    <ooclass>
     <modifier>extends</modifier>
     <classname>PDO</classname>
    </ooclass>

    <classsynopsisinfo role="comment">&InheritedConstants;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.pdo')/db:partintro/db:section/db:classsynopsis/db:fieldsynopsis[preceding-sibling::db:classsynopsisinfo[1][@role='comment' and text()='&Constants;']]))">
     <xi:fallback/>
    </xi:include>

    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="pdo-mysql.constants.attr-use-buffered-query">Pdo\Mysql::ATTR_USE_BUFFERED_QUERY</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="pdo-mysql.constants.attr-local-infile">Pdo\Mysql::ATTR_LOCAL_INFILE</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="pdo-mysql.constants.attr-local-infile-directory">Pdo\Mysql::ATTR_LOCAL_INFILE_DIRECTORY</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="pdo-mysql.constants.attr-init-command">Pdo\Mysql::ATTR_INIT_COMMAND</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="pdo-mysql.constants.attr-max-buffer-size">Pdo\Mysql::ATTR_MAX_BUFFER_SIZE</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="pdo-mysql.constants.attr-read-default-file">Pdo\Mysql::ATTR_READ_DEFAULT_FILE</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="pdo-mysql.constants.attr-read-default-group">Pdo\Mysql::ATTR_READ_DEFAULT_GROUP</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="pdo-mysql.constants.attr-compress">Pdo\Mysql::ATTR_COMPRESS</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="pdo-mysql.constants.attr-direct-query">Pdo\Mysql::ATTR_DIRECT_QUERY</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="pdo-mysql.constants.attr-found-rows">Pdo\Mysql::ATTR_FOUND_ROWS</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="pdo-mysql.constants.attr-ignore-space">Pdo\Mysql::ATTR_IGNORE_SPACE</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="pdo-mysql.constants.attr-multi-statements">Pdo\Mysql::ATTR_MULTI_STATEMENTS</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="pdo-mysql.constants.attr-server-public-key">Pdo\Mysql::ATTR_SERVER_PUBLIC_KEY</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="pdo-mysql.constants.attr-ssl-key">Pdo\Mysql::ATTR_SSL_KEY</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="pdo-mysql.constants.attr-ssl-cert">Pdo\Mysql::ATTR_SSL_CERT</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="pdo-mysql.constants.attr-ssl-ca">Pdo\Mysql::ATTR_SSL_CA</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="pdo-mysql.constants.attr-ssl-capath">Pdo\Mysql::ATTR_SSL_CAPATH</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="pdo-mysql.constants.attr-ssl-cipher">Pdo\Mysql::ATTR_SSL_CIPHER</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="pdo-mysql.constants.attr-ssl-verify-server-cert">Pdo\Mysql::ATTR_SSL_VERIFY_SERVER_CERT</varname>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.pdo-mysql')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='Pdo\\Mysql'])">
     <xi:fallback/>
    </xi:include>

    <classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.pdo')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='PDO'])">
     <xi:fallback/>
    </xi:include>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.pdo')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='PDO'])">
     <xi:fallback/>
    </xi:include>
   </classsynopsis>
   <!-- }}} -->

  </section>

  <section xml:id="pdo-mysql.constants">
   &reftitle.constants;
   <variablelist>
    <varlistentry xml:id="pdo-mysql.constants.attr-use-buffered-query">
     <term><constant>Pdo\Mysql::ATTR_USE_BUFFERED_QUERY</constant></term>
     <listitem>
      <simpara>
       デフォルトでは、全てのステートメントが
       <link linkend="mysqlinfo.concepts.buffering">バッファモード</link>
       で実行されます。
       この値を &false; に設定すると、
       <classname>Pdo\Mysql</classname> オブジェクトの
       MySQL ドライバは非バッファモードを使います。
      </simpara>
      <example><title>MySQL の非バッファモードを使う</title>
       <programlisting role="php">
<![CDATA[
<?php
$pdo = new Pdo\Mysql("mysql:host=localhost;dbname=world", 'my_user', 'my_password');
$pdo->setAttribute(PDO::MYSQL_ATTR_USE_BUFFERED_QUERY, false);

$unbufferedResult = $pdo->query("SELECT Name FROM City");
foreach ($unbufferedResult as $row) {
    echo $row['Name'] . PHP_EOL;
}
?>
]]>
       </programlisting>
      </example>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="pdo-mysql.constants.attr-local-infile">
     <term><constant>Pdo\Mysql::ATTR_LOCAL_INFILE</constant></term>
     <listitem>
      <simpara>
       <literal>LOAD LOCAL INFILE</literal> を有効にします。
      </simpara>
      <note>
       <simpara>
       この定数を使えるのは、新しいデータベースハンドルを作るときの
       <parameter>driver_options</parameter> 配列内に限ります。
       </simpara>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="pdo-mysql.constants.attr-local-infile-directory">
     <term><constant>Pdo\Mysql::ATTR_LOCAL_INFILE_DIRECTORY</constant></term>
     <listitem>
      <simpara>
       LOCAL DATA 文によるファイルのロードを、
       ここで指定したディレクトリのみに制限します。
       PHP 8.1.0 以降で利用可能です。
      </simpara>
      <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('pdo-mysql.constants.attr-local-infile')//db:note/.)">
       <xi:fallback/>
      </xi:include>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="pdo-mysql.constants.attr-init-command">
     <term><constant>Pdo\Mysql::ATTR_INIT_COMMAND</constant></term>
     <listitem>
      <simpara>
       MySQL サーバーへの接続時に実行するコマンドを指定します。
       再接続の際には自動的に再実行されます。
      </simpara>
      <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('pdo-mysql.constants.attr-local-infile')//db:note/.)">
       <xi:fallback/>
      </xi:include>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="pdo-mysql.constants.attr-read-default-file">
     <term><constant>Pdo\Mysql::ATTR_READ_DEFAULT_FILE</constant></term>
     <listitem>
      <simpara>
       <filename>my.cnf</filename> ではなく、
       指定した名前のファイルからオプションを読み込みます。
      </simpara>
      <note>
       <simpara>
        このオプションは、mysqlnd を使っている場合は利用できません。
        mysqlnd は mysql の設定ファイルを読んでいないからです。
       </simpara>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="pdo-mysql.constants.attr-read-default-group">
     <term><constant>Pdo\Mysql::ATTR_READ_DEFAULT_GROUP</constant></term>
     <listitem>
      <simpara>
       <filename>my.cnf</filename> あるいは
       別のファイル (<constant>Pdo\Mysql::ATTR_READ_DEFAULT_FILE</constant>
       で指定したもの) の中の、指定した名前のグループからオプションを読み込みます。
      </simpara>
      <note>
       <simpara>
        このオプションは、mysqlnd を使っている場合は利用できません。
        mysqlnd は mysql の設定ファイルを読んでいないからです。
       </simpara>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="pdo-mysql.constants.attr-compress">
     <term><constant>Pdo\Mysql::ATTR_COMPRESS</constant></term>
     <listitem>
      <simpara>
       ネットワーク通信の圧縮を有効にします。
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="pdo-mysql.constants.attr-direct-query">
     <term><constant>Pdo\Mysql::ATTR_DIRECT_QUERY</constant></term>
     <listitem>
      <simpara>
       <constant>PDO::ATTR_EMULATE_PREPARES</constant> &Alias;
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="pdo-mysql.constants.attr-found-rows">
     <term><constant>Pdo\Mysql::ATTR_FOUND_ROWS</constant></term>
     <listitem>
      <simpara>
       変更された行数ではなく、
       見つかった (マッチした) 行数を返します。
      </simpara>
      <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('pdo-mysql.constants.attr-local-infile')//db:note/.)">
       <xi:fallback/>
      </xi:include>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="pdo-mysql.constants.attr-ignore-space">
     <term><constant>Pdo\Mysql::ATTR_IGNORE_SPACE</constant></term>
     <listitem>
      <simpara>
       関数名の後に続く空白を許可します。
       すべての関数名が予約語になります。
      </simpara>
      <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('pdo-mysql.constants.attr-local-infile')//db:note/.)">
       <xi:fallback/>
      </xi:include>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="pdo-mysql.constants.attr-max-buffer-size">
     <term><constant>Pdo\Mysql::ATTR_MAX_BUFFER_SIZE</constant></term>
     <listitem>
      <simpara>
       バッファの最大サイズ。デフォルトは 1 MiB です。
      </simpara>
      <note>
       <simpara>
        mysqlnd を指定してコンパイルした場合は、この定数はサポートされていません。
       </simpara>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="pdo-mysql.constants.attr-multi-statements">
     <term><constant>Pdo\Mysql::ATTR_MULTI_STATEMENTS</constant></term>
     <listitem>
      <simpara>
       &false; にすると、
       <methodname>PDO::prepare</methodname>や
       <methodname>PDO::query</methodname> でのマルチクエリの実行を無効にします。
      </simpara>
      <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('pdo-mysql.constants.attr-local-infile')//db:note/.)">
       <xi:fallback/>
      </xi:include>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="pdo-mysql.constants.attr-server-public-key">
     <term><constant>Pdo\Mysql::ATTR_SERVER_PUBLIC_KEY</constant></term>
     <listitem>
      <simpara>
       SHA-256 ベースの認証で使用する <acronym>RSA</acronym> 公開鍵ファイル。
      </simpara>
      <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('pdo-mysql.constants.attr-local-infile')//db:note/.)">
       <xi:fallback/>
      </xi:include>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="pdo-mysql.constants.attr-ssl-key">
     <term><constant>Pdo\Mysql::ATTR_SSL_KEY</constant></term>
     <listitem>
      <simpara>
       <acronym>SSL</acronym> キーのファイルパス。
      </simpara>
      <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('pdo-mysql.constants.attr-local-infile')//db:note/.)">
       <xi:fallback/>
      </xi:include>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="pdo-mysql.constants.attr-ssl-cert">
     <term><constant>Pdo\Mysql::ATTR_SSL_CERT</constant></term>
     <listitem>
      <simpara>
       <acronym>SSL</acronym> 証明書のファイルパス。
      </simpara>
      <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('pdo-mysql.constants.attr-local-infile')//db:note/.)">
       <xi:fallback/>
      </xi:include>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="pdo-mysql.constants.attr-ssl-ca">
     <term><constant>Pdo\Mysql::ATTR_SSL_CA</constant></term>
     <listitem>
      <simpara>
       <acronym>SSL</acronym> 認証局のファイルパス。
      </simpara>
      <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('pdo-mysql.constants.attr-local-infile')//db:note/.)">
       <xi:fallback/>
      </xi:include>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="pdo-mysql.constants.attr-ssl-capath">
     <term><constant>Pdo\Mysql::ATTR_SSL_CAPATH</constant></term>
     <listitem>
      <simpara>
       信頼済みの
       <acronym>SSL</acronym> <acronym>CA</acronym> 証明書が入ったディレクトリパス。
       証明書は、<acronym>PEM</acronym> フォーマットで格納されています。
      </simpara>
      <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('pdo-mysql.constants.attr-local-infile')//db:note/.)">
       <xi:fallback/>
      </xi:include>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="pdo-mysql.constants.attr-ssl-cipher">
     <term><constant>Pdo\Mysql::ATTR_SSL_CIPHER</constant></term>
     <listitem>
      <simpara>
       <acronym>SSL</acronym> 暗号化に使うひとつ以上の暗号の一覧。
       OpenSSL で有効なフォーマットで指定します。
       例: <literal>DHE-RSA-AES256-SHA:AES128-SHA</literal>
      </simpara>
      <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('pdo-mysql.constants.attr-local-infile')//db:note/.)">
       <xi:fallback/>
      </xi:include>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="pdo-mysql.constants.attr-ssl-verify-server-cert">
     <term><constant>Pdo\Mysql::ATTR_SSL_VERIFY_SERVER_CERT</constant></term>
     <listitem>
      <simpara>
       サーバーの <acronym>SSL</acronym> 証明書の検証を無効にする方法を提供します。
       PHP 7.0.18 および PHP 7.1.4 以降で使用できます。
      </simpara>
      <note>
       <simpara>
        このオプションは、mysqlnd でのみ利用可能です。
       </simpara>
      </note>
      <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('pdo-mysql.constants.attr-local-infile')//db:note/.)">
       <xi:fallback/>
      </xi:include>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>
 </partintro>

 &reference.pdo-mysql.pdo.entities.mysql;

</reference>
<!-- 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
-->