db.createCollection()

オプション。各時系列ドキュメントのメタデータを含むフィールドの名前。指定されたフィールドのメタデータは、ユニークな一連のドキュメントにラベルを付けるために使用されるデータでなければなりません。メタデータは、変更されることはほとんどありません。

指定フィールドの名前を _id にすることはできません。また、timeseries.timeField と同じにすることもできません。フィールドは配列以外のすべてのタイプに設定できます。

任意。bucketRoundingSeconds と bucketMaxSpanSeconds を設定する場合は使用しないでください。指定できる値は、seconds（デフォルト）、minutes、hours です。

granularity を、連続する受信タイムスタンプ間の時間に最も近い値に設定します。これにより、MongoDB がコレクションの内部にデータを保存する方法が最適化され、パフォーマンスが向上します。

粒度とバケット間隔の詳細については、「時系列データの粒度の設定」を参照してください。

任意。granularity の代わりに、bucketRoundingSeconds と併用します。同じバケット内のタイムスタンプ間の最大時間を設定します。1～31536000 の値を設定できます。bucketMaxSpanSeconds を設定する場合は、bucketRoundingSeconds を同じ値に設定する必要があります。

MongoDB 6.3 以前のバージョンにダウングレードするには、対応する granularity 値を使用するようにコレクションを変更するか、コレクションを削除する必要があります。 詳細については、「collMod」を参照してください。

任意。granularity の代わりに、bucketMaxSpanSeconds と併用します。MongoDB が新しいバケットの最小タイムスタンプを設定するときに切り捨てる秒数を設定します。bucketMaxSpanSeconds と等しくなければなりません。

たとえば、両方のパラメーターを 1800 に設定すると、新しいバケットは 30 分単位で切り捨てられます。2023-03-27T18:24:35Z という時間が設定されたドキュメントが既存バケットに収まらない場合、MongoDB は最小時間が 2023-03-27T18:00:00Z で、最大時間が 2023-03-27T18:30:00Z の新しいバケットを作成します。

任意。時系列コレクションまたはクラスター化されたコレクションのドキュメントが期限切れになる秒数を指定します。MongoDB は期限切れのドキュメントを自動的に削除します。

クラスター化されたコレクションでは、ドキュメントはクラスター化されたインデックス キー _id に基づいて自動的に削除されます。また、値は date 型である必要があります。詳細は、「TTL インデックス」を参照してください。

MongoDB 5.3 以降、クラスター インデックス 付きのコレクションを作成できます。クラスター インデックスは、コレクション同様、WiredTiger ファイルに保存されます。結果として得られるコレクションは、クラスター化されたコレクションと呼ばれます。

clusteredIndex フィールドの構文は次のとおりです。

clusteredIndex: {
   key: <object>,
   unique: <boolean>,
   name: <string>
}

key

必須。クラスター化されたインデックス キー フィールド。{ _id: 1 } に設定する必要があります。_id フィールドのデフォルト値は自動生成されるユニークな ObjectId ですが、独自のクラスター化されたインデックス キー値を設定できます。

unique

必須。true に設定する必要があります。ユニークインデックスは、クラスターインデックスキーの値がインデックス内の既存の値と一致する挿入または更新されたドキュメントをコレクションが受け入れないことを示します。

name

任意。クラスター化されたインデックスを一意に識別する名前。

任意。

MongoDB 6.0 以降では、変更ストリーム イベントを使用して、変更前と変更後のドキュメントのバージョン（変更前とイメージと変更後のイメージ）を出力できます。

• 変更前のイメージとは、置換、更新、または削除される前のドキュメントです。挿入されたドキュメントには、変更前のイメージはありません。

• 変更後のイメージとは、挿入、置換、または更新された後のドキュメントです。削除されたドキュメントには、変更後のイメージはありません。

• db.createCollection()、create、または collMod を使用してコレクションで changeStreamPreAndPostImages を有効にします。

changeStreamPreAndPostImages の構文は次のとおりです。

changeStreamPreAndPostImages: {
   enabled: <boolean>
}

コレクションの変更ストリームの事前イメージと事後イメージを有効にするには、enabled を true に設定します。

変更ストリーム出力の完全な例については、「Change Streams とドキュメントの変更前イメージおよび変更後イメージ」を参照してください。

このページのdb.createCollection()の例については、「ドキュメントの変更ストリームの事前イメージと事後イメージを使用したコレクションの作成 」を参照してください。

