Skip to content

OpenSavvy KtMongo

SkipOption

Initializing search

KtMongo • Alpha

Home
Getting started
Features
Reference (experimental)
Reference (external)
News

OpenSavvy KtMongo

KtMongo • Alpha

Home
Getting started
Getting started
- Finding data
- Updating data
- Migrating from KMongo
  Migrating from KMongo
- Kotlin Multiplatform
  Kotlin Multiplatform
Features
Features
- CRUD operations
- Bulk writes
- Optional criteria
- Filtered collections
- Data types
  Data types
- Aggregations
  Aggregations
  - Introduction to aggregations
Reference (experimental)
Reference (experimental)
- Kotlin BSON • Based on the official MongoDB implementation
  Kotlin BSON • Based on the official MongoDB implementation
  - opensavvy.ktmongo.bson.official
    
    opensavvy.ktmongo.bson.official
    
    Bson
    
    Bson
    
    context
    
    equals
    
    hashCode
    
    raw
    
    reader
    
    toByteArray
    
    toString
    
    BsonArray
    
    BsonArray
    
    context
    
    equals
    
    hashCode
    
    raw
    
    reader
    
    toByteArray
    
    toString
    
    BsonFactory
    
    BsonFactory
    
    buildArray
    
    buildDocument
    
    JvmBsonFactory
    
    JvmBsonFactory
    
    buildArray
    
    buildDocument
    
    codecRegistry
    
    readArray
    
    readDocument
    
    JvmBsonFactory
  - opensavvy.ktmongo.bson.official.types
    
    opensavvy.ktmongo.bson.official.types
    
    Decimal128
    
    Decimal128
    
    compareTo
    
    toByte
    
    toDouble
    
    toFloat
    
    toInt
    
    toLong
    
    toShort
    
    Jvm
    
    toKtMongo
    
    toOfficial
