create

string

新しいコレクションまたはビューの名前。「命名制限」を参照してください。既に存在するコレクションまたはビューを作成しようとし、その既存のコレクションまたはビューに対して同一のオプションを指定した場合、アクションは実行されず、成功が返されます。

ブール値

任意。上限付きコレクションを作成するには、true と指定します。true と指定する場合、size フィールドに最大サイズを設定する必要もあります。

string

必須（時系列コレクションの作成時）。各時系列ドキュメントの日付を含むフィールドの名前です。時系列コレクション内のドキュメントには、timeField の値として有効な BSON 日付が必要です。

string

任意。各時系列ドキュメントのメタデータを含むフィールドの名前。指定されたフィールドのメタデータは、一意の時系列ドキュメントにラベルを付けるために使用されるデータでなければなりません。メタデータを変更する必要はめったにありません。指定されたフィールドの名前を _id または timeseries.timeField と同じ名前にはできません。フィールドは任意のデータ型に指定できます。

metaFieldフィールドは任意ですが、メタデータを使用するとクエリの最適化が向上します。 たとえば、MongoDB metaFieldtimeFieldは新しいコレクションの フィールドと フィールドに 複合インデックス を自動的に作成します 。このフィールドに値を指定しない場合、データは時間のみに基づいてバケット化されます。

string

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

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

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

integer

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

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

integer

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

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

integer

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

ドキュメント

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 とドキュメントの変更前イメージおよび変更後イメージ」を参照してください。

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

integer

任意。上限付きコレクションの最大サイズをバイト単位で指定します。MongoDB は、上限付きコレクションが最大サイズに達すると、古いドキュメントを削除して新しいドキュメント用スペースを確保します。size フィールドは、上限付きコレクションに必須であり、他のコレクションでは無視されます。

integer

任意。上限付きコレクションで許可されるドキュメントの最大数。size の制限がこの制限よりも優先されます。上限付きコレクションがドキュメントの最大数に達する前に size の制限に達した場合、MongoDB は古いドキュメントを削除します。max 制限の使用を優先する場合は、上限付きコレクションに必要な size 制限をドキュメントの最大数を十分に超える値に設定してください。

ドキュメント

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

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

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

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

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

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

ドキュメント

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

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

• 検証はアップデートや挿入中に行われます。既存のドキュメントは、変更されるまで検証チェックを受けません。

• admin、local、および config データベース内のコレクションに対してバリデーターを指定することはできません。

• system.* コレクションにバリデーターを指定することはできません。

string

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

"off"

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

"strict"

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

"moderate"

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

string

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

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

"error"

デフォルト ドキュメントは、書込みが行われる前に検証に合格する必要があります。合格していない場合は、書込み操作に失敗します。

"warn"

ドキュメントは検証に合格する必要はありません。ドキュメントがバリデーションに失敗した場合、書込み操作はバリデーションの失敗をログに記録します。

ドキュメント

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

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

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

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

string

ビューを作成するソース・コレクションまたはビューの名前。 名前はコレクションまたはビューの完全な名前空間ではありません。つまり、データベース名が含まれておらず、作成するビューと同じデータベースであることを暗示します。 ソース コレクションと同じデータベースにビューを作成する必要があります。

db.createView() も参照してください。

配列

集計パイプラインステージで構成される配列。create は、指定された pipeline を viewOn コレクションまたはビューに適用してビューを作成します。

ビュー定義pipelineには、$outまたは$mergeステージを含めることはできません。この制限は、$lookupステージまたは$facetステージで使用されるパイプラインなどの埋め込みパイプラインにも適用されます。

ビュー定義はパブリックです。つまり、ビューに対する db.getCollectionInfos() および explain操作には、ビューを定義するパイプラインが含まれます。そのため、ビュー定義で機密性の高いフィールドと値を直接参照することは避けてください。

db.createView() も参照してください。

コレクションまたはビューのデフォルトの照合手順を指定します。

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

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

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() の書込み保証 (write concern)を "majority" に変換します。

ドキュメント

任意。 作成されるコレクションのQueryable Encryptionを構成するドキュメント。

コレクション内の暗号化されたフィールドを使用するには、新しい構成オプションを指定します。この構成を作成または編集するには、コレクションを作成および変更する権限が必要です。

構成には、フィールドとそれに対応するキー識別子、型、およびサポートされているクエリのリストが含まれます。

encryptedFieldsConfig = {
    "fields": [
      {
        "keyId": UUID,                    // required
        "path": String,                   // path to field, required
        "bsonType": "string" | "int" ..., // required
        "queries":                        // optional
        [
          { "queryType": "equality" },
        ]
      }
    ],
    "queryPatterns": [                    // optional
       {"fieldName": queryType, "fieldName": queryType, … }
    ]
}

詳しくは、 「 Queryable Encryptionチュートリアル 」を参照してください。

any

任意。このコマンドに添付するユーザー指定のコメント。設定すると、このコメントは以下の場所にこのコマンドの記録と合わせて表示されます。

• attr.command.cursor.comment フィールド内のmongod ログ メッセージ。

• command.comment フィールドのデータベースプロファイラー出力。

• command.comment フィールドのcurrentOp出力。

コメントには、有効な BSON 型（string, integer, object, array など）を使用できます。