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

405 lines
12 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="mysqlnd-qc.configuration" xmlns="http://docbook.org/ns/docbook">
&reftitle.runtime;
&extension.runtime;
<para>
<table>
<title>mysqlnd_qc &ConfigureOptions;</title>
<tgroup cols="4">
<thead>
<row>
<entry>&Name;</entry>
<entry>&Default;</entry>
<entry>&Changeable;</entry>
<entry>&Changelog;</entry>
</row>
</thead>
<tbody>
<row>
<entry>mysqlnd_qc.enable_qc</entry>
<entry>1</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry><!-- leave empty, this will be filled by an automatic script -->
</entry>
</row>
<row>
<entry>mysqlnd_qc.ttl</entry>
<entry>30</entry>
<entry>PHP_INI_ALL</entry>
<entry><!-- leave empty, this will be filled by an automatic script -->
</entry>
</row>
<row>
<entry>mysqlnd_qc.cache_by_default</entry>
<entry>0</entry>
<entry>PHP_INI_ALL</entry>
<entry><!-- leave empty, this will be filled by an automatic script -->
</entry>
</row>
<row>
<entry>mysqlnd_qc.cache_no_table</entry>
<entry>0</entry>
<entry>PHP_INI_ALL</entry>
<entry><!-- leave empty, this will be filled by an automatic script -->
</entry>
</row>
<row>
<entry>mysqlnd_qc.use_request_time</entry>
<entry>0</entry>
<entry>PHP_INI_ALL</entry>
<entry><!-- leave empty, this will be filled by an automatic script -->
</entry>
</row>
<row>
<entry>mysqlnd_qc.time_statistics</entry>
<entry>1</entry>
<entry>PHP_INI_ALL</entry>
<entry><!-- leave empty, this will be filled by an automatic script -->
</entry>
</row>
<row>
<entry>mysqlnd_qc.collect_statistics</entry>
<entry>0</entry>
<entry>PHP_INI_ALL</entry>
<entry><!-- leave empty, this will be filled by an automatic script -->
</entry>
</row>
<row>
<entry>mysqlnd_qc.collect_query_trace</entry>
<entry>0</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry><!-- leave empty, this will be filled by an automatic script -->
</entry>
</row>
<row>
<entry>mysqlnd_qc.query_trace_bt_depth</entry>
<entry>3</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry><!-- leave empty, this will be filled by an automatic script -->
</entry>
</row>
<row>
<entry>mysqlnd_qc.slam_defense</entry>
<entry>0</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry><!-- leave empty, this will be filled by an automatic script -->
</entry>
</row>
<row>
<entry>mysqlnd_qc.slam_defense_ttl</entry>
<entry>30</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry><!-- leave empty, this will be filled by an automatic script -->
</entry>
</row>
<row>
<entry>mysqlnd_qc.collect_normalized_query_trace</entry>
<entry>0</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry><!-- leave empty, this will be filled by an automatic script -->
</entry>
</row>
<row>
<entry>mysqlnd_qc.std_data_copy</entry>
<entry>0</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry><!-- leave empty, this will be filled by an automatic script -->
</entry>
</row>
<row>
<entry>mysqlnd_qc.apc_prefix</entry>
<entry>qc_</entry>
<entry>PHP_INI_ALL</entry>
<entry><!-- leave empty, this will be filled by an automatic script -->
</entry>
</row>
<row>
<entry>mysqlnd_qc.memc_server</entry>
<entry>127.0.0.1</entry>
<entry>PHP_INI_ALL</entry>
<entry><!-- leave empty, this will be filled by an automatic script -->
</entry>
</row>
<row>
<entry>mysqlnd_qc.memc_port</entry>
<entry>11211</entry>
<entry>PHP_INI_ALL</entry>
<entry><!-- leave empty, this will be filled by an automatic script -->
</entry>
</row>
<row>
<entry>mysqlnd_qc.sqlite_data_file</entry>
<entry>:memory:</entry>
<entry>PHP_INI_ALL</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-qc.enable-qc">
<term>
<parameter>mysqlnd_qc.enable_qc</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-qc.ttl">
<term>
<parameter>mysqlnd_qc.ttl</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Default Time-to-Live (TTL) for cache entries in seconds.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.mysqlnd-qc.cache-by-default">
<term>
<parameter>mysqlnd_qc.cache_by_default</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Cache all queries regardless if they begin with the SQL hint that
enables caching of a query or not. Storage handler cannot overrule
the setting. It is evaluated by the core of the plugin.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.mysqlnd-qc.cache-no-table">
<term>
<parameter>mysqlnd_qc.cache_no_table</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Cache queries with no table name in any of columns meta data
of their result set, e.g.
<literal>SELECT SLEEP(1)</literal>?
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.mysqlnd-qc.use-request-time">
<term>
<parameter>mysqlnd_qc.use_request_time</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Use PHP global request time to avoid
<literal>gettimeofday()</literal> system calls?
If using
<literal>
<link linkend="ref.apc">APC</link>
</literal> storage handler
it should be set to the value of
<literal>
<link linkend="apc.configuration">apc.use_request_time</link>
</literal>, if not
warnings will be generated.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.mysqlnd-qc.time-statistics">
<term>
<parameter>mysqlnd_qc.time_statistics</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Collect run time and store time statistics using
<literal>gettimeofday()</literal> system call? Data will be
collected only if you also set
<literal>mysqlnd_qc.collect_statistics = 1</literal>,
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.mysqlnd-qc.collect-statistics">
<term>
<parameter>mysqlnd_qc.collect_statistics</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Collect statistics for
<function>mysqlnd_qc_get_core_stats()</function>?
Does not influence storage handler statistics! Handler statistics
can be an integral part of the handler internal storage format.
Thereofore, collection of some handler statistics cannot be disabled.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.mysqlnd-qc.collect-query-trace">
<term>
<parameter>mysqlnd_qc.collect_query_trace</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Collect query back traces?
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.mysqlnd-qc.query-trace-bt-depth">
<term>
<parameter>mysqlnd_qc.query_trace_bt_depth</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Maximum depth/level of a query code backtrace.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.mysqlnd-qc.slam-defense">
<term>
<parameter>mysqlnd_qc.slam_defense</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Activates handler based slam defense if available.
Supported by
<literal>Default</literal> and
<literal>
<link linkend="ref.apc">APC</link>
</literal> storage handler
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.mysqlnd-qc.slam-defense-ttl">
<term>
<parameter>mysqlnd_qc.slam_defense_ttl</parameter>
<type>integer</type>
</term>
<listitem>
<para>
<literal>TTL</literal> for stale cache entries which are
served while another client updates the entries. Supported by
<literal>
<link linkend="ref.apc">APC</link>
</literal>
storage handler.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.mysqlnd-qc.collect-normalized-query-trace">
<term>
<parameter>mysqlnd_qc.collect_normalized_query_trace</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Collect aggregated normalized query traces? The setting
has no effect by default. You compile the extension
using the define
<literal>NORM_QUERY_TRACE_LOG</literal> to make use of the setting.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.mysqlnd-qc.std-data-copy">
<term>
<parameter>mysqlnd_qc.std_data_copy</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Default storage handler: copy cached wire data?
EXPERIMENTAL use default setting!
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.mysqlnd-qc.apc-prefix">
<term>
<parameter>mysqlnd_qc.apc_prefix</parameter>
<type>string</type>
</term>
<listitem>
<para>
The
<literal>
<link linkend="ref.apc">APC</link>
</literal> storage handler stores data in the
<literal>APC</literal> user cache. The setting sets a prefix to be
used for cache entries.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.mysqlnd-qc.memc-server">
<term>
<parameter>mysqlnd_qc.memc_server</parameter>
<type>string</type>
</term>
<listitem>
<para>
<literal>MEMCACHE</literal> storage handler: memcache server host.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.mysqlnd-qc.memc-port">
<term>
<parameter>mysqlnd_qc.memc_port</parameter>
<type>integer</type>
</term>
<listitem>
<para>
<literal>MEMCACHE</literal> storage handler: memcached server port.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.mysqlnd-qc.sqlite-data-file">
<term>
<parameter>mysqlnd_qc.sqlite_data_file</parameter>
<type>string</type>
</term>
<listitem>
<para>
<literal>sqlite</literal> storage handler: data file. Any setting
but
<literal>:memory:</literal> may be of little practical value.
</para>
</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
-->