Requêtes

Les requêtes nous permettent de trouver des enregistrements correspondant à certaines conditions, par exemple:

Trouver tous les contacts favoris.
Trouver des prénoms distincts dans les contacts.
Supprimez tous les contacts dont le nom de famille n'est pas défini.

Comme les requêtes sont exécutées sur la base de données et non dans Dart, elles sont très rapides. Si nous utilisons intelligemment les index, nous pouvons encore améliorer les performances des requêtes. Dans ce qui suit, nous apprendrons comment écrire des requêtes et comment les rendre le plus rapide possible.

Il existe deux méthodes différentes pour filtrer les enregistrements: les filtres et les indexes. Nous allons commencer par examiner le fonctionnement des filtres.

Filtres

Les filtres sont faciles à utiliser et à comprendre. Selon le type des champs, il existe différentes opérations de filtrage disponibles, dont la plupart ont des noms explicites.

Les filtres fonctionnent en évaluant une expression pour chaque objet de la collection à filtrer. Si l'expression donne un résultat "vrai" (true), Isar l'inclura dans les résultats. Les filtres n'affectent pas l'ordre des résultats.

Nous utiliserons le modèle suivant pour les exemples ci-dessous:

@collection
class Shoe {
  Id? id;

  int? size;

  late String model;

  late bool isUnisex;
}

Conditions de requête

Selon le type de champ, il existe différentes conditions.

Condition	Description
`.equalTo(value)`	Recherche les valeurs qui sont égales à `value`.
`.between(lower, upper)`	Recherche les valeurs qui se situent entre `lower` et `upper`.
`.greaterThan(bound)`	Recherche les valeurs qui sont supérieures à `bound`.
`.lessThan(bound)`	Recherche les valeurs qui sont inférieures à `bound`. Les valeurs `null` seront incluses par défaut car `null` est considéré comme plus petit que toute autre valeur.
`.isNull()`	Recherche les valeurs qui sont `null`.
`.isNotNull()`	Recherche les valeurs qui ne sont pas `null`.
`.length()`	Les requêtes sur la longueur des listes, Strings et liens filtrent les objets en fonction du nombre d'éléments dans une liste ou un lien.

Supposons que la base de données contienne quatre chaussures de tailles 39, 40, 46 et une de taille non définie (null). Si nous n'effectuons pas de tri, les valeurs seront retournées trier par id.


isar.shoes.filter()
  .sizeLessThan(40)
  .findAll() // -> [39, null]

isar.shoes.filter()
  .sizeLessThan(40, include: true)
  .findAll() // -> [39, null, 40]

isar.shoes.filter()
  .sizeBetween(39, 46, includeLower: false)
  .findAll() // -> [40, 46]

Opérateurs logiques

Nous pouvons composer des prédicats à l'aide des opérateurs logiques suivants:

Opérateur	Description
`.and()`	Évalue à `true` si les expressions de gauche et de droite évaluent à `true`.
`.or()`	Évalue à `true` si l'une des deux expressions évalue à `true`.
`.xor()`	Évalue à `true` si exactement une expression évalue à `true`.
`.not()`	Négativise le résultat de l'expression suivante.
`.group()`	Regroupe les conditions et permet de spécifier l'ordre d'évaluation.

Si nous voulons trouver toutes les chaussures de taille 46, nous pouvons utiliser la requête suivante:

final result = await isar.shoes.filter()
  .sizeEqualTo(46)
  .findAll();

Si nous voulons utiliser plus d'une condition, nous pouvons combiner plusieurs filtres à l'aide du et (.and()) logique, ou (.or()) logique et xor (.xor()) logique.

final result = await isar.shoes.filter()
  .sizeEqualTo(46)
  .and() // Facultatif. Les filtres sont implicitement combinés avec des et logiques.
  .isUnisexEqualTo(true)
  .findAll();

Cette requête est équivalente à size == 46 && isUnisex == true.

Nous pouvons également regrouper des conditions en utilisant .group():

final result = await isar.shoes.filter()
  .sizeBetween(43, 46)
  .and()
  .group((q) => q
    .modelNameContains('Nike')
    .or()
    .isUnisexEqualTo(false)
  )
  .findAll()

Cette requête est équivalente à size >= 43 && size <= 46 && (modelName.contains('Nike') || isUnisex == false).

Pour nier une condition ou un groupe, utilisons l’opérateur logique not (.not()):

final result = await isar.shoes.filter()
  .not().sizeEqualTo(46)
  .and()
  .not().isUnisexEqualTo(true)
  .findAll();

Cette requête est équivalente à size != 46 && isUnisex != true.