- Kotlin BSON • Multiplatform abstraction for different BSON implementations
  Kotlin BSON • Multiplatform abstraction for different BSON implementations
  - opensavvy.ktmongo.bson
    
    opensavvy.ktmongo.bson
    
    AnyBsonWriter
    
    AnyBsonWriter
    
    Bson
    
    Bson
    
    reader
    
    toByteArray
    
    toString
    
    BsonArray
    
    BsonArray
    
    reader
    
    toByteArray
    
    toString
    
    BsonArrayReader
    
    BsonArrayReader
    
    Companion
    
    Companion
    
    equals
    
    hashCode
    
    asValue
    
    elements
    
    indices
    
    read
    
    size
    
    toBson
    
    toString
    
    BsonDocumentReader
    
    BsonDocumentReader
    
    Companion
    
    Companion
    
    equals
    
    hashCode
    
    asValue
    
    entries
    
    names
    
    read
    
    toBson
    
    toString
    
    BsonFactory
    
    BsonFactory
    
    buildArray
    
    buildDocument
    
    readArray
    
    readDocument
    
    BsonFieldWriteable
    
    BsonFieldWriteable
    
    toString
    
    writeTo
    
    BsonFieldWriter
    
    BsonFieldWriter
    
    write
    
    writeArray
    
    writeBinaryData
    
    writeBoolean
    
    writeDBPointer
    
    writeDateTime
    
    writeDecimal128
    
    writeDocument
    
    writeDouble
    
    writeInstant
    
    writeInt32
    
    writeInt64
    
    writeJavaScript
    
    writeJavaScriptWithScope
    
    writeMaxKey
    
    writeMinKey
    
    writeNull
    
    writeObjectId
    
    writeObjectSafe
    
    writeRegularExpression
    
    writeString
    
    writeSymbol
    
    writeTimestamp
    
    writeUndefined
    
    BsonPath
    
    BsonPath
    
    PathOrSelector
    
    PathOrSelector
    
    Root
    
    Root
    
    all
    
    findIn
    
    get
    
    parent
    
    parse
    
    reversed
    
    sliced
    
    toString
    
    Selector
    
    Selector
    
    findInParent
    
    all
    
    any
    
    findIn
    
    get
    
    parent
    
    reversed
    
    sliced
    
    BsonPath
    
    BsonReaderException
    
    BsonReaderException
    
    BsonReaderException
    
    BsonType
    
    BsonType
    
    Array
    
    Array
    
    BinaryData
    
    BinaryData
    
    Boolean
    
    Boolean
    
    Companion
    
    Companion
    
    fromCode
    
    DBPointer
    
    DBPointer
    
    Datetime
    
    Datetime
    
    Decimal128
    
    Decimal128
    
    Document
    
    Document
    
    Double
    
    Double
    
    Int32
    
    Int32
    
    Int64
    
    Int64
    
    JavaScript
    
    JavaScript
    
    JavaScriptWithScope
    
    JavaScriptWithScope
    
    MaxKey
    
    MaxKey
    
    MinKey
    
    MinKey
    
    Null
    
    Null
    
    ObjectId
    
    ObjectId
    
    RegExp
    
    RegExp
    
    String
    
    String
    
    Symbol
    
    Symbol
    
    Timestamp
    
    Timestamp
    
    Undefined
    
    Undefined
    
    code
    
    entries
    
    valueOf
    
    values
    
    BsonValueReader
    
    BsonValueReader
    
    Companion
    
    Companion
    
    equals
    
    hashCode
    
    read
    
    readArray
    
    readBinaryData
    
    readBinaryDataType
    
    readBoolean
    
    readDBPointerId
    
    readDBPointerNamespace
    
    readDateTime
    
    readDecimal128
    
    readDocument
    
    readDouble
    
    readInstant
    
    readInt32
    
    readInt64
    
    readJavaScript
    
    readJavaScriptWithScope
    
    readMaxKey
    
    readMinKey
    
    readNull
    
    readObjectId
    
    readObjectIdBytes
    
    readRegularExpressionOptions
    
    readRegularExpressionPattern
    
    readString
    
    readSymbol
    
    readTimestamp
    
    readUndefined
    
    toString
    
    type
    
    BsonValueWriteable
    
    BsonValueWriteable
    
    toString
    
    writeTo
    
    BsonValueWriter
    
    BsonValueWriter
    
    pipe
    
    writeArray
    
    writeBinaryData
    
    writeBoolean
    
    writeDBPointer
    
    writeDateTime
    
    writeDecimal128
    
    writeDocument
    
    writeDouble
    
    writeInstant
    
    writeInt32
    
    writeInt64
    
    writeJavaScript
    
    writeJavaScriptWithScope
    
    writeMaxKey
    
    writeMinKey
    
    writeNull
    
    writeObjectId
    
    writeObjectSafe
    
    writeRegularExpression
    
    writeString
    
    writeSymbol
    
    writeTimestamp
    
    writeUndefined
    
    BsonWriterDsl
    
    BsonWriterDsl
    
    DEPRECATED_IN_BSON_SPEC
    
    ExperimentalBsonDiffApi
    
    ExperimentalBsonDiffApi
    
    ExperimentalBsonPathApi
    
    ExperimentalBsonPathApi
    
    at
    
    diff
    
    read
    
    select
    
    selectFirst
    
    write
  - opensavvy.ktmongo.bson.types
    
    opensavvy.ktmongo.bson.types
    
    ObjectId
    
    ObjectId
    
    Companion
    
    Companion
    
    COUNTER_BOUND
    
    MAX
    
    MIN
    
    PROCESS_ID_BOUND
    
    maxAt
    
    minAt
    
    ObjectId
    
    Serializer
    
    Serializer
    
    descriptor
    
    deserialize
    
    serialize
    
    bytes
    
    compareTo
    
    counter
    
    equals
    
    hashCode
    
    hex
    
    processId
    
    timestamp
    
    toString
    
    ObjectIdGenerator
    
    ObjectIdGenerator
    
    Companion
    
    Companion
    
    Default
    
    Default
    
    Default
    
    newId
    
    Hardcoded
    
    Hardcoded
    
    Hardcoded
    
    newId
    
    newId
    
    Timestamp
    
    Timestamp
    
    Companion
    
    Companion
    
    MAX
    
    MAX_COUNTER
    
    MAX_INSTANT
    
    MIN
    
    Serializer
    
    Serializer
    
    descriptor
    
    deserialize
    
    serialize
    
    Timestamp
    
    compareTo
    
    counter
    
    equals
    
    hashCode
    
    instant
    
    toString
    
    value
    
    compareTo
    
    toObjectIdRange
