How to Use Synonyms with Atlas Search

The query searches the title field for the word automobile and uses the synonym mapping definition named transportSynonyms to search for words configured as synonyms of the query word automobile in the synonyms source collection named transport_synonyms. The query includes the following stages:

• $limit stage to limit the output to 10 results

• $project stage to exclude all fields except title and add a field named score

To run this query in MongoDB Compass:

1. Click the Aggregations tab.

2. Click Select..., then configure each of the following pipeline stages by selecting the stage from the dropdown and adding the query for that stage. Click Add Stage to add additional stages.

   Pipeline Stage	Query
   $search	{ "index": "synonyms-tutorial", "text": { "path": "title", "query": "automobile", "synonyms": "transportSynonyms" } }
   $limit	10
   $project	{ "_id": 0, "title": 1, "score": { "$meta": "searchScore" } }

   If you enabled Auto Preview, MongoDB Compass displays the following documents next to the $project pipeline stage:

   {title Cars} {score 4.197734832763672}
   {title Planes, Trains & Automobiles} {score 3.8511905670166016}
   {title Car Wash} {score 3.39473032951355}
   {title Used Cars} {score 3.39473032951355}
   {title Blue Car} {score 3.39473032951355}
   {title Cars 2} {score 3.39473032951355}
   {title Stealing Cars} {score 3.39473032951355}
   {title Cop Car} {score 3.39473032951355}
   {title The Cars That Eat People} {score 2.8496146202087402}
   {title Khrustalyov, My Car!} {score 2.8496146202087402}

   The Atlas Search results contain movies with car and automobile in the title field although the query term is automobile because we configured automobile to be a synonym of car, vehicle, and automobile in the synonyms source collection named sample_synonyms, which is specified in the index for the collection. Atlas Search returns the same results for a search of the words car and vehicle. To test this, replace the value of the query field in the query above with either car or vehicle and run the query.

The query searches the title field for the word boat and uses the synonym mapping definition named transportSynonyms to search for words configured as synonyms of the query word boat in the synonyms source collection named transport_synonyms. It includes the following stages:

• $limit stage to limit the output to 10 results

• $project stage to exclude all fields except title and add a field named score

To run this query in MongoDB Compass:

1. Click the Aggregations tab.

2. Click Select..., then configure each of the following pipeline stages by selecting the stage from the dropdown and adding the query for that stage. Click Add Stage to add additional stages.

   Pipeline Stage	Query
   $search	{ "index": "synonyms-tutorial", "text": { "path": "title", "query": "boat", "synonyms": "transportSynonyms" } }
   $limit	10
   $project	{ "_id": 0, "title": 1, "score": { "$meta": "searchScore" } }

   If you enabled Auto Preview, MongoDB Compass displays the following documents next to the $project pipeline stage:

   {title Vessel} {score 5.373150825500488}
   {title Boats} {score 4.589139938354492}
   {title And the Ship Sails On} {score 4.3452959060668945}
   {title Broken Vessels} {score 4.3452959060668945}
   {title Sailing to Paradise} {score 4.3452959060668945}
   {title Boat People} {score 3.711261749267578}
   {title Boat Trip} {score 3.711261749267578}
   {title Three Men in a Boat} {score 3.1153182983398438}
   {title The Glass Bottom Boat} {score 3.1153182983398438}
   {title Jack Goes Boating} {score 3.1153182983398438}

   The Atlas Search results contain movies with boat, vessel, and sail in the title field because we configured boat, vessel, and sail to be synonyms of boat in the synonyms source collection named sample_synonyms, which is specified in the index for the collection.

   Atlas Search returns the following documents only for a search of the word vessel in the results:

   { "title" : "Vessel", "score" : 5.373150825500488 }
   { "title" : "Broken Vessels", "score" : 4.3452959060668945 }

   Atlas Search doesn't include documents with either boat or sail in the title field in the results because we didn't configure vessel to be a synonym of either boat or sail in the synonyms source collection. To test this, replace the value of the query field in the query above with vessel and run the query again.

   Similarly, Atlas Search returns the following documents only in the results for a search of the term sail:

   { "title" : "And the Ship Sails On", "score" : 4.3452959060668945 }
   { "title" : "Sailing to Paradise", "score" : 4.3452959060668945 }

   Atlas Search doesn't include documents with either boat or vessel in the title field in the results because we didn't configure sail to be a synonym of either boat or vessel in the synonyms source collection. To test this example, replace the value of the query field in the query above with sail and run the query again.

