/ /

Referencia de query

Operadores y coleccionistas

Docs Home

Desarrollo

Buscar

Query e índices

Referencia de query

Operadores y coleccionistas

`facet` (MongoDB Search Operador)

Definición

facet

El facet colector agrupa los resultados por valores o rangos en los campos facetados específicos y devuelve el conteo para cada uno de esos grupos.

Puede utilizar facet con las etapas $search y $searchMeta. MongoDB recomienda usar facet con la etapa $searchMeta para recuperar resultados de metadatos solo para la query. Para recuperar resultados de metadatos y resultados de query utilizando la etapa $search, debe utilizar la variable de agregación $$SEARCH_META. Consulte la SEARCH_META Variable de agregación para obtener más información.

Si defines storedSource en tu definición del tipo de campo embeddedDocuments, puedes usar returnScope junto con returnStoredSource para filtrar en campos anidados dentro de un arreglo de objetos. De lo contrario, solo puede crear facetas en el campo de tipo raíz embeddedDocuments. Para un ejemplo de faceteado activado:

Campos anidados dentro de un arreglo de objetos, consulta Ejemplo de returnScope.
Coincidencia de elementos secundarios de un arreglo embeddedDocuments mediante embeddedDocument, consulte Ejemplo de faceta con ámbito incrustado.
Campo raíz de tipo embeddedDocuments, ver Consulta de Facetas.

Sintaxis

facet tiene la siguiente sintaxis:

{
  "$searchMeta"|"$search": {
    "index": <index name>, // optional, defaults to "default"
    "facet": {
      "operator": {
        <operator-specifications>
      },
      "facets": {
        <facet-definitions>
      }
    },
    "returnScope": {
      "path": "<embedded-documents-field-to-query>"
    },
    "returnStoredSource": true
  }
}

Campos

Campo	Tipo	¿Requerido?	Descripción
`facets`	Documento	Sí	Información para agrupar los datos de cada faceta. Se debe especificar al menos una Definición de faceta. Cada definición de faceta también puede especificar agregaciones de facetas para calcular métricas para cada segmento.
`operator`	Documento	no	El operador que se debe usar para realizar la faceta. Si se omite, MongoDB Search realiza el facetado sobre todos los documentos de la colección.

Requisitos de memoria

Las query de facetas son intensivas en memoria, independientemente de su nivel de clúster. Las query que especifican agregación de faceta o facetas anidadas requieren más memoria y disco que otras query de faceta. Antes de usar facetas en producción, confirme que su clúster tiene suficiente memoria para su carga de trabajo. Para obtener más información, consulte Gestión de la memoria de búsqueda. Para obtener orientación sobre el tamaño de su carga de trabajo, solicitud asistencia.

La memoria que requiere una query de faceta depende del número de valores únicos en el campo sobre el que se aplica la faceta, no del número de cubos que solicita mediante numBuckets o boundaries. Por ejemplo, una faceta que solicita 20 depósitos en un campo con cinco millones de valores únicos sigue contando cada valor único para determinar los 20 depósitos principales.

Para facetas anidadas, los valores únicos totales calculados en una query se multiplican en función de los valores únicos de cada nivel de anidamiento. Incluso cuando cada campo individual tiene una cardinalidad baja, la combinación de valores en rutas anidadas puede generar un gran número de cubos únicos. Para obtener más información sobre cómo las facetas anidadas multiplican los depósitos, consulte Facetas anidadas.

MongoDB Search rastrea los recuentos de cubos por separado para cada query, por lo que el uso total de memoria escala con el número de query de faceta simultáneos. En un clúster, MongoDB Search también requiere memoria para fusionar los depósitos de cada partición, que escalar con el número de particiones y el número de depósitos.

Definición de faceta

El documento de definición de la faceta contiene el nombre de la faceta y las opciones específicas de un tipo de faceta. MongoDB Search admite los siguientes tipos de facetas:

String Facetas
Facetas numéricas
Facetas de fecha

String Facetas

Importante

stringFacet ahora está desfasado. Usa token en su lugar, lo que proporciona mejores facetas.

Para obtener más información sobre las diferencias entre los tipos de campo actualizados y obsoletos para faceta, consulte Comparar Tipos de Campo para Faceta.

Las facetas de string permiten acotar los resultados de MongoDB Search en función de los valores de string más frecuentes del campo de string especificado. El campo de string debe estar índice como token. Para aplicar facetas a los campos string en los documentos incrustados, también debes crear un índice de los campos principales como el tipo de documento. Cuando se aplican facetas a strings en arreglos o documentos incrustados, MongoDB Search devuelve recuentos de facetas basados en el número de documentos raíz coincidentes.

Sintaxis

Las facetas de String tienen la siguiente sintaxis:

{
  "$searchMeta": {
    "facet":{
      "operator": {
        <operator-specification>
      },
      "facets": {
        "<facet-name>" : {
          "type" : "string",
          "path" : "<field-path>",
          "numBuckets" : <number-of-categories>,
          "embeddedDocument": { <embedded-document-scope> } // optional
        }
      }
    }
  }
}

opciones

Opción	Tipo	Descripción	¿Requerido?
`embeddedDocument`	Objeto	Limita los recuentos de cubos de la faceta solo a los documentos secundarios de un arreglo `embeddedDocuments` que coinciden con un predicado de query. Para obtener más información, consulte Faceta en la coincidencia de elementos secundarios de un arreglo de documentos incrustados.	no
`numBuckets`	Int	Número máximo de categorías de faceta que se devolverán en los resultados. El valor debe ser menor o igual a `10000`. Si se especifica, MongoDB Search puede devolver menos categorías de las solicitadas si los datos se agrupan en menos categorías que el número solicitado. Si se omite, el valor por defecto es `10`, lo que significa que MongoDB Search devuelve solo las `10` categorías de faceta principales por recuento.	no
`path`	string	Ruta de campo para expresar facetas. Puede especificar un campo que tenga un índice como un token.	Sí
`type`	string	Tipo de faceta. El valor debe ser `string`.	Sí

Ejemplo

El siguiente ejemplo utiliza un índice llamado default en la colección sample_mflix.movies. El campo genres en la colección está indexado como el tipo token y el campo year está indexado como el tipo número.

{
  "mappings": {
    "dynamic": false,
    "fields": {
      "genres": {
        "type": "token"
      },
      "year": {
        "type": "number"
      }
    }
  }
}

La etapa utiliza la $searchMeta para buscar year en el campo en la movies colección películas desde 2000 hasta 2015 y recuperar un recuento del número de películas en cada género.

