Docs 菜单
Docs 主页
/ /
Atlas CLI
/ / / /

atlas clusters search 索引更新

在此页面上

  • 语法
  • 参数
  • 选项
  • 继承选项
  • 输出
  • 示例

修改集群的搜索索引。

要使用此命令,您必须使用具有项目数据访问管理员角色的用户帐户或 API 密钥进行身份验证。

命令语法
atlas clusters search indexes update <indexId> [options]
名称
类型
必需
说明
indexId
字符串
true
索引的 ID。
名称
类型
必需
说明
--clusterName
字符串
true
集群名称。 要了解详情,请参阅 https://dochub.mongodb.org/core/create-cluster-api。
-f, --file
字符串
false
要使用的 JSON 索引配置文件的名称。 要了解 Atlas Search 和 Atlas Vector Search 索引配置文件,请参阅 https://dochub.mongodb.org/core/search-index-config-file-atlascli 。要了解可在配置文件中定义的 Atlas Search 索引语法和选项,请参阅 https://dochub.mongodb.org/core/index-definitions-fts 。要了解可在配置文件中定义的 Atlas Vector Search 索引语法和选项,请参阅 https://dochub.mongodb.org/core/index-definition-avs。
-h,--help
false
更新帮助
-o, --output
字符串
false
输出格式。 有效值为 json、json-path、go-template 或 go-template-file。 要查看完整输出,请使用 -o json 选项。
--projectId
字符串
false
标识要使用的项目的十六进制字符串。 此选项会覆盖配置文件或环境变量中的设置。
名称
类型
必需
说明
-P, --profile
字符串
false
要从配置文件中使用的配置文件的名称。 要了解 Atlas CLI 的配置文件,请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。

如果命令成功,CLI 将返回类似于以下示例的输出。 括号中的值代表您的价值观。

Index <Name> updated.
# Modify the search index with the ID 5f2099cd683fc55fbb30bef6 for the cluster named myCluster:
atlas clusters search indexes update 5f2099cd683fc55fbb30bef6 --clusterName myCluster --output json

后退

名单