Forum und email

PDO::sqliteCreateAggregate

(No version information available, might be only in CVS)

PDO::sqliteCreateAggregate — Référence une fonction définie par l'utilisateur agrégative pour une utilisation dans les requêtes SQL

Description

bool PDO::sqliteCreateAggregate ( string $function_name , callback $step_func , callback $finalize_func [, int $num_args ] )
Warning

Cette fonction est EXPERIMENTALE. Cela signifie que le comportement de cette fonction, son nom et, concrètement, TOUT ce qui est documenté ici peut changer dans un futur proche, SANS PREAVIS ! Soyez-en conscient, et utilisez cette fonction à vos risques et périls.

PDO::sqliteCreateAggregate() est similaire à PDO::sqliteCreateFunction() à l'exception qu'elle référence les fonctions qui peuvent être utilisés pour calculer un résultat agrégé à travers toutes les lignes d'une requête.

La différence entre cette fonction et PDO::sqliteCreateFunction() est que deux fonctions sont requises pour gérer les agrégation ; step_func est appelée pour chaque ligne du jeu de résultats. Votre fonction PHP devrait accumuler les résultats et les enregistrer dans un contexte agrégatif. Une fois que toutes les lignes ont été traitées, finalize_func sera appelée et elle devrait alors prendre les données du contexte agrégatif et retourner le résultat. Les fonctions de rappel devraient retourner un type connu par SQLite (c'est-à-dire type scalaire).

Liste de paramètres

function_name

Le nom de la fonction utilisé dans les requêtes SQL.

step_func

Fonction de rappel appelée pour chaque ligne dans le jeu de résultats.

finalize_func

Fonction de rappel pour agréger les "étapes" de données de chaque ligne.

num_args

Conseil à l'analyseur SQLite si la fonction de rappel accepte un nombre prédéterminé d'arguments.

Exemples

Example#1 Exemple d'agrégation avec une fonction max_length

<?php
$data 
= array(
   
'un',
   
'deux',
   
'trois',
   
'quatre',
   
'cinq',
   
'six',
   
'sept',
   
'huit',
   
'neuf',
   
'dix',
   );
$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$string
{
    if (
strlen($string) > $context) {
        
$context strlen($string);
    }
}

function 
max_len_finalize(&$context
{
    return 
$context;
}

$db->sqliteCreateAggregate('max_len''max_len_step''max_len_finalize');

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

?>

Dans cet exemple, on crée une fonction agrégative qui va calculer la longueur de la plus grande chaîne de caractères dans une des colonnes de la table. Pour chaque ligne, la fonction max_len_step est appelée et le paramètre context est passé. Le paramètre de contexte est comme n'importe quelle autre variable PHP et doit être fixé pour contenir un tableau ou même, un objet. Dans cet exemple, nous l'utilisons pour contenir la taille maximale que nous avons vu jusqu'à présent ; si le paramètre string a une grandeur plus importante que celle courante, on met à jour le contexte pour contenir cette nouvelle taille maximale.

Une fois que toutes les lignes ont été traitées, SQLite appelle la fonction max_len_finalize pour déterminer le résultat agrégatif. Ici, nous pourrions effectuer des calculs basés sur les données trouvées dans context . Dans notre exemple simple, nous avons calculé le résultat comme si la requête progressait, alors que nous avons simplement besoin de retourner la valeur de contexte.

Tip

Il n'est PAS recommandé d'enregistrer une copie des valeurs dans le contexte pour finalement les traiter. Dans ce cas, SQLite utiliserait beaucoup trop de mémoire pour traiter la requête - imaginez la quantité de mémoire nécessaire si un million de lignes étaient enregistrées en mémoire, sachant que chaque ligne contient une chaîne de caractères (32 octets par chaîne).

Tip

Vous pouvez utiliser PDO::sqliteCreateFunction() et PDO::sqliteCreateAggregate() pour surcharger les fonctions natives de SQLite.

Note: Cette méthode n'est pas disponible avec les pilotes de SQLite2. Utilisez l'ancien style de l'API sqlite à la place.

Voir aussi