Conditions de chaîne de caractères

En plus des conditions de recherche ci-dessus, les valeurs de type String offrent quelques conditions supplémentaires que nous pouvons utiliser. Les caractères génériques de type Regex, par exemple, permettent une plus grande flexibilité dans la recherche.

Condition	Description
`.startsWith(value)`	Recherche les valeurs qui commencent par la valeur `value` fournie.
`.contains(value)`	Recherche les valeurs qui contiennent la valeur `value` fournie.
`.endsWith(value)`	Recherche les valeurs qui se terminent par la valeur `value` fournie.
`.matches(wildcard)`	Recherche les valeurs qui correspondent au motif `wildcard` fourni.

Sensibilité à la casse
Toutes les opérations sur les chaînes de caractères ont un paramètre optionnel caseSensitive dont la valeur par défaut est true.

Motifs:
Une expression de métacaractèreopen in new window est une chaîne de caractères qui utilise des caractères normaux avec deux caractères génériques spéciaux:

Le caractère générique * correspond à zéro ou plus de n'importe quel caractère.
Le caractère générique ? correspond à n'importe quel caractère. Par exemple, la chaîne générique "d?g" correspond à "dog", "dig" et "dug", mais pas à "ding", "dg" ou "a dog".

Modificateurs de requête

Il est parfois nécessaire de construire une requête basée sur certaines conditions ou pour différentes valeurs. Isar dispose d'un outil très puissant pour construire des requêtes conditionnelles:

Modificateur	Description
`.optional(cond, qb)`	Étend la requête uniquement si la `condition` est `true`. Cela peut être utilisé presque partout dans une requête, par exemple pour la trier ou la limiter de manière conditionnelle.
`.anyOf(list, qb)`	Étend la requête pour chaque valeur de `values` et combine les conditions en utilisant l’opérateur ou.
`.allOf(list, qb)`	Étend la requête pour chaque valeur de `values` et combine les conditions en utilisant les et logiques.

Dans cet exemple, nous construisons une méthode qui trouve des chaussures avec un filtre optionnel:

Future<List<Shoe>> findShoes(Id? sizeFilter) {
  return isar.shoes.filter()
    .optional(
      sizeFilter != null, // Seulement appliquer le filtre si sizeFilter != null
      (q) => q.sizeEqualTo(sizeFilter!),
    ).findAll();
}

Si nous voulons trouver toutes les chaussures qui ont une ou plusieurs tailles, nous pouvons soit écrire une requête classique, soit utiliser le modificateur anyOf():

final shoes1 = await isar.shoes.filter()
  .sizeEqualTo(38)
  .or()
  .sizeEqualTo(40)
  .or()
  .sizeEqualTo(42)
  .findAll();

final shoes2 = await isar.shoes.filter()
  .anyOf(
    [38, 40, 42],
    (q, int size) => q.sizeEqualTo(size)
  ).findAll();

// shoes1 == shoes2

Les modificateurs de requête sont particulièrement utiles lorsque nous souhaitons construire des requêtes dynamiques.

Listes

Même les listes peuvent être utilisées dans les requêtes:

class Tweet {
  Id? id;

  String? text;

  List<String> hashtags = [];
}

Nous pouvons effectuer des requêtes en fonction de la longueur de la liste:

final tweetsWithoutHashtags = await isar.tweets.filter()
  .hashtagsIsEmpty()
  .findAll();

final tweetsWithManyHashtags = await isar.tweets.filter()
  .hashtagsLengthGreaterThan(5)
  .findAll();

Ces requêtes sont équivalentes au code Dart tweets.where((t) => t.hashtags.isEmpty) et tweets.where((t) => t.hashtags.length > 5). Nous pouvons également effectuer des requêtes sur les éléments de la liste:

final flutterTweets = await isar.tweets.filter()
  .hashtagsElementEqualTo('flutter')
  .findAll();

Cette requête est équivalente au code Dart tweets.where((t) => t.hashtags.contains('flutter')).

Objets embarqués

Les objets embarqués sont l'une des fonctionnalités les plus utiles d'Isar. Ils peuvent être filtrés très efficacement en utilisant les mêmes conditions que celles disponibles pour les objets de niveau supérieur. Supposons que nous ayons le modèle suivant:

@collection
class Car {
  Id? id;

  Brand? brand;
}

@embedded
class Brand {
  String? name;

  String? country;
}

Nous voulons filtrer toutes les voitures qui ont une marque avec le nom "BMW" et le pays "Allemagne". Nous pouvons le faire en utilisant la requête suivante:

