Atlas 集群 indexes create
为项目的指定集群创建滚动索引。
要使用此命令,您必须使用具有项目数据访问管理员角色的用户帐户或 API 密钥进行身份验证。
语法
命令语法
atlas clusters indexes create [indexName] [options]
参数
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
indexName | 字符串 | false | 索引名称。 |
选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
--clusterName | 字符串 | true | 集群名称。 要了解详情,请参阅 https://dochub.mongodb.org/core/create-cluster-api。 |
--collection | 字符串 | false | 集合的名称。 与 --文件 互斥。 |
--db | 字符串 | false | 数据库名称。 与 --文件 互斥。 |
-f, --file | 字符串 | false | 定义索引设置的可选 JSON 配置文件的路径。 与 --db、--collection、--key 互斥。 |
-h,--help | false | 创建帮助 | |
--key | 字符串 | false | 要索引的字段和索引类型,格式如下:字段:类型。 与 --文件 互斥。 |
--projectId | 字符串 | false | 标识要使用的项目的十六进制字符串。 此选项会覆盖配置文件或环境变量中的设置。 |
--sparse | false | 创建稀疏索引的标志。 要了解更多信息,请参阅 https://dochub.mongodb.org/core/index-sparse-manual。 |
继承选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
-P, --profile | 字符串 | false | 要从配置文件中使用的配置文件的名称。 要了解 Atlas CLI 的配置文件,请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |
示例
# Create an index named bedrooms_1 on the listings collection of the realestate database: atlas clusters indexes create bedrooms_1 --clusterName Cluster0 --collection listings --db realestate --key bedrooms:1
# Create a compound index named property_room_bedrooms on the listings collection of the realestate database: atlas clusters indexes create property_room_bedrooms --clusterName Cluster0 --collection listings --db realestate --key property_type:1 --key room_type:1 --key bedrooms:1
# Create an index named my_index from a JSON configuration file named myfile.json: atlas clusters indexes create my_index --clusterName Cluster0 --file file.json