1 db.movies.aggregate([
2   {
3     "$searchMeta": {
4       "facet": {
5         "operator": {
6           "range": {
7             "path": "year",
8             "gte": 2000,
9             "lte": 2015
10           }
11         },
12         "facets": {
13           "genresFacet": {
14             "type": "string",
15             "path": "genres"
16           }
17         }
18       }
19     }
20   }
21 ])

1 [
2   {
3     count: { lowerBound: Long('12568') },
4     facet: {
5       genresFacet: {
6         buckets: [
7           { _id: 'Drama', count: Long('7079') },
8           { _id: 'Comedy', count: Long('3689') },
9           { _id: 'Romance', count: Long('1764') },
10           { _id: 'Thriller', count: Long('1584') },
11           { _id: 'Documentary', count: Long('1472') },
12           { _id: 'Action', count: Long('1471') },
13           { _id: 'Crime', count: Long('1367') },
14           { _id: 'Adventure', count: Long('1056') },
15           { _id: 'Horror', count: Long('866') },
16           { _id: 'Biography', count: Long('796') }
17         ]
18       }
19     }
20   }
21 ]

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

Facetas numéricas

Importante

numberFacet ahora está desactualizado. Usa number en su lugar, que proporciona una mejor facetación.

Para obtener más información sobre las diferencias entre los tipos de campo actualizados y obsoletos para faceta, consulte Comparar Tipos de Campo para Faceta.

Las facetas numéricas permiten determinar la frecuencia de los valores numéricos en los resultados de búsqueda dividiendo los resultados en rangos separados de números. Cuando aplicas facetas a números en arreglos o documentos incrustados, MongoDB Search devuelve recuentos de facetas en función de la cantidad de documentos raíz coincidentes.

Sintaxis

Los facetas numéricas tienen la siguiente sintaxis:

{
  "$searchMeta": {
    "facet":{
      "operator": {
        <operator-specification>
      },
      "facets": {
        "<facet-name>" : {
          "type" : "number",
          "path" : "<field-path>",
          "boundaries" : <array-of-numbers>,
          "default": "<bucket-name>",
          "embeddedDocument": { <embedded-document-scope> } // optional
        }
      }
    }
  }
}

opciones

Opción	Tipo	Descripción	¿Requerido?
`boundaries`	arreglo de números	Lista de valores numéricos en orden ascendente que especifican los límites para sus depósitos. Debe especificar entre dos y diez mil valores de límite (`[2, 10000]`). Cada par adyacente de valores define un contenedor con un límite inferior inclusivo y un límite superior exclusivo. Puede especificar cualquier combinación de valores de los siguientes BSON types: entero de 32 bits (`int32`) entero de 64 bits (`int64`) punto flotante binario de 64 bits (`double`)	Sí
`default`	string	Nombre de un bucket adicional que cuenta los documentos devueltos por el operador que no se encuentran dentro de los límites especificados. Si se omite, MongoDB Search también incluye los resultados del operador de faceta que no caen en un segmento especificado, pero no los incluye en ningún recuento de segmentos.	no
`embeddedDocument`	Objeto	Limita los recuentos de cubos de la faceta solo a los documentos secundarios de un arreglo `embeddedDocuments` que coinciden con un predicado de query. Para obtener más información, consulte Faceta en la coincidencia de elementos secundarios de un arreglo de documentos incrustados.	no
`path`	string	ruta de campo para facetar. Puedes especificar un campo que se indexe como tipo de número.	Sí
`type`	string	Tipo de faceta. El valor debe ser `number`.	Sí

Ejemplo

El ejemplo siguiente utiliza un índice llamado default en la colección sample_mflix.movies. El campo year en la colección está indexado como el tipo número.

{
  "mappings": {
    "dynamic": false,
    "fields": {
      "year": [
        {
          "type": "number"
        }
      ]
    }
  }
}

La query utiliza la etapa $searchMeta para buscar en el campo year de la colección movies películas entre los años 1980 y 2000 y recuperar resultados de metadatos para la query. La query especifica tres buckets:

1980_, límite inferior inclusivo para este cubo__
1990el límite superior exclusivo para el depósito 1980 y el límite inferior inclusivo para este depósito
2000límite superior exclusivo para el grupo 1990

La query también especifica un default bucket llamado other para recuperar los resultados de la query que no se encuentren dentro de ninguno de los límites especificados.

1 db.movies.aggregate([
2   {
3     "$searchMeta": {
4       "facet": {
5         "operator": {
6          "range": {
7             "path": "year",
8             "gte": 1980,
9             "lte": 2000
10           }
11         },
12         "facets": {
13           "yearFacet": {
14             "type": "number",
15             "path": "year",
16             "boundaries": [1980,1990,2000],
17             "default": "other"
18           }
19         }
20       }
21     }
22   }
23 ])

1 [
2   {
3     count: { lowerBound: Long('6095') },
4     facet: {
5       yearFacet: {
6         buckets: [
7           { _id: 1980, count: Long('1956') },
8           { _id: 1990, count: Long('3558') },
9           { _id: 'other', count: Long('581') }
10         ]
11       }
12     }
13   }
14 ]

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

Facetas de fecha

Importante

dateFacet está ahora obsoleto. Utiliza date en su lugar, lo que proporciona una mejor faceta.

Para obtener más información sobre las diferencias entre los tipos de campo actualizados y obsoletos para faceta, consulte Comparar Tipos de Campo para Faceta.

Las facetas de fecha te permiten limitar los resultados de búsqueda según una fecha. Cuando aplicas facetas por fechas en arreglos o documentos incrustados, MongoDB Search devuelve los recuentos de facetas según el número de documentos raíz coincidentes.

Sintaxis

Los facetas de fecha tienen la siguiente sintaxis:

{
  "$searchMeta": {
    "facet":{
      "operator": {
        <operator-specification>
      },
      "facets": {
        "<facet-name>" : {
          "type" : "date",
          "path" : "<field-path>",
          "boundaries" : <array-of-dates>,
          "default": "<bucket-name>",
          "embeddedDocument": { <embedded-document-scope> } // optional
        }
      }
    }
  }
}

opciones

Opción	Tipo	Descripción	¿Requerido?
`boundaries`	arreglo de números	Lista de valores de fecha que especifican los límites de cada franja. Debe especificar: Al menos dos límites, que son menores o iguales a diez mil (`[2, 10000]`) Valores en orden ascendente, con la fecha más antigua primero Cada par adyacente de valores actúa como el límite inferior inclusivo y el límite superior exclusivo para el contenedor.	Sí
`default`	string	Nombre de un bucket adicional que cuenta los documentos devueltos por el operador que no están dentro de los límites especificados. Si se omite, MongoDB Search también incluye los resultados del operador de faceta que no entran dentro de un bucket especificado, pero MongoDB Search no incluye estos resultados en ningún conteo de bucket.	no
`embeddedDocument`	Objeto	Limita los recuentos de cubos de la faceta solo a los documentos secundarios de un arreglo `embeddedDocuments` que coinciden con un predicado de query. Para obtener más información, consulte Faceta en la coincidencia de elementos secundarios de un arreglo de documentos incrustados.	no
`path`	string	Ruta de campo para facetar. Se puede especificar un campo que se indexa como tipo fecha.	Sí
`type`	string	Tipo de faceta. El valor debe ser `date`.	Sí

