(PHP 5 >= 5.1.0, PHP 7, PECL pdo_sqlite >= 1.0.0)
PDO::sqliteCreateAggregate — Регистрация аггрегирующей пользовательской функции для использования в SQL-запросах
$function_name
, callable $step_func
, callable $finalize_func
[, int $num_args
] )Эта функция является ЭКСПЕРИМЕНТАЛЬНОЙ. Поведение этой функции, ее имя и относящаяся к ней документация могут измениться в последующих версиях PHP без уведомления. Используйте эту функцию на свой страх и риск.
Этот метод аналогичен PDO::sqliteCreateFunction за исключением того, что он регистрирует функцию, которую можно использовать для вычисления аггрегированного результата по всем строкам в запросе.
Ключевое отличие этого метода от PDO::sqliteCreateFunction в том, что для управление аггрегированием требует использование двух функций.
function_nameИмя функции для использовании в запросах.
step_funcФункция обратного вызова для каждой строки в результирующем наборе. Ваша PHP-функция должна акумулировать результат и сохранять его в контексте аггрегации.
Эта функция должна быть определена следующим образом:
Для первой строки context должен равняться NULL;
Для всех последующих строк его значение должно быть равно значению,
возвращенному на предыдущем шаге; вы должны использовать его для сохранения
состояния аггрегации.
Параметр rownumber должен быть равен номеру текущей строки.
Возвращаемое значение функции будет использовано как параметр
context при следующем запуске функции, либо как
значение передаваемое финализирующей функции.
finalize_funcФункция обратного вызова для вычисление итогового аггрегированного значения. Она будет вызвана как только все строки результирующего набора будут обработаны, ей будет передан аггрегирующий контекст и она вернет финальное значение. Данная функция должна вернуть значение типа понятного SQLite (т.е. скалярный тип).
Эта функция должна быть определена следующим образом:
context - значение, возвращанное самым последним вызовом аггрегирующей функции step_func.
rownumber - количество строк, к которым применялась аггрегирующая функция.
Возвращаемое значение этой функции будет использовано как результат аггрегации.
num_argsПодсказка для парсера SQLite, если функция обратного вызова получает заданное количество аргументов.
Возвращает TRUE в случае успешного завершения или FALSE в случае возникновения ошибки.
Пример #1 Пример аггрегирующей функции max_length
<?php
$data = array(
'one',
'two',
'three',
'four',
'five',
'six',
'seven',
'eight',
'nine',
'ten',
);
$db = new PDO('sqlite::memory:');
$db->exec("CREATE TABLE strings(a)");
$insert = $db->prepare('INSERT INTO strings VALUES (?)');
foreach ($data as $str) {
$insert->execute(array($str));
}
$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->sqliteCreateAggregate('max_len', 'max_len_step', 'max_len_finalize');
var_dump($db->query('SELECT max_len(a) from strings')->fetchAll());
?>
В этом примере мы создали аггрегирующую функцию, которая
вычисляет длину самой большой строки в одном из столбцов таблицы.
Для каждой строки, вызывается функция max_len_step и ей
передается параметр context. Этот параметр,
как и любая другая переменная PHP может содержать и массив и объект.
В данном примере она используется для хранения максимальной длины строки;
Если string имеет длину большую, чем содержится в
контексте, мы обновляем контекст новым значением.
После того, как будут обработаны все строки, SQLite вызовет функцию
max_len_finalize для вычисления результата аггрегации.
В ней мы производим вычисления, основываясь на данных из
context. В нашем простом примере мы просто
возвращаем его значение, так как никакие дополнительные вычисления не требуются.
КРАЙНЕ НЕ рекомендуется сохранять в контексте копии значений для обработки их в финализирующей функции, так как это повлечет за собой большой перерасход памяти SQLite для обработки запроса. Просто представьте, сколько памяти вам понадобится, если вам потребуется аггрегировать, например, миллион значений по 32 байта.
Вы можете использовать PDO::sqliteCreateFunction и PDO::sqliteCreateAggregate для переопределения стандартных аггрегирующих функций SQLite.
Замечание:
Этот метод недоступен с драйвером SQLite2. В этом случае используйте старое sqlite API.