The query searches the title field for the word automobile and uses the synonym mapping definition named transportSynonyms to search for words configured as synonyms of the query word automobile in the synonyms source collection named transport_synonyms. The query searches the title field for the word attire also and uses the synonym mapping definition named attireSynonyms to search for words configured as synonyms of the query word attire in the synonyms source collection named attire_synonyms.

The query includes the following stages:

• $limit stage to limit the output to 10 results

• $project stage to exclude all fields except title and add a field named score

To run this query in MongoDB Compass:

1. Click the Aggregations tab.

2. Click Select..., then configure each of the following pipeline stages by selecting the stage from the dropdown and adding the query for that stage. Click Add Stage to add additional stages.

   Pipeline Stage	Query
   $search	{ "index": "synonyms-tutorial", "compound": { "should": [{ "text": { "path": "title", "query": "automobile", "synonyms": "transportSynonyms" } }, { "text": { "path": "title", "query": "attire", "synonyms": "attireSynonyms" } }] } }
   $limit	10
   $project	{ "_id": 0, "title": 1, "score": { "$meta": "searchScore" } }

   If you enabled Auto Preview, MongoDB Compass displays the following documents next to the $project pipeline stage:

   { title: 'The Dress', score: 4.812004089355469 },
   { title: 'Cars', score: 4.197734832763672 },
   { title: 'Dressed to Kill', score: 3.891493320465088 },
   { title: '27 Dresses', score: 3.891493320465088 },
   { title: 'Planes, Trains & Automobiles', score: 3.8511905670166016 },
   { title: 'Car Wash', score: 3.39473032951355 },
   { title: 'Used Cars', score: 3.39473032951355 },
   { title: 'Blue Car', score: 3.39473032951355 },
   { title: 'Cars 2', score: 3.39473032951355 },
   { title: 'Stealing Cars', score: 3.39473032951355 }

   The Atlas Search results contain documents for both the search terms. The results contain movies with car in the title field for the query term automobile because we configured automobile to be a synonym of car, vehicle, and automobile in the synonyms source collection named transport_synonyms. The result also contains movies with dress in the title field for the query term attire because we configured attire to be a synonym of dress, apparel, and attire in the synonyms source collection named attire_synonyms.

   Atlas Search returns the same results for a search of car or vehicle in the transport_synonyms source collection and dress or apparel in the attire_synonyms source collection. To test this example, replace the value of the query field in the query above with car or vehicle and replace the value of the query field in the query above with dress or apparel, and run the query again.

The query searches the title field for the word boat and uses the synonym mapping definition named transportSynonyms to search for words configured as synonyms of the query word boat in the synonyms source collection named transport_synonyms. The query searches the title field for the word hat also and uses the synonym mapping definition named attireSynonyms to search for words configured as synonyms of the query word hat in the synonyms source collection named attire_synonyms.

The query includes the following stages:

• $limit stage to limit the output to 10 results

• $project stage to exclude all fields except title and add a field named score

To run this query in MongoDB Compass:

1. Click the Aggregations tab.

2. Click Select..., then configure each of the following pipeline stages by selecting the stage from the dropdown and adding the query for that stage. Click Add Stage to add additional stages.

   Pipeline Stage	Query
   $search	{ "index": "synonyms-tutorial", "compound": { "should": [{ "text": { "path": "title", "query": "boat", "synonyms": "transportSynonyms" } }, { "text": { "path": "title", "query": "hat", "synonyms": "attireSynonyms" } }] } }
   $limit	10
   $project	{ "_id": 0, "title": 1, "score": { "$meta": "searchScore" } }

   If you enabled Auto Preview, MongoDB Compass displays the following documents next to the $project pipeline stage:

   { title: 'Fedora', score: 5.673145294189453 },
   { title: 'Vessel', score: 5.373150825500488 },
   { title: 'Boats', score: 4.589139938354492 },
   { title: 'And the Ship Sails On', score: 4. 3452959060668945 },
   { title: 'Broken Vessels', score: 4.3452959060668945 },
   { title: 'Sailing to Paradise', score: 4.3452959060668945 },
   { title: 'Top Hat', score: 4.066137313842773 },
   { title: 'A Hatful of Rain', score: 4.066137313842773 },
   { title: 'Boat People', score: 3.711261749267578 },
   { title: 'Boat Trip', score: 3.711261749267578 }

   The Atlas Search results contain documents for both the search terms. The results contain movies with vessel, boat, and sail in the title field for the query term boat because we configured boat to be a synonym of boat, vessel, and sail in the synonyms source collection named transport_synonyms.

   Atlas Search doesn't include documents with either boat or sail in the title field in the results for a search of the term vessel because we didn't configure vessel to be a synonym of either boat or sail in the synonyms source collection. Similary, Atlas Search doesn't include documents with either boat or vessel in the title field in the results for a search of the term sail because we didn't configure sail to be a synonym of either boat or vessel in the synonyms source collection. To test these examples, replace the value of the query field in the query above with vessel or sail and run the query again.

   The result also contains movies with fedora and hat in the title field for the query term hat because we configured hat to be a synonym of hat, fedora, and headgear in the synonyms source collection named attire_synonyms.

   Atlas Search doesn't include documents with either hat or fedora in the title field in the results for a search of the term headgear because we didn't configure headgear to be a synonym of either hat or fedora in the synonyms source collection. Similary, Atlas Search doesn't include documents with either hat or headgear in the title field in the results for a search of the term fedora because we didn't configure fedora to be a synonym of either hat or headgear in the synonyms source collection. To test these examples, replace the value of the query field in the query above with fedora or headgear and run the query again.

