php-doc-en/reference/mysqlnd_ms/ini.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<section xml:id="mysqlnd-ms.configuration" xmlns="http://docbook.org/ns/docbook">
 &reftitle.runtime;
 &extension.runtime;
 <para>
  <table>
   <title>Mysqlnd_ms &ConfigureOptions;</title>
   <tgroup cols="4">
    <thead>
     <row>
      <entry>&Name;</entry>
      <entry>&Default;</entry>
      <entry>&Changeable;</entry>
      <entry>&Changelog;</entry>
     </row>
    </thead>
    <tbody xml:id="mysqlnd-ms.configuration.list">
     <row>
      <entry><link linkend="ini.mysqlnd-ms.enable">mysqlnd_ms.enable</link></entry>
      <entry>0</entry>
      <entry>PHP_INI_SYSTEM</entry>
      <entry><!-- leave empty, this will be filled by an automatic script --></entry>
     </row>
     <row>
      <entry><link linkend="ini.mysqlnd-ms.force-config-usage">mysqlnd_ms.force_config_usage</link></entry>
      <entry>0</entry>
      <entry>PHP_INI_SYSTEM</entry>
      <entry><!-- leave empty, this will be filled by an automatic script --></entry>
     </row>
     <row>
      <entry><link linkend="ini.mysqlnd-ms.ini-file">mysqlnd_ms.ini_file</link></entry>
      <entry>""</entry>
      <entry>PHP_INI_SYSTEM</entry>
      <entry><!-- leave empty, this will be filled by an automatic script --></entry>
     </row>
     <row>
      <entry><link linkend="ini.mysqlnd-ms.config-file">mysqlnd_ms.config_file</link></entry>
      <entry>""</entry>
      <entry>PHP_INI_SYSTEM</entry>
      <entry><!-- leave empty, this will be filled by an automatic script --></entry>
     </row>
     <row>
      <entry><link linkend="ini.mysqlnd-ms.collect-statistics">mysqlnd_ms.collect_statistics</link></entry>
      <entry>0</entry>
      <entry>PHP_INI_SYSTEM</entry>
      <entry><!-- leave empty, this will be filled by an automatic script --></entry>
     </row>
     <row>
      <entry><link linkend="ini.mysqlnd-ms.multi-master">mysqlnd_ms.multi_master</link></entry>
      <entry>0</entry>
      <entry>PHP_INI_SYSTEM</entry>
      <entry><!-- leave empty, this will be filled by an automatic script --></entry>
     </row>
     <row>
      <entry><link linkend="ini.mysqlnd-ms.disable-rw-split">mysqlnd_ms.disable_rw_split</link></entry>
      <entry>0</entry>
      <entry>PHP_INI_SYSTEM</entry>
      <entry><!-- leave empty, this will be filled by an automatic script --></entry>
     </row>
    </tbody>
   </tgroup>
  </table>
 </para>

 &ini.descriptions.title;

 <para>
  <variablelist>

   <varlistentry xml:id="ini.mysqlnd-ms.enable">
    <term>
     <parameter>mysqlnd_ms.enable</parameter>
     <type>integer</type>
    </term>
    <listitem>
     <para>
      Enables or disables the plugin. If disabled, the extension will not plug
      into
      <link linkend="book.mysqlnd">mysqlnd</link> to proxy internal
      <link linkend="book.mysqlnd">mysqlnd</link> C API calls.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry xml:id="ini.mysqlnd-ms.force-config-usage">
    <term>
     <parameter>mysqlnd_ms.force_config_usage</parameter>
     <type>integer</type>
    </term>
    <listitem>
     <para>
      If enabled, the plugin checks if the host (server) parameters value of any
      MySQL connection attempt, matches a section name from the plugin configuration
      file. If not, the connection attempt is blocked.
     </para>
     <para>
      This setting is not only useful to restrict PHP to certain servers but also
      to debug configuration file problems. The configuration file validity is checked
      at two different stages. The first check is performed when PHP begins to
      handle a web request. At this point the plugin reads and decodes the configuration
      file. Errors thrown at this early stage in an extensions life cycle may not be
      shown properly to the user. Thus, the plugin buffers the errors, if any, and
      additionally displays them when establishing a connection to MySQL.
      By default a buffered startup error will emit an error of type
      <literal>E_WARNING</literal>.  If <literal>force_config_usage</literal> is set,
      the error type used is <literal>E_RECOVERABLE_ERROR</literal>.
     </para>
     <para>
      Please, see also <link linkend="mysqlnd-ms.plugin-ini-json.debug_config">configuration
      file debugging notes</link>.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry xml:id="ini.mysqlnd-ms.ini-file">
    <term>
     <parameter>mysqlnd_ms.ini_file</parameter>
     <type>string</type>
    </term>
    <listitem>
     <para>
      Plugin specific configuration file. This setting has been
      renamed to <literal>mysqlnd_ms.config_file</literal> in version 1.4.0.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry xml:id="ini.mysqlnd-ms.config-file">
    <term>
     <parameter>mysqlnd_ms.config_file</parameter>
     <type>string</type>
    </term>
    <listitem>
     <para>
      Plugin specific configuration file. This setting superseeds
      <literal>mysqlnd_ms.ini_file</literal> since 1.4.0.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry xml:id="ini.mysqlnd-ms.collect-statistics">
    <term>
     <parameter>mysqlnd_ms.collect_statistics</parameter>
     <type>integer</type>
    </term>
    <listitem>
     <para>
      Enables or disables the collection of statistics. The collection of
      statistics is disabled by default for performance reasons.
      Statistics are returned by the function
      <function>mysqlnd_ms_get_stats</function>.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry xml:id="ini.mysqlnd-ms.multi-master">
    <term>
     <parameter>mysqlnd_ms.multi_master</parameter>
     <type>integer</type>
    </term>
    <listitem>
     <para>
      Enables or disables support of MySQL multi master replication setups.
      Please, see also <link linkend="mysqlnd-ms.supportedclusters">supported clusters</link>.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry xml:id="ini.mysqlnd-ms.disable-rw-split">
    <term>
     <parameter>mysqlnd_ms.disable_rw_split</parameter>
     <type>integer</type>
    </term>
    <listitem>
     <para>
      Enables or disables built-in read write splitting.
     </para>
     <para>
      Controls whether load balancing and lazy connection functionality can
      be used independently of read write splitting. If read write splitting
      is disabled, only servers from the master list will be used for
      statement execution. All configured slave servers will be ignored.
     </para>
     <para>
      The SQL hint <literal>MYSQLND_MS_USE_SLAVE</literal> will not be recognized.
      If found, the statement will be redirected to a master.
     </para>
     <para>
      Disabling read write splitting impacts the return value of
      <function>mysqlnd_ms_query_is_select</function>.
      The function will no longer propose query execution on slave servers.
     </para>
     <note>
      <title>Multiple master servers</title>
      <para>
       Setting <literal>mysqlnd_ms.multi_master=1</literal> allows the plugin
       to use multiple master servers, instead of only the first master server
       of the master list.
      </para>
      <para>
       Please, see also <link linkend="mysqlnd-ms.supportedclusters">supported clusters</link>.
      </para>
     </note>
    </listitem>
   </varlistentry>

  </variablelist>
 </para>
</section>

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