Ejemplo

El ejemplo siguiente utiliza un índice llamado default en la colección sample_mflix.movies. El campo released en la colección se indexa como el tipo fecha.

{
  "mappings": {
    "dynamic": false,
    "fields": {
      "released": [
        {
          "type": "date"
        }
      ]
    }
  }
}

La query utiliza la etapa $searchMeta para buscar en el campo released de la colección movies películas entre los años 2000 y 2015 y recuperar resultados de metadatos para la query. La query especifica cuatro buckets:

2000-01-01_, límite inferior inclusivo para este cubo__
2005-01-01el límite superior exclusivo para el depósito 2000-01-01 y el límite inferior inclusivo para este depósito
2010-01-01el límite superior exclusivo para el depósito 2005-01-01 y el límite inferior inclusivo para este depósito
2015-01-01límite superior exclusivo para el grupo 2010-01-01

La query también especifica un default bucket llamado other para recuperar los resultados de la query que no se encuentren dentro de ninguno de los límites especificados.

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           "yearFacet": {
14             "type": "date",
15             "path": "released",
16             "boundaries": [ISODate("2000-01-01"), ISODate("2005-01-01"), ISODate("2010-01-01"), ISODate("2015-01-01")],
17             "default": "other"
18           }
19         }
20       }
21     }
22   }
23 ])

1 [
2   {
3     count: { lowerBound: Long('11922') },
4     facet: {
5       yearFacet: {
6         buckets: [
7           {
8             _id: ISODate('2000-01-01T00:00:00.000Z'),
9             count: Long('3028')
10           },
11           {
12             _id: ISODate('2005-01-01T00:00:00.000Z'),
13             count: Long('3953')
14           },
15           {
16             _id: ISODate('2010-01-01T00:00:00.000Z'),
17             count: Long('4832')
18           },
19           { _id: 'other', count: Long('109') }
20         ]
21       }
22     }
23   }
24 ]

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

Comparación de los tipos de campos para facetas

Los tipos de campo de MongoDB Search actualizados proporcionan una funcionalidad mejorada para soporte facetas en comparación con los tipos obsoletos (stringFacet, numberFacet, dateFacet). La siguiente tabla destaca las diferencias clave en la funcionalidad:

Categoría de faceta	Tipo de campo actualizado	Tipo de faceta anticuado	Diferencias clave
String	token	stringFacet (desactualizado)	Normalizer Support: The `token` type supports normalizers that transform facet buckets. For example, with `normalizer: lowercase`, "ADIDAS" and "adidas" count toward the same bucket while `stringFacet` treats them as separate buckets.
Numeric	Número	numberFacet (desactualizado)	Array Support: The `number` type considers values within arrays for facet buckets. For example, a document with an array value `[0, 10]` counts toward both buckets `[1, 5]` and `[6, 10]` while `numberFacet` ignores array values completely.
fecha	fecha	dateFacet (desactualizado)	Soporte de arreglos: El tipo `date` considera los valores dentro de arreglos para los segmentos de facetas. Por ejemplo, un valor de arreglo con fechas puede contribuir a múltiples rangos de fechas, mientras que `dateFacet` ignora completamente los valores de arreglo.

Nota

Cuando tanto los tipos de campo obsoletos como los actualizados se definen para el mismo campo, los tipos de faceta obsoletos tienen prioridad. Por ejemplo, si token y stringFacet están definidos para un campo, el cálculo de facetas utiliza la asignación stringFacet.

Faceta en hijos coincidentes de un arreglo de documentos incrustados

Cada definición de faceta puede incluir un campo embeddedDocument opcional que limita los recuentos de depósitos de la faceta solo a los documentos secundarios en un arreglo de embeddedDocuments que coinciden con un predicado de query. Si omite el campo embeddedDocument, la faceta está indexada por documento.

Sin embeddedDocument, un documento raíz se cuenta en un bucket si tiene algún documento secundario que caiga en ese bucket, incluso si ese secundario no coincide con la query definida en el bloque facet.operator. El campo embeddedDocument restringe las contribuciones de los depósitos solo a los elementos secundarios que coinciden con el embeddedDocument.operator especificado. Cuenta cada documento raíz como máximo una vez por bucket.

El campo embeddedDocument toma los siguientes campos:

Campo	Tipo	Descripción	¿Requerido?
`path`	string	Campo de tipo `embeddedDocuments` índice para acotar la faceta a. El `path` de la faceta debe ser un descendiente de este campo.	Sí
`operator`	Objeto	operador para ejecutar contra cada documento secundario en el arreglo `embeddedDocuments` que especifique en `path`. Solo los documentos secundarios que coinciden con este operador contribuyen a los recuentos de depósitos de la faceta. Cada ruta a la que se hace referencia en este operador debe ser un descendiente de `path`.	Sí

Para una faceta de número o fecha, un elemento secundario coincidente cuyo valor quede fuera de los recuentos configurados de boundaries en el depósito default, si especifica uno, utilizando la misma regla que una faceta de índice de documento. Un documento raíz sin un hijo coincidente no contribuye a la faceta con ámbito embeddedDocument, pero aún puede contribuir a cualquier otra faceta sin ámbito en la misma query.

Importante

No se puede combinar una faceta de ámbito embeddedDocumentcon varias otras opciones de faceta. Para aprender más, se puede consultar Limitaciones.

Para ver un ejemplo, consulte el Ejemplo de faceta de ámbito incrustado.

Agregaciones de faceta

Importante

Agregaciones de faceta están en vista previa. La funcionalidad y la documentación correspondiente pueden cambiar en cualquier momento durante el período de vista previa. Para aprender más, consultar Funcionalidades de la vista previa.

Para calcular métricas para cada grupo de facetas, añada un documento aggregations a una definición de faceta. MongoDB Search calcula las métricas del índice de búsqueda de MongoDB Search, por lo que es mucho más eficiente que ejecutar una $group etapa más adelante en su pipeline.

Para cada bucket de faceta, aggregations le permite calcular los siguientes valores:

suma
average
Mínimo
máximo
primero
último

