Docs Menu
Docs Home
/
言語
/
PHP
/
PHP ライブラリ マニュアル
/
API ドキュメント
/
MongoDB\Collection

MongoDB\Collection::listSearchIndexes()

項目一覧

  • 定義
  • パラメーター
  • Return Values
  • エラーと例外
  • その他の参照

バージョン 1.17 の新機能。

定義

MongoDB\Collection::listSearchIndexes()

コレクション内の 1 つ以上の検索インデックスのインデックス情報を取得します。

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

このコマンドは、 MongoDB Atlasでホストされている配置でのみ実行でき、少なくとも M 10の Atlas クラスター階層が必要です。 Atlas のローカル配置は、開発にも使用できます。

パラメーター

$options : 配列

必要なオプションを指定する配列。

名前
タイプ
説明
batchSize
integer

カーソルのバッチ サイズを指定します。これは最初のaggregateコマンドと後続のgetMoreコマンドの両方に適用されます。 これにより、サーバーからの応答ごとに返されるドキュメントの最大数が決まります。

0の BatchSize はその点で特別であり、最初のaggregateコマンドにのみ適用されます。後続のgetMoreコマンドは、サーバーのデフォルトのバッチ サイズを使用します。 これは、サーバー側での目立った作業なしに、 aggregateからのカーソルやエラーをすばやく返すのに役立つ場合があります。

コーデック
MongoDB\Codec\DocumentCodec

ドキュメントのエンコードまたはデコードに使用するコーデック。 このオプションはtypeMapオプションと相互に排他的です。

デフォルトはコレクションのコーデック。 デフォルトのcodecオプションの継承は、 typeMapオプションの継承よりも優先されます。

バージョン 1.17 の新機能。

collation
array|object

照合順序を指定すると、大文字や小文字、アクセント記号など、string を比較するための言語独自のルールを指定できます。 照合を指定する場合、 localeフィールドは必須です。その他の照合フィールドはすべてオプションです。 フィールドの説明については、 「照合ドキュメント」 を参照してください。

comment
混合
maxTimeMS
integer

カーソルに対する情報処理操作の累積時間制限（ミリ秒単位）。 MongoDB は、次の割り込みポイントが最も近い時点で操作を中止します。

name
string

情報を返すインデックスの名前。

名前が指定されていない場合、コレクションのすべてのインデックスの情報が返されます。

ReadConcern

操作に使用する読み取り保証。 デフォルトはコレクションの読み取り保証 (read concern) です。

トランザクションの一部である個々の操作に対して読み取り保証を指定することはできません。 代わりに 、トランザクションを開始する ときにreadConcern オプションを設定します。

readPreference

操作に使用する読み取り設定。 コレクションの読み込み設定（read preference）がデフォルトで設定されます。

セッション

操作に関連付けるクライアント セッション。

typeMap
配列

型マップ カーソルに適用される 。これは、BSON ドキュメントが PHP 値に変換される方法を決定します。コレクションのタイプ マップがデフォルトになります。

Return Values

ドキュメントのリスト。それぞれがコレクションの検索インデックスを記述します。 出力フィールドの詳細については、MongoDB マニュアルの「 $listSearchIndexes: 出力」を参照してください。

エラーと例外

MongoDB\Exception\UnsupportedExceptionオプションが使用され、選択したサーバーでサポートされていない場合（例: collation 、 readConcern 、 writeConcern ）。

MongoDB\Exception\InvalidArgumentException は、パラメータまたはオプションの解析に関連するエラーの場合は です。

MongoDB\Driver\Exception\RuntimeException 拡張レベルのその他のエラー（例:）。

その他の参照

戻る

listIndexes()

次へ

mapReduce()