PDO::sqliteCreateAggregate

(PHP 5 >= 5.1.0, PHP 7, PHP 8, PECL pdo_sqlite >= 1.0.0)

PDO::sqliteCreateAggregate — Registriert eine benutzerdefinierte Aggregationsfunktion zur Verwendung in SQL-Annweisungen

Beschreibung

public PDO::sqliteCreateAggregate(
    string $function_name,
    callable $step_func,
    callable $finalize_func,
    int $num_args = ?
): bool

Warnung

Diese Funktion ist EXPERIMENTELL. Das Verhalten, der Funktionsname und die zugehörige Dokumentation können sich in zukünftigen PHP-Versionen ohne Ankündigung ändern. Die Verwendung dieser Funktion erfolgt auf eigene Gefahr.

Diese Methode entspricht PDO::sqliteCreateFunction, mit dem Unterschied, dass sie Funktionen registriert, welche benutzt werden können, ein Ergebnis über alle Zeilen einer Anfrage zu aggregieren.

Der Hauptunterschied zwischen dieser Methode und PDO::sqliteCreateFunction ist, dass zwei Funktionen notwendig sind, um das Aggregat zu verwalten.

Parameter-Liste

function_name

Der Name der in SQL-Anweisungen genutzten Funktion.

step_func

Die Callback-Funktion, welche für jede Zeile des Abfrageergebnisses ausgeführt wird. Ihr PHP sollte das Ergebnis akkumulieren und im Aggregationskontext speichern.

Es ist notwendig, diese Funktion wie folgt zu definieren:

step(
    mixed $context,
    int $rownumber,
    mixed $value,
    mixed ...$values
): mixed

context: Der Aggregationskontext. null für die erste Zeile; in den folgenden Zeilen hat er den Wert, der zuvor von der Schritt-Funktion zurückgegeben wurde. Sie sollten diesen nutzen, um den Aggregationszustand zu bewahren.
rownumber: Die Nummer der aktuellen Zeile.
value: Das erste Argument, das an das Aggregat übergeben wurde.
values: Weitere Argumente, die an das Aggregat übergeben wurden.

Der Rückgabewert dieser Funktion wird als context-Argument im nächsten Aufruf der Schritt- oder End-Funktion verwendet.

finalize_func

Die Callback-Funktion, die die Informationen aller Zeilen aggregiert. Sind alle Zeilen abgearbeitet, wird diese Funktion aufgerufen. Diese sollte dann die Daten des Aggregationskontexts auswerten und das Ergebnis zurückgeben. Diese Callback-Funktion sollte einen Variablentyp liefern, der von SQLite erwartet wird, z. B. den Skalar-Typ.

Diese Funktion ist wie folgt zu definieren:

fini(mixed $context, int $rowcount): mixed

context: Enthält den Rückgabewert des letzten Aufrufs der Schritt-Funktion.
rowcount: Enthält die Anzahl an Zeilen, die bereits aggregiert wurden.

Der Rückgabewert dieser Funktion wird als Rückgabewert für die Aggregation genutzt.

num_args

Hinweis für den SQLite-Parser, ob die Callback-Funktion eine bestimmte Anzahl an Parametern erwartet.

Rückgabewerte

Gibt bei Erfolg true zurück. Bei einem Fehler wird false zurückgegeben.

Beispiele

Beispiel #1 Beispiel für eine 'max_length'-Aggregationsfunktion

<?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 Aggregationsfunktion, die die Länge der längsten Zeichenkette innerhalb einer der Tabellenspalten ermittelt. Die max_len_step-Funktion wird für jede durchlaufene Zeile mit dem Parameter $context aufgerufen. Der Parameter 'context' ist eine normal PHP-Variable, welche ein Array oder sogar einen Objektwert beinhalten kann. In diesem Beispiel benötigen wir ihn als Speicher für die größte bisher gefundene Länge. Wenn 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 Zeilen 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 einfachen Beispiel haben wir die Berechnungen jedoch bereits bei der Datenerhebung getätigt, sodass wir nun nur noch den Inhalt von 'context' zurückzugeben brauchen.

Tipp

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 Zeilen mit je 32 Byte Inhalt aus der Datenbank liest.

Tipp

Sie können PDO::sqliteCreateFunction und PDO::sqliteCreateAggregate nutzen, um SQLites native SQL-Funktionen zu überschreiben.

Siehe auch

PDO::sqliteCreateFunction
sqlite_create_function()
sqlite_create_aggregate()

add a note

User Contributed Notes

There are no user contributed notes for this page.