/ /

/ /

`$searchMeta`

$searchMeta

The $searchMeta stage returns different types of metadata result documents.

Nota

To run $searchMeta queries over sharded collections, your cluster must run MongoDB v6.0 or later.

Compatibilidad

El escenario $searchMeta está disponible en los siguientes entornos:

MongoDB Atlas
MongoDB Enterprise implementaciones que ejecutan la versión 8.2 o posterior con el Kubernetes operador.
MongoDB Community implementaciones que ejecutan la versión 8.2 o posterior

Sintaxis

Una etapa de pipeline $searchMeta tiene la siguiente forma de prototipo:

{
  $searchMeta: {
    "index": "<index-name>",
    "<collector-name>"|"<operator-name>": {
      <collector-specification>|<operator-specification>
    },
    "concurrent": true | false,
    "count": {
      <count-options>
    },
    "returnScope": {
      "path": "<embedded-documents-field-to-retrieve>"
    }
    "returnStoredSource": true | false
  }
}

Campos

La etapa $searchMeta procesa un documento con los siguientes campos:

Campo	Tipo	Necesidad	Descripción
`<collector-name>`	Objeto	Condicional	Nombre del recolector que se utilizará en la query. Puede proporcionar un documento que contenga las opciones específicas del recolector como el valor para este campo. El valor debe ser `facet` para recuperar un mapeo de los nombres de facetas definidos a un arreglo de buckets para esa faceta. Para más información, consulte `facet` (Operador de búsqueda de MongoDB). Debe especificar esto o `<operator-name>`.
`concurrent`	booleano	Opcional	Paralelice la búsqueda entre segmentos en nodos de búsqueda dedicados. Si no tiene nodos de búsqueda separados en su clúster, la búsqueda de MongoDB ignora ese indicador. Si se omite, es por defecto `false`. Para aprender más, consulte Paralelización de la ejecución de queries entre segmentos.
`count`	Objeto	Opcional	Documento que especifica las opciones de conteo para obtener un conteo de los resultados. Para obtener más información, consulte Conteo de los resultados de la búsqueda de MongoDB.
`index`	string	Opcional	Nombre del índice de búsqueda de MongoDB que se utilizará. Si se omite, es por defecto `default`. La búsqueda de MongoDB no devuelve resultados si escribe mal el nombre del índice o si el índice especificado no existe en el clúster.
`<operator-name>`	Objeto	Condicional	Nombre del operador con el que buscar. Puedes proporcionar un documento que contenga las opciones específicas del operador como el valor para este campo. Debe especificar esto o `<collector-name>`. `$searchMeta` devuelve solo los metadatos por defecto de `count`.
`returnScope`	Objeto	Opcional	Objeto que establece el contexto de la query en el campo de documento incrustado especificado. También debe especificar `returnStoredSource` y configurarlo en `true` si la versión de su clúster de MongoDB es inferior a 8.2.
`returnStoredSource`	booleano	Condicional	Indicador que especifica si se debe realizar una búsqueda completa de documentos en la base de datos de backend o devolver solo los campos de origen almacenados directamente desde MongoDB Search. Si se omite, es por defecto `false`. Debe ser `true` si especifica `returnScope` y la versión de MongoDB del clúster es inferior a 8.2. Para obtener más información, consulta Devolver los campos de origen almacenados.

Comportamiento

The $searchMeta stage must be the first stage in any pipeline.

Tipos de resultados de metadatos

The structure of the metadata results document that is returned by the $searchMeta stage varies based on the type of results. MongoDB Search supports the following result types:

Tipo	Estructura de resultados
`count`	El resultado de recuento incluido en los resultados indica si el recuento devuelto en los resultados es un recuento total de los resultados de búsqueda, o un límite inferior. Para obtener más información, consulta Contar resultados.
`facet`	El resultado de una query de facetas es un mapeo de los nombres de facetas definidos a un arreglo de buckets para esa faceta. Para obtener más información, consulte Resultados de la Faceta.

Ejemplo

Supón el siguiente índice en la colección sample_mflix.movies.

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

The following query searches for the number of movies released in 1998 using the $searchMeta stage.

db.movies.aggregate([
  {
    "$searchMeta": {
      "range": {
        "path": "year",
        "gte": 1998,
        "lt": 1999
      },
      "count": {
        "type": "total"
      }
    }
  }
])

[ { count: { total: Long("552") } } ]

Solución de problemas

Si se están experimentando problemas con las queries de MongoDB Search $search, se puede consultar Solucionar problemas de queries.

Volver

Documentos: $search

Operadores y coleccionistas