- Kotlin BSON • Pure Kotlin Multiplatform implementation
  Kotlin BSON • Pure Kotlin Multiplatform implementation
  - opensavvy.ktmongo.bson.multiplatform
    
    opensavvy.ktmongo.bson.multiplatform
    
    Bson
    
    Bson
    
    eager
    
    equals
    
    hashCode
    
    reader
    
    toByteArray
    
    toString
    
    BsonArray
    
    BsonArray
    
    eager
    
    equals
    
    hashCode
    
    reader
    
    toByteArray
    
    toString
    
    BsonFactory
    
    BsonFactory
    
    BsonFactory
    
    buildArray
    
    buildDocument
    
    readArray
    
    readDocument
  - opensavvy.ktmongo.bson.multiplatform.serialization
    
    opensavvy.ktmongo.bson.multiplatform.serialization
    
    BsonDecodingException
    
    BsonDecodingException
    
    BsonDecodingException
    
    BsonEncodingException
    
    BsonEncodingException
    
    BsonEncodingException
    
    BsonUnknownElementException
    
    BsonUnknownElementException
    
    BsonUnknownElementException
    
    decodeFromBson
    
    encodeToBson
- Kotlin BSON • Test suites
  Kotlin BSON • Test suites
  - opensavvy.ktmongo.bson
    
    opensavvy.ktmongo.bson
    
    validateBsonFactory
    
    validateDiffAlgorithms
  - opensavvy.ktmongo.bson.path
    
    opensavvy.ktmongo.bson.path
    
    IntList
    
    IntList
    
    IntList
    
    items
    
    Pet
    
    Pet
    
    Pet
    
    age
    
    name
    
    species
    
    Profile
    
    Profile
    
    Profile
    
    age
    
    name
    
    Species
    
    Species
    
    Bird
    
    Bird
    
    Cat
    
    Cat
    
    Goat
    
    Goat
    
    entries
    
    valueOf
    
    values
    
    User
    
    User
    
    User
    
    _id
    
    pets
    
    profile
    
    bsonPathTests
  - opensavvy.ktmongo.bson.raw
    
    opensavvy.ktmongo.bson.raw
    
    BsonDeclaration
    
    BsonDeclaration
    
    Companion
    
    Companion
    
    document
    
    hex
    
    json
    
    serialize
    
    verify
    
    array
    
    binary
    
    boolean
    
    code
    
    datetime
    
    document
    
    double
    
    int32
    
    int64
    
    minMaxKey
    
    objectId
    
    regex
    
    reprNull
    
    reprUndefined
    
    shouldBeHex
    
    shouldBeJson
    
    string
    
    testBson
    
    timestamp
- KtMongo annotations
  KtMongo annotations
  - opensavvy.ktmongo.dsl
    
    opensavvy.ktmongo.dsl
    
    DangerousMongoApi
    
    DangerousMongoApi
    
    LowLevelApi
    
    LowLevelApi
- MongoDB driver for Kotlin (coroutines)
  MongoDB driver for Kotlin (coroutines)
  - opensavvy.ktmongo.coroutines
    
    opensavvy.ktmongo.coroutines
    
    JvmMongoCollection
    
    JvmMongoCollection
    
    aggregate
    
    asKotlinClient
    
    bulkWrite
    
    context
    
    count
    
    countEstimated
    
    deleteMany
    
    deleteOne
    
    drop
    
    find
    
    findOneAndUpdate
    
    insertMany
    
    insertOne
    
    replaceOne
    
    repsertOne
    
    toString
    
    updateMany
    
    updateManyWithPipeline
    
    updateOne
    
    updateOneWithPipeline
    
    upsertOne
    
    upsertOneWithPipeline
    
    JvmMongoIterable
    
    JvmMongoIterable
    
    asFlow
    
    asKotlinMongoIterable
    
    first
    
    firstOrNull
    
    forEach
    
    toList
    
    toString
    
    LazyMongoIterable
    
    LazyMongoIterable
    
    asIterable
    
    MongoAggregationPipeline
    
    MongoAggregationPipeline
    
    asIterable
    
    embedInUnionWith
    
    group
    
    limit
    
    match
    
    project
    
    reinterpret
    
    sample
    
    set
    
    skip
    
    sort
    
    unionWith
    
    unset
    
    withStage
    
    MongoCollection
    
    MongoCollection
    
    MongoIterable
    
    MongoIterable
    
    asFlow
    
    asSequence
    
    first
    
    firstOrNull
    
    forEach
    
    toList
    
    toSequence
    
    toSet
    
    asFlow
    
    asIterable
    
    asKtMongo
    
    filter
    
    first
    
    firstOrNull
    
    forEach
    
    toList
    
    toSet
  - opensavvy.ktmongo.coroutines.operations
    
    opensavvy.ktmongo.coroutines.operations
    
    AggregationOperations
    
    AggregationOperations
    
    aggregate
    
    BaseOperations
    
    BaseOperations
    
    context
    
    CollectionOperations
    
    CollectionOperations
    
    drop
    
    CountOperations
    
    CountOperations
    
    count
    
    countEstimated
    
    DeleteOperations
    
    DeleteOperations
    
    deleteMany
    
    deleteOne
    
    FindOperations
    
    FindOperations
    
    find
    
    findOne
    
    InsertOperations
    
    InsertOperations
    
    insertMany
    
    insertOne
    
    UpdateOperations
    
    UpdateOperations
    
    bulkWrite
    
    findOneAndUpdate
    
    replaceOne
    
    repsertOne
    
    updateMany
    
    updateOne
    
    upsertOne
    
    UpdatePipelineOperations
    
    UpdatePipelineOperations
    
    updateManyWithPipeline
    
    updateOneWithPipeline
    
    upsertOneWithPipeline
