pdo-mysql.xml

<?xml version="1.0" encoding="utf-8"?>
<reference xml:id="class.pdo-mysql" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 <title>The Pdo\Mysql class</title>
 <titleabbrev>Pdo\Mysql</titleabbrev>

 <partintro>

  <!-- {{{ ClassName intro -->
  <section xml:id="pdo-mysql.intro">
   &reftitle.intro;
   <simpara>
    A <classname>PDO</classname> subclass representing a connection using
    the MySQL PDO driver.
   </simpara>
   <para>
    This driver supports a dedicated SQL query parser for the MySQL dialect.
    It can handle the following:
    <itemizedlist>
     <listitem>
      <simpara>
       Single and double-quoted literals with both doubling and backslash as escaping mechanisms
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       Backtick literals with doubling as escaping mechanism
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       Two-dashes, C-style comments, and Hash-comments.
      </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>
       By default all statements are executed in
       <link linkend="mysqlinfo.concepts.buffering">buffered mode</link>.
       If this attribute is set to &false; on a
       <classname>Pdo\Mysql</classname> object,
       the MySQL driver will use the unbuffered mode.
      </simpara>
      <example><title>Setting MySQL unbuffered mode</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>
       Enable <literal>LOAD LOCAL INFILE</literal>.
      </simpara>
      <note>
       <simpara>
        Can only be used in the <parameter>driver_options</parameter>
        array when constructing a new database handle.
       </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>
       Allows restricting LOCAL DATA loading to files located in this
       designated directory.
      </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>
       Command to execute when connecting to the MySQL server.
       Will automatically be re-executed when reconnecting.
      </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>
       Read options from the named option file instead of from
       <filename>my.cnf</filename>.
      </simpara>
      <note>
       <simpara>
        This option is not available if mysqlnd is used,
        because mysqlnd does not read the mysql configuration files.
       </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>
       Read options from the named group from <filename>my.cnf</filename> or
       the file specified with
       <constant>Pdo\Mysql::ATTR_READ_DEFAULT_FILE</constant>.
      </simpara>
      <note>
       <simpara>
        This option is not available if mysqlnd is used,
        because mysqlnd does not read the mysql configuration files.
       </simpara>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="pdo-mysql.constants.attr-compress">
     <term><constant>Pdo\Mysql::ATTR_COMPRESS</constant></term>
     <listitem>
      <simpara>
       Enable network communication compression.
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="pdo-mysql.constants.attr-direct-query">
     <term><constant>Pdo\Mysql::ATTR_DIRECT_QUERY</constant></term>
     <listitem>
      <simpara>
       &Alias; <constant>PDO::ATTR_EMULATE_PREPARES</constant>.
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="pdo-mysql.constants.attr-found-rows">
     <term><constant>Pdo\Mysql::ATTR_FOUND_ROWS</constant></term>
     <listitem>
      <simpara>
       Return the number of found (matched) rows,
       not the number of changed rows.
      </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>
       Permit spaces after SQL function names.
       Makes all SQL functions names reserved words.
      </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>
       Maximum buffer size. Defaults to 1 MiB.
      </simpara>
      <note>
       <simpara>
        This constant is not supported when compiled against 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>
       Disables multi query execution in both
       <methodname>PDO::prepare</methodname> and
       <methodname>PDO::query</methodname> when set to &false;.
      </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>
       <acronym>RSA</acronym> public key file used with the SHA-256 based authentication.
      </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>
       The file path to the <acronym>SSL</acronym> key.
      </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>
       The file path to the <acronym>SSL</acronym> certificate.
      </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>
       The file path to the <acronym>SSL</acronym> certificate authority.
      </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>
       The file path to the directory that contains the trusted
       <acronym>SSL</acronym> <acronym>CA</acronym> certificates,
       which are stored in <acronym>PEM</acronym> format.
      </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>
       A list of one or more permissible ciphers to use for
       <acronym>SSL</acronym> encryption, in a format understood by OpenSSL.
       For example: <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>
       Provides a way to disable verification of the server <acronym>SSL</acronym> certificate.
      </simpara>
      <note>
       <simpara>
        This option is available only with 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
-->