KtMongo: MongoDB request DSL/opensavvy.ktmongo.dsl.command/FindOptions

FindOptions

class FindOptions<Document : Any>(context: BsonContext) : Options, WithLimit, WithSkip, WithMaxTime, WithSort<Document> , WithReadConcern, WithReadPreference(source)

The options for a Find command.

Constructors

FindOptions

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

@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.

freeze

@LowLevelApi

open override fun freeze()

Makes this expression immutable.

limit

open fun limit(limit: Int)

open fun limit(limit: Long)

The maximum number of matching documents to return.

maxTime

open fun maxTime(timeout: Duration)

Specifies a maximum amount of time for processing the request.

option

@LowLevelApi

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

Accesses the value of a given Option.

readConcern

open fun readConcern(concern: ReadConcern)

Specifies the ReadConcern for this operation.

readPreference

open fun readPreference(concern: ReadPreference)

Specifies the ReadPreference for this operation.

simplify

@LowLevelApi

open override fun simplify(): BsonNode?

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

skip

open fun skip(skip: Int)

open fun skip(skip: Long)

The number of documents to skip before processing the request.

sort

open fun sort(block: SortOptionDsl<Document>.() -> Unit)

The order in which documents should be returned.

toBson

@LowLevelApi

open override fun toBson(): Bson

Writes the result of simplifying to a new BSON document.

toString

open override fun toString(): String

JSON representation of this option.

writeTo

@LowLevelApi

open override fun writeTo(writer: BsonFieldWriter)

Writes the result of simplifying this expression into writer.