-
Notifications
You must be signed in to change notification settings - Fork 80
Expand file tree
/
Copy pathcreateaggregate.xml
More file actions
269 lines (259 loc) · 10.9 KB
/
createaggregate.xml
File metadata and controls
269 lines (259 loc) · 10.9 KB
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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 855bfee2f3db70d7dbb4c60c7c4a4efa567f1c60 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="sqlite3.createaggregate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SQLite3::createAggregate</refname>
<refpurpose>Зарегистрировать функцию PHP в качестве агрегирующей функции SQL</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="SQLite3">
<modifier>public</modifier> <type>bool</type><methodname>SQLite3::createAggregate</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>callable</type><parameter>stepCallback</parameter></methodparam>
<methodparam><type>callable</type><parameter>finalCallback</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>argCount</parameter><initializer>-1</initializer></methodparam>
</methodsynopsis>
<para>
Регистрирует функцию PHP или пользовательскую функцию в качестве
агрегирующей функции SQL для использования в запросах.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
Имя агрегирующей функции SQL, которая должна быть создана или переопределена.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>stepCallback</parameter></term>
<listitem>
<para>
Функция обратного вызова, которая будет вызвана для каждой строки
результирующего набора. Ваша PHP-функция должна аккумулировать
результат и хранить его в контексте агрегации.
</para>
<para>
Эта функция должна быть определена следующим образом:
<methodsynopsis>
<type>mixed</type><methodname><replaceable>step</replaceable></methodname>
<methodparam><type>mixed</type><parameter>context</parameter></methodparam>
<methodparam><type>int</type><parameter>rownumber</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
<methodparam rep="repeat"><type>mixed</type><parameter>values</parameter></methodparam>
</methodsynopsis>
<variablelist>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
Для первой строки должно равняться &null;;
Для всех последующих строк его значение должно быть равно значению,
возвращённому на предыдущем шаге; вы должны использовать его для сохранения
состояния агрегации.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>rownumber</parameter></term>
<listitem>
<para>
Номер текущей строки.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
Первый аргумент переданный агрегатору.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>values</parameter></term>
<listitem>
<para>
Последующие аргументы.
</para>
</listitem>
</varlistentry>
</variablelist>
Возвращаемое значение функции будет использовано как параметр
<parameter>context</parameter> при следующем запуске функции, либо как
значение передаваемое финализирующей функции.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>finalCallback</parameter></term>
<listitem>
<para>
Функция обратного вызова для вычисление итогового агрегированного
значения. Она будет вызвана как только все строки результирующего набора
будут обработаны, ей будет передан агрегирующий контекст и она вернёт
финальное значение. Данная функция должна вернуть значение типа понятного
SQLite (т.е. <link
linkend="language.types.intro">скалярный тип</link>).
</para>
<para>
Эта функция должна быть определена следующим образом:
<methodsynopsis>
<type>mixed</type><methodname><replaceable>fini</replaceable></methodname>
<methodparam><type>mixed</type><parameter>context</parameter></methodparam>
<methodparam><type>int</type><parameter>rownumber</parameter></methodparam>
</methodsynopsis>
<variablelist>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
Содержит результат самого последнего вызова агрегирующей функции.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>rownumber</parameter></term>
<listitem>
<para>
Всегда <literal>0</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
Возвращаемое значение этой функции будет использовано как
возвращаемое значение всего агрегатора.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>argCount</parameter></term>
<listitem>
<para>
Количество аргументов, которое принимает функция агрегирования SQL.
Если значение отрицательное, то функция может использовать любое количество
аргументов.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Возвращает &true; в случае успешного выполнения&return.falseforfailure;.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Пример агрегирующей функции max_length</title>
<programlisting role="php">
<![CDATA[
<?php
$data = array(
'one',
'two',
'three',
'four',
'five',
'six',
'seven',
'eight',
'nine',
'ten',
);
$db = new SQLite3(':memory:');
$db->exec("CREATE TABLE strings(a)");
$insert = $db->prepare('INSERT INTO strings VALUES (?)');
foreach ($data as $str) {
$insert->bindValue(1, $str);
$insert->execute();
}
$insert = null;
function max_len_step($context, $rownumber, $string)
{
if (strlen($string) > $context) {
$context = strlen($string);
}
return $context;
}
function max_len_finalize($context, $rownumber)
{
return $context === null ? 0 : $context;
}
$db->createAggregate('max_len', 'max_len_step', 'max_len_finalize');
var_dump($db->querySingle('SELECT max_len(a) from strings'));
?>
]]>
</programlisting>
&example.outputs;
<screen role="php">
<![CDATA[
int(5)
]]>
</screen>
</example>
</para>
<para>
В этом примере мы написали агрегирующую функцию, которая
вычисляет самой длинной строки в одной колонке таблицы.
Для каждой строки вызывается функция <literal>max_len_step</literal> и ей
передаётся параметр <literal>$context</literal>. Этот параметр ничем не отличается
от обычной переменной PHP и спокойно может содержать массив или объект.
В этом примере мы используем её для хранения максимальной найденной
длины строки. Если <literal>$string</literal> будет иметь длину больше, чем
текущая сохранённая, то значение контекста будет обновлено.
</para>
<para>
После того, как все строки обработаны, SQLite вызовет функцию
<literal>max_len_finalize</literal>, для окончательной подготовки результата.
Тут мы можем произвести необходимые расчёты на основе данных из
<literal>$context</literal>. В нашем простом примере никакая постобработке не нужна
и мы просто возвращаем полученное значение.
</para>
<tip>
<para>
НЕ рекомендуется хранить копию значений в контексте, а обработку производить
в финализирующей функции, так как это может привести к большому потреблению памяти
при обработке запроса. Просто представьте, сколько памяти вам понадобится для
хранения миллиона строк, по 32 байта каждая, в памяти.
</para>
</tip>
<tip>
<para>
Для переопределения встроенных в SQLite агрегирующих функций вы можете
использовать <methodname>SQLite3::createAggregate</methodname>.
</para>
</tip>
</refsect1>
</refentry>
<!-- 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
-->