Al utilizar aggregations, debe:

Índice el campo que especifique en el path para cada métricas como token, number o date.
Incluya explícitamente la métrica count si desea el recuento de depósitos.
Solo especifique aggregations en el nivel hoja de facetas anidadas.

Si desea calcular métricas para una agrupación intermedia, especifique esa agrupación como una faceta de nivel superior independiente con aggregations y sin facetas anidadas.

MongoDB Search calcula aggregations sobre los datos en el índice de búsqueda de MongoDB, que es finalmente coherente.

Nota

Requisitos de memoria

Las query de faceta que especifican aggregations o facetas anidadas aumentan la memoria y el disco que requiere su índice de MongoDB Search más allá de los requisitos para otras query de faceta. Para aprender más, consulte Requisitos de memoria.

Sintaxis

aggregations tiene la siguiente sintaxis:

{
  "$searchMeta": {
    "facet": {
      "facets": {
        "<facet-name>": {
          "type": "<facet-type>",
          "path": "<field-path>",
          "aggregations": {
            "<aggregation-name>": {
              "type": "sum" | "min" | "max" | "avg" | "first" | "last",
              "path": "<field-path>"
            }
          }
        }
      }
    }
  }
}

Cada clave en el documento aggregations es un nombre de agregación que usted especifica. MongoDB Search devuelve cada agregación en los documentos de bucket con el nombre que especifique.

opciones

Opción	Tipo	Descripción	¿Requerido?
`path`	string	Ruta de campo sobre la que calcular la métrica. Esto es necesario para todos los tipos de métricas, excepto `count`, que no acepta un `path`. Cada otro tipo de métrica calcula un valor de un segundo campo, por lo que debe nombrar ese campo. Por ejemplo, para devolver la calificación promedio de los documentos en un bucket, especifique `avg` con un `path` de `rating`. La métrica `count` cuenta los documentos en el depósito, por lo que no necesita un segundo campo.	Condicional
`type`	string	Tipo de métrica a calcular. El valor puede ser uno de los siguientes: `count` `sum` `avg` `min` `max` `first` `last` Para aprender más sobre cada tipo de métrica, consulte Tipos de métricas.	Sí

Tipos de métricas

Tipo	Requisitos de campo	Descripción
`count`	Ninguno	Cuenta los documentos en el bucket. No especifique un `path` para este tipo de métrica. Si omite `aggregations` de una definición de faceta, MongoDB Search devuelve una métrica `count` para el bucket. Si especifica `aggregations`, MongoDB Search devuelve una métrica `count` solo si especifica `count` en el documento `aggregations`.
`sum`	Número	Suma los valores del campo especificado para los documentos en el depósito.
`avg`	Número	Devuelve el promedio de los valores del campo especificado para los documentos en el bucket. Si ningún documento en el bucket tiene un valor para el campo, MongoDB Search devuelve `null`.
`min`	Ninguno	Devuelve el valor más bajo del campo especificado para los documentos del bucket.
`max`	Ninguno	Devuelve el valor más alto del campo especificado para los documentos en el segmento.
`first`	Ninguno	Devuelve el valor del campo especificado para el primer documento del bucket, según el orden que define la opción de ordenación de la query. Si la query no especifica una ordenación, el orden es arbitrario. Para aprender cómo especificar una ordenación, consulte Ordenar resultados de MongoDB Search.
`last`	Ninguno	Devuelve el valor del campo especificado para el último documento del bucket, según el orden que define la opción de ordenación de la query. Si la query no especifica una ordenación, el orden es arbitrario. Para aprender cómo especificar una ordenación, consulte Ordenar resultados de MongoDB Search.

Importante

min y max admiten todos los tipos de campo, incluido token. Cuando MongoDB Search calcula estas métricas, omite cualquier documento en el que el campo se resuelve en un tipo no compatible. MongoDB Search no devuelve un error cuando omite un documento. Para determinar si MongoDB Search omitió documentos en un bucket, agregue una métrica count al mismo documento aggregations y compárela con el número de documentos que espera.

Para los valores que MongoDB Search no omite, min selecciona el valor más pequeño del bucket y max selecciona el más grande. Si los valores no son todos del mismo tipo, MongoDB Search aplica orden de comparación de tipos BSON para determinar qué valor es el más pequeño o el más grande.

Consideraciones sobre arreglos

Cada tipo de métrica gestiona un campo que se resuelve en más de un valor, como un arreglo, de forma diferente:

sum y avg omitir el documento.
min y max selecciona el valor más bajo y el más alto en el arreglo para usarlo como elemento representativo para el documento.
first y last devuelve todos los valores como un arreglo.

Para first y last, el arreglo devuelto difiere del documento de origen de las siguientes maneras:

El orden de los valores podría diferir. MongoDB Search lee los valores del índice, lo que no conserva el orden del documento de origen. Por ejemplo, si un documento contiene ["red", "blue", "green"], MongoDB Search podría devolver ["blue", "green", "red"].
MongoDB Search devuelve solo una instancia de un valor duplicado.
MongoDB Search devuelve cada valor en la ruta, incluidos los valores de un tipo en el que no se puede aplicar una faceta. Por ejemplo, si un arreglo contiene tanto cadenas como un booleano, MongoDB Search devuelve el booleano con las cadenas.

Para devolver los valores exactamente como los contiene el documento de origen, defina storedSource para el campo en la definición de su índice y establezca returnStoredSource en true en su query.

Facetas anidadas

Importante

Las facetas anidadas están en vista previa. La funcionalidad y la documentación correspondiente pueden cambiar en cualquier momento durante el período de vista previa. Para aprender más, consultar Funcionalidades de la vista previa.

To group the documents in each bucket by additional fields, add a facets document to an existing facet definition. Each nested facet definition uses the same syntax as a top-level facet definition, so you can nest facets to build a tree of groupings. MongoDB Search returns the buckets for a nested facet inside each bucket of its parent facet.

For each bucket of a facet that contains a nested facet, MongoDB Search also returns a count field with the number of documents in the bucket. You don't need to specify a count metric for these intermediate buckets.

You can nest facets without limit on the number of levels. However, the following restrictions apply:

Puede especificar aggregations solo en una faceta hoja en un árbol de facetas anidadas. Una definición de faceta que especifica facets no puede especificar también aggregations. Para calcular métricas para una agrupación intermedia, especifique esa agrupación como una faceta de nivel superior independiente con aggregations y sin faceta anidada.
You can't name a nested facet count. MongoDB Search reserves count for the document count of intermediate buckets.
El número total de depósitos únicos que una query puede devolver no puede superar 100000. Para calcular los cubos que produce un árbol de facetas, multiplique el número de cubos en cada nivel de su rama de anidamiento. El número de depósitos en un nivel es numBuckets para una faceta de string o el número de depósitos que boundaries y default definen para una faceta de número o fecha. Por ejemplo, una faceta que solicita 20 cubos y contiene una faceta anidada que solicita 20 cubos produce 400 cubos únicos. Dado que cada nivel multiplica este total, la solicitud de más depósitos en cada nivel reduce el número de niveles que se pueden anidar.

