Manage MongoDB Search Indexes

Supported Clients

You can create and manage MongoDB Search indexes from the Atlas UI or one of the following supported clients:

• Atlas CLI, with Atlas cluster running MongoDB 7.0+

• mongosh, with Atlas cluster running MongoDB 7.0+.

• Compass, with Atlas cluster running MongoDB 7.0+.

• Supported MongoDB Drivers:

  MongoDB Driver	Driver Version
  C	1.25.0 or higher
  C++	3.9.0 or higher
  C#	2.21.0 or higher
  Go	1.13.0 or higher
  Java	4.11.0 or higher
  Mongoid	9.0 or higher
  Motor	3.3.0 or higher
  Kotlin	5.2.0 or higher
  Node	5.6.0 or higher
  PHP	1.17.0 or higher
  Python	4.5 or higher
  Ruby	2.19.2 or higher
  Rust	2.8.0 or higher
  Scala	5.2.0 or higher

Required Access

You can assign Project User Roles or Database Built-in User Roles to provide access to the user privileges necessary to perform the MongoDB Search index actions described in this guide:

• The following table shows the modes of access that the following Project User Roles support for the specified MongoDB Search actions:

  Project User Role	MongoDB Search Action	Atlas UI	Atlas CLI	Atlas API [1]
  Project Data Access Read Only or higher	To view MongoDB Search indexes and analyzers.	✓		✓
  Project Data Access Admin or higher	To create, view, update, and delete MongoDB Search indexes and analyzers.	✓	✓	✓
  Project Search Index Editor	To create, view, update, and delete MongoDB Search indexes.	✓	✓	✓

  [1]	Each role grants permission to call either a subset or the full set of MongoDB Search API endpoints in the Atlas Administration API. See the MongoDB Search Action column for descriptions of the API endpoints that each role grants access to.

• The following table shows the Database Built-in User Roles that support the specified MongoDB Search Index Privilege Actions.

  Database Built-in User Roles	MongoDB Search Action Description	MongoDB Search Index Privilege Action
  read or readAnyDatabase	To view MongoDB Search indexes and analyzers.	listSearchIndexes
  readWrite or readWriteAnyDatabase	To create, view, update, and delete MongoDB Search indexes and analyzers.	createSearchIndexes, listSearchIndexes updateSearchIndex, and dropSearchIndex

  To learn more, see Built-In Roles or Built-In Roles.

Learn More

• To learn how to define a MongoDB Search index to meet your MongoDB Search query needs, see Define Your Query.

• To learn how to create a MongoDB Search index, see Create a MongoDB Search index.

• To learn more about the MongoDB Search index configurations described in this tutorial, see the following reference pages:

  • Process Data with Analyzers
  • Define Field Mappings
  • Define Stored Source Fields in Your MongoDB Search Index
  • Define Synonym Mappings in Your MongoDB Search Index

• For hands-on experience creating MongoDB Search indexes for the sample datasets and running MongoDB Search queries against the indexed data, try the MongoDB Search Quick Start.

• For a conceptual overview of how to define an index to meet your query preferences, see Define Your Index.

• To retrieve MongoDB Search index size and other search metrics programmatically using the Atlas Administration API, see Retrieve MongoDB Search Metrics Programmatically.