-
Notifications
You must be signed in to change notification settings - Fork 164
Expand file tree
/
Copy pathcreateaggregate.xml
More file actions
271 lines (261 loc) · 9.07 KB
/
createaggregate.xml
File metadata and controls
271 lines (261 loc) · 9.07 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
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 855bfee2f3db70d7dbb4c60c7c4a4efa567f1c60 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<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>Enregistre une fonction PHP à utiliser comme fonction d'agrégation SQLite</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>
Enregistre une fonction PHP ou une fonction définie par l'utilisateur à
utiliser comme fonction d'agrégation SQL, qui sera utilisée dans les requêtes
SQL.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
Nom de la fonction d'agrégation SQL à créer ou à redéfinir.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>stepCallback</parameter></term>
<listitem>
<para>
Fonction de rappel appelée pour chaque ligne dans le jeu de résultats. La
fonction PHP devrait accumuler le résultat et stocker son contexte d'agrégation.
</para>
<para>
Cette fonction doit être définie comme :
<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; pour la première ligne ; sur les lignes suivantes ceci aura la valeur
qui a été précédemment retournée par la fonction step ; il est recommandé d'utiliser
ceci pour maintenir l'état d'agrégation.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>rownumber</parameter></term>
<listitem>
<para>
Le numéro de ligne courante.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
Le premier argument à passer à l'agrégateur.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>values</parameter></term>
<listitem>
<para>
Arguments supplémentaires à passer à l'agrégateur.
</para>
</listitem>
</varlistentry>
</variablelist>
La valeur retournée de cette fonction sera utilisée comme argument
<parameter>context</parameter> lors du prochain appel d'une fonction
d'étape ou finale.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>finalCallback</parameter></term>
<listitem>
<para>
Fonction de rappel pour agréger les "étapes" de données de chaque ligne.
Une fois que toutes les lignes ont été traitées, la fonction sera appelée,
prendra les données du contexte d'agrégation et retournera le résultat.
La fonction de rappel doit retourner un type compris par SQLite
(c.-à-d. un <link linkend="language.types.intro">type scalaire</link>).
</para>
<para>
Cette fonction doit être définie comme :
<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>
Contient la valeur de retour du tout dernier appel à la fonction step.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>rownumber</parameter></term>
<listitem>
<para>
Toujours <literal>0</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
La valeur de retour de cette fonction sera utilisée comme valeur de retour pour
l'agrégation.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>argCount</parameter></term>
<listitem>
<para>
Le nombre d'arguments pris par la fonction d'agrégation SQL.
Si ce nombre est négatif, alors la fonction d'agrégation SQL
pourra prendre un nombre non défini d'arguments.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne &true; si la création de l'agrégat a réussi, &return.falseforfailure;.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemple d'une fonction d'agrégation avec 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>
Dans cet exemple, on crée une fonction agrégative qui va calculer la
longueur de la plus grande chaîne de caractères dans une des colonnes de la
table. Pour chaque ligne, la fonction <literal>max_len_step</literal> est
appelée et le paramètre <literal>$context</literal> est passé. Le
paramètre de contexte est comme n'importe quelle autre variable PHP et
doit être fixé pour contenir un tableau ou même, un objet. Dans cet exemple,
nous l'utilisons pour contenir la taille maximale que nous avons vu jusqu'à
présent ; si le paramètre <literal>$string</literal> a une grandeur plus
importante que celle courante, on met à jour le contexte pour contenir cette
nouvelle taille maximale.
</para>
<para>
Une fois que toutes les lignes ont été traitées, SQLite appelle la fonction
<literal>max_len_finalize</literal> pour déterminer le résultat agrégatif.
Ici, nous pourrions effectuer des calculs basés sur les données trouvées
dans <literal>$context</literal>. Dans notre exemple simple, nous avons
calculé le résultat comme si la requête progressait, alors que nous avons
simplement besoin de retourner la valeur de contexte.
</para>
<tip>
<para>
Il n'est PAS recommandé d'enregistrer une copie des valeurs dans le contexte
pour finalement les traiter. Dans ce cas, SQLite utiliserait beaucoup trop
de mémoire pour traiter la requête - imaginez la quantité de mémoire nécessaire
si un million de lignes étaient enregistrées en mémoire, sachant que chaque ligne
contient une chaîne de caractères (32 octets par chaîne).
</para>
</tip>
<tip>
<para>
Il est possible d'utiliser <methodname>SQLite3::createAggregate</methodname> pour surcharger les
fonctions natives de SQLite.
</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
-->