MongoDB\Collection::listSearchIndexes()

在此页面上

定义

参数
Return Values
错误/异常
另请参阅

1.17 版本中的新增功能。

定义

MongoDB\Collection::listSearchIndexes()

获取collection中一个或多个搜索索引的索引信息。

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

此命令只能在托管在 MongoDB Atlas上的部署上运行，并且需要至少 M 10的 Atlas 集群层。本地 Atlas 部署也可用于开发。

参数

$options : array

指定所需选项的数组。

名称	类型	说明
batchSize	整型	索引列表中返回的每个批处理中的最大文档数，适用于 `aggregate` 命令。默认下，`aggregate` 命令的初始批处理大小为 `101` 个文档，后续每个批处理的最大大小为 16 兆字节 (MiB)。此选项可以实施小于 16 MiB 的限制，但不能强制执行大于 MiB 的限制。如果将 `batchSize`设立为导致批量大于 16 MiB 的限制，则此选项无效。
编解码器	MongoDB\Codec\DocumentCodec	用于对文档进行编码或解码的编解码器。此选项与`typeMap`选项互斥。默认为集合的编解码器。默认 `codec` 选项的继承优先于 `typeMap` 选项的继承。 1.17 版本中的新增功能。
排序规则	数组\|对象	排序规则允许用户为string比较指定特定于语言的规则，例如字母大小写和重音符号规则。指定排序规则时， `locale`字段为必填字段；所有其他排序规则字段都是可选的。有关字段的说明，请参阅排序规则文档。
comment	混合	使用户可以指定任意注释来帮助通过数据库分析器、currentOp 输出和日志来跟踪操作。
maxTimeMS	整型	处理游标操作的累计时间限制（以毫秒为单位）。MongoDB 最早会在中断点之后中止操作。
名称	字符串	要返回信息的索引名称。如果未指定名称，则返回collection上所有索引的信息。
事务外的	MongoDB\Driver\ReadConcern	读取关注以用于操作。默认为集合的读关注。无法将单个操作的读关注指定为事务的一部分。相反，请在`readConcern` 启动事务时设置选项。
readPreference	MongoDB\Driver\ReadPreference	读取要用于操作的偏好。默认为集合的读取偏好。
会话	MongoDB\Driver\Session	与操作相关联的客户端会话。
typeMap	阵列	类型映射应用于游标，决定如何将 BSON 文档转换为 PHP 值。默认为集合的类型映射。

Return Values

文档列表，每个文档都描述了集合上的一个Atlas Search索引。有关输出字段的详细信息，请参阅 MongoDB 手册中的$listSearchIndexes: Output 。

错误/异常

MongoDB\Exception\UnsupportedException，如果所选服务器使用了选项但不支持选项（例如collation、readConcern、writeConcern）。

MongoDB\Exception\InvalidArgumentException 用于与参数或选项解析相关的错误。

MongoDB\ 驱动程序\Exception\RuntimeException 对于扩展级别的其他错误（例如连接错误）。

另请参阅

MongoDB\Collection::createSearchIndex()
MongoDB\Collection::createSearchIndexes()
MongoDB\Collection::dropSearchIndex()
MongoDB\Collection::updateSearchIndex()
MongoDB手册中的$listSearchIndexes聚合管道阶段参考
MongoDB 手册中的Atlas Search文档

后退

listIndexes()

来年

mapReduce()