CreateCollectionOptions Structure Reference


                    
                    
                    capped

Indicates whether this will be a capped collection.

Declaration

Swift

public var capped: Bool?

Show on GitHub


                    
                    
                    collation

Specifies the default collation for the collection.

Declaration

Swift

public var collation: BSONDocument?

Show on GitHub


                    
                    
                    dataCodingStrategy

Specifies the DataCodingStrategy to use for BSON encoding/decoding operations performed by this collection. It is the responsibility of the user to ensure that any Datas already stored in this collection can be decoded using this strategy.

Declaration

Swift

public var dataCodingStrategy: DataCodingStrategy?

Show on GitHub


                    
                    
                    dateCodingStrategy

Specifies the DateCodingStrategy to use for BSON encoding/decoding operations performed by this collection. It is the responsibility of the user to ensure that any Dates already stored in this collection can be decoded using this strategy.

Declaration

Swift

public var dateCodingStrategy: DateCodingStrategy?

Show on GitHub


                    
                    
                    expireAfterSeconds

Number of seconds after which old time series data should be deleted.

Declaration

Swift

public var expireAfterSeconds: Int?

Show on GitHub


                    
                    
                    indexOptionDefaults

Specify a default configuration for indexes created on this collection.

Declaration

Swift

public var indexOptionDefaults: BSONDocument?

Show on GitHub

max

Maximum number of documents allowed in the collection (if capped).

Declaration

Swift

public var max: Int?

Show on GitHub


                    
                    
                    pipeline

An array consisting of aggregation pipeline stages. When used with viewOn, will create the view by applying this pipeline to the source collection or view.

Declaration

Swift

public var pipeline: [BSONDocument]?

Show on GitHub


                    
                    
                    size

Maximum size, in bytes, of this collection (if capped).

Declaration

Swift

public var size: Int?

Show on GitHub


                    
                    
                    storageEngine

Specifies storage engine configuration for this collection.

Declaration

Swift

public var storageEngine: BSONDocument?

Show on GitHub


                    
                    
                    timeseries

The options used for creating a time series collection. This feature is only available on MongoDB 5.0+.

Declaration

Swift

public var timeseries: TimeseriesOptions?

Show on GitHub


                    
                    
                    uuidCodingStrategy

Specifies the UUIDCodingStrategy to use for BSON encoding/decoding operations performed by this collection. It is the responsibility of the user to ensure that any UUIDs already stored in this collection can be decoded using this strategy.

Declaration

Swift

public var uuidCodingStrategy: UUIDCodingStrategy?

Show on GitHub


                    
                    
                    validationAction

Determines whether to error on invalid documents or just warn about the violations but allow invalid documents to be inserted.

Declaration

Swift

public var validationAction: String?

Show on GitHub


                    
                    
                    validationLevel

Determines how strictly MongoDB applies the validation rules to existing documents during an update.

Declaration

Swift

public var validationLevel: String?

Show on GitHub


                    
                    
                    validator

What validator should be used for the collection.

Declaration

Swift

public var validator: BSONDocument?

Show on GitHub


                    
                    
                    viewOn

The name of the source collection or view from which to create the view.

Declaration

Swift

public var viewOn: String?

Show on GitHub


                    
                    
                    writeConcern

A write concern to use when executing this command. To set a read or write concern for the collection itself, retrieve the collection using MongoDatabase.collection.

Declaration

Swift

public var writeConcern: WriteConcern?

Show on GitHub


                    
                    
                    init(capped:collation:dataCodingStrategy:dateCodingStrategy:expireAfterSeconds:indexOptionDefaults:max:pipeline:size:storageEngine:timeseries:uuidCodingStrategy:validationAction:validationLevel:validator:viewOn:writeConcern:)

Convenience initializer allowing any/all parameters to be omitted or optional.

Declaration

Swift

public init(
    capped: Bool? = nil,
    collation: BSONDocument? = nil,
    dataCodingStrategy: DataCodingStrategy? = nil,
    dateCodingStrategy: DateCodingStrategy? = nil,
    expireAfterSeconds: Int? = nil,
    indexOptionDefaults: BSONDocument? = nil,
    max: Int? = nil,
    pipeline: [BSONDocument]? = nil,
    size: Int? = nil,
    storageEngine: BSONDocument? = nil,
    timeseries: TimeseriesOptions? = nil,
    uuidCodingStrategy: UUIDCodingStrategy? = nil,
    validationAction: String? = nil,
    validationLevel: String? = nil,
    validator: BSONDocument? = nil,
    viewOn: String? = nil,
    writeConcern: WriteConcern? = nil
)

Show on GitHub