- MongoDB driver for Kotlin (coroutines, compatibility for KMongo)
  MongoDB driver for Kotlin (coroutines, compatibility for KMongo)
  - opensavvy.ktmongo.coroutines.kmongo
    
    opensavvy.ktmongo.coroutines.kmongo
    
    asKtMongo
- MongoDB driver for Kotlin (synchronous)
  MongoDB driver for Kotlin (synchronous)
  - opensavvy.ktmongo.sync
    
    opensavvy.ktmongo.sync
    
    JvmMongoCollection
    
    JvmMongoCollection
    
    aggregate
    
    asKotlinClient
    
    bulkWrite
    
    context
    
    count
    
    countEstimated
    
    deleteMany
    
    deleteOne
    
    drop
    
    find
    
    findOneAndUpdate
    
    insertMany
    
    insertOne
    
    replaceOne
    
    repsertOne
    
    toString
    
    updateMany
    
    updateManyWithPipeline
    
    updateOne
    
    updateOneWithPipeline
    
    upsertOne
    
    upsertOneWithPipeline
    
    JvmMongoIterable
    
    JvmMongoIterable
    
    asKotlinMongoIterable
    
    asStream
    
    first
    
    firstOrNull
    
    forEach
    
    toList
    
    toString
    
    LazyMongoIterable
    
    LazyMongoIterable
    
    asIterable
    
    MongoAggregationPipeline
    
    MongoAggregationPipeline
    
    asIterable
    
    embedInUnionWith
    
    limit
    
    match
    
    project
    
    reinterpret
    
    sample
    
    set
    
    skip
    
    sort
    
    unionWith
    
    unset
    
    withStage
    
    MongoCollection
    
    MongoCollection
    
    MongoIterable
    
    MongoIterable
    
    asSequence
    
    first
    
    firstOrNull
    
    forEach
    
    toList
    
    toSequence
    
    toSet
    
    asIterable
    
    asKtMongo
    
    filter
    
    first
    
    firstOrNull
    
    forEach
    
    toList
    
    toSet
  - opensavvy.ktmongo.sync.operations
    
    opensavvy.ktmongo.sync.operations
    
    AggregationOperations
    
    AggregationOperations
    
    aggregate
    
    BaseOperations
    
    BaseOperations
    
    context
    
    CollectionOperations
    
    CollectionOperations
    
    drop
    
    CountOperations
    
    CountOperations
    
    count
    
    countEstimated
    
    DeleteOperations
    
    DeleteOperations
    
    deleteMany
    
    deleteOne
    
    FindOperations
    
    FindOperations
    
    find
    
    findOne
    
    InsertOperations
    
    InsertOperations
    
    insertMany
    
    insertOne
    
    UpdateOperations
    
    UpdateOperations
    
    bulkWrite
    
    findOneAndUpdate
    
    replaceOne
    
    repsertOne
    
    updateMany
    
    updateOne
    
    upsertOne
    
    UpdatePipelineOperations
    
    UpdatePipelineOperations
    
    updateManyWithPipeline
    
    updateOneWithPipeline
    
    upsertOneWithPipeline
