facet (MongoDB Search Operador)

La definición del índice en la colección sample_mflix.movies especifica lo siguiente para los campos a indexar:

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

La siguiente query busca películas que se estrenaron entre el 1 de enero de 2000 y el 31 de enero de 2015. Solicita metadatos en los campos directors y 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
]

Los resultados muestran un recuento de lo siguiente en la colección sample_mflix.movies:

• Cantidad de películas del año 2000, límite inferior inclusivo, hasta 2015, límite superior exclusivo, que MongoDB Search devolvió para la query.

• Número de películas para cada director que MongoDB Search devolvió para la query

Para obtener más información sobre estos resultados, consulte Resultados de Facetas.

La definición del índice en la colección sample_mflix.movies especifica lo siguiente para los campos a indexar:

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

La siguiente query busca películas lanzadas cerca del 01 de julio de 1999 usando la etapa $search. La query incluye una $facet etapa para procesar los documentos de entrada utilizando las siguientes etapas de sub-pipeline:

• $project etapa para excluir todos los campos de los documentos excepto los campos title y released en el campo de salida docs

• $limit etapa para realizar lo siguiente:

  • Limita la salida de la etapa $search a 2 documentos

  • Limite la salida a 1 documento en el campo de salida meta

  Nota

  El límite debe ser pequeño para que los resultados quepan en un documento de 16 MB.

• $replaceWith etapa para incluir los resultados de metadatos almacenados en la variable $$SEARCH_META en el campo de salida meta

La consulta también incluye una etapa $set para agregar el 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 obtener más información sobre estos resultados, consulte Resultados de Facetas.

La definición del índice en la colección sample_training.companies indexa el campo funding_rounds como embeddedDocuments (documentos integrados). Indexa de forma dinámica todos los campos en el arreglo funding_rounds de objetos y almacena los campos raised_currency_code y raised_amount en el arreglo funding_rounds de objetos utilizando la opción storedSource.

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

La siguiente query:

• Utiliza el text (MongoDB Search operador) para buscar fondos recaudados en USD .

• Utiliza las opciones returnScope para establecer el contexto de la consulta en el campo embeddedDocuments llamado funding_rounds. Para utilizar returnScope, la query:

  • Especifica la opción returnStoredSource, que es requerida, para devolver los campos de origen almacenados.

• Facetas en el campo raised_amount del arreglo funding_rounds de objetos. La query especifica tres buckets:

  • 5000000, límite inferior inclusivo para este intervalo

  • 5250000, límite superior exclusivo para el cubo 5000000 y límite inferior inclusivo para este cubo

  • 5500000, límite superior exclusivo para el intervalo 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
]

En los resultados anteriores de MongoDB Search, los recuentos de facetas se basan en los documentos secundarios incrustados y no en los principales.

La siguiente definición de índice en la colección sample_airbnb.listingsAndReviews indexa automáticamente todos los campos indexables de manera dinámica y configura los campos cancellation_policy, room_type y price para búsquedas facetadas.

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

La query siguiente utiliza la etapa $searchMeta para realizar las siguientes acciones:

• Faceta en los campos cancellation_policy, roomType y accommodates.

  La faceta cancellation_policy tiene los siguientes cubos:

  • "strict_14_with_grace_period"

  • "moderate"

  • "flexible"

  • "super_strict_30"

  • "super_strict_60"

  La faceta room_type tiene los siguientes cubos:

  • "Entire home/apt"

  • "Private room"

  • "Shared room"

  La consulta divide la faceta accommodates en bloques para:

  • 1_, límite inferior inclusivo para este cubo__

  • 2límite superior exclusivo para el grupo 1 y límite inferior inclusivo para este grupo.

  • 4límite superior exclusivo para el grupo 2 y límite inferior inclusivo para este grupo.

  • 8límite superior exclusivo para el grupo 4

• Realice una búsqueda de compound Operador para listados que deben contener el texto new york city en el description y filtrar los resultados para los listados con un moderate cancellation_policy. La configuración de doesNotAffect garantiza que filtrar por un moderate cancellation_policy no altere los recuentos de otros cubos en la faceta; los recuentos para "strict_14_with_grace_period", "flexible", "super_strict_30" y "super_strict_60" son valores distintos de cero.

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
      accomodatesFacet: {
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('380') }
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 los recuentos para compartimentos en cancellationFacet no se reducen a cero a pesar de que el filtro de query sobre un valor de moderate.

La siguiente definición de índice en la colección sample_airbnb.listingsAndReviews indexa los campos cancellation_policy, room_type y price, lo que permite la búsqueda facetada en ellos.

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

La siguiente query:

• Busca anuncios que incluyan el texto new york city en su description y que tengan un cancellation_policy de moderate.

• Facetas en los campos cancellation_policy, roomType y accommodates.

  Cada una de las facetas cancellation_policy y roomType tiene tres buckets, correspondientes a los tres valores únicos de estos campos en toda la colección. La consulta divide la accommodates faceta en agrupamientos para:

  • 1_, límite inferior inclusivo para este cubo__

  • 2límite superior exclusivo para el grupo 1 y límite inferior inclusivo para este grupo.

  • 4límite superior exclusivo para el grupo 2 y límite inferior inclusivo para este grupo.

  • 8límite superior exclusivo para el grupo 4

• Establece la propiedad doesNotAffect en el Operador equals del compound.filter en accommodatesFacet. Esto excluye los cubos dentro de la faceta accommodates del filtrado. Como resultado, el filtrado en el moderate cancellation_policy reduce la cantidad de otros buckets en la faceta cancellation_policy a 0 y reduce la cantidad de buckets en la faceta roomType, pero la cantidad de buckets en la faceta accommodates no cambia. Esto permite comparar el impacto del filtrado en 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
      accomodatesFacet: {
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: "flexible", count: Long('XXX') },
15
          { _id: "moderate", count: Long('531') },
16
          { _id: "strict_14_with_grace_period", count: Long('XXX') },
17
        ]
18
      },
19
      roomTypeFacet: {
20
        buckets: [
21
          { _id: "Entire home/apt", count: Long('369') },
22
          { _id: "Private room", count: Long('159') },
23
          { _id: "Shared room", count: Long('3') },
24
        ]
25
      }
26
    }
27
  }
28
]