db.collection.updateSearchIndex() (mongosh method方法)

Definition定义

db.collection.updateSearchIndex()

Updates an existing MongoDB Search index or Vector Search index.更新现有的MongoDB搜索索引或矢量搜索索引。

Compatibility兼容性

This method is available in deployments hosted in the following environments:此方法在以下环境中托管的部署中可用：

• MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud：云中MongoDB部署的完全托管服务

Syntax语法

Command syntax:命令语法：

db.<collection>.updateSearchIndex(
   <name>,
   {
      <definition>
   }
)

Command Fields命令字段

updateSearchIndex() takes these 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>"
   } ]
}

{
  "fields": [
    {
      "type": "vector" | "filter",
      "path": "<field-to-index>",
      "numDimensions": <number-of-dimensions>,
      "similarity": "euclidean" | "cosine" | "dotProduct"
    }
  ]
}

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.updateSearchIndex()使用新的索引定义触发索引构建。从收到命令的响应到更新的索引准备就绪之间可能会有延迟。

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.在构建新索引时，旧的索引定义仍然可以支持查询。一旦新索引构建完成，旧索引就不再可用。要查看搜索索引的状态，请使用$listSearchIndexes聚合阶段。

Access Control访问控制

If your deployment enforces access control, the user running updateSearchIndex() must have the updateSearchIndex privilege action on the database or collection:如果部署强制执行访问控制，则运行updateSearchIndex()的用户必须对数据库或集合具有updateSearchIndex权限操作：

{
   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:内置的readWrite和restore角色提供updateSearchIndex权限。以下示例授予qa数据库上的readWrite角色：

db.grantRolesToUser(
   "<user>",
   [ { role: "readWrite", db: "qa" } ]
)

Example示例

The following example creates a new MongoDB Search index and then updates that index.以下示例创建一个新的MongoDB搜索索引，然后更新该索引。

1. Create a search index named searchIndex01 on the movies collection:在movies集合上创建一个名为searchIndex01的搜索索引：

   db.movies.createSearchIndex(
      "searchIndex01",
      {
         mappings: { dynamic: true },
         storedSource: {
            exclude: [ "imdb.rating" ]
         }
      }
   )

2. Update the searchIndex01 index:更新searchIndex01索引：

   db.movies.updateSearchIndex(
      "searchIndex01",
      {
         mappings: { dynamic: true },
         storedSource: {
            exclude: [ "movies" ]
         }
      }
   )