MongoDB\Collection::listSearchIndexes()

定义

MongoDB\Collection::listSearchIndexes()

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

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

此命令只能在托管在MongoDB Atlas上的部署上运行，并需要至少M10级别的Atlas集群层。也可以使用本地Atlas部署进行开发。

参数

$options : array

指定所需选项的数组。

名称	类型	描述
batchSize	整数	指定游标的批量大小，这将应用于初始 aggregate 命令和任何后续的 getMore 命令。这决定了每次从服务器返回的最大文档数。 batchSize 的值为 0 是特殊的，它将只应用于初始的 aggregate 命令；后续的 getMore 命令将使用服务器的默认批量大小。这可能在快速返回游标或从 aggregate 处理失败而无需进行大量服务器端工作时很有用。
codec	MongoDB\Codec\DocumentCodec	用于编码或解码文档的codec。此选项与 typeMap 选项互斥。 默认为集合的 codec。默认 codec 选项的继承优先于 typeMap 选项。 新自版本1.17.
collation	数组|对象	Collation 允许用户指定字符串比较的语言特定规则，例如字母大小写和重音符号的规则。在指定 collation 时，locale 字段是必需的；所有其他 collation 字段都是可选的。有关字段的说明，请参阅 Collation Document。
comment	混合	允许用户指定任意注释，以帮助通过 database profiler、currentOp 输出和 logs 跟踪操作。
maxTimeMS	整数	处理游标上操作的累计时间限制（以毫秒为单位）。MongoDB 在第一个 中断点 处终止操作。
name	字符串	返回信息的索引名称。 如果没有指定名称，将返回集合上所有索引的信息。
readConcern	MongoDB\Driver\ReadConcern	用于操作的 Read concern。默认为集合的 read concern。 无法在事务中将读取关注点指定为单个操作的一部分。相反，在 开始事务 时设置 readConcern 选项。
readPreference	MongoDB\Driver\ReadPreference	读取偏好用于操作。默认为集合的读取偏好。
会话	MongoDB\Driver\Session	与操作关联的客户端会话。
typeMap	数组	应用于游标的类型映射，用于确定BSON文档如何转换为PHP值。默认为集合的类型映射。

返回值

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

错误/异常

如果选项被使用且不支持所选服务器（例如collation、readConcern、writeConcern），则抛出MongoDB\Exception\UnsupportedException。

对于与参数或选项解析相关的错误，抛出MongoDB\Exception\InvalidArgumentException。

MongoDB\Driver\Exception\RuntimeException 用于扩展级别的其他错误（例如连接错误）。

参见

• MongoDB\Collection::createSearchIndex()

• MongoDB\Collection::createSearchIndexes()

• MongoDB\Collection::dropSearchIndex()

• MongoDB\Collection::updateSearchIndex()

• $listSearchIndexes 聚合管道阶段参考 MongoDB 手册

• Atlas Search MongoDB 手册中的文档