MongoDB\Collection::listSearchIndexes()

Definición

MongoDB\Collection::listSearchIndexes()

Obtiene información de índice para uno o más índices de búsqueda en la colección.

function listSearchIndexes(array $options = []): Countable&Iterator

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

$options : matriz

Una matriz que especifica las opciones deseadas.

Nombre	Tipo	Descripción
tamaño del lote	entero	El número máximo de documentos dentro de cada lote devuelto en la lista de índices, que se aplica al comando aggregate. De forma predeterminada, el comando aggregate tiene un tamaño de lote inicial de 101 documentos y un tamaño máximo de 16 mebibytes (MiB) para cada lote posterior. Esta opción puede imponer un límite inferior a 16 MiB, pero no superior. Si se establece batchSize en un límite que resulte en lotes superiores a 16 MiB, esta opción no tiene efecto.
codec	MongoDB\Códec\DocumentCodec	El Codificar datos con códecs de tipo para codificar o decodificar documentos. Esta opción es mutuamente excluyente con la typeMap opción. El valor predeterminado es el códec de la colección. La herencia de la opción predeterminada codec prevalece sobre la de la opción typeMap. Nuevo en la versión 1.17.
intercalación	matriz|objeto	Laintercalación permite a los usuarios especificar reglas específicas del idioma para la comparación de cadenas, como el uso de mayúsculas y minúsculas y tildes. Al especificar la intercalación, el locale campo es obligatorio; todos los demás campos son opcionales. Para obtener descripciones de los campos, consulte el documento de intercalació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.
maxTimeMS	entero	El límite de tiempo acumulado en milisegundos para procesar operaciones en el cursor. MongoDB cancela la operación en el punto de interrupción posterior más cercano.
Nombre	string	Nombre del índice sobre el que se devolverá información. Si no se especifica el nombre, se devolverá información de todos los índices de la colección.
readConcern	MongoDB\Driver\ReadConcern	Preocupación de lectura para la operación. El valor predeterminado es la preocupación de lectura de la colección. No es posible especificar una preocupación de lectura para operaciones individuales como parte de una transacción. En su lugar, configure la readConcern opción al iniciar la transacción.
readPreference	MongoDB\Controlador\Preferencia de lectura	Preferencia de lectura para la operación. El valor predeterminado es la preferencia de lectura de la colección.
sesión	MongoDB\Controlador\Sesión	Sesión de cliente para asociar a la operación.
typeMap	arreglo	El mapa de tipos que se aplica a los cursores y que determina cómo se convierten los documentos BSON a valores PHP. El valor predeterminado es el mapa de tipos de la colección.

Return Values

Una lista de documentos, cada uno de los cuales describe un índice de búsqueda en la colección. Para obtener más información sobre los campos de salida, consulte $listSearchIndexes: Salida en el manual de MongoDB.

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\Driver\Exception\RuntimeException para otros errores en el nivel de extensión (por ejemplo, errores de conexión).

Ver también

• MongoDB\Collection::createSearchIndex()

• MongoDB\Collection::createSearchIndexes()

• MongoDB\Collection::dropSearchIndex()

• MongoDB\Collection::updateSearchIndex()

• Referencia de la etapa $listSearchIndexes del pipeline de agregación en el manual MongoDB

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