MongoDB\Collection::createSearchIndexes()

Definición

MongoDB\Collection::createSearchIndexes()

Cree uno o más índices de búsqueda MongoDB o de búsqueda vectorial para la colección.

function createSearchIndexes(
    array $indexes,
    array $options = []
): string

Este comando solo se puede ejecutar en una implementación alojada en MongoDB Atlas requiere un nivel de clúster Atlas de al menos M.10 También se puede usar una implementación local de Atlas para el desarrollo.

Parámetros

$indexes : matriz

Matriz de documentos que describen los índices a crear.

Un definition campo de documento obligatorio describe el índice que se creará. Para obtener más información sobre la sintaxis de definición, consulte Sintaxis de definición de índice de búsqueda.

Un campo de cadena opcional name especifica el nombre del índice de búsqueda que se creará. No se pueden crear varios índices con el mismo nombre en una misma colección. Si no se especifica un nombre, el nombre predeterminado del índice es default.

Un campo de cadena type opcional especifica el tipo de índice de búsqueda que se creará. Los valores aceptados son 'search' y 'vectorSearch'. Si no se especifica un tipo, el método crea un índice de búsqueda de MongoDB.

$options : matriz

Una matriz que especifica las opciones deseadas.

Nombre	Tipo	Descripción
comment	mixto	Permite a los usuarios especificar un comentario arbitrario para ayudar a rastrear la operación a través del generador de perfiles de base de datos, la salidacurrentOp y los registros.

Return Values

Los nombres de los índices de búsqueda MongoDB y búsqueda vectorial creados como una matriz de cadenas.

Errores/Excepciones

MongoDB\Exception\UnsupportedException si se utilizan opciones que no son compatibles con el servidor seleccionado (porcollation readConcernwriteConcernejemplo,,,).

MongoDB\Exception\InvalidArgumentException para errores relacionados con el análisis de parámetros u opciones.

MongoDB\Controlador\Excepción\Excepción de tiempo de ejecución para otros errores a nivel de extensión (por ejemplo errores de conexión).

Comportamiento

Los índices de MongoDB Search y Vector Search se gestionan de forma asíncrona. Después de crear o actualizar un índice, puedes ejecutar periódicamente y comprobar MongoDB\Collection::listSearchIndexes() el queryable campo de salida para determinar si está listo para usarse.

Ejemplos

<?php
$collection = (new MongoDB\Client)->getCollection('test', 'articles');
$indexNames = $collection->createSearchIndexes(
    [
        [
            'name' => 'test-search-index',
            'definition' => ['mappings' => ['dynamic' => true]],
        ],
    ]
);
var_dump($indexNames);

array(1) {
  [0]=>
  string(17) "test-search-index"
}

Ver también

• MongoDB\Collection::createSearchIndex()

• MongoDB\Collection::dropSearchIndex()

• MongoDB\Collection::listSearchIndexes()

• MongoDB\Collection::updateSearchIndex()

• Guíade índices de búsqueda de MongoDB

• Referencia del comandocreateSearchIndexes en el manual de MongoDB

• Documentación de búsqueda de MongoDB en el Manual de MongoDB