HasBypassDocumentValidation

interface HasBypassDocumentValidation : Options

Whether this operation is allowed to bypass document validation.

See HasBypassDocumentValidation.bypassDocumentValidation.

Inheritors

• InsertOneOptions
• InsertManyOptions

Properties

allOptions

@LowLevelApi
abstract val allOptions: List<Option>

The full list of options set on this container.

Specific options are usually searched using the option extension.

context

@LowLevelApi
abstract val context: BsonContext

The context used to generate this expression.

Functions

accept

@LowLevelApi
@DangerousMongoApi
abstract 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.

bypassDocumentValidation

open fun bypassDocumentValidation(bypass: Boolean = true)

Whether this operation is allowed to bypass document validation.

By default, or when called with false, this operation will need to respect the configured documentation validation for the current collection.

If called with true or no parameters, this operation will succeed even if documentation validation should've blocked it.

Example

class User(
    val name: String,
    val age: Int,
)

users.insertOne(
    User("John Doe", 42),
    options = { bypassDocumentValidation() }
)

See also

• HasValidation.validator: Configure the validation on a collection.

freeze

@LowLevelApi
abstract override fun freeze()

Makes this node immutable.

option

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

Accesses the value of a given Option.

For example, if we have a helper function that sets some default options, and we want to know what maximum limit it set, we can use:

collection.count(
    options = {
        println(option<LimitOption>()) // Will print an integer
    }
)

simplify

@LowLevelApi
abstract fun simplify(): BsonNode?

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

toBson

@LowLevelApi
open fun toBson(): BsonDocument

Writes the result of simplifying to a new BsonDocument.

toString

abstract override fun toString(): String

JSON representation of this option.

writeTo

@LowLevelApi
abstract override fun writeTo(writer: BsonFieldWriter)

Writes the result of simplifying this expression into writer.