Database Manual / Reference / mongosh Methods / MongoDB Search Index

db.collection.dropSearchIndex() (mongosh method)

Definition

db.collection.dropSearchIndex()

New in version 7.0: (Also available starting in 6.0.7)

Deletes an existing MongoDB Search index or Vector Search index.

Important

mongosh Method

This page documents a mongosh method. This is not the documentation for database commands or language-specific drivers, such as Node.js.

For the database command, see the dropSearchIndex command.

For MongoDB API drivers, refer to the language-specific MongoDB driver documentation.

Compatibility

This method is available in deployments hosted in the following environments:

  • MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud

Important

This command is not supported in serverless instances. For more information, see Unsupported Commands.

Syntax

Command syntax:

db.<collection>.dropSearchIndex(<name>)

Command Fields

dropSearchIndex() takes the following field:

FieldTypeNecessityDescription

name

string

Required

Name of the search index to drop.

Behavior

After you run dropSearchIndex(), there may be a delay between when you receive a response from the command and when the index is deleted.

To see the status of your search indexes, use the $listSearchIndexes aggregation stage. Once your index is deleted, that index no longer appears in the $listSearchIndexes output.

Access Control

If your deployment enforces access control, the user running the dropSearchIndex() method must have the dropSearchIndex privilege action on the database:

{ resource: { database : true }, actions: [ "dropSearchIndex" ] }

The built-in dbAdmin and readWrite roles provide the dropSearchIndex privilege. The following example grants the readWrite role on the qa database:

db.grantRolesToUser(
   "<user>",
   [ { role: "readWrite", db: "qa" } ]
)

Example

The following example deletes a search index named searchIndex01 on the movies collection:

db.movies.dropSearchIndex("searchIndex01")