facet ( Operador de pesquisa MongoDB )

A definição do índice na coleção sample_mflix.movies especifica o seguinte para os campos a serem indexados:

{
  "mappings": {
    "dynamic": false,
    "fields": {
      "directors": {
        "type": "token"
      },
      "year": {
        "type": "number"
      },
      "released": {
        "type": "date"
      }
    }
  }
}

As pesquisas de query a seguir para filmes lançados entre 1º de janeiro de 2000 e 31 de janeiro de 2015. Ela solicita metadados no campo directors e year.

1
db.movies.aggregate([
2
  {
3
    "$searchMeta": {
4
      "facet": {
5
        "operator": {
6
          "range": {
7
            "path": "released",
8
            "gte": ISODate("2000-01-01T00:00:00.000Z"),
9
            "lte": ISODate("2015-01-31T00:00:00.000Z")
10
          }
11
        },
12
        "facets": {
13
          "directorsFacet": {
14
            "type": "string",
15
            "path": "directors",
16
            "numBuckets" : 7
17
          },
18
          "yearFacet" : {
19
            "type" : "number",
20
            "path" : "year",
21
            "boundaries" : [2000,2005,2010, 2015]
22
          }
23
        }
24
      }
25
    }
26
  }
27
])

1
[
2
  {
3
    count: { lowerBound: Long('11922') },
4
    facet: {
5
      yearFacet: {
6
        buckets: [
7
          { _id: 2000, count: Long('3064') },
8
          { _id: 2005, count: Long('4035') },
9
          { _id: 2010, count: Long('4553') }
10
        ]
11
      },
12
      directorsFacet: {
13
        buckets: [
14
          { _id: 'Takashi Miike', count: Long('26') },
15
          { _id: 'Johnnie To', count: Long('20') },
16
          { _id: 'Steven Soderbergh', count: Long('18') },
17
          { _id: 'Michael Winterbottom', count: Long('16') },
18
          { _id: 'Ridley Scott', count: Long('15') },
19
          { _id: 'Tyler Perry', count: Long('15') },
20
          { _id: 'Clint Eastwood', count: Long('14') }
21
        ]
22
      }
23
    }
24
  }
25
]

Os resultados mostram uma contagem dos seguintes itens na collection sample_mflix.movies:

• Número de filmes do ano 2000, limite inferior inclusivo, até 2015, limite superior excluindo, que a Pesquisa MongoDB retornou para a query

• Número de filmes para cada diretor que a Pesquisa MongoDB retornou para a consulta

Para saber mais sobre esses resultados, consulte Resultados de faceta.

A definição do índice na coleção sample_mflix.movies especifica o seguinte para os campos a serem indexados:

{
  "mappings": {
    "dynamic": false,
    "fields": {
      "genres": {
        "type": "token"
      },
      "released": {
        "type": "date"
      }
    }
  }
}

A query a seguir pesquisa filmes lançados perto de 01 de julho de 1999 usando o estágio $search . A consulta inclui um estágio $facet para processar os documentos de entrada usando os seguintes estágios de subpipeline:

• Etapa $project para excluir todos os campos nos documentos, exceto os campos title e released no campo de saída docs.

• $limit estágio para fazer o seguinte:

  • Limite a saída do estágio $search a 2 documentos

  • Limite a saída ao documento 1 no campo de saída meta.

  Observação

  O limite deve ser pequeno para que os resultados caibam em um documento de 16 MB .

• o estágio $replaceWith para incluir os resultados de metadados armazenados na variável $$SEARCH_META no campo de saída meta

A query também inclui um estágio $set para adicionar o campo meta.

1
db.movies.aggregate([
2
 {
3
   "$search": {
4
     "facet": {
5
       "operator": {
6
         "near": {
7
           "path": "released",
8
           "origin": ISODate("1999-07-01T00:00:00.000+00:00"),
9
           "pivot": 7776000000
10
         }
11
       },
12
       "facets": {
13
         "genresFacet": {
14
           "type": "string",
15
           "path": "genres"
16
         }
17
       }
18
     }
19
   }
20
 },
21
 { "$limit": 2 },
22
 {
23
   "$facet": {
24
     "docs": [
25
       { "$project":
26
         {
27
           "title": 1,
28
           "released": 1
29
         }
30
       }
31
     ],
32
     "meta": [
33
       {"$replaceWith": "$$SEARCH_META"},
34
       {"$limit": 1}
35
     ]
36
   }
37
 },
38
 {
39
   "$set": {
40
     "meta": {
41
       "$arrayElemAt": ["$meta", 0]
42
     }
43
   }
44
 }
45
])

