Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CreateCollectionOptions

Hierarchy继承层级

Index索引

Properties属性

authdb?: string
autoIndexId?: boolean
deprecated

Create an index on the _id field of the document, True by default on MongoDB 2.6 - 3.0在文档的_id字段上创建索引,在MongoDB 2.6-3.0上默认为True

bsonRegExp?: boolean

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

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.序列化程序将检查键是否有效。

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. 反序列化BSON文档时启用utf8验证。Defaults to true.默认为true

encryptedFields?: Document
experimental
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.允许指定是否存在我们希望作为非序列化原始缓冲区返回的字段。

flags?: number

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

fullResponse?: boolean
deprecated

This option does nothing

ignoreUndefined?: boolean

serialize will not emit undefined fields (default:true)序列化不会发出未定义的字段(默认值:true

indexOptionDefaults?: Document

Allows users to specify a default configuration for indexes when creating a collection on MongoDB 3.2 or higher允许用户在MongoDB 3.2或更高版本上创建集合时指定索引的默认配置

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 on MongoDB 3.4 or higher通过将指定的管道应用于viewOn集合或MongoDB 3.4或更高版本上的视图来创建视图

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实例返回。

promoteLongs?: boolean

when deserializing a Long will fit it into a Number if it's smaller than 53 bits当反序列化Long时,如果Long小于53位,它将适合Number

promoteValues?: boolean

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

raw?: boolean

Return BSON filled buffers from operations从操作返回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 (default:false).序列化javascript函数(默认值: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 on MongoDB 3.0 or higher允许用户在MongoDB 3.0或更高版本上创建集合时,按每个集合指定存储引擎的配置

strict?: boolean

Returns an error if the collection does not exist如果集合不存在,则返回错误

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

validationAction?: string

Determines whether to error on invalid documents or just warn about the violations but allow invalid documents to be inserted on MongoDB 3.2 or higher确定是在无效文档上出错,还是仅警告违规,但允许在MongoDB 3.2或更高版本上插入无效文档

validationLevel?: string

Determines how strictly MongoDB applies the validation rules to existing documents during an update on MongoDB 3.2 or higher确定在MongoDB 3.2或更高版本的更新过程中,MongoDB对现有文档应用验证规则的严格程度

validator?: Document

Allows users to specify validation rules or expressions for the collection. For more information, see Document Validation on MongoDB 3.2 or higher允许用户为集合指定验证规则或表达式。有关更多信息,请参阅MongoDB 3.2或更高版本上的文档验证

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 on MongoDB 3.4 or higher名称不是集合或视图的完整名称空间;即,不包括数据库名称,并表示与要在MongoDB 3.4或更高版本上创建的视图相同的数据库

willRetryWrite?: boolean

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

Generated using TypeDoc