1. Create a file named synonyms-equivalent-query.go.

2. Copy and paste the code example into the synonyms-equivalent-query.go file.

   The code example contains the following stages:

   • $search stage to search the title field for the word automobile and uses the synonym mapping definition named transportSynonyms to search for words configured as synonyms of the query word automobile in the synonyms source collection named transport_synonyms.

   • $limit stage to limit the output to 10 results.

   • $project stage to exclude all fields except title and add a field named score.

   1
   package main
   2
   3
   import (
   4
   	"context"
   5
   	"fmt"
   6
   	"time"
   7
   8
   	"go.mongodb.org/mongo-driver/v2/bson"
   9
   	"go.mongodb.org/mongo-driver/v2/mongo"
   10
   	"go.mongodb.org/mongo-driver/v2/mongo/options"
   11
   )
   12
   13
   // define structure of movies collection
   14
   type MovieCollection struct {
   15
   	title string `bson:"Title,omitempty"`
   16
   }
   17
   18
   func main() {
   19
   	var err error
   20
   	// connect to the Atlas cluster
   21
   	ctx := context.Background()
   22
   	client, err := mongo.Connect(options.Client().ApplyURI("<connection-string>"))
   23
   	if err != nil {
   24
   		panic(err)
   25
   	}
   26
   	defer client.Disconnect(ctx)
   27
   	// set namespace
   28
   	collection := client.Database("sample_mflix").Collection("movies")
   29
   	// define pipeline
   30
   	searchStage := bson.D{{"$search", bson.D{{"index", "synonyms-tutorial"}, {"text", bson.D{{"path", "title"}, {"query", "automobile"}, {"synonyms", "transportSynonyms"}}}}}}
   31
   	limitStage := bson.D{{"$limit", 10}}
   32
   	projectStage := bson.D{{"$project", bson.D{{"title", 1}, {"_id", 0}, {"score", bson.D{{"$meta", "searchScore"}}}}}}
   33
   	// specify the amount of time the operation can run on the server
   34
   	opts := options.Aggregate().SetMaxTime(5 * time.Second)
   35
   	// run pipeline
   36
   	cursor, err := collection.Aggregate(ctx, mongo.Pipeline{searchStage, limitStage, projectStage}, opts)
   37
   	if err != nil {
   38
   		panic(err)
   39
   	}
   40
   	// print results
   41
   	var results []bson.D
   42
   	if err = cursor.All(context.TODO(), &results); err != nil {
   43
   		panic(err)
   44
   	}
   45
   	for _, result := range results {
   46
   		fmt.Println(result)
   47
   	}
   48
   }

3. Before you run the sample, replace <connection-string> with your Atlas connection string. Ensure that your connection string includes your database user's credentials. To learn more, see Connect via Drivers.

4. Run the following command to query your collection:

   go run synonyms-equivalent-query.go

   When you run synonyms-equivalent-query.go, the program prints the following documents to your terminal:

   [{title Cars} {score 4.197734832763672}]
   [{title Planes, Trains & Automobiles} {score 3.8511905670166016}]
   [{title Car Wash} {score 3.39473032951355}]
   [{title Used Cars} {score 3.39473032951355}]
   [{title Blue Car} {score 3.39473032951355}]
   [{title Cars 2} {score 3.39473032951355}]
   [{title Stealing Cars} {score 3.39473032951355}]
   [{title Cop Car} {score 3.39473032951355}]
   [{title The Cars That Eat People} {score 2.8496146202087402}]
   [{title Khrustalyov, My Car!} {score 2.8496146202087402}]

   The Atlas Search results contain movies with car and automobile in the title field although the query term is automobile because we configured automobile to be a synonym of car, vehicle, and automobile in the synonyms source collection named sample_synonyms, which is specified in the index for the collection. Atlas Search returns the same results for a search of the words car and vehicle. To test this, replace the value of the query field in the query above with either car or vehicle and run the query.

