MongoDB\Collection::listSearchIndexes()

Definición

MongoDB\Collection::listSearchIndexes()

Obtiene información de 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 y requiere un nivel de clúster de Atlas de al menos M.10 También se puede utilizar una implementación local de Atlas para el desarrollo.

Parámetros

$options : arreglo

Un arreglo que especifica las opciones deseadas.

Nombre	Tipo	Descripción
batchSize	entero	El número máximo de documentos dentro de cada lote devuelto en la lista de índices, que se aplica al comando aggregate. Por defecto, 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 aplicar un límite menor que 16 MiB, pero no uno mayor. Si configuras batchSize en un límite que origine lotes más grandes que 16 MiB, esta opción no tendrá efecto.
códec	MongoDB\Codec\DocumentCodec	Codifica datos con códecs de tipos para codificar o decodificar documentos. Esta opción es mutuamente excluyente con la opción typeMap. Se configura de forma predeterminada al códec de la colección. La herencia para una opción codec por defecto tiene prioridad sobre la de la opción typeMap. Nuevo en la versión 1.17.
intercalación	arreglo|objeto	Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks. When specifying collation, the locale field is mandatory; all other collation fields are optional. For descriptions of the fields, see Collation Document.
comment	mixto	Permite a los usuarios especificar un comentario arbitrario para ayudar a rastrear la operación a través del perfilador de bases de datos, la salida actualOp() y registros.
maxTimeMS	entero	El límite de tiempo acumulativo en milisegundos para las operaciones de procesamiento en el cursor. MongoDB aborta la operación lo antes posible tras el punto de interrupción.
Nombre	string	Nombre del índice sobre el cual devolver información. Si no se especifica el nombre, se devolverá la información de todos los índices de la colección.
readConcern	MongoDB\Driver\ReadConcern	Nivel de consistencia de lectura para usar en la operación. Por defecto, adopta el nivel de consistencia de lectura de la colección. No es posible especificar un nivel de consistencia de lectura para operaciones individuales como parte de una transacción. En su lugar, configura la opción readConcern al iniciar la transacción.
readPreference	MongoDB\Driver\ReadPreference	Preferencia de lectura a utilizar para la operación. Por defecto, se utiliza la preferencia de lectura de la colección.
sesión	MongoDB\Driver\Session	Sesión de cliente para asociar con la operación.
typeMap	arreglo	El mapa de tipos para aplicar a cursores, que determina cómo se convierten los documentos BSON en valores PHP. Por defecto, se utiliza 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 detalles sobre los campos de salida, consulta $listSearchIndexes: Output en el manual de MongoDB.

Errores/Excepciones

MongoDB\Exception\UnsupportedException si se usan opciones que no sean compatibles con el servidor seleccionado (p. ej. collation, readConcern, writeConcern).

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

MongoDB\Driver\Exception\RuntimeException para otros errores a 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

• MongoDB Search documentación en el Manual de MongoDB