HasComment

interface HasComment : Options

User-defined message associated with an operation, which is repeated in the logs.

See HasComment.comment.

Inheritors

• CreateCollectionOptions
• 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.

comment

open fun comment(comment: String)

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

This option exists to easily find the query in the database logs. It does not impact the behavior of the request.

Example

users.insertOne(
    User("Bob", 25),
    options = { comment("register user") },
)

open fun comment(comment: BsonValueWriteable)

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

This option exists to easily find the query in the database logs. It does not impact the behavior of the request.

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

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

This option exists to easily find the query in the database logs. It does not impact the behavior of the request.

Example

users.insertOne(
    User("Bob", 25),
    options = {
        comment {
            writeDocument {
                writeString("request", "Register user")
                writeString("name", "Bob")
            }
        }
    },
)

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

inline fun <T> comment(comment: T)

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

This option exists to easily find the query in the database logs. It does not impact the behavior of the request.

Example

users.insertOne(
    User("Bob", 25),
    options = { comment(TelemetryInformation.current) },
)

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.