db.collection.updateSearchIndex()
On this page
Definition
New in version 6.0.7.
Updates an existing Atlas Search index.
Important
This command can only be run on a deployment hosted on MongoDB Atlas, and requires an Atlas cluster tier of at least M10.
Important
mongosh Method
This page documents a mongosh
method. This is not
the documentation for database commands or language-specific drivers,
such as Node.js.
For the database command, see the updateSearchIndex
command.
For MongoDB API drivers, refer to the language-specific MongoDB driver documentation.
Syntax
Command syntax:
db.<collection>.updateSearchIndex( <name>, { <definition> } )
Command Fields
updateSearchIndex()
takes these fields:
Field | Type | Necessity | Description |
---|---|---|---|
name | string | Required | Name of the search index to update. |
definition | document | Required | Document that describes the updated index definition. For details
on definition syntax, see
Search Index Definition Syntax. |
Search Index Definition Syntax
The search index definition takes the following fields:
{ analyzer: "<analyzer-for-index>", searchAnalyzer: "<analyzer-for-query>", mappings: { dynamic: <boolean>, fields: { <field-definition> } }, analyzers: [ <custom-analyzer> ], storedSource: <boolean> | { <stored-source-definition> }, synonyms: [ { name: "<synonym-mapping-name>", source: { collection: "<source-collection-name>" }, analyzer: "<synonym-mapping-analyzer>" } ] }
Field | Type | Necessity | Description |
---|---|---|---|
analyzer | string | Optional | Specifies the analyzer to apply to string fields when indexing. If you omit this field, the index uses the standard analyzer. |
searchAnalyzer | string | Optional | Specifies the analyzer to apply to query text before the text is searched. If you omit this field, the index uses the same analyzer specified
in the If you omit both the |
mappings | object | Optional | Specifies how to index fields on different paths for this index. |
mappings.dynamic | boolean | Optional | Enables or disables dynamic field mapping for this index. If set to If set to If omitted, defaults to |
mappings.fields | document | Conditional | Required only if dynamic mapping is disabled. Specifies the fields to index. To learn more, see Define Field Mappings. |
analyzers | array | Optional | Specifies the Custom Analyzers to use in this index. |
storedSource | boolean or Stored Source Definition | Optional | Specifies document fields to store for queries performed using the returnedStoredSource option. You can store fields of all Data Types on Atlas Search.
The
If omitted, defaults to To learn more, see Define Stored Source Fields in Your Atlas Search Index. |
synonyms | array of Synonym Mapping Definitions | Optional | Specifies synonym mappings to use in your index. Configuring synonyms allows you to you index and search for words that have the same or a similar meaning. To learn more, see Define Synonym Mappings in Your Atlas Search Index. |
Behavior
updateSearchIndex()
triggers an index build with the new index
definition. There may be a delay between when you receive a response
from the command and when the updated index is ready.
The old index definition can still support queries while the new index
is being built. Once the new index finishes building, the old index is
no longer usable. To see the status of your search indexes, use the
$listSearchIndexes
aggregation stage.
Access Control
If your deployment enforces access control, the user running
updateSearchIndex()
must have the updateSearchIndex
privilege
action on the database or collection:
{ resource: { db : <database>, collection: <collection> }, actions: [ "updateSearchIndex" ] }
The built-in readWrite
and restore
roles provide
the updateSearchIndex
privilege. The following example grants the
readWrite
role on the qa
database:
db.grantRolesToUser( "<user>", [ { role: "readWrite", db: "qa" } ] )
Example
The following example creates a new Atlas Search index and then updates that index.
Create a search index named
searchIndex01
on themovies
collection:db.movies.createSearchIndex( "searchIndex01", { mappings: { dynamic: true }, storedSource: { exclude: [ "imdb.rating" ] } } ) Update the
searchIndex01
index:db.movies.updateSearchIndex( "searchIndex01", { mappings: { dynamic: true }, storedSource: { exclude: [ "movies" ] } } )