Usar a pesquisa de texto

Use os recursos de pesquisa de texto no Cloud Firestore para procurar strings específicas em uma coleção.

Antes de começar

Antes de começar a usar as pesquisas de texto, faça o seguinte:

  1. Verifique se você tem acesso a um banco de dados de operações compatíveis com o MongoDB ou crie um banco de dados e se conecte a ele.

  2. Verifique se você tem um índice de texto ou crie um.

As pesquisas de texto usam o operador $text dentro de um filtro. Especifique a string de consulta no argumento $search.

Execute o comando a seguir para realizar uma pesquisa de texto geral:

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

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

Se o índice for particionado, será possível filtrar com base na partição incluindo-a em um filtro de igualdade "and" na pesquisa. Por exemplo, se você tiver uma partição city, poderá filtrar uma Text Search da seguinte maneira:

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

Também é possível filtrar uma agregação com base em uma partição. Exemplo:

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

O valor da partição precisa ser uma string. O filtro de partição precisa ser unido à Text Search usando um "and".

Definir o idioma da pesquisa de texto

É possível definir o idioma da pesquisa de texto usando o argumento $language. Exemplo:

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

Se você não definir um idioma, a pesquisa vai usar o idioma do índice de texto.

Pesquisar um termo exato

Para pesquisar um termo exato, configure-o como uma sequência de palavras entre aspas duplas. Exemplo:

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

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

Pesquisar uma combinação de termos

Para tornar sua pesquisa de texto mais precisa, especifique uma cadeia de termos. Por exemplo, a pesquisa a seguir retorna documentos que correspondem à combinação 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" } } },
  ]);

Excluir um termo

Para excluir um termo de uma Text Search, use um hífen (-) como prefixo:

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

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

Calcular o índice de relevância

Use a expressão {$meta: "textScore"} para calcular a pontuação de relevância dos documentos correspondentes à Text Search. Para classificar os resultados em ordem decrescente de pontuação, use $meta em uma expressão de classificação. Considere os exemplos a seguir, em que SCORE_FIELD é o nome do campo usado para armazenar o valor da pontuação:

  # 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"} } },
  ]);

Também é possível usar a pontuação de texto em expressões de projeção. Exemplo:

  # 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"} } },
  ]);

Para melhorar a relevância dos resultados do Text Search, o operador $text aumenta a string de pesquisa de acordo com o idioma especificado para incluir correspondências de sinônimos que consideram o contexto, formas derivadas, termos com correção ortográfica, variações diacríticas e muito mais.

Limitações

  • Os operadores $near e $text não podem ser usados na mesma Text Search.
  • É permitido um único operador $text por pesquisa find ou aggregation.
  • Em agregações, a etapa $match com $text precisa ser a primeira etapa do pipeline.
  • $text só pode ser aninhado em $and e $or.
  • Se $text estiver dentro de $or, as disjunções que não são de pesquisa poderão usar índices ordenados existentes para otimizar a pesquisa. Se as outras disjunções não forem indexadas, a pesquisa vai depender de uma verificação de coleção.
  • $text não pode ser usado com dicas.
  • As consultas com Text Search não podem ser classificadas por $natural.