SQLite3::createAggregate
(PHP 5 >= 5.3.0, PHP 7, PHP 8)
SQLite3::createAggregate — Registriert eine PHP-Funktion zum Gebrauch als SQL-Aggregat-Funktion
Beschreibung
string
$name,callable
$stepCallback,callable
$finalCallback,int
$argCount = -1): bool
Registriert eine PHP-Funktion zum Gebrauch als SQL-Aggregat-Funktion.
Parameter-Liste
-
name -
Name des erstellten oder neu definierten SQL-Aggregates.
-
stepCallback -
'Callback'-Funktion, welche für jede Reihe des Abfrageergebnisses ausgeführt wird. Ihr PHP sollte das Ergebnis akkumulieren und es im Aggregations-Kontext speichern.
Es ist notwendig, diese Funktion wie folgt zu definieren:
-
context -
nullfür die erste Reihe. Folgende Reihen werden den zuvor zurückgegebenen Wert haben. Sie sollten diesen nutzen, um den Status der Aggregation zu pflegen. -
rownumber -
Die Nummer der aktuellen Reihe.
-
value -
Das erste Argument, das an das Aggregat übergeben wurde.
-
values -
Weitere Argumente, die an das Aggregat übergeben wurden.
contextArgument im nächsten Aufruf der step oder finalize Funktion verwendet. -
-
finalCallback -
'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:
-
context -
Enthält den Rückgabewert des letzten Aufrufs der Schritt-Funktion.
-
rownumber -
Immer
0.
-
-
argCount -
Anzahl der Argumente, welche das SQL-Aggregat erwartet. Ist dieser Parameter negativ, wird das SQL-Aggregat jedwede Zahl von Argumenten erkennen.
Rückgabewerte
Gibt true zurück, wenn die Aggregierung erfolgreich war.
Bei einem Fehler wird false zurückgegeben.
Beispiele
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 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'));
?>
Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
int(5)
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.
SQLite3::createAggregate() kann verwendet werden, um native SQL-Funktionen von SQLite zu übersteuern.
