Atlasクラスターのオンラインアーカイブ作成
指定されたクラスター内のコレクションのオンライン アーカイブを作成します。
M10 以上のクラスターのオンラインアーカイブを作成できます。
オンライン アーカイブの詳細については、 https://www.mongodb.com/ja-jp/docs/atlas/online-archive/manage-online-archive/ をご覧ください。
このコマンドを使用するには、プロジェクト データアクセス管理者ロールのユーザー アカウントまたは API キーで認証する必要があります。
構文
atlas clusters onlineArchives create [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
--archiveAfter | 整数 | false | クラスター データをアーカイブする日数。 --file と相互に排他的。 |
--clusterName | string | true | クラスターの名前。 詳細については、 https://docub.mongodb.org/core/create-cluster-api を参照してください。 |
--collection | string | false | コレクション名。 --file と相互に排他的。 |
--dateField | string | false | ドキュメントのすでにインデックス作成された日付フィールドの名前。 --file と相互に排他的。 |
--dateFormat | string | false | 日付フィールドの日付形式。 有効な値は、"ISODATE"、"EPOCH_SECONDS"、"EPOCH_MILLIS"、または "EPOCH_ANANOSECONDS" です。 --file と相互に排他的。 この値のデフォルトは "ISODATE" です。 |
--db | string | false | データベースの名前。 --file と相互に排他的。 |
--expireAfterDays | 整数 | false | 削除のドキュメントを指定するために日付基準で使用される日数。 --file と相互に排他的。 |
--file | string | false | オンライン アーカイブ設定を定義する任意の JSON 構成ファイルへのパス。 Atlas CLI 用のオンライン アーカイブ構成ファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-json-online-archive-config を参照してください。 --db、-collection、-dateField、-dateFormat、-archiveAfter、-expireAfterDays、-- partitionと相互に排他的です。 |
-h, --help | false | 作成用ヘルプ | |
-o, --output | string | false | 出力形式。 有効な値は、 JSON 、 JSON -path、go-template、または go-template-file です。 完全な出力を表示するには、 -o JSONオプションを使用します。 |
--partition | string | false | データのパーティション分割に使用するフィールド。 頻繁にクエリされるフィールドをカンマで区切って最大 2 つ指定できます。 --file と相互に排他的。 |
--projectId | string | false | 使用するプロジェクトを識別する 16 進数の string。 このオプションは、構成ファイルまたは環境変数の 設定を上書きします。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 https://docub.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