Resultados de Faceta

Para una consulta de faceta, MongoDB Search devuelve una asignación de los nombres de facetas definidos a un arreglo de buckets para esa faceta en los resultados. El documento de resultados de la faceta contiene la opción buckets, que es un arreglo de cubos resultantes para la faceta. Cada documento de agrupación por facetas en el arreglo tiene los siguientes campos:

Opción	Tipo	Descripción
`_id`	Objeto	Identificador único que identifica este bucket de facetas. Este valor coincide con el tipo de faceta en la que se está aplicando.
`count`	Int	Cantidad de documentos en este bucket de facetas. Para obtener más información sobre el campo `count`, consulta Recuento de resultados de MongoDB Search.

If the facet definition specifies Facet Aggregations, each bucket document contains the metrics that you name in the aggregations document instead of the count field. If the facet definition specifies nested facets, each bucket document contains a count field with the number of documents in the bucket, and the results for the nested facet.

Facetas de selección múltiple

MongoDB Search te permite ver y seleccionar múltiples "buckets" dentro de la misma faceta simultáneamente. Normalmente, seleccionar un bucket dentro de una faceta filtra los resultados de la búsqueda según esa selección y modifica los recuentos para todas las facetas.

Ejemplo

Suponga que una definición de índice para la colección sample_airbnb.listings especifica facetas para los siguientes campos:

cancellation_policy
room_type
accommodates

La faceta cancellation_policy tiene los siguientes cubos:

flexible
moderate
strict_14_with_grace_period
super_strict_30
super_strict_60

Cada cubo tiene su propio recuento de resultados. Cuando busca el moderate cancellation_policy, los recuentos de los otros cuatro depósitos Go a 0. Además, los recuentos de los depósitos en las facetas room_type y accommodates se reducen al número de resultados de cada depósito que también tienen un flexible cancellation_policy.

En escenarios en los que necesita un control más granular sobre cómo los facetas afectan el conteo de resultados de búsqueda, active el faceting de selección múltiple con la propiedad doesNotAffect en sus consultas facetadas. Estas facetas siguen filtrando los resultados, pero la query no altera sus recuentos de resultados.

Puede especificar doesNotAffect en los siguientes operadores:

Para excluir varias facetas, especifique un arreglo de nombres de faceta. La mayoría de los casos de uso excluyen únicamente la faceta que comparte una ruta con el filtro. Por ejemplo, un filtro equals en el campo rating especifica el nombre de la faceta que utiliza rating como su ruta.

Nota

La opción doesNotAffect no funciona con facetas que especifican agregación. Para aprender más, se puede consultar Limitaciones.

Ejemplo

Considere una query en la colección sample_airbnb.listingsAndReviews para documentos con un moderate cancellation_policy. Si especifica un valor doesNotAffect de cancellation_policy, el recuento de depósitos en la faceta cancellation_policy no cambia, pero el recuento de resultados de los depósitos de otras facetas se reduce al número de resultados de cada depósito que también tienen un moderate cancellation_policy.

Para obtener más información, consulta el ejemplo de Selección múltiple por facetas.

No puede combinar doesNotAffect con una faceta con ámbito de embeddedDocument. Para aprender más, consulte Faceta en la coincidencia de elementos secundarios de un arreglo de documentos incrustados.

Por último, para casos de uso con muchas facetas, puede limitar qué otros filtros afectan a una faceta determinada. Puede hacerlo especificando cualquier faceta en la propiedad doesNotAffect de cualquier filtro, incluidas las facetas en otros campos. Esto le permite observar de un vistazo qué selecciones reducen las opciones más o menos rápidamente.

Ejemplo

Considere una query en la colección sample_airbnb.listingsAndReviews para documentos con un valor accommodates de 3. Si especifica un valor doesNotAffect de cancellation_policy, el recuento de resultados de los depósitos room_type se reduce al número de resultados de cada depósito que también admiten 3 personas, pero el recuento de resultados de los depósitos de cancellation_policy no se ve afectado.

Para más información, consulte el Ejemplo de exclusión de filtros entre facetas.

`SEARCH_META` Variable de agregación

Cuando ejecute su query utilizando la etapa $search, MongoDB Search almacena los resultados de metadatos en la variable $$SEARCH_META y devuelve solo los resultados de búsqueda. Se puede utilizar la variable $$SEARCH_META en todas las etapas del pipeline de agregación compatibles para ver los resultados de metadatos de su $search query. También puede usar la variable $$SEARCH_META con faceta.agregaciones.

MongoDB recomienda usar la variable $$SEARCH_META solo si necesitas tanto los resultados de la búsqueda como los resultados de los metadatos. De lo contrario, utiliza la:

$search etapa solo para los resultados de búsqueda.
$searchMeta etapa solo para los resultados de los metadatos.

Limitaciones

Solo puedes ejecutar query de faceta en un único campo. No puedes ejecutar consultas de facetas sobre grupos de campos.

Limitaciones para facetas de ámbito incrustado

Las siguientes limitaciones se aplican a Faceta en la coincidencia de elementos secundarios de un arreglo de documentos incrustados:

No puede combinar una opción returnScope de nivel superior con una faceta con ámbito embeddedDocumenten la misma query.
Una faceta con ámbito embeddedDocumentsolo devuelve un recuento.
No puede combinar drill-sideways faceting (doesNotAffect) con una faceta con ámbito embeddedDocumenten la misma query.

Limitaciones para agregaciones de faceta

Se aplican las siguientes limitaciones a agregaciones de facetas:

No puede utilizar las siguientes opciones con aggregations:
- returnScope
- doesNotAffect para Faceta de selección múltiple
No puede aplicar facetas o calcular agregaciones en los siguientes BSON types:
- binData
- bool
- decimal
- null
- objectId
- timestamp
Para calcular métricas sobre uno de estos tipos, utilice una vista para convertir el campo a un tipo compatible antes de índice.

Ejemplos

