Interface CreateCollectionOptions

Hierarchy

Properties

authdb?: string
autoIndexId?: boolean

Deprecated

Create an index on the _id field of the document. This option is deprecated in MongoDB 3.2+ and will be removed once no longer supported by the server.在文档的_id字段上创建索引。此选项在MongoDB 3.2+中已被弃用,一旦服务器不再支持,将被删除。

bsonRegExp?: boolean

return BSON regular expressions as BSONRegExp instances.将BSON正则表达式作为BSONRegExp实例返回。

Default Value默认值

false

capped?: boolean

Create a capped collection创建封顶集合

changeStreamPreAndPostImages?: {
    enabled: boolean;
}

If set, enables pre-update and post-update document events to be included for any change streams that listen on this collection.如果设置了,则启用为侦听此集合的任何更改流包括更新前和更新后文档事件。

Type declaration

  • enabled: boolean
checkKeys?: boolean

the serializer will check if keys are valid.序列化程序将检查键是否有效。

Default Value

false

A document specifying configuration options for clustered collections. For MongoDB 5.3 and above.指定群集集合的配置选项的文档。适用于MongoDB 5.3及以上版本。

collation?: CollationOptions

Collation排序规则

comment?: unknown

Comment to apply to the operation.要应用于操作的注释。

In server versions pre-4.4, 'comment' must be string. 在4.4之前的服务器版本中,“comment”必须是字符串。 A server error will be thrown if any other type is provided.如果提供了任何其他类型,则会引发服务器错误。

In server versions 4.4 and above, 'comment' can be any valid BSON type.在服务器版本4.4及更高版本中,“comment”可以是任何有效的BSON类型。

dbName?: string
enableUtf8Validation?: boolean

Enable utf8 validation when deserializing BSON documents. Defaults to true.在反序列化BSON文档时启用utf8验证。默认为true

encryptedFields?: Document
expireAfterSeconds?: number

The number of seconds after which a document in a timeseries or clustered collection expires.时间序列或群集集合中的文档过期的秒数。

Specifies the verbosity mode for the explain output.指定解释输出的详细模式。

fieldsAsRaw?: Document

allow to specify if there what fields we wish to return as unserialized raw buffer.允许指定我们希望返回哪些字段作为未序列化的原始缓冲区。

Default Value

null

flags?: number

Available for the MMAPv1 storage engine only to set the usePowerOf2Sizes and the noPadding flag可用于MMAPv1存储引擎,仅用于设置usePowerOf2SizenoPadding标志

ignoreUndefined?: boolean

serialize will not emit undefined fields note that the driver sets this to false序列化不会发出未定义的字段请注意,驱动程序将其设置为false

Default Value

true

indexOptionDefaults?: Document

Allows users to specify a default configuration for indexes when creating a collection允许用户在创建集合时为索引指定默认配置

max?: number

The maximum number of documents in the capped collection封顶集合中的最大文档数

maxTimeMS?: number
noResponse?: boolean
omitReadPreference?: boolean
pipeline?: Document[]

An array that consists of the aggregation pipeline stage. Creates the view by applying the specified pipeline to the viewOn collection or view由聚合管道阶段组成的数组。通过将指定的管道应用于viewOn集合或视图来创建视图

pkFactory?: PkFactory

A primary key factory function for generation of custom _id keys.用于生成自定义_id键的主键工厂函数。

promoteBuffers?: boolean

when deserializing a Binary will return it as a node.js Buffer instance.当反序列化Binary时,它将作为nodejs Buffer实例返回。

Default Value

false

promoteLongs?: boolean

when deserializing a Long will fit it into a Number if it's smaller than 53 bits.当反序列化Long时,如果它小于53位,则将其放入Number中。

Default Value

true

promoteValues?: boolean

when deserializing will promote BSON values to their Node.js closest equivalent types.反序列化时将BSON值提升为其Node.js最接近的等效类型。

Default Value

true

raw?: boolean

Enabling the raw option will return a Node.js Buffer which is allocated using allocUnsafe API.启用raw选项将返回使用allocUnsafe API分配的Node.js缓冲区 See this section from the Node.js Docs here for more detail about what "unsafe" refers to in this context.请参阅Node.js文档中的这一部分,了解有关“不安全”在本文中所指内容的更多详细信息。 If you need to maintain your own editable clone of the bytes returned for an extended life time of the process, it is recommended you allocate your own buffer and clone the contents:如果您需要维护自己的可编辑字节克隆,以延长进程的使用寿命,建议您分配自己的缓冲区并克隆内容:

Example

const raw = await collection.findOne({}, { raw: true });
const myBuffer = Buffer.alloc(raw.byteLength);
myBuffer.set(raw, 0);
// Only save and use `myBuffer` beyond this point

Remarks

Please note there is a known limitation where this option cannot be used at the MongoClient level (see NODE-3946).请注意,有一个已知的限制,即此选项不能在MongoClient级别使用(请参阅NODE-3946)。 It does correctly work at Db, Collection, and per operation the same as other BSON options work.它在DbCollection和每个操作中都能正常工作,与其他BSON选项的工作方式相同。

readConcern?: ReadConcernLike

Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)指定集合的读取关注和级别。(仅支持MongoDB 3.2或更高版本)

readPreference?: ReadPreferenceLike

The preferred read preference (ReadPreference.primary, ReadPreference.primary_preferred, ReadPreference.secondary, ReadPreference.secondary_preferred, ReadPreference.nearest).首选读取首选项(ReadPreference.primaryReadPreference.primary_preferredReadPreference.secondaryReadPreference.secondary_preferredReadPreference.nearest)。

retryWrites?: boolean

Should retry failed writes应重试失败的写入

serializeFunctions?: boolean

serialize the javascript functions序列化javascript函数

Default Value

false

session?: ClientSession

Specify ClientSession for this command为此命令指定ClientSession

size?: number

The size of the capped collection in bytes带上限的集合的大小(以字节为单位)

storageEngine?: Document

Allows users to specify configuration to the storage engine on a per-collection basis when creating a collection允许用户在创建集合时按每个集合指定存储引擎的配置

A document specifying configuration options for timeseries collections.指定时间序列集合的配置选项的文档。

useBigInt64?: boolean

when deserializing a Long return as a BigInt.当将Long返回反序列化为BigInt时。

Default Value

false

validationAction?: string

Determines whether to error on invalid documents or just warn about the violations but allow invalid documents to be inserted确定是在无效文档上出错,还是仅警告冲突,但允许插入无效文档

validationLevel?: string

Determines how strictly MongoDB applies the validation rules to existing documents during an update确定MongoDB在更新期间对现有文档应用验证规则的严格程度

validator?: Document

Allows users to specify validation rules or expressions for the collection. For more information, see Document Validation允许用户为集合指定验证规则或表达式。有关详细信息,请参阅文档验证

viewOn?: string

The name of the source collection or view from which to create the view. The name is not the full namespace of the collection or view (i.e., does not include the database name and implies the same database as the view to create)要从中创建视图的源集合或视图的名称。该名称不是集合或视图的完整名称空间(即,不包括数据库名称,并暗示与要创建的视图相同的数据库)

willRetryWrite?: boolean

Write Concern as an object将关注作为对象写入

Generated using TypeDoc