(PHP 5 >= 5.1.0, PHP 7, PECL pdo_sqlite >= 1.0.0)
PDO::sqliteCreateAggregate — Registriert eine aggregierte, benutzerdefinierte Funktion, die in einer SQLite-Anfrage genutzt werden kann
$function_name
, callable $step_func
, callable $finalize_func
[, int $num_args
] ) : boolDiese Funktion ist EXPERIMENTELL. Das Verhalten, der Funktionsname und alles Andere, was hier dokumentiert ist, kann sich in zukünftigen PHP-Versionen ohne Ankündigung ändern. Seien Sie gewarnt und verwenden Sie diese Funktion auf eigenes Risiko.
Diese Methode entspricht PDO::sqliteCreateFunction, mit dem Unterschied, dass sie Funktionen registriert, welche benutzt werden können, ein Ergebnis über alle Reihen einer Anfrage zu aggregieren.
Der Hauptunterschied zwischen dieser Methode und PDO::sqliteCreateFunction ist, dass zwei Funktionen notwendig sind, um die Aggregierung zu verwalten.
function_nameDer Name der in der Anfrage genutzten Funktion.
step_func'Callback'-Funktion, welche für jede Reihe des Abfrageergebnisses ausgeführt wird. Ihr PHP sollte das Ergebnis akkumulieren und in der Aggregation 'context' speichern.
Es ist notwendig, diese Funktion wie folgt zu definieren:
context
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.
rownumberDie Nummer der aktuellen Reihe.
value1Das erste Argument, das an das Aggregat übergeben wurde.
...Weitere Argumente, die an das Aggregat übergeben wurden.
context
Argument im nächsten Aufruf der step oder finalize Funktion verwendet.
finalize_func'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 (z.B. scalar type).
Diese Funktion ist wie folgt zu definieren:
contextEnthält den Rückgabewert des letzten Aufrufs der Schritt-Funktion.
rowcountEnthält die Anzahl an Reihen, die bereits aggregiert wurden.
num_argsHinweis für den SQLite-Parser, ob die 'Callback'-Funktion eine bestimmte Anzahl an Parametern erwartet.
Gibt bei Erfolg TRUE zurück. Im Fehlerfall wird FALSE zurückgegeben.
Beispiel #1 Beispiel für eine 'max_length'-Aggregierungs-Funktion
<?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, $rowcount)
{
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());
?>
In diesem Beispiel erzeugen wir eine Aggregat-Funktion, die die Länge der längsten Zeichenkette innerhalb einer der Tabellenspalten ermittelt. Die max_len_step-Funktion wird für jede durchlaufene Reihe mit dem Parameter $context 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 $string länger ist, als die aktuell Längste, wird der Inhalt von 'context' mit der neuen Länge überschrieben.
Nachdem alle Reihen abgearbeitet wurden, ruft SQLite die max_len_finalize-Funktion auf, um das Endergebnis zu ermitteln. Hier können wir nun jede Art von Berechnungen, basierend auf den in $context 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.
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.
Sie können PDO::sqliteCreateFunction und PDO::sqliteCreateAggregate nutzen, um SQLites native SQL-Funktionen zu überschreiben.
Hinweis:
Diese Methode ist im SQLite2-Treiber nicht verfügbar. Benutzen Sie stattdessen die alte SQLite-API.