db.collection.dropSearchIndex()
定義
バージョン 7.0 の新機能: （6.0.7 以降でも利用可能）
既存の Atlas Search インデックスを削除します。
重要
mongosh メソッド
このページでは、mongosh メソッドについて記載しています。ただし、データベースコマンドや Node.js などの言語固有のドライバーのドキュメントには該当しません。
データベースコマンドについては、 dropSearchIndexコマンドを参照してください。
MongoDB API ドライバーについては、各言語の MongoDB ドライバー ドキュメントを参照してください。
互換性
このメソッドは、次の環境でホストされている配置で使用できます。
MongoDB Atlas はクラウドでの MongoDB 配置のためのフルマネージド サービスです
重要
This command is not supported in M0, M2, and M5 clusters or in serverless instances. 詳細については、「サポートされていないコマンド 」を参照してください。
構文
コマンド構文:
db.<collection>.dropSearchIndex(<name>)
コマンドフィールド
dropSearchIndex() は、次のフィールドを使用します。
フィールド | タイプ | 必要性 | 説明 |
|---|---|---|---|
| string | 必須 | 削除する検索インデックスの名前。 |
動作
dropSearchIndex()の実行後、 コマンドからの応答を受け取ってからインデックスが削除されるまでの間にタイムラグが生じる可能性があります。
検索インデックスのステータスを確認するには、 $listSearchIndexes集計ステージを使用します。 インデックスが削除されると、そのインデックスは$listSearchIndexesの出力に表示されなくなります。
アクセス制御
配置でアクセス制御を適用する場合、 dropSearchIndex()メソッドを実行するユーザーは、データベースに対するdropSearchIndex特権アクションを持っている必要があります。
{ resource: { database : true }, actions: [ "dropSearchIndex" ] }
組み込みのdbAdmin } ロールとreadWriteロールによってdropSearchIndex特権が付与されます。 次の例では、 qaデータベースでreadWriteロールを付与しています。
db.grantRolesToUser( "<user>", [ { role: "readWrite", db: "qa" } ] )
例
次の例では、 moviesコレクションにあるsearchIndex01という名前の検索インデックスを削除します。
db.movies.dropSearchIndex("searchIndex01")