MongoDB\Collection::listSearchIndexes()
1.17 版本中的新增功能。
定义
MongoDB\Collection::listSearchIndexes()
获取collection中一个或多个搜索索引的索引信息。
function listSearchIndexes(array $options = []): Countable&Iterator 此命令只能在托管在 MongoDB Atlas上的部署上运行,并且需要至少 M 10的 Atlas 集群层。 本地 Atlas 部署也可用于开发。
参数
$options
: array指定所需选项的数组。
名称类型说明batchSize整型指定光标的批处理大小,将应用于初始
aggregate
命令和任何后续getMore
命令。这决定了服务器每次响应中返回的最大文档数。批量大小为
0
的特殊之处在于,它仅适用于初始的aggregate
命令;后续的getMore
命令将使用服务器的默认批量大小。这对于从aggregate
快速返回游标或失败结果可能很有用,而无需进行大量的服务器端工作。编解码器MongoDB\Codec\DocumentCodec排序规则数组|对象comment混合maxTimeMS整型处理游标操作的累计时间限制(以毫秒为单位)。MongoDB 最早会在中断点之后中止操作。
名称字符串要返回信息的索引名称。
如果未指定名称,则返回collection上所有索引的信息。
事务外的readPreference读取要用于操作的偏好。 默认为集合的读取偏好。
会话与操作相关联的客户端会话。
typeMap阵列类型映射 应用于游标,决定如何将 BSON 文档转换为 PHP 值。默认为集合的类型映射。
Return Values
文档列表,每个文档都描述了集合上的一个Atlas Search索引。 有关输出字段的详细信息,请参阅 MongoDB 手册中的$listSearchIndexes: Output 。
错误/异常
MongoDB\Exception\UnsupportedException
,如果所选服务器使用了选项但不支持选项(例如collation
、readConcern
、writeConcern
)。
MongoDB\Exception\InvalidArgumentException
用于与参数或选项解析相关的错误。
MongoDB\ 驱动程序\Exception\RuntimeException 对于扩展级别的其他错误(例如连接错误)。