1. Create a file named synonyms-explicit-query.go.

2. Copy and paste the code example into the synonyms-explicit-query.go file.

   The code example contains the following stages:

   • $search stage to search the title field for the word boat and uses the synonym mapping definition named transportSynonyms to search for words configured as synonyms of the query word boat in the synonyms source collection named transport_synonyms.

   • $limit stage to limit the output to 10 results.

   • $project stage to exclude all fields except title and add a field named score.

   1
   package main
   2
   3
   import (
   4
   	"context"
   5
   	"fmt"
   6
   	"time"
   7
   8
   	"go.mongodb.org/mongo-driver/v2/bson"
   9
   	"go.mongodb.org/mongo-driver/v2/mongo"
   10
   	"go.mongodb.org/mongo-driver/v2/mongo/options"
   11
   )
   12
   13
   // define structure of movies collection
   14
   type MovieCollection struct {
   15
   	title string `bson:"Title,omitempty"`
   16
   }
   17
   18
   func main() {
   19
   	var err error
   20
   	// connect to the Atlas cluster
   21
   	ctx := context.Background()
   22
   	client, err := mongo.Connect(options.Client().ApplyURI("<connection-string>"))
   23
   	if err != nil {
   24
   		panic(err)
   25
   	}
   26
   	defer client.Disconnect(ctx)
   27
   	// set namespace
   28
   	collection := client.Database("sample_mflix").Collection("movies")
   29
   	// define pipeline
   30
   	searchStage := bson.D{{"$search", bson.D{{"text", bson.D{{"index", "synonyms-tutorial"}, {"path", "title"}, {"query", "boat"}, {"synonyms", "transportSynonyms"}}}}}}
   31
   	limitStage := bson.D{{"$limit", 10}}
   32
   	projectStage := bson.D{{"$project", bson.D{{"title", 1}, {"_id", 0}, {"score", bson.D{{"$meta", "searchScore"}}}}}}
   33
   	// specify the amount of time the operation can run on the server
   34
   	opts := options.Aggregate().SetMaxTime(5 * time.Second)
   35
   	// run pipeline
   36
   	cursor, err := collection.Aggregate(ctx, mongo.Pipeline{searchStage, limitStage, projectStage}, opts)
   37
   	if err != nil {
   38
   		panic(err)
   39
   	}
   40
   	// print results
   41
   	var results []bson.D
   42
   	if err = cursor.All(context.TODO(), &results); err != nil {
   43
   		panic(err)
   44
   	}
   45
   	for _, result := range results {
   46
   		fmt.Println(result)
   47
   	}
   48
   }

3. Before you run the sample, replace <connection-string> with your Atlas connection string. Ensure that your connection string includes your database user's credentials. To learn more, see Connect via Drivers.

4. Run the following command to query your collection:

   go run synonyms-explicit-query.go

   HIDE OUTPUT

   [{title Vessel} {score 5.373150825500488}]
   [{title Boats} {score 4.589139938354492}]
   [{title And the Ship Sails On} {score 4.3452959060668945}]
   [{title Broken Vessels} {score 4.3452959060668945}]
   [{title Sailing to Paradise} {score 4.3452959060668945}]
   [{title Boat People} {score 3.711261749267578}]
   [{title Boat Trip} {score 3.711261749267578}]
   [{title Three Men in a Boat} {score 3.1153182983398438}]
   [{title The Glass Bottom Boat} {score 3.1153182983398438}]
   [{title Jack Goes Boating} {score 3.1153182983398438}]

   The Atlas Search results contain movies with boat, vessel, and sail in the title field because we configured boat, vessel, and sail to be synonyms of boat in the synonyms source collection named sample_synonyms, which is specified in the index for the collection.

   Atlas Search returns the following documents only for a search of the word vessel in the results:

   { "title" : "Vessel", "score" : 5.373150825500488 }
   { "title" : "Broken Vessels", "score" : 4.3452959060668945 }

   Atlas Search doesn't include documents with either boat or sail in the title field in the results because we didn't configure vessel to be a synonym of either boat or sail in the synonyms source collection. To test this, replace the value of the query field in the query above with vessel and run the query again.

   Similarly, Atlas Search returns the following documents only in the results for a search of the term sail:

   { "title" : "And the Ship Sails On", "score" : 4.3452959060668945 }
   { "title" : "Sailing to Paradise", "score" : 4.3452959060668945 }

   Atlas Search doesn't include documents with either boat or vessel in the title field in the results because we didn't configure sail to be a synonym of either boat or vessel in the synonyms source collection. To test this example, replace the value of the query field in the query above with sail and run the query again.

