Atlas 部署搜索索引创建
为指定部署创建搜索索引。
语法
命令语法
atlas deployments search indexes create [indexName] [options]
参数
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
indexName | 字符串 | false | 索引名称。 |
选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
--collection | 字符串 | false | 集合的名称。 与 --文件 互斥。 |
--db | 字符串 | false | 数据库名称。 与 --文件 互斥。 |
--deploymentName | 字符串 | false | 部署的名称。 |
-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。 与 --db、--collection 互斥。 |
-h,--help | false | 创建帮助 | |
-o, --output | 字符串 | false | 输出格式。 有效值为 json、json-path、go-template 或 go-template-file。 要查看完整输出,请使用 -o json 选项。 |
--password | 字符串 | false | 用户的密码。 |
--projectId | 字符串 | false | 标识要使用的项目的十六进制字符串。 此选项会覆盖配置文件或环境变量中的设置。 |
--type | 字符串 | false | 部署类型。 有效值为 ATLAS 或 LOCAL。 |
--username | 字符串 | false | 用于向 MongoDB 进行身份验证的用户名。 |
-w, --watch | false | 该标志指示是否监视命令,直到命令完成执行或监视超时。 要设置手表超时的时间,请使用 --watchTimeout 选项。 | |
--watchTimeout | uint | false | 手表超时之前的时间(以秒为单位)。 监视超时后,CLI 将不再监视该命令。 |
继承选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
-P, --profile | 字符串 | false | 要从配置文件中使用的配置文件的名称。 要了解 Atlas CLI 的配置文件,请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |