MongoDB\Collection::updateSearchIndex()

定義

MongoDB\Collection::updateSearchIndex()

コレクションの Atlas Search インデックスを更新します。

function updateSearchIndex(
    string $name,
    array|object $definition,
    array $options = []
): void

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

パラメーター

$name : string

更新するインデックスの名前。

$definition : array|object

更新された検索インデックスの定義を説明するドキュメント。 指定された定義は、検索インデックス内の以前の定義を置き換えます。 定義構文の詳細については、「検索インデックスの定義構文 」を参照してください。

$options : 配列

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

名前	タイプ	説明
comment	混合	データベースプロファイラ、 currentOp出力、およびログから操作を追跡するのに役立つ任意のコメントを指定できるようにします。

エラーと例外

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

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

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

動作

Atlas Search インデックスは非同期で管理されます。 After creating or updating an index, you can periodically execute MongoDB\Collection::listSearchIndexes() and check the queryable output field to determine whether it is ready to be used.

その他の参照

• MongoDB\Collection::createSearchIndex()

• MongoDB\Collection::createSearchIndexes()

• MongoDB\Collection::dropSearchIndex()

• MongoDB\Collection::listSearchIndexes()

• MongoDB マニュアルのupdateSearchIndexコマンド参照

• MongoDB マニュアルのAtlas Searchのドキュメント