任意。WiredTiger ストレージエンジンでのみ使用できます。

コレクション作成時に、ユーザーがコレクションごとにストレージエンジンの構成を指定できるようにします。storageEngine オプションの値は、次の形式になります。

{ <storage-engine-name>: <options> }

コレクション作成時に指定されたストレージエンジンの設定は、レプリカセット内で異なるストレージエンジンを使用するノードをサポートするために、複製中に oplog に検証され、ログが記録されます。

MongoDB 7.2 以降（および 7.0.5）では、db.createCollection() でコレクションを作成する場合、wiredTiger ストレージエンジン暗号化オプションは指定できません。WiredTiger ストレージ エンジンで暗号化を構成するには、「保管時の暗号化」を参照してください。

詳細については、「ストレージエンジン オプションの指定」を参照してください。

任意。ユーザーがコレクションの検証ルールまたは式を指定できるようにします。

validator オプションは、検証ルールまたは式を指定するドキュメントを受け取ります。クエリ演算子と同じ演算子を使用して式を指定できます。ただし、$near、$nearSphere、$text、$where は対象外です。

スキーマ検証を使用してコレクションを作成する方法については、「JSON スキーマ検証の指定」を参照してください。

任意。更新中に MongoDB が既存のドキュメントに検証ルールをどの程度厳密に適用するかを決定します。

"off"

挿入またはアップデートの検証は行われません。

"strict"

デフォルト すべての挿入とすべてのアップデートに検証ルールを適用します。

"moderate"

既存の有効なドキュメントの挿入とアップデートに検証ルールを適用します。既存の無効なドキュメントのアップデートにはルールは適用しません。

validationLevel を使用する例については、「既存のドキュメントの検証レベルを指定する」を参照してください。

任意。無効なドキュメントで error を発行するか、違反に関する warn のみに留め、無効なドキュメントを挿入できるようにするかを指定します。

重要: ドキュメントの検証は、validationLevelによって決定されたドキュメントにのみ適用されます。

validationAction の使用例については、「無効なドキュメントの処理方法を選択する」を参照してください。

任意。ユーザーがコレクションの作成時にインデックスのデフォルト構成を指定できるようにします。

indexOptionDefaults オプションは、次の形式をとる storageEngine ドキュメントを受け入れます。

{ <storage-engine-name>: <options> }

インデックスの作成時に指定されたストレージエンジン構成は、異なるストレージエンジンを使用するノードのあるレプリカセットをサポートするために、レプリケーション中に検証され、oplog に記録されます。

コレクションにデフォルトの照合を指定します。

照合を指定すると、大文字・小文字やアクセント記号など、文字列を比較するための言語独自のルールを指定できます。

照合オプションの構文は次のとおりです。

collation: {
   locale: <string>,
   caseLevel: <boolean>,
   caseFirst: <string>,
   strength: <int>,
   numericOrdering: <boolean>,
   alternate: <string>,
   maxVariable: <string>,
   backwards: <boolean>
}

照合を指定する場合、locale フィールドは必須ですが、その他の照合フィールドはすべて任意です。フィールドの説明については、照合ドキュメントを参照してください。

コレクション・レベルで照合を指定すると、次の効果が生じます。

• インデックス作成操作で別の照合順序を明示的に指定しない限り、そのコレクションのインデックスはその照合順序で作成されます。

• そのコレクションに対する操作では、明示的に別の照合順序を指定しない限り、コレクションのデフォルトの照合順序が使用されます。

  1 つの操作に複数の照合は指定できません。たとえば、フィールドごとに異なる照合を指定できません。また、ソートと検索を一度に実行する場合、検索とソートで別の照合を使用できません。

コレクションにも操作にも照合が指定されていない場合、MongoDB では以前のバージョンで使用されていた単純なバイナリ比較によって文字列が比較されます。

コレクションに照合を指定できるのは、コレクションの作成時のみです。コレクションのデフォルトの照合は、一度設定すると変更できません。

例については、「照合の指定 」を参照してください。

任意。操作の書込み保証（write concern）を表現するドキュメント。デフォルトの書込み保証を使用する場合は省略します。

シャーディングされたクラスターで発行すると、mongos は コマンドとそのヘルパーcreate のdb.createCollection() 書込み 保証を"majority" に変換します。