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

Definición

db.collection.createSearchIndex()

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

Crea un Índice de búsqueda de MongoDB o índice de búsqueda vectorial en una colección o vista específica.

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 createSearchIndexes 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>.createSearchIndex(
   <name>,
   <type>,
   {
      <definition>
   }
)

Campos de comandos

createSearchIndex() toma estos campos:

Campo	Tipo	Necesidad	Descripción
`name`	string	Opcional	Nombre del índice de búsqueda a crear. No se pueden crear varios índices con el mismo nombre en una sola colección. Si no especificas un `name`, el índice se denomina `default`.
`type`	string	Opcional	Tipo de índice de búsqueda a crear. Puede especificar cualquiera: `search` `vectorSearch` Si omite el campo `type`, el tipo de índice es `search`.
`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. Puedes almacenar campos de todos los tipos de campos de búsqueda de MongoDB en MongoDB Search. El valor de `storedSource` puede ser uno de estos: `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 para usar en el índice. Configurar sinónimos permite indexar y buscar palabras con significados iguales o similares. 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

createSearchIndex() Activa la creación de un índice. Puede haber un retraso entre la respuesta del comando y la preparación del índice.

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 createSearchIndex() debe tener la acción de privilegio createSearchIndexes en la base de datos o colección:

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

El rol integrado proporciona readWrite el createSearchIndexes privilegio. El siguiente ejemplo otorga a accountUser01 el readWrite rol en la products base de datos:

db.grantRolesToUser(
   "accountUser01",
   [ { role: "readWrite", db: "products" } ]
)

Ejemplos

Crear un índice de búsqueda en todos los campos

El siguiente ejemplo crea un índice de búsqueda llamado searchIndex01 en la colección movies:

db.movies.createSearchIndex(
   "searchIndex01",
   { mappings: { dynamic: true } }
)

La definición del mappings: { dynamic: true } índice especifica, lo que significa que el índice contiene todos los campos de la colección que tienen tipos de datos admitidos.

Crear un índice de búsqueda con un analizador de idiomas

Un analizador de lenguaje introduce palabras vacías, que son palabras que no son lo suficientemente significativas como para ser indexadas.

El siguiente ejemplo crea un índice de búsqueda llamado frenchIndex01 en la colección cars y especifica el analizador lucene.french en el campo fr:

db.cars.createSearchIndex(
   "frenchIndex01",
   {
      mappings: {
         fields: {
            subject: {
               fields: {
                  fr: {
                     analyzer: "lucene.french",
                     type: "string"
                  }
               },
               type: "document"
            }
         }
      }
   }
)

Para obtener más información sobre los analizadores de lenguaje, consulte Analizadores de lenguaje.

Crear un índice de búsqueda con el nombre predeterminado

El siguiente método createSearchIndex() solo especifica la definición del índice y omite el nombre del índice. El comando crea un índice de búsqueda con el nombre default en la colección food:

db.food.createSearchIndex(
   {
      mappings: {
         fields: {
            title: {
               type: "string"
            }
         }
      }
   }
)

Crear un índice de búsqueda vectorial

El siguiente ejemplo crea un índice de búsqueda vectorial llamado vectorSearchIndex01 en la colección movies:

db.movies.createSearchIndex(
   "vectorSearchIndex01",
   "vectorSearch",
   {
      fields: [
         {
            type: "vector",
            numDimensions: 1,
            path: "genre",
            similarity: "cosine"
         }
      ]
   }
)

El índice de búsqueda vectorial contiene una dimensión e indexa el campo genre.

Obtén más información

$vectorSearch etapa de agregación
Tutorial: Búsqueda semántica
Registro de cambios de búsqueda de vectores

Volver

Métodos mongosh

db.colección.dropSearchIndex