Utiliser la recherche textuelle

Utilisez les fonctionnalités de recherche de texte dans Cloud Firestore pour rechercher des chaînes spécifiques dans une collection.

Avant de commencer

Avant de commencer à utiliser les recherches textuelles, procédez comme suit :

  1. Assurez-vous d'avoir accès à une base de données d'opérations compatible avec MongoDB ou créez une base de données et connectez-vous-y.

  2. Assurez-vous de disposer d'un index textuel ou créez-en un.

Les recherches de texte utilisent l'opérateur $text dans un filtre. Spécifiez la chaîne de requête dans l'argument $search.

Exécutez la commande suivante pour effectuer une recherche textuelle générale :

  # Find search
  db.cities.find({ $text: { $search: "french bread" } })

  # Aggregation search
  db.cities.aggregate([
    { $match: { $text: { $search: "french bread" } } }
  ]);

Si votre index est partitionné, vous pouvez filtrer les résultats en fonction de la partition en l'incluant dans un filtre d'égalité "and" dans votre recherche. Par exemple, si vous aviez une partition city, vous pourriez filtrer une recherche de texte comme suit :

db.myCollection.find( { $and: [
  { $text: { $search: "french bread" } },
  { "city": "Paris" }
] } )

Vous pouvez également filtrer une agrégation en fonction d'une partition. Exemple :

db.myCollection.aggregate([
 { $match: { $text: { $search: "french bread" } } },
 { "city": "Paris" }
] );

La valeur de votre partition doit être une chaîne. Votre filtre de partition doit être associé à votre recherche de texte à l'aide d'un "and".

Définir la langue de la recherche textuelle

Vous pouvez définir la langue de la recherche textuelle à l'aide de l'argument $language. Exemple :

  db.cities.find({ $text: { $search: "french bread", $language: "en"} })

Si vous ne définissez pas de langue, la recherche utilise la langue de l'index de texte.

Rechercher un terme exact

Pour rechercher un terme exact, configurez-le comme une séquence de mots entre guillemets. Exemple :

  # Find search
  db.cities.find({ $text: { $search: "\"best french bread\"" } })

  # Aggregation search
  db.cities.aggregate([
    { $match: { $text: { $search: "\"best french bread\"" } } },
  ]);

Rechercher une combinaison de termes

Pour rendre votre recherche textuelle plus précise, spécifiez une chaîne de termes. Par exemple, la recherche suivante renvoie les documents qui correspondent à la combinaison best AND french AND ("bread" OR "is") :

  # Find search
  db.cities.find({ $text: { $search: "\"best\" \"french\" bread is" } })

  # Aggregation search
  db.cities.aggregate([
    { $match: { $text: { $search: "\"best\" \"french\" bread is" } } },
  ]);

Exclure un terme

Pour exclure un terme d'une recherche textuelle, ajoutez un trait d'union (-) devant le terme :

  # Find search
  db.cities.find({ $text: { $search: "best bread -french"} })

  # Aggregation search
  db.cities.aggregate([
    { $match: { $text: { $search: "best bread -french" } } },
  ]);

Calculer le score de pertinence

Utilisez l'expression {$meta: "textScore"} pour calculer le score de pertinence des documents correspondant à la recherche textuelle. Pour trier les résultats par ordre décroissant de score, utilisez $meta dans une expression de tri. Prenons les exemples suivants, où SCORE_FIELD est le nom du champ utilisé pour stocker la valeur du score :

  # Find search
  db.cities
    .find({ $text: { $search: "best french bread" } })
    .sort({ SCORE_FIELD: { $meta: "textScore" } })

  # Aggregation search
  db.cities.aggregate([
    { $match: { $text: { $search: "best french bread" } } },
    { $sort: { "SCORE_FIELD": { $meta: "textScore"} } },
  ]);

Vous pouvez également utiliser le score de texte dans les expressions de projection. Exemple :

  # Find search
  db.cities
    .find({ $text: { $search: "best french bread" } })
    .project({ score: { $meta: "textScore" } })

  # Aggregation search
  db.cities.aggregate([
    { $match: { $text: { $search: "best french bread" } } },
    { $project: { "scoreField": { $meta: "textScore"} } },
  ]);

Pour améliorer la pertinence des résultats de recherche textuelle, l'opérateur $text augmente la chaîne de recherche en fonction de la langue spécifiée afin d'inclure des correspondances pour les synonymes contextuels, les formes dérivées, les termes corrigés, les variations diacritiques, etc.

Limites

  • Les opérateurs $near et $text ne peuvent pas être utilisés dans la même recherche textuelle.
  • Un seul opérateur $text est autorisé par recherche find ou aggregation.
  • Dans les agrégations, l'étape $match avec $text doit être la première étape du pipeline.
  • $text ne peut être imbriqué que dans $and et $or.
  • Si $text se trouve dans $or, les disjonctions sans recherche peuvent utiliser des index ordonnés existants pour optimiser la recherche. Si les autres disjonctions ne sont pas indexées, la recherche repose sur une analyse de collection.
  • $text ne peut pas être utilisé avec des indications.
  • Les requêtes avec recherche textuelle ne peuvent pas être triées par $natural.