1. Create a file named synonyms-equivalent-query.go.

2. Copy and paste the code example into the synonyms-equivalent-query.go file.

   The code example contains the following stages:

   • $search stage to search the title field for the word automobile and uses the synonym mapping definition named transportSynonyms to search for words configured as synonyms of the query word automobile in the synonyms source collection named transport_synonyms. The query searches the title field for the word attire also and uses the synonym mapping definition named attireSynonyms to search for words configured as synonyms of the query word attire in the synonyms source collection named attire_synonyms.

   • $limit stage to limit the output to 10 results.

   • $project stage to exclude all fields except title and add a field named score.

   1
   package main
   2
   3
   import (
   4
   	"context"
   5
   	"fmt"
   6
   	"time"
   7
   8
   	"go.mongodb.org/mongo-driver/v2/bson"
   9
   	"go.mongodb.org/mongo-driver/v2/mongo"
   10
   	"go.mongodb.org/mongo-driver/v2/mongo/options"
   11
   )
   12
   13
   // define structure of movies collection
   14
   type MovieCollection struct {
   15
   	title string `bson:"Title,omitempty"`
   16
   }
   17
   18
   func main() {
   19
   	var err error
   20
   	// connect to the Atlas cluster
   21
   	ctx := context.Background()
   22
   	client, err := mongo.Connect(options.Client().ApplyURI("<connection-string>"))
   23
   	if err != nil {
   24
   		panic(err)
   25
   	}
   26
   	defer client.Disconnect(ctx)
   27
   	// set namespace
   28
   	collection := client.Database("sample_mflix").Collection("movies")
   29
   	// define pipeline
   30
   	searchStage := bson.D{{"$search", bson.M{
   31
   		"index": "synonyms-tutorial",
   32
   		"compound": bson.M{
   33
   			"should": bson.A{
   34
   				bson.M{
   35
   					"text": bson.D{
   36
   						{"path", "title"}, {"query", "automobile"}, {"synonyms", "transportSynonyms"},
   37
   					},
   38
   				},
   39
   				bson.M{
   40
   					"text": bson.D{
   41
   						{"path", "title"}, {"query", "attire"}, {"synonyms", "attireSynonyms"},
   42
   					},
   43
   				},
   44
   			},
   45
   		},
   46
   	}}}
   47
   	limitStage := bson.D{{"$limit", 10}}
   48
   	projectStage := bson.D{{"$project", bson.D{{"title", 1}, {"_id", 0}, {"score", bson.D{{"$meta", "searchScore"}}}}}}
   49
   	// specify the amount of time the operation can run on the server
   50
   	opts := options.Aggregate().SetMaxTime(5 * time.Second)
   51
   	// run pipeline
   52
   	cursor, err := collection.Aggregate(ctx, mongo.Pipeline{searchStage, limitStage, projectStage}, opts)
   53
   	if err != nil {
   54
   		panic(err)
   55
   	}
   56
   	// print results
   57
   	var results []bson.D
   58
   	if err = cursor.All(context.TODO(), &results); err != nil {
   59
   		panic(err)
   60
   	}
   61
   	for _, result := range results {
   62
   		fmt.Println(result)
   63
   	}
   64
   }

3. Before you run the sample, replace <connection-string> with your Atlas connection string. Ensure that your connection string includes your database user's credentials. To learn more, see Connect via Drivers.

4. Run the following command to query your collection:

   go run synonyms-equivalent-query.go

   HIDE OUTPUT

   [{title The Dress} {score 4.812004089355469}]
   [{title Cars} {score 4.197734832763672}]
   [{title Dressed to Kill} {score 3.891493320465088}]
   [{title 27 Dresses} {score 3.891493320465088}]
   [{title Planes, Trains & Automobiles} {score 3.8511905670166016}]
   [{title Car Wash} {score 3.39473032951355}]
   [{title Used Cars} {score 3.39473032951355}]
   [{title Blue Car} {score 3.39473032951355}]
   [{title Cars 2} {score 3.39473032951355}]
   [{title Stealing Cars} {score 3.39473032951355}]

   The Atlas Search results contain documents for both the search terms. The results contain movies with car in the title field for the query term automobile because we configured automobile to be a synonym of car, vehicle, and automobile in the synonyms source collection named transport_synonyms. The result also contains movies with dress in the title field for the query term attire because we configured attire to be a synonym of dress, apparel, and attire in the synonyms source collection named attire_synonyms.

   Atlas Search returns the same results for a search of car or vehicle in the transport_synonyms source collection and dress or apparel in the attire_synonyms source collection. To test this example, replace the value of the query field in the query above with car or vehicle and replace the value of the query field in the query above with dress or apparel, and run the query again.

