atlas clusters onlineArchives create
为指定的集群中的collection创建Atlas Online Archive。
您可以为 M10 或更大的集群创建在线存档。
要了解有关在线存档的更多信息,请参阅 https://www.mongodb.com/zh-cn/docs/atlas/online-archive/manage-online-archive/。
要使用此命令,您必须使用具有项目数据访问管理员角色的用户帐户或 API 密钥进行身份验证。
语法
命令语法
atlas clusters onlineArchives create [options]
选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
--archiveAfter | int | false | 存档集群数据的天数。 与 --文件 互斥。 |
--clusterName | 字符串 | true | 集群名称。 要了解更多信息,请参阅 https://dochub.mongodb.org/core/create-cluster-api。 |
--collection | 字符串 | false | 集合的名称。 与 --文件 互斥。 |
--dateField | 字符串 | false | 文档中已建立索引的日期字段的名称。 与 --文件 互斥。 |
--dateFormat | 字符串 | false | 日期字段的日期格式。有效值为 "ISODATE"、"EPOCH_SECONDS"、"EPOCH_MILLIS" 或 "EPOCH_NANOSECONDS"。 与 --file 互斥。 此值默认为“ISODATE”。 |
--db | 字符串 | false | 数据库名称。 与 --文件 互斥。 |
--expireAfterDays | int | false | 指定删除文档的日期条件中使用的天数。 与 --文件 互斥。 |
--file | 字符串 | false | JSON定义Atlas Online Archive 设置的可选 配置文件的路径。要了解有关Atlas Online Archive 的Atlas CLI 配置文件的更多信息,请参阅 https://dochub.mongodb.org/core/atlas-cli-json-online-archive-config。 与 --db、--collection、--dateField、--dateFormat、--archiveAfter、--expireAfterDays、--partition 互斥。 |
-h,--help | false | 创建帮助 | |
-o, --output | 字符串 | false | 输出格式。 有效值为 json、json-path、go-template 或 go-template-file。 要查看完整输出,请使用 -o json 选项。 |
--partition | 字符串 | false | 用于对数据进行分区的字段。 您最多可以指定两个经常查询的字段,用逗号分隔。 与 --文件 互斥。 |
--projectId | 字符串 | false | 标识要使用的项目的十六进制字符串。 此选项会覆盖配置文件或环境变量中的设置。 |
继承选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
-P, --profile | 字符串 | false | 要从配置文件中使用的配置文件的名称。 要了解 Atlas CLI 的配置文件,请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |
示例
# Create an online archive for the sample_mflix.movies collection in a cluster named myTestCluster when the current date is greater than the value of released date plus 2 days: atlas clusters onlineArchive create --clusterName myTestCluster --db sample_mflix --collection movies --dateField released --archiveAfter 2 --output json
# Create an online archive for the sample_mflix.movies collection in a cluster named myTestCluster using a profile named egAtlasProfile when the current date is greater than the value of the released date plus 2 days. Data is partitioned based on the title field, year field, and released field from the documents in the collection: atlas clusters onlineArchive create --clusterName myTestCluster --db sample_mflix --collection movies --dateField released --archiveAfter 2 --partition title,year --output json -P egAtlasProfile