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

FindOptions

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

The options for a Find command.

Constructors

Link copied to clipboard
constructor(context: <Error class: unknown class>)

Properties

Link copied to clipboard
open override val allOptions: List<Option>

The full list of options set on this container.

Link copied to clipboard
open override val context: <Error class: unknown class>

The context used to generate this expression.

Functions

Link copied to clipboard
open override fun accept(node: BsonNode)

Adds a new node as a child of this one.

Link copied to clipboard
fun <N : Node> CompoundNode<N>.acceptAll(nodes: Iterable<N>)

Adds any number of nodes into this one.

Link copied to clipboard
open override fun freeze()

Makes this expression immutable.

Link copied to clipboard
open fun limit(limit: Int)
open fun limit(limit: Long)

The maximum number of matching documents to return.

Link copied to clipboard
open fun maxTime(timeout: <Error class: unknown class>)

Specifies a maximum amount of time for processing the request.

Link copied to clipboard
inline fun <O : Option> Options.option(): O?

Accesses the value of a given Option.

Link copied to clipboard
open fun readConcern(concern: ReadConcern)

Specifies the ReadConcern for this operation.

Link copied to clipboard
open fun readPreference(concern: ReadPreference)

Specifies the ReadPreference for this operation.

Link copied to clipboard
open override fun simplify(): BsonNode?

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

Link copied to clipboard
open fun skip(skip: Int)
open fun skip(skip: Long)

The number of documents to skip before processing the request.

Link copied to clipboard
open fun sort(block: SortOptionDsl<Document>.() -> Unit)

The order in which documents should be returned.

Link copied to clipboard
open override fun toBson(): <Error class: unknown class>

Writes the result of simplifying to a new Bson.

Link copied to clipboard
open override fun toString(): String

JSON representation of this option.

Link copied to clipboard
open override fun writeTo(writer: <Error class: unknown class>)

Writes the result of simplifying this expression into writer.