1. Create a file named synonyms-explicit-query.go.

2. Copy and paste the code example into the synonyms-explicit-query.go file.

   The code example contains the following stages:

   • $search stage to search the title field for the word boat and uses the synonym mapping definition named transportSynonyms to search for words configured as synonyms of the query word boat in the synonyms source collection named transport_synonyms. The query searches the title field for the word hat also and uses the synonym mapping definition named attireSynonyms to search for words configured as synonyms of the query word hat in the synonyms source collection named attire_synonyms.

   • $limit stage to limit the output to 10 results.

   • $project stage to exclude all fields except title and add a field named score.

   1
   package main
   2
   3
   import (
   4
   	"context"
   5
   	"fmt"
   6
   	"time"
   7
   8
   	"go.mongodb.org/mongo-driver/v2/bson"
   9
   	"go.mongodb.org/mongo-driver/v2/mongo"
   10
   	"go.mongodb.org/mongo-driver/v2/mongo/options"
   11
   )
   12
   13
   // define structure of movies collection
   14
   type MovieCollection struct {
   15
   	title string `bson:"Title,omitempty"`
   16
   }
   17
   18
   func main() {
   19
   	var err error
   20
   	// connect to the Atlas cluster
   21
   	ctx := context.Background()
   22
   	client, err := mongo.Connect(options.Client().ApplyURI("<connection-string>"))
   23
   	if err != nil {
   24
   		panic(err)
   25
   	}
   26
   	defer client.Disconnect(ctx)
   27
   	// set namespace
   28
   	collection := client.Database("sample_mflix").Collection("movies")
   29
   	// define pipeline
   30
   	searchStage := bson.D{{"$search", bson.M{
   31
   		"index": "synonyms-tutorial",
   32
   		"compound": bson.M{
   33
   			"must": bson.A{
   34
   				bson.M{
   35
   					"text": bson.D{
   36
   						{"path", "title"}, {"query", "boat"}, {"synonyms", "transportSynonyms"},
   37
   					},
   38
   				},
   39
   				bson.M{
   40
   					"text": bson.D{
   41
   						{"path", "title"}, {"query", "hat"}, {"synonyms", "attireSynonyms"},
   42
   					},
   43
   				},
   44
   			},
   45
   		},
   46
   	}}}
   47
   	limitStage := bson.D{{"$limit", 10}}
   48
   	projectStage := bson.D{{"$project", bson.D{{"title", 1}, {"_id", 0}, {"score", bson.D{{"$meta", "searchScore"}}}}}}
   49
   	// specify the amount of time the operation can run on the server
   50
   	opts := options.Aggregate().SetMaxTime(5 * time.Second)
   51
   	// run pipeline
   52
   	cursor, err := collection.Aggregate(ctx, mongo.Pipeline{searchStage, limitStage, projectStage}, opts)
   53
   	if err != nil {
   54
   		panic(err)
   55
   	}
   56
   	// print results
   57
   	var results []bson.D
   58
   	if err = cursor.All(context.TODO(), &results); err != nil {
   59
   		panic(err)
   60
   	}
   61
   	for _, result := range results {
   62
   		fmt.Println(result)
   63
   	}
   64
   }

3. Before you run the sample, replace <connection-string> with your Atlas connection string. Ensure that your connection string includes your database user's credentials. To learn more, see Connect via Drivers.

4. Run the following command to query your collection:

   go run synonyms-explicit-query.go

   HIDE OUTPUT

   [{title Fedora} {score 5.673145294189453}]
   [{title Vessel} {score 5.373150825500488}]
   [{title Boats} {score 4.589139938354492}]
   [{title And the Ship Sails On} {score 4.3452959060668945}]
   [{title Broken Vessels} {score 4.3452959060668945}]
   [{title Sailing to Paradise} {score 4.3452959060668945}]
   [{title Top Hat} {score 4.066137313842773}]
   [{title A Hatful of Rain} {score 4.066137313842773}]
   [{title Boat People} {score 3.711261749267578}]
   [{title Boat Trip} {score 3.711261749267578}]

   The Atlas Search results contain documents for both the search terms. The results contain movies with vessel, boat, and sail in the title field for the query term boat because we configured boat to be a synonym of boat, vessel, and sail in the synonyms source collection named transport_synonyms.

   Atlas Search doesn't include documents with either boat or sail in the title field in the results for a search of the term vessel because we didn't configure vessel to be a synonym of either boat or sail in the synonyms source collection. Similary, Atlas Search doesn't include documents with either boat or vessel in the title field in the results for a search of the term sail because we didn't configure sail to be a synonym of either boat or vessel in the synonyms source collection. To test these examples, replace the value of the query field in the query above with vessel or sail and run the query again.

   The result also contains movies with fedora and hat in the title field for the query term hat because we configured hat to be a synonym of hat, fedora, and headgear in the synonyms source collection named attire_synonyms.

   Atlas Search doesn't include documents with either hat or fedora in the title field in the results for a search of the term headgear because we didn't configure headgear to be a synonym of either hat or fedora in the synonyms source collection. Similary, Atlas Search doesn't include documents with either hat or headgear in the title field in the results for a search of the term fedora because we didn't configure fedora to be a synonym of either hat or headgear in the synonyms source collection. To test these examples, replace the value of the query field in the query above with fedora or headgear and run the query again.

