Step 1: Create an Atlas Search Index

Navigate to the Atlas Search page for your project.

1. If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.

2. If it is not already displayed, select your desired project from the Projects menu in the navigation bar.

3. Click your cluster's name.

4. Click the Atlas Search tab.

Click Create Search Index.

Select an Atlas Search Configuration Method and click Next.

• For a guided experience, select the Atlas Search Visual Editor.

• To edit the raw index definition, select the Atlas Search JSON Editor.

Enter the Index Name, and set the Database and Collection.

1. In the Index Name field, enter default.

   Note

   If you name your index default, you don't need to specify an index parameter when using the $search pipeline stage. Otherwise, you must specify the index name using the index parameter.

2. In the Database and Collection section, find the sample_mflix database, and select the movies collection.

Specify an index definition.

You can create an Atlas Search index that uses dynamic mappings or static mappings. To learn more about dynamic and static mappings, see Static and Dynamic Mappings.

The following index definition dynamically indexes the fields of supported types in the movies collection. You can use the Atlas Search Visual Editor or the Atlas Search JSON Editor in the Atlas user interface to create the index.

Click Save Changes.

Click Create Search Index.

Close the You're All Set! Modal Window.

A modal window appears to let you know your index is building. Click the Close button.

Wait for the index to finish building.

The index should take about one minute to build. While it is building, the Status column reads Build in Progress. When it is finished building, the Status column reads Active.

Copy and paste the sample cURL request in your preferred text editor.

The following index definition dynamically indexes the fields of supported types in the movies collection.

1
PUBLIC_KEY=MY_PUBLIC_KEY # replace replace with your public key
2
PRIVATE_KEY=MY_PRIVATE_KEY # replace with your private key
3
GROUP_ID=YOUR_GROUP_ID # replace with your project ID
4
CLUSTER_NAME=YOUR_CLUSTER_NAME # replace with your cluster's name
5
6
curl --user "$PUBLIC_KEY:$PRIVATE_KEY" --digest \
7
     --header "Content-Type: application/json" \
8
     --include \
9
     --request POST "https://cloud.mongodb.com/api/atlas/v1.0/groups/$GROUP_ID/clusters/$CLUSTER_NAME/fts/indexes?pretty=true" \
10
     --data '{
11
         "collectionName": "movies",
12
         "database": "sample_mflix",
13
         "mappings": {
14
             "dynamic": true
15
         },
16
         "name": "default"
17
       }'

Replace the variables in your sample cURL request.

The sample cURL requests use these variables. Replace these variables with your desired values before running the cURL command to create an Atlas Search index.

Run the modified cURL request to create the Atlas Search index.

1
{
2
  "collectionName" : "movies",
3
  "database" : "sample_mflix",
4
  "indexID" : "60bfd25f59fc81594354eed3",
5
  "mappings" : {
6
    "dynamic" : true
7
  },
8
  "name" : "default",
9
  "status" : "IN_PROGRESS"
10
}

Create and save the JSON index definition in a file.

Copy the following sample index definition, then paste the JSON index example into a new file, and save the file:

The following index definition dynamically indexes the fields of supported types in the movies collection.

1
{
2
  "name": "INDEX_NAME",
3
  "clusterName": "CLUSTER_NAME",
4
  "collectionName": "movies",
5
  "database": "sample_mflix",
6
  "mappings": {
7
    "dynamic": true
8
  }
9
}

Copy and modify the sample Atlas CLI request.

Paste the following sample Atlas CLI request into your favorite text editor and replace the variables.

atlas clusters search index create \
    --clusterName CLUSTER_NAME \
    --file FILE_PATH \
    --projectId PROJECT_ID
    --profile PROFILE_NAME

The sample Atlas CLI requests use these variables. Replace these variables with your desired values before running the command to create an Atlas Search index.

Run the modified Atlas CLI request in your terminal to create the Atlas Search index.

Run the request. You receive this response when Atlas Search begins creating the index:

{
  "collectionName": "movies",
  "database": "sample_mflix",
  "indexID": <index-id>,
  "mappings": {
    "dynamic": true
  },
  "name": <index-name>,
  "status": "IN_PROGRESS"
}