1
[
2
 {
3
   docs: [
4
     {
5
       _id: ObjectId('573a1393f29313caabcde1ae'),
6
       title: 'Begone Dull Care',
7
       released: ISODate('1999-07-01T00:00:00.000Z')
8
     },
9
     {
10
       _id: ObjectId('573a13a9f29313caabd2048a'),
11
       title: 'Fara'                released: ISODate('1999-07-01T00:00:00.000Z')
12
     }
13
   ],
14
   meta: {
15
     count: { lowerBound: Long('20878') },
16
     facet: {
17
       genresFacet: {
18
         buckets: [
19
           { _id: 'Drama', count: Long('12149') },
20
           { _id: 'Comedy', count: Long('6436') },
21
           { _id: 'Romance', count: Long('3274') },
22
           { _id: 'Crime', count: Long('2429') },
23
           { _id: 'Thriller', count: Long('2400') },
24
           { _id: 'Action', count: Long('2349') },
25
           { _id: 'Adventure', count: Long('1876') },
26
           { _id: 'Documentary', count: Long('1755') },
27
           { _id: 'Horror', count: Long('1432') },
28
           { _id: 'Biography', count: Long('1244') }
29
         ]
30
       }
31
     }
32
   }
33
 }
34
]

Para saber mais sobre esses resultados, consulte Resultados de faceta.

A definição de índice na coleção sample_training.companies indexa o campo funding_rounds como o tipo embeddedDocuments. Ele indexa dinamicamente todos os campos do array funding_rounds de objetos e armazena os campos raised_currency_code e raised_amount no array funding_rounds de objetos usando a opção storedSource.

{
  "mappings": {
    "dynamic": false,
    "fields": {
      "funding_rounds": {
        "type": "embeddedDocuments",
        "dynamic": true,
        "storedSource": {
          "include": [
            "raised_currency_code",
            "raised_amount"
          ]
        }
      }
    }
  }
}

A seguinte query:

• Usa o text (operador do MongoDB Search) para pesquisar fundos angariados em USD .

• Usa as opções returnScope para definir o contexto da query para o campo embeddedDocuments chamado funding_rounds. Para usar returnScope, a query:

  • Especifica a opção returnStoredSource, que é necessária, para retornar os campos de origem armazenados.

• Facetas no campo raised_amount no array funding_rounds de objetos. A query especifica três buckets:

  • 5000000, limite inferior inclusivo para este bucket

  • 5250000, limite superior exclusivo para o bucket 5000000 e limite inferior inclusivo para esse bucket

  • 5500000, limite superior exclusivo para o bucket 5250000

1
db.companies.aggregate([
2
 {
3
   "$searchMeta": {
4
     "returnStoredSource": true,
5
     "returnScope": {
6
       "path": "funding_rounds"
7
     },
8
     "facet": {
9
       "operator": {
10
         "text": {
11
           "path": "funding_rounds.raised_currency_code",
12
           "query": "USD"
13
         }
14
       },
15
       "facets": {
16
         "raisedAmountFacet": {
17
           "type": "number",
18
           "path": "funding_rounds.raised_amount",
19
           "boundaries": [5000000, 5250000, 5500000]
20
         }
21
       }
22
     }
23
   }
24
 }
25
])

1
[
2
  {
3
    count: { lowerBound: Long('5329') },
4
    facet: {
5
      raisedAmountFacet: {
6
        buckets: [
7
          { _id: 5000000, count: Long('251') },
8
          { _id: 5250000, count: Long('32') }
9
        ]
10
      }
11
    }
12
  }
13
]

Nos resultados anteriores da MongoDB Search, as contagens de facetas são baseadas nos documentos secundários incorporados e não nos principais.

A seguinte definição de índice na coleção sample_airbnb.listingsAndReviews indexa automaticamente todos os campos dinamicamente indexáveis e configura os campos cancellation_policy, room_type e price para a pesquisa facetada.

{
  "mappings": {
    "dynamic": true,
    "fields": {
      "cancellation_policy": {
        "type": "token"
      },
      "room_type": {
        "type": "token"
      },
      "accommodates": {
        "type": "number"
      }
    }
  }
}

A seguinte consulta utiliza o estágio $searchMeta para executar as seguintes ações:

• Faceta nos campos cancellation_policy, roomType e accommodates.

  O faceta cancellation_policy tem os seguintes buckets:

  • "strict_14_with_grace_period"

  • "moderate"

  • "flexible"

  • "super_strict_30"

  • "super_strict_60"

  O faceta room_type tem os seguintes buckets:

  • "Entire home/apt"

  • "Private room"

  • "Shared room"

  A query divide o faceta accommodates em buckets para:

  • 1, limite inferior inclusivo para este bucket

  • 2, limite superior exclusivo para o bucket 1 e limite inferior inclusivo para este bucket.

  • 4, limite superior exclusivo para o bucket 2 e limite inferior inclusivo para este bucket.

  • 8, limite superior exclusivo para o bucket 4

• Execute uma pesquisa do Operadorcompound para anúncios que devem conter o texto new york city no description e filtra os resultados para anúncios com um moderate cancellation_policy. A configuração doesNotAffect garante que a filtragem por um moderate cancellation_policy não altere as contagens de outros buckets no faceta; as contagens para "strict_14_with_grace_period", "flexible", "super_strict_30" e "super_strict_60" são valores diferentes de zero.

