updateSearchIndex (database command数据库命令)

Definition定义

updateSearchIndex

Updates an existing MongoDB Search index.更新现有的MongoDB搜索索引。

The mongosh method db.collection.updateSearchIndex() provides a wrapper around the updateSearchIndex database command.mongosh方法db.collection.updateSearchIndex()为updateSearchIndex数据库命令提供了一个包装器。

Syntax语法

Command syntax:命令语法：

db.runCommand(
   {
      updateSearchIndex: "<collection name>",
      id: "<index Id>",
      name: "<index name>",
      type: "search | vectorSearch",
      definition: {
         /* search index definition fields */
      }
   }
)

Command Fields命令字段

The updateSearchIndex command takes the following fields:updateSearchIndex命令包含以下字段：

{
   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>"
   } ]
}

Behavior行为

The updateSearchIndex command 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 the updateSearchIndex command 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" } ]
)

Output输出

A successful updateSearchIndex command returns the following:成功的updateSearchIndex命令返回以下内容：

{
   ok: 1
}

Example示例

The following example updates a search index named searchIndex01 on the contacts collection:以下示例更新contacts集合上名为searchIndex01的搜索索引：

db.runCommand( {
   updateSearchIndex: "contacts",
   name: "searchIndex01",
   definition:
      {
         mappings: { dynamic: true },
         storedSource: {
            exclude: [ "directors", "imdb.rating" ]
         }
      }
} )