- MongoDB driver for Kotlin (synchronous, compatibility for KMongo)
  MongoDB driver for Kotlin (synchronous, compatibility for KMongo)
  - opensavvy.ktmongo.sync.kmongo
    
    opensavvy.ktmongo.sync.kmongo
    
    asKtMongo
- MongoDB driver for Kotlin (synchronous, with Java helpers)
  MongoDB driver for Kotlin (synchronous, with Java helpers)
  - opensavvy.ktmongo.sync
    
    opensavvy.ktmongo.sync
    
    JavaField
    
    JavaField
    
    Companion
    
    Companion
    
    of
    
    child
    
    path
    
    KtMongo
    
    KtMongo
    
    from
    
    filter
    
    options
    
    sort
- MongoDB request DSL
  MongoDB request DSL
  - opensavvy.ktmongo.dsl
    
    opensavvy.ktmongo.dsl
    
    BsonContext
    
    BsonContext
    
    BsonContext
    
    KtMongoDsl
    
    KtMongoDsl
  - opensavvy.ktmongo.dsl.aggregation
    
    opensavvy.ktmongo.dsl.aggregation
    
    AbstractPipeline
    
    AbstractPipeline
    
    AbstractPipeline
    
    chain
    
    context
    
    toString
    
    withStage
    
    writeTo
    
    AbstractValue
    
    AbstractValue
    
    AbstractValue
    
    context
    
    simplify
    
    toString
    
    writeTo
    
    AccumulationOperators
    
    AccumulationOperators
    
    AggregationOperators
    
    AggregationOperators
    
    AggregationPipeline
    
    AggregationPipeline
    
    Pipeline
    
    Pipeline
    
    context
    
    reinterpret
    
    toString
    
    withStage
    
    writeTo
    
    PipelineChainLink
    
    PipelineChainLink
    
    PipelineChainLink
    
    toBsonList
    
    toList
    
    toString
    
    withStage
    
    writeTo
    
    UpdatePipeline
    
    UpdatePipeline
    
    Value
    
    Value
    
    context
    
    freeze
    
    simplify
    
    toString
    
    writeTo
  - opensavvy.ktmongo.dsl.aggregation.accumulators
    
    opensavvy.ktmongo.dsl.aggregation.accumulators
    
    ArithmeticValueAccumulators
    
    ArithmeticValueAccumulators
    
    average
    
    sum
    
    ValueAccumulators
    
    ValueAccumulators
  - opensavvy.ktmongo.dsl.aggregation.operators
    
    opensavvy.ktmongo.dsl.aggregation.operators
    
    ArithmeticValueOperators
    
    ArithmeticValueOperators
    
    abs
    
    ceil
    
    div
    
    floor
    
    minus
    
    plus
    
    times
    
    ArrayValueOperators
    
    ArrayValueOperators
    
    average
    
    filter
    
    map
    
    sorted
    
    sortedBy
    
    sortedDescending
    
    take
    
    takeLast
    
    ComparisonValueOperators
    
    ComparisonValueOperators
    
    eq
    
    gt
    
    gte
    
    lt
    
    lte
    
    ne
    
    ConditionalValueOperators
    
    ConditionalValueOperators
    
    cond
    
    switch
    
    StringValueOperators
    
    StringValueOperators
    
    concat
    
    length
    
    lengthUTF8
    
    lowercase
    
    replace
    
    replaceFirst
    
    split
    
    substring
    
    substringUTF8
    
    trim
    
    trimEnd
    
    trimStart
    
    uppercase
    
    TrigonometryValueOperators
    
    TrigonometryValueOperators
    
    acos
    
    acosh
    
    asin
    
    asinh
    
    atan
    
    atanh
    
    cos
    
    cosh
    
    sin
    
    sinh
    
    tan
    
    tanh
    
    toDegrees
    
    toRadians
    
    TypeValueOperators
    
    TypeValueOperators
    
    isArray
    
    isNumber
    
    toBoolean
    
    toDouble
    
    toInstant
    
    toInt
    
    toLong
    
    toObjectId
    
    toText
    
    toUuid
    
    type
    
    ValueOperators
    
    ValueOperators
    
    context
    
    div
    
    of
  - opensavvy.ktmongo.dsl.aggregation.stages
    
    opensavvy.ktmongo.dsl.aggregation.stages
    
    HasCount
    
    HasCount
    
    countTo
    
    HasGroup
    
    HasGroup
    
    group
    
    HasLimit
    
    HasLimit
    
    limit
    
    HasMatch
    
    HasMatch
    
    match
    
    HasProject
    
    HasProject
    
    project
    
    HasSample
    
    HasSample
    
    sample
    
    HasSet
    
    HasSet
    
    set
    
    HasSkip
    
    HasSkip
    
    skip
    
    HasSort
    
    HasSort
    
    sort
    
    HasUnionWith
    
    HasUnionWith
    
    unionWith
    
    HasUnionWithCompatibility
    
    HasUnionWithCompatibility
    
    embedInUnionWith
    
    HasUnset
    
    HasUnset
    
    unset
    
    ProjectStageOperators
    
    ProjectStageOperators
    
    excludeId
    
    include
    
    SetStageOperators
    
    SetStageOperators
    
    set
    
    setIf
    
    setUnless
    
    UnsetStageOperators
    
    UnsetStageOperators
    
    exclude
  - opensavvy.ktmongo.dsl.command
    
    opensavvy.ktmongo.dsl.command
    
    AvailableInBulkWrite
    
    AvailableInBulkWrite
    
    BulkWrite
    
    BulkWrite
    
    BulkWrite
    
    accept
    
    filtered
    
    insertMany
    
    insertOne
    
    operations
    
    options
    
    replaceOne
    
    repsertOne
    
    updateMany
    
    updateOne
    
    upsertOne
    
    BulkWriteOptions
    
    BulkWriteOptions
    
    BulkWriteOptions
    
    Command
    
    Command
    
    Count
    
    Count
    
    Count
    
    filter
    
    options
    
    CountOptions
    
    CountOptions
    
    CountOptions
    
    DeleteMany
    
    DeleteMany
    
    DeleteMany
    
    filter
    
    options
    
    DeleteManyOptions
    
    DeleteManyOptions
    
    DeleteManyOptions
    
    DeleteOne
    
    DeleteOne
    
    DeleteOne
    
    filter
    
    options
    
    DeleteOneOptions
    
    DeleteOneOptions
    
    DeleteOneOptions
    
    Drop
    
    Drop
    
    Drop
    
    options
    
    DropOptions
    
    DropOptions
    
    DropOptions
    
    Find
    
    Find
    
    Find
    
    filter
    
    options
    
    FindOptions
    
    FindOptions
    
    FindOptions
    
    InsertMany
    
    InsertMany
    
    InsertMany
    
    documents
    
    options
    
    InsertManyOptions
    
    InsertManyOptions
    
    InsertManyOptions
    
    InsertOne
    
    InsertOne
    
    InsertOne
    
    document
    
    options
    
    InsertOneOptions
    
    InsertOneOptions
    
    InsertOneOptions
    
    ReplaceOne
    
    ReplaceOne
    
    ReplaceOne
    
    document
    
    filter
    
    options
    
    ReplaceOptions
    
    ReplaceOptions
    
    ReplaceOptions
    
    RepsertOne
    
    RepsertOne
    
    RepsertOne
    
    document
    
    filter
    
    options
    
    UpdateMany
    
    UpdateMany
    
    UpdateMany
    
    filter
    
    options
    
    update
    
    UpdateManyWithPipeline
    
    UpdateManyWithPipeline
    
    UpdateManyWithPipeline
    
    filter
    
    options
    
    update
    
    updates
    
    UpdateOne
    
    UpdateOne
    
    UpdateOne
    
    filter
    
    options
    
    update
    
    UpdateOneWithPipeline
    
    UpdateOneWithPipeline
    
    UpdateOneWithPipeline
    
    filter
    
    options
    
    update
    
    updates
    
    UpdateOptions
    
    UpdateOptions
    
    UpdateOptions
    
    UpsertOne
    
    UpsertOne
    
    UpsertOne
    
    filter
    
    options
    
    update
    
    UpsertOneWithPipeline
    
    UpsertOneWithPipeline
    
    UpsertOneWithPipeline
    
    filter
    
    options
    
    update
    
    updates
  - opensavvy.ktmongo.dsl.options
    
    opensavvy.ktmongo.dsl.options
    
    AbstractCompoundOption
    
    AbstractCompoundOption
    
    AbstractCompoundOption
    
    simplify
    
    AbstractOption
    
    AbstractOption
    
    AbstractOption
    
    name
    
    read
    
    LimitOption
    
    LimitOption
    
    LimitOption
    
    limit
    
    MaxTimeOption
    
    MaxTimeOption
    
    MaxTimeOption
    
    timeout
    
    Option
    
    Option
    
    name
    
    read
    
    Options
    
    Options
    
    allOptions
    
    toString
    
    ReadConcern
    
    ReadConcern
    
    Available
    
    Available
    
    Linearizable
    
    Linearizable
    
    Local
    
    Local
    
    Majority
    
    Majority
    
    Snapshot
    
    Snapshot
    
    bsonName
    
    valueOf
    
    values
    
    ReadConcernOption
    
    ReadConcernOption
    
    ReadConcernOption
    
    concern
    
    ReadPreference
    
    ReadPreference
    
    Nearest
    
    Nearest
    
    Primary
    
    Primary
    
    PrimaryPreferred
    
    PrimaryPreferred
    
    Secondary
    
    Secondary
    
    SecondaryPreferred
    
    SecondaryPreferred
    
    bsonName
    
    valueOf
    
    values
    
    ReadPreferenceOption
    
    ReadPreferenceOption
    
    ReadPreferenceOption
    
    concern
    
    SkipOption
    
    SkipOption
    
    SkipOption
    
    skip
    
    SortOption
    
    SortOption
    
    SortOption
    
    block
    
    SortOptionDsl
    
    SortOptionDsl
    
    ascending
    
    descending
    
    WithLimit
    
    WithLimit
    
    limit
    
    WithMaxTime
    
    WithMaxTime
    
    maxTime
    
    WithReadConcern
    
    WithReadConcern
    
    readConcern
    
    WithReadPreference
    
    WithReadPreference
    
    readPreference
    
    WithSkip
    
    WithSkip
    
    skip
    
    WithSort
    
    WithSort
    
    sort
    
    WithWriteConcern
    
    WithWriteConcern
    
    writeConcern
    
    WriteAcknowledgment
    
    WriteAcknowledgment
    
    Majority
    
    Majority
    
    Nodes
    
    Nodes
    
    Nodes
    
    count
    
    Tagged
    
    Tagged
    
    Tagged
    
    tag
    
    WriteConcern
    
    WriteConcern
    
    Companion
    
    Companion
    
    FireAndForget
    
    Majority
    
    Primary
    
    WriteConcern
    
    acknowledgment
    
    copy
    
    writeTimeout
    
    writeToJournal
    
    WriteConcernOption
    
    WriteConcernOption
    
    WriteConcernOption
    
    concern
    
    option
  - opensavvy.ktmongo.dsl.path
    
    opensavvy.ktmongo.dsl.path
    
    Field
    
    Field
    
    Companion
    
    Companion
    
    unsafe
    
    path
    
    FieldDsl
    
    FieldDsl
    
    context
    
    div
    
    field
    
    get
    
    unsafe
    
    Path
    
    Path
    
    Companion
    
    Companion
    
    Path
    
    asSequence
    
    parent
    
    segment
    
    toString
    
    Path
    
    PathSegment
    
    PathSegment
    
    AllPositional
    
    AllPositional
    
    toString
    
    Field
    
    Field
    
    Field
    
    name
    
    toString
    
    Indexed
    
    Indexed
    
    index
    
    Indexed
    
    toString
    
    Positional
    
    Positional
    
    toString
    
    PropertyNameStrategy
    
    PropertyNameStrategy
    
    Default
    
    Default
    
    pathOf
    
    pathOf
    
    div
  - opensavvy.ktmongo.dsl.query
    
    opensavvy.ktmongo.dsl.query
    
    FilterQuery
    
    FilterQuery
    
    and
    
    any
    
    anyValue
    
    bitsAllClear
    
    bitsAllSet
    
    bitsAnyClear
    
    bitsAnySet
    
    containsAll
    
    div
    
    doesNotExist
    
    eq
    
    eqNotNull
    
    exists
    
    expr
    
    gt
    
    gtNotNull
    
    gte
    
    gteNotNull
    
    hasType
    
    invoke
    
    isEmpty
    
    isIn
    
    isMapEmpty
    
    isMapNotEmpty
    
    isNotEmpty
    
    isNotNull
    
    isNotOneOf
    
    isNotUndefined
    
    isNull
    
    isOneOf
    
    isUndefined
    
    lt
    
    ltNotNull
    
    lte
    
    lteNotNull
    
    ne
    
    nor
    
    not
    
    or
    
    regex
    
    size
    
    FilterQuery
    
    FilterQueryPredicate
    
    FilterQueryPredicate
    
    bitsAllClear
    
    bitsAllSet
    
    bitsAnyClear
    
    bitsAnySet
    
    doesNotExist
    
    eq
    
    eqNotNull
    
    exists
    
    gt
    
    gtNotNull
    
    gte
    
    gteNotNull
    
    hasType
    
    isNotNull
    
    isNotOneOf
    
    isNotUndefined
    
    isNull
    
    isOneOf
    
    isUndefined
    
    lt
    
    ltNotNull
    
    lte
    
    lteNotNull
    
    ne
    
    not
    
    regex
    
    FilterQueryPredicate
    
    UpdateQuery
    
    UpdateQuery
    
    addToSet
    
    all
    
    inc
    
    max
    
    min
    
    mul
    
    plusAssign
    
    renameTo
    
    selected
    
    set
    
    setIf
    
    setToCurrentDate
    
    setUnless
    
    unset
    
    UpdateQuery
    
    UpdateWithPipelineQuery
    
    UpdateWithPipelineQuery
    
    project
    
    set
    
    unset
    
    UpdateWithPipelineQuery
    
    UpsertQuery
    
    UpsertQuery
    
    setOnInsert
    
    UpsertQuery
  - opensavvy.ktmongo.dsl.tree
    
    opensavvy.ktmongo.dsl.tree
    
    AbstractBsonNode
    
    AbstractBsonNode
    
    AbstractBsonNode
    
    Companion
    
    Companion
    
    context
    
    simplify
    
    toString
    
    writeTo
    
    AbstractCompoundBsonNode
    
    AbstractCompoundBsonNode
    
    AbstractCompoundBsonNode
    
    Companion
    
    Companion
    
    accept
    
    simplify
    
    BsonNode
    
    BsonNode
    
    Companion
    
    Companion
    
    context
    
    freeze
    
    simplify
    
    toBson
    
    toString
    
    writeTo
    
    CompoundBsonNode
    
    CompoundBsonNode
    
    Companion
    
    Companion
    
    accept
    
    CompoundNode
    
    CompoundNode
    
    accept
    
    Node
    
    Node
    
    freeze
    
    acceptAll