1
db.listingsAndReviews.aggregate([
2
  {
3
    $searchMeta: {
4
      facet: {
5
        facets: {
6
          accommodatesFacet: {
7
            path: "accommodates",
8
            type: "number",
9
            boundaries: [1,2,4,8],
10
          },
11
          cancellationFacet: {
12
            path: "cancellation_policy",
13
            type: "string",
14
          },
15
          roomTypeFacet: {
16
            path: "room_type",
17
            type: "string",
18
          }
19
        },
20
        operator: {
21
          compound: {
22
            must: [
23
              {
24
                text: {
25
                  path: "description",
26
                  query: "new york city",
27
                },
28
              },
29
            ],
30
            filter: [
31
              {
32
                equals: {
33
                  path: "cancellation_policy",
34
                  value: "moderate",
35
                  doesNotAffect:
36
                    "cancellationFacet",
37
                },
38
              },
39
            ],
40
          },
41
        },
42
      },
43
    }
44
  },
45
]

1
[
2
  {
3
    count: { lowerBound: Long('531') },
4
    facet: {
5
      accommodatesFacet: {
6
        buckets: [
7
          { _id: 1, count: Long('25') },
8
          { _id: 2, count: Long('270') },
9
          { _id: 4, count: Long('204') }
10
        ]
11
      },
12
      cancellationFacet: {
13
        buckets: [
14
          { _id: 'strict_14_with_grace_period', count: Long('849') },
15
          { _id: 'moderate', count: Long('531') },
16
          { _id: 'flexible', count: Long('380') },
17
          { _id: 'super_strict_60', count: Long('25') },
18
          { _id: 'super_strict_30', count: Long('11') }
19
        ]
20
      },
21
      roomTypeFacet: {
22
        buckets: [
23
          { _id: 'Entire home/apt', count: Long('369') },
24
          { _id: 'Private room', count: Long('159') },
25
          { _id: 'Shared room', count: Long('3') }
26
        ]
27
      }
28
    }
29
  }
30
]

Observe que as contagens de buckets em cancellationFacet não são reduzidas a zero, apesar da filtragem de consulta em um valor de moderate.

A seguinte definição de índice na coleção sample_airbnb.listingsAndReviews indexa os campos cancellation_policy, room_type e price, permitindo a pesquisa facetada neles.

{
  "mappings": {
    "dynamic": true,
    "fields": {
      "cancellation_policy": {
        "type": "token"
      },
      "room_type": {
        "type": "token"
      },
      "accommodates": {
        "type": "number"
      }
    }
  }
}

A seguinte query:

• Pesquisas de anúncios que incluam o texto new york city em seu description e que tenham um cancellation_policy de moderate.

• Facetas nos campos cancellation_policy, roomType e accommodates.

  Cada uma das facetas cancellation_policy e roomType tem três compartimentos, correspondendo aos três valores exclusivos desses campos em toda a coleção. A consulta divide a faceta accommodates em compartimentos para:

  • 1, limite inferior inclusivo para este bucket

  • 2, limite superior exclusivo para o bucket 1 e limite inferior inclusivo para este bucket.

  • 4, limite superior exclusivo para o bucket 2 e limite inferior inclusivo para este bucket.

  • 8, limite superior exclusivo para o bucket 4

• Define a propriedade doesNotAffect no operador equals de compound.filter como accommodatesFacet. Isso exclui os buckets dentro da faceta accommodates do filtro. Como resultado, o filtro no moderate cancellation_policy reduz as contagens de outros buckets na cancellation_policy faceta para 0 e reduz as contagens de buckets na roomType faceta, mas as contagens de buckets no accommodates faceta não foram alterados. Isso permite comparar o impacto da filtragem em diferentes facetas.

1
db.listingsAndReviews.aggregate([
2
  {
3
    $searchMeta: {
4
      facet: {
5
        facets: {
6
          accommodatesFacet: {
7
            path: "accommodates",
8
            type: "number",
9
            boundaries: [1,2,4,8],
10
          },
11
          cancellationFacet: {
12
            path: "cancellation_policy",
13
            type: "string",
14
          },
15
          roomTypeFacet: {
16
            path: "room_type",
17
            type: "string",
18
          }
19
        },
20
        operator: {
21
          compound: {
22
            must: [
23
              {
24
                text: {
25
                  path: "description",
26
                  query: "new york city",
27
                },
28
              },
29
            ],
30
            filter: [
31
              {
32
                equals: {
33
                  path: "cancellation_policy",
34
                  value: "moderate",
35
                  doesNotAffect:
36
                    "accommodatesFacet",
37
                },
38
              },
39
            ],
40
          },
41
        },
42
      },
43
    },
44
  },
45
]

1
[
2
  {
3
    count: { lowerBound: Long('531') },
4
    facet: {
5
      accommodatesFacet: {
6
        buckets: [
7
          { _id: 1, count: Long('141') },
8
          { _id: 2, count: Long('834') },
9
          { _id: 4, count: Long('703') }
10
        ]
11
      },
12
      cancellationFacet: {
13
        buckets: [
14
          { _id: 'moderate', count: Long('531') }
15
        ]
16
      },
17
      roomTypeFacet: {
18
        buckets: [
19
          { _id: 'Entire home/apt', count: Long('369') },
20
          { _id: 'Private room', count: Long('159') },
21
          { _id: 'Shared room', count: Long('3') }
22
        ]
23
      }
24
    }
25
  }
26
]