1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 330340 $ -->
<book xml:id="book.mysqlnd-qc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Mysqlnd query result cache plugin</title>
<titleabbrev>mysqlnd_qc</titleabbrev>
<preface xml:id="intro.mysqlnd-qc">
&reftitle.intro;
<para>
The mysqlnd query result cache plugin adds easy to use client-side query
caching to all PHP MySQL extensions using
<link linkend="book.mysqlnd">mysqlnd</link>.
</para>
<para>
As of version PHP 5.3.3 the MySQL native driver for PHP (
<literal>mysqlnd</literal>)
features an internal plugin C API. C plugins, such as the query cache
plugin, can extend the functionality of
<link linkend="book.mysqlnd">mysqlnd</link>.
</para>
<para>
Mysqlnd plugins such as the query cache plugin operate transparent
from a user perspective. The cache plugin supports all PHP applications
and all PHP MySQL extensions (
<link linkend="ref.mysqli">mysqli</link>,
<link linkend="ref.mysql">mysql</link>,
<link linkend="ref.pdo-mysql">PDO_MYSQL</link>).
It does not change existing APIs.
</para>
<para>
No significant application changes are required to cache a query.
The cache has two operation modes. It will either cache all
queries (not recommended) or only those queries marked with a
certain SQL hint (recommended).
</para>
<section xml:id="mysqlnd-qc.key-features">
<title>Key Features</title>
<para>
<itemizedlist>
<listitem>
<para>
Transparent and therefore easy to use
</para>
<para>
<itemizedlist>
<listitem>
<para>
supports all PHP MySQL extensions
</para>
</listitem>
<listitem>
<para>
no API changes
</para>
</listitem>
<listitem>
<para>
very little application changes required
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
<listitem>
<para>
Flexible invalidation strategy
</para>
<para>
<itemizedlist>
<listitem>
<para>
Time-to-Live (TTL)
</para>
</listitem>
<listitem>
<para>
user-defined
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
<listitem>
<para>
Storage with different scope and life-span
</para>
<para>
<itemizedlist>
<listitem>
<para>
Default (Hash, process memory)
</para>
</listitem>
<listitem>
<para>
<link linkend="ref.apc">APC</link>
</para>
</listitem>
<listitem>
<para>
MEMCACHE
</para>
</listitem>
<listitem>
<para>
sqlite
</para>
</listitem>
<listitem>
<para>
user-defined
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
<listitem>
<para>
Built-in slam defense to prevent cache stampeding.
</para>
</listitem>
</itemizedlist>
</para>
</section>
<section xml:id="mysqlnd-qc.limitations">
<title>Limitations</title>
<para>
The current 1.0.1 release of PECL mysqlnd_qc does
not support PHP 5.4. Version 1.1.0-alpha lifts this limitation.
</para>
<para>
Prepared statements and unbuffered queries are fully supported.
Thus, the plugin is capable of caching all statements issued
with <literal>mysqli</literal> or <literal>PDO_MySQL</literal>, which are
the only two PHP MySQL APIs to offer prepared statement support.
</para>
</section>
<section xml:id="mysqlnd-qc.name">
<title>On the name</title>
<para>
The shortcut <literal>mysqlnd_qc</literal>
stands for <literal>mysqlnd query cache plugin</literal>. The name
was chosen for a quick-and-dirty proof-of-concept. In the beginning
the developers did not expect to continue using the code base.
Sometimes PECL/mysqlnd_qc has also been called
<literal>client-side query result set cache</literal>.
</para>
</section>
</preface>
&reference.mysqlnd-qc.quickstart;
&reference.mysqlnd-qc.setup;
&reference.mysqlnd-qc.constants;
&reference.mysqlnd-qc.reference;
&reference.mysqlnd-qc.changes;
</book>
<!-- 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
-->
|