Los siguientes ejemplos utilizan los datos de muestra. El ejemplo de resultados de metadatos demuestra cómo ejecutar una $searchMeta query con facet para recuperar solo los metadatos de los resultados. El ejemplo de metadatos y resultados de búsqueda demuestra cómo ejecutar una $search query con facet y la variable de agregación $SEARCH_META para recuperar tanto los resultados de búsqueda como los metadatos. El ejemplo returnScope demuestra cómo crear facetas en campos anidados en un arreglo de objetos indexados dinámicamente utilizando el tipo embeddedDocuments. El ejemplo de faceta de alcance incrustado demuestra cómo aplicar facetas solo a los elementos secundarios coincidentes de un arreglo embeddedDocuments. Los ejemplos de exclusión de filtro de selección múltiple y entre facetas demuestran cómo usar doesNotAffect para controlar cómo las facetas afectan los recuentos de las demás. El ejemplo de agregación demuestra cómo calcular métricas para cada cubo de facetas, y el ejemplo de faceta anidada demuestra cómo agrupar resultados por un segundo campo y calcular métricas para cada cubo.

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

Nombre de campo	Tipo de dato
`directors`	token
`year`	Número
`released`	fecha

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

La siguiente query busca películas que se estrenaron entre el 01 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:

Nombre de campo	Tipo de dato
`genres`	token
`released`	fecha

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

La siguiente query busca películas estrenadas cerca del 01 de julio de 1999 utilizando 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 en 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 los metadatos almacenados en la variable $$SEARCH_META en el campo de salida meta

La query también incluye una etapa de $set para agregar el campo meta.

Nota

Para ver los resultados de metadatos de la siguiente query, MongoDB Search debe devolver documentos que coincidan con la query.

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 (operador de MongoDB Search) 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 definición de índice en la colección sample_training.companies indexa el campo funding_rounds como el tipo embeddedDocuments, con los campos round_code y raised_currency_code de cada ronda de financiación indexados como token.

{
  "mappings": {
    "dynamic": false,
    "fields": {
      "name": {
        "type": "token"
      },
      "funding_rounds": {
        "type": "embeddedDocuments",
        "dynamic": false,
        "fields": {
          "round_code": {
            "type": "token"
          },
          "raised_currency_code": {
            "type": "token"
          }
        }
      }
    }
  }
}

KickApps, Topix y StumbleUpon tienen varias rondas de financiación, solo algunas de las cuales se recaudaron en USD:

// KickApps
{ "name": "KickApps",
  "funding_rounds": [
    { "round_code": "a", "raised_currency_code": "USD" },
    { "round_code": "b", "raised_currency_code": "USD" },
    { "round_code": "c", "raised_currency_code": "GBP" }
  ]
}
// Topix
{ "name": "Topix",
  "funding_rounds": [
    { "round_code": "a", "raised_currency_code": null },
    { "round_code": "b", "raised_currency_code": "USD" }
  ]
}
// StumbleUpon
{ "name": "StumbleUpon",
  "funding_rounds": [
    { "round_code": "seed", "raised_currency_code": "USD" },
    { "round_code": "a", "raised_currency_code": null },
    { "round_code": "b", "raised_currency_code": "USD" },
    { "round_code": "angel", "raised_currency_code": null }
  ]
}

La siguiente query utiliza el operador in para restringir la faceta a estas tres empresas, luego faceta en funding_rounds.round_code. La definición de roundFacet especifica un bloque embeddedDocument que limita la faceta únicamente a las rondas de financiación donde raised_currency_code es USD.

1 db.companies.aggregate([
2   {
3     "$searchMeta": {
4       "facet": {
5         "operator": {
6           "in": {
7             "path": "name",
8             "value": ["KickApps", "Topix", "StumbleUpon"]
9           }
10         },
11         "facets": {
12           "roundFacet": {
13             "type": "string",
14             "path": "funding_rounds.round_code",
15             "embeddedDocument": {
16               "path": "funding_rounds",
17               "operator": {
18                 "equals": {
19                   "path": "funding_rounds.raised_currency_code",
20                   "value": "USD"
21                 }
22               }
23             }
24           }
25         }
26       }
27     }
28   }
29 ])

1 [
2   {
3     count: { lowerBound: Long('3') },
4     facet: {
5       roundFacet: {
6         buckets: [
7           { _id: 'b', count: Long('3') },
8           { _id: 'a', count: Long('1') },
9           { _id: 'seed', count: Long('1') }
10         ]
11       }
12     }
13   }
14 ]

Cada empresa cuenta una vez por código de ronda para la que tiene al menos una ronda de financiación obtenida en USD:

b recuentos 3: KickApps, Topix y StumbleUpon han recaudado cada uno una ronda b en USD.
a recuentos 1: solo KickApps tiene una ronda a recaudada en USD. Las a rondas de Topix y StumbleUpon no tienen divisa registrada, por lo que no se corresponden.
seed recuentos 1: la ronda seed de StumbleUpon se recaudó en USD.

La ronda c de KickApps no contribuye a un grupo c porque se recaudó en GBP, no en USD. Sin el bloque embeddedDocument, la faceta en funding_rounds.round_code requiere la indexación de funding_rounds como el tipo de documento en su lugar, y una faceta sin ámbito también contaría KickApps en un depósito c, porque el documento raíz tiene un elemento secundario coincidente en ese depósito independientemente de su vigencia.

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": true,
    "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       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 ]

Los recuentos de los buckets en cancellationFacet no se reducen a cero a pesar de que la query filtra por 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:

Buscar anuncios que incluyan el texto new york city en su description y que tengan un cancellation_policy de moderate.
Faceta en los campos cancellation_policy, roomType y accommodates.

Cada una de las facetas cancellation_policy y roomType tiene tres categorías, que corresponden a los tres valores únicos de estos campos en toda la colección. La query divide la faceta accommodates en cubos 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
Establezca la propiedad doesNotAffect en el operador equals de compound.filter en accommodatesFacet. Esto excluye los depósitos dentro de la faceta accommodates del filtro. Como resultado, el filtro en moderate cancellation_policy reduce el recuento de otros depósitos en la faceta cancellation_policy a 0, y reduce el recuento de depósitos en la faceta roomType, pero el recuento de depósitos en la faceta accommodates no cambia. Esto le permite comparar el impacto del filtro 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       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 ]

El siguiente ejemplo utiliza un índice llamado default en la colección sample_airbnb.listingsAndReviews. Los campos property_type y amenities de la colección están indexados como el tipo token y el campo accommodates está indexado como el tipo number.

{
  "mappings": {
    "dynamic": false,
    "fields": {
      "property_type": [
        {
          "type": "token"
        }
      ],
      "amenities": [
        {
          "type": "token"
        }
      ],
      "accommodates": [
        {
          "type": "number"
        }
      ]
    }
  }
}

