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

bsonRegExp?: boolean

return BSON regular expressions as BSONRegExp instances.

capped?: boolean

Create a capped collection

checkKeys?: boolean

the serializer will check if keys are valid.

A document specifying configuration options for clustered collections. For MongoDB 5.3 and above.

collation?: CollationOptions

Collation

comment?: unknown

Comment to apply to the operation.

In server versions pre-4.4, 'comment' must be string. 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.

dbName?: string
enableUtf8Validation?: boolean

Enable utf8 validation when deserializing BSON documents. Defaults to 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

fullResponse?: boolean
deprecated

This option does nothing

ignoreUndefined?: boolean

serialize will not emit undefined fields (default:true)

indexOptionDefaults?: Document

Allows users to specify a default configuration for indexes when creating a collection on MongoDB 3.2 or higher

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

pkFactory?: PkFactory

A primary key factory function for generation of custom _id keys.

promoteBuffers?: boolean

when deserializing a Binary will return it as a node.js Buffer instance.

promoteLongs?: boolean

when deserializing a Long will fit it into a Number if it's smaller than 53 bits

promoteValues?: boolean

when deserializing will promote BSON values to their Node.js closest equivalent types.

raw?: boolean

Return BSON filled buffers from operations

readConcern?: ReadConcernLike

Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)

readPreference?: ReadPreferenceLike

The preferred read preference (ReadPreference.primary, ReadPreference.primary_preferred, ReadPreference.secondary, ReadPreference.secondary_preferred, ReadPreference.nearest).

retryWrites?: boolean

Should retry failed writes

serializeFunctions?: boolean

serialize the javascript functions (default:false).

session?: ClientSession

Specify ClientSession for this command

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

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

validationLevel?: string

Determines how strictly MongoDB applies the validation rules to existing documents during an update on MongoDB 3.2 or higher

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

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

willRetryWrite?: boolean

Write Concern as an object

Generated using TypeDoc