CountOptions¶

class CountOptions<Document>(context: BsonContext) : Options, WithLimit, WithSkip, WithMaxTime

The options for a Count command.

Constructors¶

constructor(context: BsonContext)

@LowLevelApi
open override val allOptions: List<Option>

The full list of options set on this container.

@LowLevelApi
open override val context: BsonContext

The context used to generate this expression.

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

Adds a new node as a child of this one.

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

Adds any number of nodes into this one.

@LowLevelApi
open override fun freeze()

Makes this expression immutable.

open fun limit(limit: Int)

The maximum number of matching documents to return.

open fun limit(limit: Long)

The maximum number of matching documents to return.

open fun maxTime(timeout: Duration)

Specifies a maximum amount of time for processing the request.

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

Accesses the value of a given Option.

@LowLevelApi
open override fun simplify(): BsonNode?

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

open fun skip(skip: Int)

The number of documents to skip before processing the request.

open fun skip(skip: Long)

The number of documents to skip before processing the request.

@LowLevelApi
open override fun toBson(): BsonDocument

Writes the result of simplifying to a new BsonDocument.

open override fun toString(): String

JSON representation of this option.

@LowLevelApi
open override fun writeTo(writer: BsonFieldWriter)

Writes the result of simplifying this expression into writer.