db.createCollection()（mongosh方法）

capped

布尔

可选。要创建固定大小集合，请将该字段设为 true。如果将该字段设为 true，则还须在 size 字段中设置最大大小。

timeseries.timeField

字符串

创建时间序列集合时需要。包含每个时间序列文档中日期的字段的名称。时间序列集合中的文档必须具有有效 BSON 日期，以作为 timeField 的值。

timeseries.metaField

字符串

可选.包含每个时间序列文档中元数据的字段的名称。指定字段中的元数据标记一系列独一无二的文档。元数据应该很少改变（如果有的话）。

指定字段的名称不能是 _id，也不能与 timeseries.timeField 相同。 该字段可为除数组之外的任意类型。

timeseries.granularity

字符串

可选，如果设置 bucketRoundingSeconds 和 bucketMaxSpanSeconds，请勿使用。可能的值为 seconds（默认值）、minutes 和 hours。

将 granularity 设置为与连续传入的时间戳之间的时间最匹配的值。通过优化 MongoDB 在集合中内部存储数据的方式，可以提高性能。

有关粒度和桶间隔的更多信息，请参阅设置时间序列数据的粒度。

timeseries.bucketMaxSpanSeconds

整型

可选，与 bucketRoundingSeconds 一起使用从而作为 granularity 的替代方案。设置同一数据桶中不同时间戳之间的最大间隔时间。可能的值为 1-31536000。如果设置 bucketMaxSpanSeconds，则须将 bucketRoundingSeconds 设为同一值。

要降级到 MongoDB 6.3 以下，必须修改集合以使用相应的 granularity 值，或者删除该集合。有关详细信息，请参阅 collMod。

timeseries.bucketRoundingSeconds

整型

可选，与bucketMaxSpanSeconds一起使用，作为granularity的替代。设置 MongoDB 设定新存储桶的最小时间戳时向下舍入的秒数。必须等于bucketMaxSpanSeconds。

例如，将两个参数设置为 1800 会将新的存储桶向下舍入到最近的 30 分钟。如果时间为 2023-03-27T18:24:35Z 的文档不适合现有存储桶，MongoDB 将创建一个新存储桶，其最小时间为 2023-03-27T18:00:00Z，最大时间为 2023-03-27T18:30:00Z。

expireAfterSeconds

数字

可选。指定时间序列集合或集群化集合中的文档过期的秒数。MongoDB 将自动删除过期文档。

对于集群化集合，会根据集群索引键 _id 自动删除文档，并且值必须是日期类型。请参阅 TTL 索引。

clusteredIndex

文档

从 MongoDB 5.3开始，您可以创建具有集群化索引的集合。集群化索引与集合存储在同一个 WiredTiger 文件中。得到的集合称为集群化集合。

clusteredIndex 字段采用以下语法：

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

key

必需。集群索引键字段。必须设置为 { _id: 1 }。_id 字段的默认值是自动生成的唯一对象标识符，您也可以设置自己的集群索引键值。

unique

必需。必须设置为 true。唯一索引表示集合不会接受集群索引键值与索引中现有值匹配的文档插入或更新。

name

可选。唯一标识集群索引的名称。

changeStreamPreAndPostImages

文档

可选。

从 MongoDB 6.0 开始，可使用变更流事件来输出更改前后的文档版本（文档前映像和后映像）：

• 前映像是指被替换、更新或删除之前的文档。已插入的文档没有前映像。

• 后图像是插入、替换或更新后的文档。 已删除的文档没有后图像。

• Enable changeStreamPreAndPostImages for a collection using db.createCollection(), create, or collMod. For example, when using the collMod command:

  db.runCommand( {
     collMod: <collection>,
     changeStreamPreAndPostImages: { enabled: true }
  } )

To check the current changeStreamPreAndPostImages setting for a collection, run db.getCollectionInfos():

db.getCollectionInfos( {
  name: "<collection>"
} )[0].options.changeStreamPreAndPostImages

{ changeStreamPreAndPostImages: { enabled: true } }

changeStreamPreAndPostImages 通过以下语法实现：

changeStreamPreAndPostImages: {
   enabled: <boolean>
}

要启用集合的变更流前图像和后图像，请将 enabled 设定为 true。

有关变更流输出的完整示例，请参阅使用文档前像和后像的变更流。

如需了解有关本页的 db.createCollection() 示例，请参阅为文档创建具有变更流前后图像的集合。

size

数字

