CreateCollectionOptions

class CreateCollectionOptions<Document : Any>(context: BsonContext) : Options, HasCapped, HasValidation<Document> , HasWriteConcern, HasComment

The options for a CreateCollection command.

Constructors

CreateCollectionOptions

constructor(context: BsonContext)

Properties

allOptions

@LowLevelApi
open override val allOptions: List<Option>

The full list of options set on this container.

context

@LowLevelApi
open override val context: BsonContext

The context used to generate this expression.

Functions

accept

@LowLevelApi
@DangerousMongoApi
open override fun accept(node: BsonNode)

Adds a new node as a child of this one.

acceptAll

@LowLevelApi
@DangerousMongoApi
fun <N : Node> CompoundNode<N>.acceptAll(nodes: Iterable<N>)

Adds any number of nodes into this one.

capped

open fun capped(sizeBytes: Long, max: Long? = null)

Specifies that this collection is capped: it has a maximum size. Once that size is reached, MongoDB removes the oldest documents.

comment

inline fun <T> comment(comment: T)

Specifies a user-defined message which will be associated with this information in the logs, etc.

open fun comment(comment: BsonValueWriter.() -> Unit)

Specifies a user-defined message which will be associated with this information in the logs, etc.

open fun comment(comment: String)

Specifies a user-defined message which will be associated with this information in the logs, etc.

open fun comment(comment: BsonValueWriteable)

Specifies a user-defined message which will be associated with this information in the logs, etc.

open fun <T> comment(comment: T, type: KType)

Specifies a user-defined message which will be associated with this information in the logs, etc.

freeze

@LowLevelApi
open override fun freeze()

Makes this node immutable.

option

@LowLevelApi
inline fun <O : Option> Options.option(): O?

Accesses the value of a given Option.

simplify

@LowLevelApi
open override fun simplify(): BsonNode?

Returns a simplified (but equivalent) expression to the current expression.

toBson

@LowLevelApi
open override fun toBson(): BsonDocument

Writes the result of simplifying to a new BsonDocument.

toString

open override fun toString(): String

JSON representation of this option.

validator

open fun validator(
    level: ValidationLevel = ValidationLevel.Strict, 
    action: ValidationAction = ValidationAction.Error, 
    validator: FilterQuery<Document>.() -> Unit
)

Specifies validation rules for a collection.

writeConcern

open fun writeConcern(concern: WriteConcern)

Specifies the WriteConcern for this operation.

open fun writeConcern(
    acknowledgement: WriteAcknowledgment? = null, 
    writeToJournal: Boolean? = null, 
    writeTimeout: Duration? = null
)

Specifies the WriteConcern for this operation.

writeTo

@LowLevelApi
open override fun writeTo(writer: BsonFieldWriter)

Writes the result of simplifying this expression into writer.