バージョン1.17の新機能。
定義
MongoDB\Collection::listSearchIndexes()コレクション内の 1 つ以上の検索インデックスのインデックス情報を取得します。
function listSearchIndexes(array $options = []): Countable&Iterator This command can only be run on a deployment hosted on MongoDB Atlas and requires an Atlas cluster tier of at least M10. A Local Atlas Deployment can also be used for development.
パラメーター
$options: 配列必要なオプションを指定する配列。
名前タイプ説明batchSize
integer
インデックス リストで返される各バッチする内のドキュメントの最大数。これは
aggregateコマンドに適用されます。デフォルトでは 、aggregateコマンドの初期バッチするサイズは101ドキュメントで、最大サイズは 16バッチする（MiB）です。このオプションを使用すると、16 MiB より小さい制限が適用できますが、超えることはありません。batchSizeを、バッチが 16 MiB を超える制限に設定している場合、このオプションは効果がありません。コーデック
MongoDB\Codec\DocumentCodec
collation
array|object
Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks. When specifying collation, the
localefield is mandatory; all other collation fields are optional. For descriptions of the fields, see Collation Document.comment
混合
maxTimeMS
integer
カーソルに対する情報処理操作の累積時間制限（ミリ秒単位）。MongoDB は、割り込みポイントの後の最も早く操作を中止します。
name
string
情報を返すインデックスの名前。
名前が指定されていない場合、コレクションのすべてのインデックスの情報が返されます。
ReadConcern
操作に使用する読み取り保証。 デフォルトはコレクションの読み取り保証 (read concern) です。
トランザクションの一部である個々の操作に対して読み取り保証 (read concern)を指定することはできません。代わりに、トランザクションを開始するときに
readConcernオプションを設定します。readPreference
操作に使用する読み取り設定。 コレクションの読み込み設定（read preference）がデフォルトで設定されます。
セッション
操作に関連付けるクライアント セッション。
typeMap
配列
The type map to apply to cursors, which determines how BSON documents are converted to PHP values. Defaults to the collection's type map.
Return Values
ドキュメントのリスト。それぞれがコレクションの検索インデックスを記述します。 出力フィールドの詳細については、MongoDB マニュアルの「 $listSearchIndexes: 出力」を参照してください。
エラーと例外
MongoDB\Exception\UnsupportedExceptionオプションが使用され、選択したサーバーでサポートされていない場合（例: collation 、 readConcern 、 writeConcern ）。
MongoDB\Exception\InvalidArgumentException は、パラメータまたはオプションの解析に関連するエラーの場合は です。
MongoDB$Driver\Exception\RuntimeException は、拡張レベルの他のエラーの場合（例:）。
その他の参照
MongoDB マニュアルの$listSearchIndexes集計パイプライン ステージ参照
MongoDB 検索する MongoDBマニュアルのドキュメント