final germanCars = await isar.cars.filter()
  .brand((q) => q
    .nameEqualTo('BMW')
    .and()
    .countryEqualTo('Germany')
  ).findAll();

Essayez toujours de regrouper les requêtes imbriquées. La requête ci-dessus est plus efficace que la suivante, même si le résultat est le même:

final germanCars = await isar.cars.filter()
  .brand((q) => q.nameEqualTo('BMW'))
  .and()
  .brand((q) => q.countryEqualTo('Germany'))
  .findAll();

Liens

Si nos modèles contiennent des liens, nous pouvons filtrer sur les objets liés ou le nombre d'objets liés.

Avertissement

Gardez en tête que les requêtes de liens peuvent être coûteuses, car Isar doit rechercher les objets liés. Pensez à utiliser des objets embarqués à la place.

@collection
class Teacher {
  Id? id;

  late String subject;
}

@collection
class Student {
  Id? id;

  late String name;

  final teachers = IsarLinks<Teacher>();
}

Nous voulons trouver tous les élèves qui ont un professeur de mathématiques ou d'anglais:

final result = await isar.students.filter()
  .teachers((q) {
    return q.subjectEqualTo('Math')
      .or()
      .subjectEqualTo('English');
  }).findAll();

Les filtres de liens sont évalués à true si au moins un objet lié correspond aux conditions.

Cherchons tous les élèves qui n'ont pas de professeur:

final result = await isar.students.filter().teachersLengthEqualTo(0).findAll();

ou sinon:

final result = await isar.students.filter().teachersIsEmpty().findAll();

Clauses `Where`

Les clauses where sont un outil très puissant, mais il n'est pas toujours facile de les utiliser correctement.

Contrairement aux filtres, les clauses where utilisent les index que nous définissons dans le schéma pour évaluer les conditions de la requête. La requête d'un index est beaucoup plus rapide que le filtrage individuel de chaque entrée.

➡️ En savoir plus: Indices

Conseil

En règle générale, vous devriez toujours essayer de réduire les entrées autant que possible à l'aide de clauses where, et effectuer le reste du filtrage à l'aide de filtres.

Nous pouvons uniquement combiner les clauses where en utilisant des ou logiques. En d'autres termes, nous pouvons additionner plusieurs clauses where, mais nous ne pouvons pas effectuer une requête sur l'intersection de plusieurs clauses where.

Ajoutons des index à la collection Shoe:

@collection
class Shoe with IsarObject {
  Id? id;

  @Index()
  Id? size;

  late String model;

  @Index(composite: [CompositeIndex('size')])
  late bool isUnisex;
}

Il y a deux index. L'index sur size nous permet d'utiliser des clauses where comme .sizeEqualTo(). L'index composé sur isUnisex permet d'utiliser des clauses where comme isUnisexSizeEqualTo(), mais aussi isUnisexEqualTo(), car nous pouvons toujours utiliser n'importe quel préfixe d'un index.

Nous pouvons maintenant réécrire la requête précédente qui trouve des chaussures unisexes de taille 46 en utilisant l'index composé. Cette requête sera beaucoup plus rapide que la précédente:

final result = isar.shoes.where()
  .isUnisexSizeEqualTo(true, 46)
  .findAll();

Les clauses where ont deux autres superpouvoirs: elles vous offrent un tri "gratuit" et une opération distincte super rapide.

Combinaison de clauses `where` et de filtres

Vous vous souvenez des requêtes shoes.filter()? Il s'agit en fait d'un raccourci pour shoes.where().filter(). Nous pouvons (et devrions) combiner les clauses where et les filtres dans une même requête pour bénéficier des avantages des deux:

final result = isar.shoes.where()
  .isUnisexEqualTo(true)
  .filter()
  .modelContains('Nike')
  .findAll();

La clause where est d'abord appliquée pour réduire le nombre d'objets à filtrer. Ensuite, le filtre est appliqué aux objets restants.

Triage

Nous pouvons définir comment les résultats doivent être triés lors de l'exécution de la requête en utilisant les méthodes .sortBy(), .sortByDesc(), .thenBy() et .thenByDesc().

Pour trouver toutes les chaussures triées par nom de modèle en ordre croissant et par taille en ordre décroissant sans utiliser d'index:

final sortedShoes = isar.shoes.filter()
  .sortByModel()
  .thenBySizeDesc()
  .findAll();

Le tri de nombreux résultats peut s'avérer coûteux, d'autant plus que le tri intervient avant le offset et limit. Les méthodes de tri ci-dessus ne font jamais appel aux index. Heureusement, nous pouvons à nouveau utiliser le tri par clause where et rendre notre requête rapide comme l'éclair, même si nous devons trier un million d'objets.