La query utiliza la etapa $searchMeta para encontrar los listados que ofrecen al menos una de las comodidades especificadas y agruparlos por property_type. Para cada tipo de propiedad, la query calcula el número de anuncios y el número mínimo y máximo de huéspedes que un anuncio puede alojar.

1 db.listingsAndReviews.aggregate([
2   {
3     "$searchMeta": {
4       "facet": {
5         "operator": {
6           "in": {
7             "path": "amenities",
8             "value": ["Wifi", "Pets allowed", "Wheelchair accessible"]
9           }
10         },
11         "facets": {
12           "propertyTypeFacet": {
13             "type": "string",
14             "path": "property_type",
15             "aggregations": {
16               "listingCount": {
17                 "type": "count"
18               },
19               "minAccommodates": {
20                 "type": "min",
21                 "path": "accommodates"
22               },
23             "maxAccommodates": {
24                 "type": "max",
25                 "path": "accommodates"
26               }
27             }
28           }
29         }
30       }
31     }
32   }
33 ])

[
  {
    count: { lowerBound: Long('5355') },
    facet: {
      propertyTypeFacet: {
        buckets: [
          {
            _id: 'Apartment',
            listingCount: Long('3488'),
            minAccommodates: 1,
            maxAccommodates: 16
          },
          {
            _id: 'House',
            listingCount: Long('584'),
            minAccommodates: 1,
            maxAccommodates: 16
          },
          {
            _id: 'Condominium',
            listingCount: Long('386'),
            minAccommodates: 1,
            maxAccommodates: 12
          },
          {
            _id: 'Serviced apartment',
            listingCount: Long('182'),
            minAccommodates: 1,
            maxAccommodates: 16
          },
          {
            _id: 'Loft',
            listingCount: Long('139'),
            minAccommodates: 1,
            maxAccommodates: 16
          },
          {
            _id: 'Townhouse',
            listingCount: Long('104'),
            minAccommodates: 1,
            maxAccommodates: 16
          },
          {
            _id: 'Guest suite',
            listingCount: Long('79'),
            minAccommodates: 1,
            maxAccommodates: 8
          },
          {
            _id: 'Bed and breakfast',
            listingCount: Long('64'),
            minAccommodates: 1,
            maxAccommodates: 16
          },
          {
            _id: 'Boutique hotel',
            listingCount: Long('51'),
            minAccommodates: 1,
            maxAccommodates: 16
          },
          {
            _id: 'Guesthouse',
            listingCount: Long('49'),
            minAccommodates: 1,
            maxAccommodates: 8
          }
        ]
      }
    }
  }
]

El siguiente ejemplo utiliza un índice llamado default en la colección sample_airbnb.listingsAndReviews. El campo property_type de la colección está indexado como el tipo token y los campos bedrooms y accommodates están indexados como el tipo numérico.

{
  "mappings": {
    "dynamic": false,
    "fields": {
      "property_type": [
        {
          "type": "token"
        }
      ],
      "bedrooms": [
        {
          "type": "number"
        }
      ],
      "accommodates": [
        {
          "type": "number"
        }
      ]
    }
  }
}

The query groups the listings by property_type, and then groups the listings in each property type by number of bedrooms (0, 2, or 4). The query computes the number of listings and the largest number of guests that a listing accommodates for each bedroom range.

1 db.listingsAndReviews.aggregate([
2   {
3     "$searchMeta": {
4       "facet": {
5         "facets": {
6           "propertyTypeFacet": {
7             "type": "string",
8             "path": "property_type",
9             "facets": {
10               "bedroomsFacet": {
11                 "type": "number",
12                 "path": "bedrooms",
13                 "boundaries": [0, 2, 4],
14                 "default": "other",
15                 "aggregations": {
16                   "listingCount": {
17                     "type": "count"
18                   },
19                   "maxAccommodates": {
20                     "type": "max",
21                     "path": "accommodates"
22                   }
23                 }
24               }
25             }
26           }
27         }
28       }
29     }
30   }
31 ])

[
  {
    count: { lowerBound: Long('5555') },
    facet: {
      propertyTypeFacet: {
        buckets: [
          {
            _id: 'Apartment',
            count: { total: Long('3626') },
            bedroomsFacet: {
              buckets: [
                { _id: 0, listingCount: Long('2534'), maxAccommodates: 12 },
                { _id: 2, listingCount: Long('1006'), maxAccommodates: 13 },
                { _id: 'other', listingCount: Long('86'), maxAccommodates: 16 }
              ]
            }
          },
          {
            _id: 'House',
            count: { total: Long('606') },
            bedroomsFacet: {
              buckets: [
                { _id: 0, listingCount: Long('312'), maxAccommodates: 16 },
                { _id: 2, listingCount: Long('183'), maxAccommodates: 16 },
                { _id: 'other', listingCount: Long('111'), maxAccommodates: 16 }
              ]
            }
          },
          {
            _id: 'Condominium',
            count: { total: Long('399') },
            bedroomsFacet: {
              buckets: [
                { _id: 0, listingCount: Long('256'), maxAccommodates: 10 },
                { _id: 2, listingCount: Long('138'), maxAccommodates: 11 },
                { _id: 'other', listingCount: Long('5'), maxAccommodates: 12 }
              ]
            }
          },
          {
            _id: 'Serviced apartment',
            count: { total: Long('185') },
            bedroomsFacet: {
              buckets: [
                { _id: 0, listingCount: Long('128'), maxAccommodates: 7 },
                { _id: 2, listingCount: Long('53'), maxAccommodates: 12 },
                { _id: 'other', listingCount: Long('4'), maxAccommodates: 16 }
              ]
            }
          },
          {
            _id: 'Loft',
            count: { total: Long('142') },
            bedroomsFacet: {
              buckets: [
                { _id: 0, listingCount: Long('123'), maxAccommodates: 16 },
                { _id: 2, listingCount: Long('15'), maxAccommodates: 6 },
                { _id: 'other', listingCount: Long('4'), maxAccommodates: 16 }
              ]
            }
          },
          {
            _id: 'Townhouse',
            count: { total: Long('108') },
            bedroomsFacet: {
              buckets: [
                { _id: 0, listingCount: Long('59'), maxAccommodates: 8 },
                { _id: 2, listingCount: Long('42'), maxAccommodates: 10 },
                { _id: 'other', listingCount: Long('7'), maxAccommodates: 16 }
              ]
            }
          },
          {
            _id: 'Guest suite',
            count: { total: Long('81') },
            bedroomsFacet: {
              buckets: [
                { _id: 0, listingCount: Long('68'), maxAccommodates: 7 },
                { _id: 2, listingCount: Long('12'), maxAccommodates: 6 },
                { _id: 'other', listingCount: Long('1'), maxAccommodates: 8 }
              ]
            }
          },
          {
            _id: 'Bed and breakfast',
            count: { total: Long('69') },
            bedroomsFacet: {
              buckets: [
                { _id: 0, listingCount: Long('61'), maxAccommodates: 12 },
                { _id: 2, listingCount: Long('6'), maxAccommodates: 9 },
                { _id: 'other', listingCount: Long('2'), maxAccommodates: 16 }
              ]
            }
          },
          {
            _id: 'Boutique hotel',
            count: { total: Long('53') },
            bedroomsFacet: {
              buckets: [
                { _id: 0, listingCount: Long('47'), maxAccommodates: 16 },
                { _id: 2, listingCount: Long('5'), maxAccommodates: 6 },
                { _id: 'other', listingCount: Long('1'), maxAccommodates: 15 }
              ]
            }
          },
          {
            _id: 'Guesthouse',
            count: { total: Long('50') },
            bedroomsFacet: {
              buckets: [
                { _id: 0, listingCount: Long('43'), maxAccommodates: 8 },
                { _id: 2, listingCount: Long('7'), maxAccommodates: 6 },
                { _id: 'other', listingCount: Long('0'), maxAccommodates: null }
              ]
            }
          }
        ]
      }
    }
  }
]

