db.collection.dropIndex()

項目一覧

定義

動作
例

定義

db.collection.dropIndex(index)

MongoDB とドライバー

このページでは、 mongoshメソッドについて説明します。 MongoDB ドライバーで同等のメソッドを確認するには、プログラミング言語の対応するページを参照してください。

C#Java Sync Node.js PyMongo C C++Go Java RS Kotlin Coroutine Kotlin Sync PHP Mongoid Rust Scala

コレクションから指定されたインデックスを削除または排除します。

注意

_idフィールドのデフォルトインデックスを削除することはできません。
db.collection.dropIndex("*")を指定して_id以外のインデックスをすべて削除することはできません。代わりに db.collection.dropIndexes()を使用してください。

db.collection.dropIndex()メソッドのインデックス名またはインデックス仕様ドキュメントを取得するには、 db.collection.getIndexes()メソッドを使用します。

db.collection.dropIndex()メソッドでは、次のパラメーターが使われます。

Parameter	タイプ	説明
`index`	文字列またはドキュメント	必須。削除するインデックスを指定します。インデックスは、インデックス名またはインデックス仕様ドキュメントによって指定できます。テキストインデックスを削除するには、インデックス名を指定します。 `"*"`を指定して`_id`以外のインデックスをすべて削除することはできません。代わりに`db.collection.dropIndexes()`を使用してください。 `db.collection.dropIndex()`に指定されたインデックスがまだビルド中の場合、 `db.collection.dropIndex()`は進行中のビルドを停止しようとします。インデックスのビルドを停止すると、ビルドされたインデックスを削除するのと同じ効果があります。詳細なドキュメントについては、「進行中のインデックスビルドの停止」を参照してください。

動作

MongoDB 5.2以降では、別のインデックスでビルドが進行中の場合でも、 db.collection.dropIndex()を使用して同じコレクションの既存のインデックスを削除できます。以前のバージョンでは、インデックスのビルドが進行中に別のインデックスを削除しようとするとBackgroundOperationInProgressForNamespaceエラーが発生していました。

リソースのロック

db.collection.dropIndex()は、操作中、指定されたコレクションに対する排他ロックを取得します。コレクションに対する後続のすべての操作は、 db.collection.dropIndex()がロックを解放するまで待機する必要があります。

進行中のインデックスビルドの停止

db.collection.dropIndex()に指定されたインデックスがまだビルド中の場合、 db.collection.dropIndex()は進行中のビルドを停止しようとします。インデックスのビルドを停止すると、ビルドされたインデックスを削除するのと同じ効果があります。

レプリカセットの場合は、プライマリでdb.collection.dropIndex() を実行します。プライマリはインデックスのビルドを停止し、関連する "abortIndexBuild" oplogエントリを作成します。 "abortIndexBuild" oplog エントリを複製するセカンダリは、進行中のインデックスビルドを停止し、ビルドジョブを破棄します。インデックス構築プロセスの詳細なドキュメントについては、「インデックス構築プロセス」を参照してください。

currentOp操作またはcreateIndexesdb.collection.createIndexes() 操作に関連付けられたインデックスビルドを識別するには、を使用します。例については、「アクティブなインデックス操作」を参照してください。

Hidden Indexes

MongoDB では、クエリプランナーからインデックスを非表示または再表示する機能が提供されます。プランナーからインデックスを非表示にすることで、実際にインデックスを削除せずに、インデックスを削除した場合の潜在的な影響を評価できます。

評価後にユーザーがインデックスを削除する場合は、非表示のインデックスを削除できます。つまり、削除するために最初に再表示する必要はありません。

ただし、影響が負の場合、ユーザーは削除されたインデックスを再度作成する必要がある代わりに、インデックスを再表示できます。また、インデックスは非表示になっている間完全に維持されているため、非表示が解除されたらすぐに使用できるようになります。

非表示インデックスの詳細については、「非表示のインデックス」を参照してください。

例

pets コレクションを検討します。pets コレクションで db.collection.getIndexes() メソッドを呼び出すと、次のインデックスが返されます。

[
   {
      "v" : 2,
      "key" : {
         "_id" : 1
      },
      "name" : "_id_"
   },
   {
      "v" : 2,
      "key" : {
         "cat" : -1
      },
      "name" : "catIdx"
   },
   {
      "v" : 2,
      "key" : {
         "cat" : 1,
         "dog" : -1
      },
      "name" : "cat_1_dog_-1"
   }
]

フィールド cat の単一フィールドインデックスには、ユーザー指定の名前の catIdx [1] とインデックス仕様ドキュメントの { "cat" : -1 } があります。

インデックス catIdx を削除するには、次のいずれかのインデックス名を使用できます。

db.pets.dropIndex( "catIdx" )

または、インデックス仕様ドキュメント { "cat" : -1 } を使用できます。

db.pets.dropIndex( { "cat" : -1 } )

[1]	インデックスの作成時に、ユーザーがインデックス名を指定しない場合、システムはインデックスキーフィールドと値をアンダースコアで連結して名前を生成します。例: `cat_1`

戻る

db.collection.drop

db.collection.dropIndexes