Tri par clause `where`

Si nous utilisons une clause where simple dans notre requête, les résultats sont déjà triés par l'index. Ce n'est pas rien!

Supposons que nous avons des chaussures de taille [43, 39, 48, 40, 42, 45] et que nous voulons trouver toutes les chaussures dont la taille est supérieure à 42 et les trier par taille:

final bigShoes = isar.shoes.where()
  .sizeGreaterThan(42) // Trie également les résultats par taille
  .findAll(); // -> [43, 45, 48]

Comme nous pouvons le constater, le résultat est trié par l'index size. Si nous voulons inverser l'ordre de tri de la clause where, nous pouvons donner à sort la valeur Sort.desc :

final bigShoesDesc = await isar.shoes.where(sort: Sort.desc)
  .sizeGreaterThan(42)
  .findAll(); // -> [48, 45, 43]

Parfois, nous ne voulons pas utiliser des clauses where, mais nous pouvons tout de même bénéficier du tri implicite. Nous pouvons utiliser la clause where any:

final shoes = await isar.shoes.where()
  .anySize()
  .findAll(); // -> [39, 40, 42, 43, 45, 48]

Si nous utilisons un index composé, les résultats sont triés par tous les champs de l'index.

Conseil

Si vous avez besoin que les résultats soient triés, pensez à utiliser un index dans ce but. Surtout si vous utilisez avec offset() et limit().

Parfois, il n'est pas possible ou utile d'utiliser un index pour le tri. Dans ce cas, nous devons utiliser des index pour réduire autant que possible le nombre d'entrées résultantes.

Valuers uniques

Pour ne renvoyer que les entrées ayant des valeurs uniques, utilisez le prédicat distinct. Par exemple, pour savoir combien de modèles de chaussures différents nous avons dans votre base de données Isar:

final shoes = await isar.shoes.filter()
  .distinctByModel()
  .findAll();

Nous pouvons également chaîner plusieurs conditions distinctes pour trouver toutes les chaussures avec des combinaisons modèle-taille distinctes:

final shoes = await isar.shoes.filter()
  .distinctByModel()
  .distinctBySize()
  .findAll();

Seul le premier résultat de chaque combinaison distincte est retourné. Nous pouvons utiliser des clauses where et des opérations de tri pour le contrôler.

Clause `where` distincte

Si nous avons un index non-unique, nous pouvons vouloir obtenir toutes ses valeurs distinctes. Nous pouvons utiliser l'opération distinctBy de la section précédente, mais elle est effectuée après le tri et les filtres, ce qui entraîne une certaine lourdeur.
Si nous n'utilisons qu'une seule clause where, nous pouvons nous fier à l'index pour effectuer l'opération de distinction.

final shoes = await isar.shoes.where(distinct: true)
  .anySize()
  .findAll();

Conseil

En théorie, nous pouvons même utiliser plusieurs clauses where pour le tri et la distinction. La seule restriction est que ces clauses where ne doivent pas se chevaucher et utiliser le même index. Pour un tri correct, elles doivent également être appliquées dans l'ordre de tri. Soyez très prudent si vous vous fiez à cela!

Décalage et limite

C'est souvent une bonne idée de limiter le nombre de résultats d'une requête pour les listes "lazy". Nous pouvons le faire en définissant un limit():

final firstTenShoes = await isar.shoes.where()
  .limit(10)
  .findAll();

En définissant un offset(), nous pouvons également paginer les résultats de notre requête.

final firstTenShoes = await isar.shoes.where()
  .offset(20)
  .limit(10)
  .findAll();

L'instanciation des objets Dart étant souvent la partie la plus coûteuse de l'exécution d'une requête, il est judicieux de ne charger que les objets dont nous avons de besoin.

Ordre d'exécution

Isar exécute les requêtes toujours dans le même ordre :

Traverser l'index primaire ou secondaire pour trouver des objets (appliquer des clauses where)
Filtrer les objets
Trier les résultats
Appliquer l'opération distincte
Décalage et limite des résultats
Retour des résultats

Opérations de requêtes

Dans les exemples précédents, nous avons utilisé .findAll() pour récupérer tous les objets correspondants. Cependant, d'autres opérations sont disponibles:

Opération	Description
`.findFirst()`	Retourne seulement le premier objet correspondant ou `null` si aucun ne correspond.
`.findAll()`	Retourne tous les objets correspondants.
`.count()`	Compte le nombre d'objets correspondant à la requête.
`.deleteFirst()`	Supprime le premier objet correspondant de la collection.
`.deleteAll()`	Supprime tous les objets correspondants de la collection.
`.build()`	Compile la requête pour la réutiliser plus tard. Cela permet d'économiser le coût de construction d'une requête si nous souhaitons l'exécuter plusieurs fois.

