Get Started with Atlas Search
On this page
Important
Serverless Instances are in Preview
Serverless instances are in preview and do not support this feature at this time. To learn more, see Serverless Instance Limitations.
This tutorial takes you through the steps of setting up and querying an Atlas Search index. You will use a collection with movie data from the Atlas sample data set.
Prerequisites
To complete this tutorial you will need:
- An Atlas cluster with MongoDB version 4.2 or higher.
- The sample datasets loaded into your Atlas cluster.
One of the following applications to run queries on your Atlas cluster:
- Choose static or dynamic index mapping.
Roles
The following table shows the modes of access each role supports.
Role | Action | Atlas UI | Atlas API | Atlas Search API | Atlas CLI |
|---|---|---|---|---|---|
Project Data Access Read Only or higher role | To view Atlas Search analyzers and indexes. | ✓ | ✓ | ||
Project Data Access Admin or higher role | To create and manage Atlas Search analyzers and indexes, and
assign the role to your API Key. | ✓ | ✓ | ✓ | ✓ |
Project Owner role | ✓ | ✓ | |||
Organization Owner role | To create access list entries for
your API Key and send the request from a client that appears in the
access list for your API Key. | ✓ | ✓ | ||
To create, view, edit, and delete Atlas Search indexes using the
Atlas UI or API. | ✓ | ✓ | ✓ |
Next Steps
Choose one of the following ways to create your Atlas Search index: