-
Notifications
You must be signed in to change notification settings - Fork 50
Expand file tree
/
Copy pathcreateaggregate.xml
More file actions
272 lines (263 loc) · 8.87 KB
/
createaggregate.xml
File metadata and controls
272 lines (263 loc) · 8.87 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
270
271
272
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 855bfee2f3db70d7dbb4c60c7c4a4efa567f1c60 Maintainer: lapistano Status: ready -->
<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>
Registriert eine PHP-Funktion zum Gebrauch als SQL-Aggregat-Funktion
</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>
Registriert eine PHP-Funktion zum Gebrauch als SQL-Aggregat-Funktion.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
Name des erstellten oder neu definierten SQL-Aggregates.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>stepCallback</parameter></term>
<listitem>
<para>
'Callback'-Funktion, welche für jede Reihe des Abfrageergebnisses
ausgeführt wird. Ihr PHP sollte das Ergebnis akkumulieren und es im
Aggregations-Kontext speichern.
</para>
<para>
Es ist notwendig, diese Funktion wie folgt zu definieren:
<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; für die erste Reihe. Folgende Reihen werden den zuvor
zurückgegebenen Wert haben. Sie sollten diesen nutzen, um den
Status der Aggregation zu pflegen.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>rownumber</parameter></term>
<listitem>
<para>
Die Nummer der aktuellen Reihe.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
Das erste Argument, das an das Aggregat übergeben wurde.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>values</parameter></term>
<listitem>
<para>
Weitere Argumente, die an das Aggregat übergeben wurden.
</para>
</listitem>
</varlistentry>
</variablelist>
Der Rückgabewert dieser Funktion wird als <parameter>context</parameter>
Argument im nächsten Aufruf der step oder finalize Funktion verwendet.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>finalCallback</parameter></term>
<listitem>
<para>
'Callback'-Funktion, die die Informationen aller Reihen aggregiert.
Sind alle Reihen abgearbeitet, wird diese Funktion aufgerufen. Diese
sollte dann die Daten der Aggregation 'context' auswerten und das
Ergebnis zurückgeben. 'Callback'-Funktionen sollten einen Variablentyp
liefern, der von SQLite erwartet wird (&zb;
<link linkend="language.types.intro">scalar type</link>).
</para>
<para>
Diese Funktion ist wie folgt zu definieren:
<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>
Enthält den Rückgabewert des letzten Aufrufs der Schritt-Funktion.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>rownumber</parameter></term>
<listitem>
<para>
Immer <literal>0</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
Der Rückgabewert dieser Funktion wird als Rückgabewert für die
Aggregation genutzt.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>argCount</parameter></term>
<listitem>
<para>
Anzahl der Argumente, welche das SQL-Aggregat erwartet.
Ist dieser Parameter negativ, wird das SQL-Aggregat jedwede Zahl von
Argumenten erkennen.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Gibt &true; zurück, wenn die Aggregierung erfolgreich war.
&return.falseforfailure;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Beispiel für eine 'max_length'-Aggregierungs-Funktion</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>
In diesem Beispiel erzeugen wir eine Aggregat-Funktion, die die Länge
der längsten Zeichenkette innerhalb einer der Tabellenspalten ermittelt.
Die <literal>max_len_step</literal>-Funktion wird für jede durchlaufene Reihe
mit dem Parameter <literal>$context</literal> aufgerufen. Der Parameter
'context' ist eine normal PHP Variable, welche Listen oder Objektinhalte
beinhalten kann. In diesem Beispiel benötigen wir sie als Speicher für die
größte bisher gefundene Länge der geprüften Zeichenketten. Wenn also die
die Zeichenkette in <literal>$string</literal> länger ist, als die aktuell
Längste, wird der Inhalt von 'context' mit der neuen Länge überschrieben.
</para>
<para>
Nachdem alle Reihen abgearbeitet wurden, ruft SQLite die
<literal>max_len_finalize</literal>-Funktion auf, um das Endergebnis
zu ermitteln. Hier können wir nun jede Art von Berechnungen,
basierend auf den in <literal>$context</literal> gesammelten Daten,
durchführen. In unserem Beispiel haben wir die Berechgungen bereits bei
der Datenerhebung getätigt, dass wir nun nur noch das Ergebnis -
den Inhalt von 'context' - zurückgeben brauchen.
</para>
<tip>
<para>
Es ist nicht ratsam, eine Kopie der Inhalte in 'context' zu speichern,
um diese dann am Ende auszuwerten. Das würde dazu führen, dass SQLite eine
große Menge an Speicher benötigt, um die Abfrage abzuarbeiten. Überlegen Sie
nur mal, wieviel Speicher eine Abfrage braucht, die 1 Millionen Reihen mit
je 32 Byte Inhalt aus der Datenbank liest.
</para>
</tip>
<tip>
<para>
<methodname>SQLite3::createAggregate</methodname> kann verwendet werden, um
native SQL-Funktionen von SQLite zu übersteuern.
</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
-->