Requêtes de propriété

Si nous ne sommes intéressés que par les valeurs d'une seule propriété, nous pouvons utiliser une requête de propriété. Il suffit de construire une requête ordinaire et de sélectionner une propriété:

List<String> models = await isar.shoes.where()
  .modelProperty()
  .findAll();

List<int> sizes = await isar.shoes.where()
  .sizeProperty()
  .findAll();

L'utilisation d'une seule propriété permet de gagner du temps lors de la désérialisation. Les requêtes de propriétés fonctionnent également pour les objets embarqués et les listes.

Agrégation

Isar supporte l'agrégation des valeurs d'une requête de propriété. Les opérations d'agrégation disponibles sont les suivantes :

Opération	Description
`.min()`	Trouve la valeur minimale ou `null` si aucune ne correspond.
`.max()`	Trouve la valeur maximale ou `null` si aucune ne correspond.
`.sum()`	Additionne toutes les valeurs.
`.average()`	Calcule la moyenne de toutes les valeurs ou `NaN` si aucune ne correspond.

L'utilisation des agrégations est beaucoup plus rapide que la recherche de tous les objets correspondants et l'exécution manuelle de l'agrégation.

Requêtes dynamiques

Danger

Cette section n'est probablement pas pertinente pour vous. Il est déconseillé d'utiliser des requêtes dynamiques, sauf si vous en avez absolument besoin (ce qui est rarement le cas).

Tous les exemples ci-dessus ont utilisé le QueryBuilder et les méthodes d'extension statiques générées. Peut-être voulez-vous créer des requêtes dynamiques ou un langage de requête personnalisé (comme l'inspecteur Isar). Dans ce cas, nous pouvons utiliser la méthode buildQuery() :

Paramètre	Description
`whereClauses`	Les clauses `where` de la requête.
`whereDistinct`	Si les clauses `where` doivent retourner des valeurs distinctes (utile uniquement pour les clauses `where` uniques).
`whereSort`	L'ordre de passage des clauses `where` (utile uniquement pour les clauses `where` uniques).
`filter`	Le filtre à appliquer aux résultats.
`sortBy`	Une liste de propriétés à trier.
`distinctBy`	Une liste de propriétés à distinguer par.
`offset`	Le décalage des résultats.
`limit`	Le nombre maximum de résultats à retourner.
`property`	Si non-nulle, seules les valeurs de cette propriété sont renvoyées.

Créons une requête dynamique:

final shoes = await isar.shoes.buildQuery(
  whereClauses: [
    WhereClause(
      indexName: 'size',
      lower: [42],
      includeLower: true,
      upper: [46],
      includeUpper: true,
    )
  ],
  filter: FilterGroup.and([
    FilterCondition(
      type: ConditionType.contains,
      property: 'model',
      value: 'nike',
      caseSensitive: false,
    ),
    FilterGroup.not(
      FilterCondition(
        type: ConditionType.contains,
        property: 'model',
        value: 'adidas',
        caseSensitive: false,
      ),
    ),
  ]),
  sortBy: [
    SortProperty(
      property: 'model',
      sort: Sort.desc,
    )
  ],
  offset: 10,
  limit: 10,
).findAll();

La requête suivante est équivalente:

final shoes = await isar.shoes.where()
  .sizeBetween(42, 46)
  .filter()
  .modelContains('nike', caseSensitive: false)
  .not()
  .modelContains('adidas', caseSensitive: false)
  .sortByModelDesc()
  .offset(10).limit(10)
  .findAll();

# Requêtes

# Filtres

# Conditions de requête

# Opérateurs logiques

# Conditions de chaîne de caractères

# Modificateurs de requête

# Listes

# Objets embarqués

# Liens

# Clauses Where

# Combinaison de clauses where et de filtres

# Triage

# Tri par clause where

# Valuers uniques

# Clause where distincte

# Décalage et limite

# Ordre d'exécution

# Opérations de requêtes

# Requêtes de propriété

# Agrégation

# Requêtes dynamiques

Requêtes

Filtres

Conditions de requête

Opérateurs logiques

Conditions de chaîne de caractères

Modificateurs de requête

Listes

Objets embarqués

Liens

Clauses `Where`

Combinaison de clauses `where` et de filtres

Triage

Tri par clause `where`

Valuers uniques

Clause `where` distincte

Décalage et limite

Ordre d'exécution

Opérations de requêtes

Requêtes de propriété

Agrégation

Requêtes dynamiques