Docs Menu

atlas clusters onlineArchives create

On this page

  • Syntax
  • Options
  • Inherited Options

Create an online archive for a cluster.

atlas clusters onlineArchives create [options]
Name
Type
Required
Description
--archiveAfter
float
true
Number of days that specifies the age limit for the data in the live Atlas cluster.
--clusterName
string
true
Name of the cluster.
--collection
string
true
Collection name.
--dateField
string
true
Name of an already indexed date field from the documents.
--dateFormat
string
false
Date format for the date field. Valid values are ISODATE, EPOCH_SECONDS, EPOCH_MILLIS, or EPOCH_NANOSECONDS. This value defaults to "ISODATE".
--db
string
true
Database name.
-h, --help
false
help for create
-o, --output
string
false
Output format. Valid values are json, json-path, go-template, or go-template-file.
--partition
strings
false
Fields to use to partition data. You can specify up to two frequently queried fields to use for partitioning data.
--projectId
string
false
Project ID to use. Overrides the settings in the configuration file or environment variable.
Name
Type
Required
Description
-P, --profile
string
false
Profile to use from your configuration file.
What is MongoDB Atlas? →
Give Feedback
© 2022 MongoDB, Inc.

About

  • Careers
  • Investor Relations
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2022 MongoDB, Inc.