db.collection.updateSearchIndex() (método mongosh)

Definición

db.collection.updateSearchIndex()

Nuevo en la versión 7.0: (También disponible a partir de la versión 6.0.7)

Actualiza un existente Índice de búsqueda Atlas o índice de búsqueda vectorial Atlas.

Importante

Método mongosh

Esta página documenta un método mongosh. Esta no es la documentación para los comandos de base de datos ni para los drivers específicos de lenguajes, como Nodo.js.

Para el comando de base de datos, consulte el updateSearchIndex dominio.

Para los drivers de API de MongoDB, consulte la documentación del driver de MongoDB específica del lenguaje.

Compatibilidad

Este método está disponible en implementaciones alojadas en los siguientes entornos:

MongoDB Atlas: El servicio totalmente gestionado para implementaciones de MongoDB en la nube

Sintaxis

Sintaxis del comando:

db.<collection>.updateSearchIndex(
   <name>,
   {
      <definition>
   }
)

Campos de comandos

updateSearchIndex() toma estos campos:

Campo	Tipo	Necesidad	Descripción
`name`	string	Requerido	Nombre del índice de búsqueda a actualizar.
`definition`	Documento	Requerido	Documento que describe el índice que se creará. La sintaxis `definition` depende de si se crea un índice de búsqueda estándar o un índice de búsqueda vectorial. Para la sintaxis `definition`, consulte: Sintaxis de definición del índice de búsqueda Sintaxis de definición del índice de búsqueda de vectores

Sintaxis de definición del índice de búsqueda

La definición del índice de búsqueda toma los siguientes campos:

{
   analyzer: "<analyzer-for-index>",
   searchAnalyzer: "<analyzer-for-query>",
   mappings: {
      dynamic: <boolean>,
      fields: { <field-definition> }
   },
   analyzers: [ <custom-analyzer> ],
   storedSource: <boolean> | {
      <stored-source-definition>
   },
   synonyms: [ {
      name: "<synonym-mapping-name>",
      source: {
         collection: "<source-collection-name>"
      },
      analyzer: "<synonym-mapping-analyzer>"
   } ]
}

Campo	Tipo	Necesidad	Descripción
`analyzer`	string	Opcional	Especifica el analizador que se aplicará a los campos de cadena durante la indexación. Si omite este campo, el índice utiliza el analizador estándar.
`searchAnalyzer`	string	Opcional	Especifica el analizador que se aplicará para consultar el texto antes de buscarlo. Si omite este campo, el índice utiliza el mismo analizador especificado en el campo `analyzer`. Si omite `searchAnalyzer` los `analyzer` campos y, el índice utiliza el analizador estándar.
`mappings`	Objeto	Requerido	Especifica cómo indexar campos en diferentes rutas para este índice.
`mappings.dynamic`	booleano	Opcional	Habilita o deshabilita la asignación dinámica de campos para este índice. Si `true` se establece en, el índice contiene todos los campos que contienen tipos de datos admitidos. Si se establece en `false`, debe especificar campos individuales para indexar utilizando `mappings.fields`. Si se omite, es por defecto `false`.
`mappings.fields`	Documento	Condicional	Obligatorio sólo si el mapeo dinámico está deshabilitado. Especifica los campos para indexar. Para obtener más información, consulte Definir mapeos de campos.
`analyzers`	arreglo	Opcional	Especifica los analizadores personalizados que se utilizarán en este índice.
`storedSource`	Definición de fuentebooleana o almacenada	Opcional	Especifica los campos del documento que se almacenarán para las consultas realizadas utilizando la opción returnsStoredSource. Puede almacenar campos de todos los tipos de búsqueda de MongoDB en Atlas Search. El `storedSource` valor puede ser uno de los siguientes: `true`, para almacenar todos los campos `false`, para no almacenar ningún campo Un objeto que especifica los campos a `include` o `exclude` desde el almacenamiento Si se omite, es por defecto `false`. Para obtener más información, consulta Definir campos fuente almacenados en tu MongoDB Search.
`synonyms`	Matriz de definiciones de mapeo de sinónimos	Opcional	Especifica las asignaciones de sinónimos que se deben usar en su índice. La configuración de sinónimos permite indexar y buscar palabras que tengan el mismo o similar significado. Para obtener más información, consulte Definir asignaciones de sinónimos en su índice de búsqueda de MongoDB.

Sintaxis de definición del índice de búsqueda de vectores

La definición del índice de búsqueda vectorial toma los siguientes campos:

{
  "fields": [
    {
      "type": "vector" | "filter",
      "path": "<field-to-index>",
      "numDimensions": <number-of-dimensions>,
      "similarity": "euclidean" | "cosine" | "dotProduct"
    }
  ]
}

Para obtener explicaciones sobre los campos de definición del índice de búsqueda vectorial, consulte Cómo indexar campos para la búsqueda vectorial.

Comportamiento

updateSearchIndex() Inicia la creación de un índice con la nueva definición. Puede haber un retraso entre la respuesta del comando y la disponibilidad del índice actualizado.

La definición del índice anterior aún admite consultas mientras se construye el nuevo. Una vez que el nuevo índice termina de construirse, el índice anterior deja de ser utilizable. Para ver el estado de sus índices de búsqueda, utilice la $listSearchIndexes etapa de agregación.

Control de acceso

Si el despliegue aplica control de acceso, el usuario que ejecuta updateSearchIndex() debe tener la acción de privilegio updateSearchIndex en la base de datos o colección:

{
   resource: {
      db : <database>,
      collection: <collection>
   },
   actions: [ "updateSearchIndex" ]
}

Los roles readWrite integrados y restore otorgan el updateSearchIndex privilegio. El siguiente ejemplo otorga el readWrite rol en la qa base de datos:

db.grantRolesToUser(
   "<user>",
   [ { role: "readWrite", db: "qa" } ]
)

Ejemplo

El siguiente ejemplo crea un nuevo índice de Atlas Search y luego actualiza ese índice.

Cree un índice de búsqueda llamado searchIndex01 en la colección movies:
```
db.movies.createSearchIndex(
   "searchIndex01",
   {
      mappings: { dynamic: true },
      storedSource: {
         exclude: [ "imdb.rating" ]
      }
   }
)
```
Actualizar el índice searchIndex01:
```
db.movies.updateSearchIndex(
   "searchIndex01",
   {
      mappings: { dynamic: true },
      storedSource: {
         exclude: [ "movies" ]
      }
   }
)
```

Volver

db.collection.getSearchIndexes

sp.createStreamProcessor