1. Create a file named SynonymsEquivalentQuery.java.

2. Copy and paste the following code into the file.

   The code example contains the following stages:

   • $search stage to search the title field for the word automobile and uses the synonym mapping definition named transportSynonyms to search for words configured as synonyms of the query word automobile in the synonyms source collection named transport_synonyms.

   • $limit stage to limit the output to 10 results.

   • $project stage to exclude all fields except title and add a field named score.

   1
   import java.util.Arrays;
   2
   import static com.mongodb.client.model.Filters.eq;
   3
   import static com.mongodb.client.model.Aggregates.limit;
   4
   import static com.mongodb.client.model.Aggregates.project;
   5
   import static com.mongodb.client.model.Projections.excludeId;
   6
   import static com.mongodb.client.model.Projections.fields;
   7
   import static com.mongodb.client.model.Projections.include;
   8
   import static com.mongodb.client.model.Projections.computed;
   9
   import com.mongodb.client.MongoClient;
   10
   import com.mongodb.client.MongoClients;
   11
   import com.mongodb.client.MongoCollection;
   12
   import com.mongodb.client.MongoDatabase;
   13
   import org.bson.Document;
   14
   15
   public class SynonymsEquivalentQuery {
   16
     public static void main( String[] args ) {
   17
       // define query
   18
       Document agg = new Document("$search",
   19
           new Document("index", "synonyms-tutorial")
   20
           .append("text", 
   21
               new Document("query", "automobile")
   22
               .append("path","title")
   23
               .append("synonyms", "transportSynonyms")));
   24
   25
       // specify connection
   26
       String uri = "<connection-string>";
   27
   28
       // establish connection and set namespace
   29
       try (MongoClient mongoClient = MongoClients.create(uri)) {
   30
         MongoDatabase database = mongoClient.getDatabase("sample_mflix");
   31
         MongoCollection<Document> collection = database.getCollection("movies");
   32
         
   33
   			// run query and print results
   34
         collection.aggregate(Arrays.asList(agg, 
   35
           limit(10), 
   36
           project(fields(excludeId(), include("title"), computed("score", new Document("$meta", "searchScore")))))
   37
         ).forEach(doc -> System.out.println(doc.toJson()));	
   38
       }
   39
     }
   40
   }

   Note

   To run the sample code in your Maven environment, add the following above the import statements in your file.

   package com.mongodb.drivers;

3. Before you run the sample, replace <connection-string> with your Atlas connection string. Ensure that your connection string includes your database user's credentials. To learn more, see Connect via Drivers.

4. Compile and run SynonymsEquivalentQuery.java file.

   javac SynonymsEquivalentQuery.java
   java SynonymsEquivalentQuery

   HIDE OUTPUT

   {"title": "Cars", "score": 4.197734832763672}
   {"title": "Planes, Trains & Automobiles", "score": 3.8511905670166016}
   {"title": "Car Wash", "score": 3.39473032951355}
   {"title": "Used Cars", "score": 3.39473032951355}
   {"title": "Blue Car", "score": 3.39473032951355}
   {"title": "Cars 2", "score": 3.39473032951355}
   {"title": "Stealing Cars", "score": 3.39473032951355}
   {"title": "Cop Car", "score": 3.39473032951355}
   {"title": "The Cars That Eat People", "score": 2.8496146202087402}
   {"title": "Khrustalyov, My Car!", "score": 2.8496146202087402}

   The Atlas Search results contain movies with car and automobile in the title field although the query term is automobile because we configured automobile to be a synonym of car, vehicle, and automobile in the synonyms source collection named sample_synonyms, which is specified in the index for the collection. Atlas Search returns the same results for a search of the words car and vehicle. To test this, replace the value of the query field in the query above with either car or vehicle and run the query.

