Get Started with Atlas Search
On this page
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.
Note
Feature Unavailable in Serverless Instances
Serverless instances don't support this feature at this time. To learn more, see Serverless Instance Limitations.
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 clients to run queries on your Atlas cluster:
Note
You can run Atlas Search queries by using any
MongoDB Driver through the $search
aggregation stage. This tutorial includes examples for only
the drivers in the preceding list.
Required Access
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:
Note
To learn more about Atlas Search, you can take Unit 1 of the
Atlas Search Course on MongoDB University. The 2.25
hour unit includes an overview of Atlas Search and lessons on how to create
Atlas Search indexes, use $search with different operators, and
generate search facets.
Prefer to learn by watching?
Watch an overview of Atlas and Atlas Search and get started setting up Atlas Search for your data. The video demonstrates how to load sample data on your cluster, create an Atlas Search index, and run a sample query using Search Tester and Data Explorer.
Duration: 10 Minutes