DB

interface DB : DBRead, DBWrite, Closeable

Types

Companion

common

object Companion

RegisterDsl

common

interface RegisterDsl<M : Any>

Functions

common

abstract fun close()

delete

common

open fun <M : Any> delete(type: KClass<M>, key: Key<M>)

open override fun <M : Any> delete(type: KClass<M>, key: Key<M>, vararg options: Options.Deletes)

abstract fun <M : Any> delete(type: KClass<M>, key: Key<M>, vararg options: Options.DirectDelete)

find

common

abstract fun <M : Any> find(type: KClass<M>, vararg options: Options.Find): DBRead.FindDsl<M>

findAll

common

abstract fun findAll(vararg options: Options.Find): Cursor<*>

flowOf

common

abstract fun <M : Any> flowOf(type: KClass<M>, key: Key<M>, init: Boolean = true): Flow<M?>

get

common

abstract operator fun <M : Any> get(type: KClass<M>, key: Key<M>, vararg options: Options.Get): M?

getIndexesOf

common

abstract fun getIndexesOf(key: Key<*>): Set<String>

keyById

common

abstract fun <M : Any> keyById(type: KClass<M>, vararg id: Any): Key<M>

keyFrom

common

abstract fun <M : Any> keyFrom(model: M, vararg options: Options.Puts): Key<M>

keyFromB64

common

abstract fun <M : Any> keyFromB64(type: KClass<M>, b64: String): Key<M>

newBatch

common

abstract fun newBatch(vararg options: Options.NewBatch): Batch

newSnapshot

common

abstract fun newSnapshot(vararg options: Options.NewSnapshot): Snapshot

common

abstract fun <M : Any> on(type: KClass<M>): DB.RegisterDsl<M>

onAll

common

abstract fun onAll(): DB.RegisterDsl<Any>

put

common

open fun <M : Any> put(model: M): Key<M>

abstract fun <M : Any> put(model: M, vararg options: Options.DirectPut): Key<M>

open override fun <M : Any> put(model: M, vararg options: Options.Puts): Key<M>

open fun <M : Any> put(key: Key<M>, model: M)

abstract fun <M : Any> put(key: Key<M>, model: M, vararg options: Options.DirectPut)

open override fun <M : Any> put(key: Key<M>, model: M, vararg options: Options.Puts)

Extensions

delete

common

inline fun <M : Any> DB.delete(key: Key<M>, vararg options: Options.DirectDelete)

deleteAll

common

inline fun <M : Any> DB.deleteAll(cursor: Cursor<M>, vararg options: Options.DirectDelete)

deleteById

common

inline fun <M : Any> DB.deleteById(vararg id: Any, options: Array<out Options.DirectDelete> = emptyArray())

execBatch

common

inline fun DB.execBatch(vararg options: Options.BatchWrite, block: ExecBatch.() -> Unit)

flowOf

common

inline fun <M : Any> DB.flowOf(key: Key<M>, init: Boolean = true): Flow<M?>

common

inline fun <M : Any> DB.on(): DB.RegisterDsl<M>

stateFlowFrom

common

inline suspend fun <M : Any> DB.stateFlowFrom(scope: CoroutineScope, model: M): StateFlow<M?>

stateFlowOf

common

suspend fun <M : Any> DB.stateFlowOf(scope: CoroutineScope, type: KClass<M>, key: Key<M>): StateFlow<M?>

inline suspend fun <M : Any> DB.stateFlowOf(scope: CoroutineScope, key: Key<M>): StateFlow<M?>

stateFlowOfId

common

inline suspend fun <M : Any> DB.stateFlowOfId(scope: CoroutineScope, vararg id: Any): StateFlow<M?>