-
Notifications
You must be signed in to change notification settings - Fork 59
Expand file tree
/
Copy pathcreateaggregate.xml
More file actions
270 lines (260 loc) · 8.93 KB
/
createaggregate.xml
File metadata and controls
270 lines (260 loc) · 8.93 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
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 855bfee2f3db70d7dbb4c60c7c4a4efa567f1c60 Maintainer: PhilDaiguille 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>Registra una función PHP para ser utilizada como función de agregación 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>
Registra una función PHP o una función definida por el usuario para ser
utilizada como función de agregación SQL, que será utilizada en las consultas
SQL.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
Nombre de la función de agregación SQL a crear o redefinir.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>stepCallback</parameter></term>
<listitem>
<para>
Función de retrollamada llamada para cada fila en el conjunto de resultados. Su
función PHP debería acumular el resultado y almacenar su contexto de agregación.
</para>
<para>
Esta función debe ser definida como:
<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 la primera fila; en las filas siguientes esto tendrá el valor
que previamente fue retornado por la función step; debería utilizarse
esto para mantener el estado de agregación.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>rownumber</parameter></term>
<listitem>
<para>
El número de fila actual.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
El primer argumento a pasar al agregador.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>values</parameter></term>
<listitem>
<para>
Argumentos adicionales a pasar al agregador.
</para>
</listitem>
</varlistentry>
</variablelist>
El valor retornado por esta función será utilizado como argumento
<parameter>context</parameter> durante la próxima llamada a una función
de paso o final.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>finalCallback</parameter></term>
<listitem>
<para>
Función de retrollamada para agregar los "pasos" de datos de cada fila.
Una vez que todas las filas han sido procesadas, la función será llamada,
tomará los datos del contexto de agregación y retornará el resultado.
La función de retrollamada debe retornar un tipo comprendido por SQLite
(i.e. un <link linkend="language.types.intro">tipo escalar</link>).
</para>
<para>
Esta función debe ser definida como:
<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>
Contiene el valor de retorno de la última llamada a la función step.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>rownumber</parameter></term>
<listitem>
<para>
Siempre <literal>0</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
El valor de retorno de esta función será utilizado como valor de retorno para
la agregación.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>argCount</parameter></term>
<listitem>
<para>
El número de argumentos tomados por la función de agregación SQL.
Si este número es negativo, entonces la función de agregación SQL
podrá tomar un número no definido de argumentos.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retorna &true; si la creación del agregado ha tenido éxito, &return.falseforfailure;.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Ejemplo de una función de agregación con 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>
En este ejemplo, se crea una función agregativa que calculará la
longitud de la cadena de caracteres más larga en una de las columnas de la
tabla. Para cada fila, la función <literal>max_len_step</literal> es
llamada y el parámetro <literal>$context</literal> es pasado. El
parámetro de contexto es como cualquier otra variable PHP y debe ser fijado para
contener un array o incluso, un objeto. En este ejemplo,
se utiliza para contener la longitud máxima que se ha visto hasta el momento; si el
parámetro <literal>$string</literal> tiene una longitud mayor que la actual, se
actualiza el contexto para contener esta nueva longitud máxima.
</para>
<para>
Una vez que todas las filas han sido procesadas, SQLite llama a la función
<literal>max_len_finalize</literal> para determinar el resultado agregativo.
Aquí, se podrían realizar cálculos basados en los datos encontrados
en <literal>$context</literal>. En nuestro ejemplo simple, hemos
calculado el resultado como si la consulta estuviera progresando, aunque simplemente
necesitamos retornar el valor de contexto.
</para>
<tip>
<para>
No se RECOMIENDA registrar una copia de los valores en el contexto
para finalmente procesarlos. En este caso, SQLite utilizaría mucha memoria
para procesar la consulta - imagine la cantidad de memoria necesaria
si un millón de filas fueran registradas en memoria, sabiendo que cada fila
contiene una cadena de caracteres (32 bytes por cadena).
</para>
</tip>
<tip>
<para>
Puede utilizarse <methodname>SQLite3::createAggregate</methodname> para sobrescribir las
funciones nativas 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
-->