1. Create a file named SynonymsExplicitQuery.java.

2. Copy and paste the following code into the file.

   The code example contains the following stages:

   • $search stage to search the title field for the word boat and uses the synonym mapping definition named transportSynonyms to search for words configured as synonyms of the query word boat in the synonyms source collection named transport_synonyms.

   • $limit stage to limit the output to 10 results.

   • $project stage to exclude all fields except title and add a field named score.

   1
   import java.util.Arrays;
   2
   import static com.mongodb.client.model.Filters.eq;
   3
   import static com.mongodb.client.model.Aggregates.limit;
   4
   import static com.mongodb.client.model.Aggregates.project;
   5
   import static com.mongodb.client.model.Projections.excludeId;
   6
   import static com.mongodb.client.model.Projections.fields;
   7
   import static com.mongodb.client.model.Projections.include;
   8
   import static com.mongodb.client.model.Projections.computed;
   9
   import com.mongodb.client.MongoClient;
   10
   import com.mongodb.client.MongoClients;
   11
   import com.mongodb.client.MongoCollection;
   12
   import com.mongodb.client.MongoDatabase;
   13
   import org.bson.Document;
   14
   15
   public class SynonymsExplicitQuery {
   16
     public static void main( String[] args ) {
   17
       // define query
   18
       Document agg = new Document("$search",
   19
           new Document("index", "synonyms-tutorial")
   20
           .append("text", 
   21
               new Document("query", "boat")
   22
               .append("path","title")
   23
               .append("synonyms", "transportSynonyms")));
   24
   25
       // specify connection
   26
       String uri = "<connection-string>";
   27
   28
       // establish connection and set namespace
   29
       try (MongoClient mongoClient = MongoClients.create(uri)) {
   30
         MongoDatabase database = mongoClient.getDatabase("sample_mflix");
   31
         MongoCollection<Document> collection = database.getCollection("movies");
   32
   			
   33
         // run query and print results
   34
         collection.aggregate(Arrays.asList(agg, 
   35
           limit(10), 
   36
           project(fields(excludeId(), include("title"), computed("score", new Document("$meta", "searchScore")))))
   37
         ).forEach(doc -> System.out.println(doc.toJson()));	
   38
       }
   39
     }
   40
   }

   Note

   To run the sample code in your Maven environment, add the following above the import statements in your file.

   package com.mongodb.drivers;

3. Before you run the sample, replace <connection-string> with your Atlas connection string. Ensure that your connection string includes your database user's credentials. To learn more, see Connect via Drivers.

4. Compile and run SynonymsExplicitQuery.java file.

   javac SynonymsExplicitQuery.java
   java SynonymsExplicitQuery

   HIDE OUTPUT

   {"title": "Vessel", "score": 5.373150825500488}
   {"title": "Boats", "score": 4.589139938354492}
   {"title": "And the Ship Sails On", "score": 4.3452959060668945}
   {"title": "Broken Vessels", "score": 4.3452959060668945}
   {"title": "Sailing to Paradise", "score": 4.3452959060668945}
   {"title": "Boat People", "score": 3.711261749267578}
   {"title": "Boat Trip", "score": 3.711261749267578}
   {"title": "Three Men in a Boat", "score": 3.1153182983398438}
   {"title": "The Glass Bottom Boat", "score": 3.1153182983398438}
   {"title": "Jack Goes Boating", "score": 3.1153182983398438}

   The Atlas Search results contain movies with boat, vessel, and sail in the title field because we configured boat, vessel, and sail to be synonyms of boat in the synonyms source collection named sample_synonyms, which is specified in the index for the collection.

   Atlas Search returns the following documents only for a search of the word vessel in the results:

   { "title" : "Vessel", "score" : 5.373150825500488 }
   { "title" : "Broken Vessels", "score" : 4.3452959060668945 }

   Atlas Search doesn't include documents with either boat or sail in the title field in the results because we didn't configure vessel to be a synonym of either boat or sail in the synonyms source collection. To test this, replace the value of the query field in the query above with vessel and run the query again.

   Similarly, Atlas Search returns the following documents only in the results for a search of the term sail:

   { "title" : "And the Ship Sails On", "score" : 4.3452959060668945 }
   { "title" : "Sailing to Paradise", "score" : 4.3452959060668945 }

   Atlas Search doesn't include documents with either boat or vessel in the title field in the results because we didn't configure sail to be a synonym of either boat or vessel in the synonyms source collection. To test this example, replace the value of the query field in the query above with sail and run the query again.