Navigation

text

The text operator performs a full-text search using the analyzer specified in the index configuration. If you do not specify an analyzer, the default standard analyzer is used.

text has the following syntax:

{
$search: {
"index": <index name>, // optional, defaults to "default"
"text": {
"query": "<search-string>",
"path": "<field-to-search>",
"fuzzy": <options>,
"score": <options>
}
}
}
Field
Type
Description
Required?
query
string or array of strings
The string or strings to search for. If there are multiple terms in a string, Atlas Search also looks for a match for each term in the string separately.
yes
path
string or array of strings
The indexed field or fields to search. You can also specify a wildcard path to search. See path construction for more information.
yes
fuzzy
object
Enable fuzzy search. Find strings which are similar to the search term or terms.
no
fuzzy.maxEdits
integer
Maximum number of single-character edits required to match the specified search term. Value can be 1 or 2. The default value is 2. Uses Levenshtein distance.
no
fuzzy.prefixLength
integer
Number of characters at the beginning of each term in the result that must exactly match. The default value is 0.
no
fuzzy.maxExpansions
integer
The maximum number of variations to generate and search for. This limit applies on a per-token basis. The default value is 50.
no
score
object

The score assigned to matching search term results. Use one of the following options to modify the score:

  • boost: multiply the result score by the given number.
  • constant: replace the result score with the given number.
no

The following examples use the movies collection in the sample_mflix database. If you have the sample dataset on your cluster, you can create the Atlas Search index on the title field and run the queries on your cluster. The Tutorial: Create and Query an Atlas Search Index contains instructions for loading the sample dataset, creating an index definition, and running Atlas Search queries.

The following Atlas Search example uses the text operator to search the title field in the movies collection for the term surfer.

Example

The following query searches the title field for the term surfer. It includes a $project stage to:

  • Exclude all fields except title
  • Add a field named score
db.movies.aggregate([
{
$search: {
"text": {
"path": "title",
"query": "surfer"
}
}
},
{
$project: {
"_id": 0,
"title": 1,
score: { $meta: "searchScore" }
}
}
])

The above query returns the following results:

{ "title" : "Soul Surfer", "score" : 4.572484970092773 }
{ "title" : "Little Surfer Girl", "score" : 3.9323642253875732 }
{ "title" : "Fantastic 4: Rise of the Silver Surfer", "score" : 2.520784616470337 }

The following examples use the text operator to search the title field in the movies collection for terms that are within one character variation of each term in the query phrase naw yark.

Give Feedback

On this page

  • Definition
  • Syntax
  • Fields
  • Examples