MongoDB Search returns the following information for each facet bucket:

The number of listings (count) in the bucket (such as Apartment, House, and so on).
The maximum number of guests that a listing in the bucket range (0 bedrooms, 2 bedrooms, and so on) accommodates (maxAccommodates).

Continuar Aprendiendo

Para obtener más información, se puede consultar Cómo utilizar facetas con la MongoDB Search.

Puede aprender más sobre facet (Operador de búsqueda de MongoDB) en MongoDB Search con nuestro curso y video.

Aprende con cursos

Para obtener más información sobre el uso de facetas en MongoDB Search, puedes tomar la Unidad 9 del Curso de introducción a MongoDB en MongoDB University. La unidad de 1,5 horas incluye un resumen de MongoDB Search y lecciones sobre cómo crear índices de MongoDB Search, ejecutar queries de $search con operadores compuestos y agrupar resultados con facet.

Aprende observando

Vea este video para aprender a crear y usar un operador numérico y string facet (MongoDB Search Operador) en su query para agrupar resultados y recuperar un recuento de los resultados en los grupos.

Duración: 11 minutos

Volver

exists

geoShape

1	db.movies.aggregate([
2	{
3	"$searchMeta": {
4	"facet": {
5	"operator": {
6	"range": {
7	"path": "year",
8	"gte": 2000,
9	"lte": 2015
10	}
11	},
12	"facets": {
13	"genresFacet": {
14	"type": "string",
15	"path": "genres"
16	}
17	}
18	}
19	}
20	}
21	])

1	[
2	{
3	count: { lowerBound: Long('12568') },
4	facet: {
5	genresFacet: {
6	buckets: [
7	{ _id: 'Drama', count: Long('7079') },
8	{ _id: 'Comedy', count: Long('3689') },
9	{ _id: 'Romance', count: Long('1764') },
10	{ _id: 'Thriller', count: Long('1584') },
11	{ _id: 'Documentary', count: Long('1472') },
12	{ _id: 'Action', count: Long('1471') },
13	{ _id: 'Crime', count: Long('1367') },
14	{ _id: 'Adventure', count: Long('1056') },
15	{ _id: 'Horror', count: Long('866') },
16	{ _id: 'Biography', count: Long('796') }
17	]
18	}
19	}
20	}
21	]

1	[
2	{
3	count: { lowerBound: Long('6095') },
4	facet: {
5	yearFacet: {
6	buckets: [
7	{ _id: 1980, count: Long('1956') },
8	{ _id: 1990, count: Long('3558') },
9	{ _id: 'other', count: Long('581') }
10	]
11	}
12	}
13	}
14	]

1	[
2	{
3	count: { lowerBound: Long('11922') },
4	facet: {
5	yearFacet: {
6	buckets: [
7	{
8	_id: ISODate('2000-01-01T00:00:00.000Z'),
9	count: Long('3028')
10	},
11	{
12	_id: ISODate('2005-01-01T00:00:00.000Z'),
13	count: Long('3953')
14	},
15	{
16	_id: ISODate('2010-01-01T00:00:00.000Z'),
17	count: Long('4832')
18	},
19	{ _id: 'other', count: Long('109') }
20	]
21	}
22	}
23	}
24	]

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	]

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	]

1	[
2	{
3	count: { lowerBound: Long('3') },
4	facet: {
5	roundFacet: {
6	buckets: [
7	{ _id: 'b', count: Long('3') },
8	{ _id: 'a', count: Long('1') },
9	{ _id: 'seed', count: Long('1') }
10	]
11	}
12	}
13	}
14	]

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	]

facet (MongoDB Search Operador)

Definición

Sintaxis

Campos

Requisitos de memoria

Definición de faceta

String Facetas

Sintaxis

opciones

Ejemplo

Facetas numéricas

Sintaxis

opciones

Ejemplo

Facetas de fecha

Sintaxis

opciones

Ejemplo

Comparación de los tipos de campos para facetas

Faceta en hijos coincidentes de un arreglo de documentos incrustados

Agregaciones de faceta

Sintaxis

opciones

Tipos de métricas

Consideraciones sobre arreglos

Facetas anidadas

Resultados de Faceta

Facetas de selección múltiple

SEARCH_META Variable de agregación

Limitaciones

Limitaciones para facetas de ámbito incrustado

Limitaciones para agregaciones de faceta

Ejemplos

Ejemplo de resultados de metadatosComplete los pasos anteriores del tutorial e instale las dependencias

Ejemplo de metadatos y resultados de búsquedaBusque usando $search y recupere tanto los resultados de búsqueda como los metadatos usando la variable $$SEARCH_META.

returnScope EjemploBuscar usando faceta y faceta en campos secundarios en embeddedDocuments.

Ejemplo de faceta de ámbito incrustadoFaceta solo en los elementos secundarios coincidentes de un arreglo embeddedDocuments.

Ejemplo de faceta de selección múltipleBusque con doesNotAffect para un control más granular sobre el filtro de facetas.

Ejemplo de exclusión de filtro inter-facetaBúsqueda con doesNotAffect en una faceta que no sea el campo de query.

Ejemplo de agregaciónBúsqueda con agregación de facetas.

Ejemplo de facetas anidadasBúsqueda con facetas anidadas.

Continuar Aprendiendo

Aprende con cursos

Aprende observando

`facet` (MongoDB Search Operador)

`SEARCH_META` Variable de agregación