opensavvy.ktmongo.bson¶

Utilities and primitives to read and write BSON documents.

Bson and BsonArray respectively represent BSON documents and arrays.

BsonFactory is the entry point to create new BSON documents.

BsonPath provides a convenient way to search for data in a complex BSON document.

Types¶

`AnyBsonWriter`¶

@LowLevelApi



sealed interface AnyBsonWriter

Parent interface for type parameters that can accept either BsonValueWriter or BsonFieldWriter.

`Bson`¶

interface Bson

A BSON document.

`BsonArray`¶

interface BsonArray

A BSON array.

`BsonArrayReader`¶

@LowLevelApi



interface BsonArrayReader

Utilities for decomposing a BsonArray into its elements.

`BsonDocumentReader`¶

@LowLevelApi



interface BsonDocumentReader

Utilities for decomposing a Bson document into its fields.

`BsonFactory`¶

interface BsonFactory

Entrypoint for creating Bson and BsonArray instances.

`BsonFieldWriteable`¶

interface BsonFieldWriteable

An object that can be represented as fields in a BSON document.

`BsonFieldWriter`¶

@LowLevelApi



interface BsonFieldWriter : AnyBsonWriter

Generator of BSON document fields.

`BsonPath`¶

sealed interface BsonPath

Access specific fields in arbitrary BSON documents using a JSONPath-like API.

`BsonReaderException`¶

class BsonReaderException(message: String, cause: Throwable? = null) : IllegalStateException

Exception thrown when BSON reading fails.

`BsonType`¶

enum BsonType : Enum<BsonType>

The different data types supported in BSON documents.

`BsonValueReader`¶

@LowLevelApi



interface BsonValueReader

Representation of a BSON value.

`BsonValueWriteable`¶

interface BsonValueWriteable

An object that can be represented as a BSON value (value of a field, item in an array, an array itself).

`BsonValueWriter`¶

@LowLevelApi



interface BsonValueWriter : AnyBsonWriter

Generator of BSON values.

`BsonWriterDsl`¶

@DslMarker
annotation class BsonWriterDsl

Annotation to mark types that are part of the BSON writer DSL.

`ExperimentalBsonDiffApi`¶

annotation class ExperimentalBsonDiffApi

`ExperimentalBsonPathApi`¶

@Target
(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.TYPEALIAS, AnnotationTarget.PROPERTY, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.FUNCTION])annotation class ExperimentalBsonPathApi

Properties¶

`DEPRECATED_IN_BSON_SPEC`¶

const val DEPRECATED_IN_BSON_SPEC: String

Deprecation messages for BSON functionality that is deprecated in the BSON spec.

opensavvy.ktmongo.bson¶

Types¶

Properties¶

Functions¶