可选。指定固定大小集合的最大大小（以字节为单位）。一旦固定大小集合达到其最大大小，MongoDB 就会删除旧文档，为新文档腾出空间。对于固定大小集合，size 字段为必需项，对于其他集合，则忽略该字段。

max

数字

可选。固定大小集合中允许的最大文档数。size限制优先于此限制。如果固定大小集合在达到最大文档数之前达到size限制，则 MongoDB 将删除旧文档。如果您希望使用max限制，请确保固定大小集合所需的size限制足以包含最大数量的文档。

storageEngine

文档

可选。仅适用于 WiredTiger 存储引擎。

指定基于每个集合的存储引擎配置。storageEngine 选项的值采用以下形式：

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

在复制过程中，对创建集合时指定的存储引擎配置进行验证并记录到 oplog 中，以支持节点使用不同存储引擎的副本集。

从MongoDB7.2 开始，当您使用 创建集合时，无法指定wiredTiger db.createCollection()存储引擎加密选项。要为WiredTiger存储引擎配置加密，请参阅静态加密。

有关详细信息，请参见指定存储引擎选项。

validator

文档

可选。为集合指定验证规则或表达式。

validator 选项采用指定验证规则或表达式的文档。可以使用与该查询操作符相同的操作符来指定表达式，但 $near、$nearSphere、$text 和 $where 除外。

要了解如何使用模式验证创建集合，请参阅指定 JSON 模式验证。

validationLevel

字符串

可选。确定 MongoDB 在更新期间将验证规则应用于现有文档的严格程度。

"off"

不对插入或更新进行验证。

"strict"

默认将验证规则应用于所有插入和所有更新。

"moderate"

将验证规则应用于现有有效文档的插入和更新。请勿将规则应用于现有无效文档的更新。

要查看使用 validationLevel 的示例，请参阅为现有文档指定验证级别。

validationAction

字符串

可选。 确定是对无效文档上的error，还是仅对违规行为的warn，但允许插入无效文档。

重要提示：文档验证仅适用于由 validationLevel 确定的文档。

要查看使用 validationAction 的示例，请参阅选择如何处理无效文档。

indexOptionDefaults

文档

可选。 指定集合中索引的默认配置。

indexOptionDefaults 选项接受 storageEngine 文档，该文档应采用以下形式：

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

在复制过程中，对创建索引时指定的存储引擎配置进行验证并记录到 oplog 中，以支持其成员使用不同存储引擎的副本集。

viewOn

字符串

要从中创建视图的源集合或视图的名称。有关详细信息，请参阅db.createView() 。

pipeline

阵列

由聚合管道阶段组成的数组。db.createView()将指定的 pipeline 应用于 viewOn 集合或视图，从而创建视图。有关详细信息，请参阅db.createView()。

collation

文档

为集合指定默认排序规则。

排序规则允许用户为字符串比较指定特定于语言的规则，例如字母大小写和重音符号规则。

排序规则选项的语法如下：

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

指定排序规则时，locale 字段为必填字段；所有其他排序规则字段均为可选字段。有关字段的说明，请参阅排序规则文档。

如果在集合级别指定排序规则：

• 除非索引创建操作显式指定其他排序规则，否则会用该排序规则创建此集合上的索引。

• 除非明确指定其他排序规则，否则对该集合的操作使用集合的默认排序规则。

  您不能为一个操作指定多个排序规则。例如，您不能为每个字段指定不同的排序规则，或者如果执行带排序的查找，则不能使用一种排序规则进行查找而另一种排序规则进行排序。

如果没有为收集或操作指定排序规则，MongoDB 将使用先前版本中使用的简单二进制比较来进行字符串比较。

对于集合，只能在创建集合时指定排序规则。设置后，无法修改集合的默认排序规则。

有关示例，请参阅指定排序规则。

writeConcern

文档

可选。表达该操作的写关注的文档。省略以使用默认的写关注。

When issued on a sharded cluster, mongos converts the write concern of the create command and its helper db.createCollection() to "majority".

encryptedFields

文档

可选。为正在创建的集合配置 Queryable Encryption 的文档。

要在集合中使用加密字段，请指定新的配置选项。您必须拥有创建和修改集合的权限，才能在集合创建期间设立此配置。创建集合后，encryptedFields 值就不可变。

配置包括字段列表及其对应的键标识符、类型和支持的查询。

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

有关创建加密集合的助手，请参阅 db.createEncryptedCollection()。

有关详细信息，请参阅Queryable Encryption教程。