Kotlin BSON/opensavvy.ktmongo.bson

Package-level declarations

Utilities and primitives to read and write BSON documents.

opensavvy.ktmongo.bson.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

sealed interface AnyBsonWriter

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

@Serializable(with = ContextualSerializer::class)

interface BsonArray

A BSON array.

BsonDecodingException

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

Exception thrown when decoding a BsonValue fails.

@Serializable(with = ContextualSerializer::class)

interface BsonDocument

A BSON document.

BsonEncodingException

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

Exception thrown when encoding a BsonValue fails.

interface BsonFactory

Entrypoint for creating BsonDocument and BsonArray instances.

BsonFieldWriteable

interface BsonFieldWriteable

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

BsonFieldWriter

interface BsonFieldWriter : AnyBsonWriter

Generator of BSON document fields.

sealed interface BsonPath

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

enum BsonType : Enum<BsonType>

The different data types supported in BSON documents.

@Serializable(with = ContextualSerializer::class)

interface BsonValue

An arbitrary 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

interface BsonValueWriter : AnyBsonWriter

Generator of BSON values.

annotation class BsonWriterDsl

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

ExperimentalBsonDiffApi

@RequiresOptIn(message = "This method is part of an experimental API to analyse the difference between BSON objects. Please share your feedback in https://gitlab.com/opensavvy/ktmongo/-/issues/98")

annotation class ExperimentalBsonDiffApi

ExperimentalBsonPathApi

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

@RequiresOptIn(message = "This symbol is part of the experimental BsonPath API. It may change or be removed without warnings. Please provide feedback in https://gitlab.com/opensavvy/ktmongo/-/issues/93.")

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.

Functions

infix inline fun <T> BsonDocument.at(path: BsonPath): T

Finds the first value that matches path in a given BSON document.

fun BsonPath(@Language(value = "JSONPath") text: String): BsonPath

Parses an RFC-9535 compliant string expression into a BsonPath instance.

inline fun <T> BsonArray.decode(): T

Decodes this array into an instance of the Kotlin type T.

inline fun <T> BsonDocument.decode(): T

Decodes this document into an instance of the Kotlin type T.

inline fun <T> BsonValue.decode(): T

Decodes this value into an instance of the Kotlin type T.

inline fun <T> BsonArray.decodeElements(): List<T>

Decodes this array into a List of the Kotlin type T.

infix fun BsonArray.diff(other: BsonArray): String?

Analyzes the difference between two BSON arrays.

infix fun BsonDocument.diff(other: BsonDocument): String?

Analyzes the difference between two BSON documents.

infix fun BsonValue.diff(other: BsonValue): String?

Analyzes the difference between two BSON values.

inline fun <T : Any> BsonFactory.encode(obj: T): BsonDocument

Writes an arbitrary Kotlin obj into a top-level BSON document.

inline fun <T> BsonDocument.select(@Language(value = "JSONPath") path: String): Sequence<T>

inline fun <T> BsonDocument.select(path: BsonPath): Sequence<T>

Finds all values that match path in a given BSON document.

inline fun <T> BsonDocument.selectFirst(@Language(value = "JSONPath") path: String): T

inline fun <T> BsonDocument.selectFirst(path: BsonPath): T

Finds the first value that matches path in a given BSON document.