- Shared utilities for the sync and coroutinesBased KtMongo drivers based on the KMongo library
  Shared utilities for the sync and coroutinesBased KtMongo drivers based on the KMongo library
  - opensavvy.ktmongo.utils.kmongo
    
    opensavvy.ktmongo.utils.kmongo
    
    KMongoNameStrategy
    
    KMongoNameStrategy
    
    KMongoNameStrategy
    
    pathOf
- Shared utilities for the sync and coroutinesBased KtMongo drivers based on the official Kotlin driver
  Shared utilities for the sync and coroutinesBased KtMongo drivers based on the official Kotlin driver
  - opensavvy.ktmongo.official
    
    opensavvy.ktmongo.official
    
    JvmBsonContext
    
    JvmBsonContext
    
    JvmBsonContext
    
    toJava
  - opensavvy.ktmongo.official.command
    
    opensavvy.ktmongo.official.command
    
    toJava
  - opensavvy.ktmongo.official.options
    
    opensavvy.ktmongo.official.options
    
    readLimit
    
    readMaxTimeMS
    
    readReadConcern
    
    readReadPreference
    
    readSkip
    
    readSortDocument
    
    toJava
Reference (external)
Reference (external)
- Reference
News
News
- News by category
- Archive
  Archive
  - 2026
  - 2025
  - 2024

jvm

MongoDB request DSL • opensavvy.ktmongo.dsl.options • SkipOption • SkipOption

SkipOption¶

constructor(skip: Long, context: BsonContext)

ReadPreferenceOption

KtMongo is licensed under Apache 2.0. Mokodee (our precious mascot) was created by Lilywhiteout.

Made with Material for MkDocs