Registriert eine benutzerdefinierte Aggregationsfunktion zur Verwendung in SQL-Anweisungen

# Pdo\Sqlite::createAggregate

(PHP 8 >= 8.4.0)

Pdo\Sqlite::createAggregate — Registriert eine benutzerdefinierte Aggregationsfunktion zur Verwendung in SQL-Anweisungen

### Beschreibung

public function Pdo\Sqlite::createAggregate(
string `$name`,
callable `$step`,
callable `$finalize`,
int `$numArgs` = -1
): bool

Diese Methode entspricht Pdo\Sqlite::createFunction(), mit dem Unterschied, dass sie Funktionen registriert, die verwendet werden können, um ein über alle Zeilen einer Abfrage aggregiertes Ergebnis zu berechnen.

Der Hauptunterschied zwischen dieser Methode und Pdo\Sqlite::createFunction() ist, dass zwei Funktionen notwendig sind, um das Aggregat zu verwalten.

Tipp

Mit dieser Methode ist es möglich, native SQL-Funktionen zu überschreiben.

### Parameter-Liste

`name`
  Der Name der in SQL-Anweisungen genutzten Funktion.
`step`
  Die Callback-Funktion, welche für jede Zeile des Abfrageergebnisses ausgeführt wird. Der Callback sollte das Ergebnis akkumulieren und im Aggregationskontext speichern.

  Es ist notwendig, diese Funktion wie folgt zu definieren:

  function 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 wird.
  `values`
    Weitere Argumente, die an das Aggregat übergeben werden.
  Der Rückgabewert dieser Funktion wird im nächsten Aufruf der Schritt- oder End-Funktion als Argument für `context` verwendet.
`finalize`
  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 zurückgeben, der von SQLite verstanden wird, z. B. den Skalar-Typ.

  Diese Funktion ist wie folgt zu definieren:

  function 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.
`numArgs`
  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 Pdo\Sqlite::createAggregate()-Beispiel

In diesem Beispiel wird eine benutzerdefinierte Aggregationsfunktion mit dem Namen `max_length` erstellt, die in SQL-Abfragen verwendet werden kann.

In diesem Beispiel erzeugen wir eine Aggregationsfunktion mit dem Namen `max_length`, die die Länge der längsten Zeichenkette innerhalb einer der Tabellenspalten ermittelt. Für jede durchlaufene Zeile wird die Funktion `max_len_step` mit dem Parameter `$context` aufgerufen. Der Parameter "context" ist eine normale PHP-Variable, welche ein array oder sogar ein object 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. Auf Basis der in `$context` gesammelten Daten können beliebige Berechnungen durchgeführt werden. In diesem einfachen Beispiel wurde das Ergebnis bereits während der Abfrage berechnet, so dass der Wert von "context" direkt zurückgegeben werden kann.

    <?php
    $data = [
       'one',
       'two',
       'three',
       'four',
       'five',
       'six',
       'seven',
       'eight',
       'nine',
       'ten',
    ];
    $db = new Pdo\Sqlite('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, $row_number, $string)
    {
        if (strlen($string) > $context) {
            $context = strlen($string);
        }
        return $context;
    }

    function max_len_finalize($context, $row_count)
    {
        return $context === null ? 0 : $context;
    }

    $db->createAggregate('max_len', 'max_len_step', 'max_len_finalize');

    var_dump($db->query('SELECT max_len(a) from strings')->fetchAll());

    ?>

Tipp

Es ist NICHT ratsam, eine Kopie der Werte 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 - stellen Sie sich vor, wie viel Speicherplatz Sie benötigen würden, wenn eine Million Zeilen im Speicher abgelegt würden, von denen jede eine Zeichenkette von 32 Byte Länge enthält.

### Siehe auch

- Pdo\Sqlite::createFunction() - Registriert eine benutzerdefinierte Funktion zur Verwendung in SQL-Anweisungen
- Pdo\Sqlite::createCollation() - Registers a user-defined function for use as a collating function in SQL statements
- sqlite_create_function()
- sqlite_create_aggregate()

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open