Skip to content

MongoDB request DSLopensavvy.ktmongo.dsl.optionsSkipOption

SkipOption

class SkipOption(val skip: Long, context: BsonContext) : AbstractOption

Number of documents to skip before processing the request.

For more information, see WithSkip.

Constructors

SkipOption

constructor(skip: Long, context: BsonContext)

Properties

context

open override val context: BsonContext

The context used to generate this expression.

name

open override val name: String

The name of this option, as it appears in the BSON representation.

skip

val skip: Long

Functions

freeze

open override fun freeze()

Makes this node immutable.

read

override fun read(): ERROR CLASS: Symbol not found for BsonValueReader

Reads the value of this option.

simplify

open override fun simplify(): AbstractBsonNode?

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

toBson

open fun toBson(): ERROR CLASS: Symbol not found for Bson

Writes the result of simplifying to a new Bson.

toString

override fun toString(): String

JSON representation of this expression.

fun toString(simplified: Boolean): String

JSON representation of this expression.

writeTo

override fun writeTo(writer: ERROR CLASS: Symbol not found for BsonFieldWriter)

Writes the result of simplifying this expression into writer.