micro_utils.dokka
0.15.1

# ExposedKeyValueRepo

open class ExposedKeyValueRepo<Key, Value>(database: <Error class: unknown class>, keyColumnAllocator: ColumnAllocator<Key>, valueColumnAllocator: ColumnAllocator<Value>, tableName: String? = null) : ExposedReadKeyValueRepo<Key, Value> , KeyValueRepo<Key, Value>

## Constructors

ExposedKeyValueRepo
Link copied to clipboard
fun ExposedKeyValueRepo(database: <Error class: unknown class>, keyColumnAllocator: ColumnAllocator<Key>, valueColumnAllocator: ColumnAllocator<Value>, tableName: String? = null)

## Functions

clear
Link copied to clipboard
open suspend fun clear()

By default, will remove all the data of current repo using doAllWithCurrentPaging, keys and unset

contains
Link copied to clipboard
abstract suspend fun contains(key: Key): Boolean
count
Link copied to clipboard
abstract suspend fun count(): Long
get
Link copied to clipboard
abstract suspend fun get(k: Key): Value?
keys
Link copied to clipboard
abstract suspend fun keys(pagination: Pagination, reversed: Boolean = false): PaginationResult<Key>
abstract suspend fun keys(v: Value, pagination: Pagination, reversed: Boolean = false): PaginationResult<Key>

This method should use sorted by Keys search and take the PaginationResult. By default, it should use ascending sort for Keys

set
Link copied to clipboard
open suspend override fun set(toSet: Map<Key, Value>)

Will set as batch toSet data in current repo. Must pass the data which were successfully updated in repo to onNewValue

unset
Link copied to clipboard
open suspend override fun unset(toUnset: List<Key>)

Will unset as batch data with keys from toUnset. Must pass the Keys which were successfully removed in repo to onValueRemoved

unsetWithValues
Link copied to clipboard
open suspend override fun unsetWithValues(toUnset: List<Value>)

By default, will walk throw all the keys with Values from toUnset and run doAllWithCurrentPaging with unset of found data Keys

values
Link copied to clipboard
abstract suspend fun values(pagination: Pagination, reversed: Boolean = false): PaginationResult<Value>

This method should use sorted by Keys search and take the PaginationResult. By default, it should use ascending sort for Keys

## Properties

asId
Link copied to clipboard
open override val <Error class: unknown class>.asId: Key
asKey
Link copied to clipboard
open override val <Error class: unknown class>.asKey: Key

Same as asId in context of KeyValue repo

asObject
Link copied to clipboard
open override val <Error class: unknown class>.asObject: Value
database
Link copied to clipboard
abstract val database: <Error class: unknown class>
keyColumn
Link copied to clipboard
open override val keyColumn: <Error class: unknown class><Key>
onNewValue
Link copied to clipboard
open override val onNewValue: Flow<Pair<Key, Value>>

This flow must emit data each time when data by Key has been changed with set method or in any other way excluding cases of data removing

onValueRemoved
Link copied to clipboard
open override val onValueRemoved: Flow<Key>

This flow must emit data each time when data by Key has been removed with unset/unsetWithValues methods or in any other way

primaryKey
Link copied to clipboard
open val primaryKey: <Error class: unknown class>
selectAll
Link copied to clipboard
open val selectAll: <Error class: unknown class>.() -> <Error class: unknown class>
selectById
Link copied to clipboard
open override val selectById: <Error class: unknown class>.(Key) -> <Error class: unknown class><Boolean>
selectByIds
Link copied to clipboard
open val selectByIds: <Error class: unknown class>.(List<Key>) -> <Error class: unknown class><Boolean>
selectByValue
Link copied to clipboard
open override val selectByValue: <Error class: unknown class>.(Value) -> <Error class: unknown class><Boolean>
valueColumn
Link copied to clipboard
val valueColumn: <Error class: unknown class><Value>

## Extensions

cached
Link copied to clipboard
fun <Key, Value> KeyValueRepo<Key, Value>.cached(kvCache: KVCache<Key, Value>, scope: CoroutineScope = CoroutineScope(Dispatchers.Default)): KeyValueCacheRepo<Key, Value>
fun <Key, Value> KeyValueRepo<Key, Value>.cached(kvCache: FullKVCache<Key, Value>, scope: CoroutineScope = CoroutineScope(Dispatchers.Default)): FullKeyValueCacheRepo<Key, Value>
fun <Key, Value> ReadKeyValueRepo<Key, Value>.cached(kvCache: KVCache<Key, Value>): ReadKeyValueCacheRepo<Key, Value>
fun <Key, Value> ReadKeyValueRepo<Key, Value>.cached(kvCache: FullKVCache<Key, Value>): FullReadKeyValueCacheRepo<Key, Value>
caching
Link copied to clipboard
fun <Key, Value> WriteKeyValueRepo<Key, Value>.caching(kvCache: FullKVCache<Key, Value>, scope: CoroutineScope = CoroutineScope(Dispatchers.Default)): FullWriteKeyValueCacheRepo<Key, Value>
set
Link copied to clipboard
inline suspend fun <Key, Value> WriteKeyValueRepo<Key, Value>.set(vararg toSet: Pair<Key, Value>)
inline suspend fun <Key, Value> WriteKeyValueRepo<Key, Value>.set(k: Key, v: Value)
unset
Link copied to clipboard
inline suspend fun <Key, Value> WriteKeyValueRepo<Key, Value>.unset(vararg k: Key)
unsetWithValues
Link copied to clipboard
inline suspend fun <Key, Value> WriteKeyValueRepo<Key, Value>.unsetWithValues(vararg v: Value)
withMapper
Link copied to clipboard
inline fun <FromKey, FromValue, ToKey, ToValue> KeyValueRepo<ToKey, ToValue>.withMapper(mapper: MapperRepo<FromKey, FromValue, ToKey, ToValue>): KeyValueRepo<FromKey, FromValue>
inline fun <FromKey, FromValue, ToKey, ToValue> KeyValueRepo<ToKey, ToValue>.withMapper(noinline keyFromToTo: suspend FromKey.() -> ToKey = { this as ToKey }, noinline valueFromToTo: suspend FromValue.() -> ToValue = { this as ToValue }, noinline keyToToFrom: suspend ToKey.() -> FromKey = { this as FromKey }, noinline valueToToFrom: suspend ToValue.() -> FromValue = { this as FromValue }): KeyValueRepo<FromKey, FromValue>
inline fun <FromKey, FromValue, ToKey, ToValue> ReadKeyValueRepo<ToKey, ToValue>.withMapper(mapper: MapperRepo<FromKey, FromValue, ToKey, ToValue>): ReadKeyValueRepo<FromKey, FromValue>
inline fun <FromKey, FromValue, ToKey, ToValue> ReadKeyValueRepo<ToKey, ToValue>.withMapper(noinline keyFromToTo: suspend FromKey.() -> ToKey = { this as ToKey }, noinline valueFromToTo: suspend FromValue.() -> ToValue = { this as ToValue }, noinline keyToToFrom: suspend ToKey.() -> FromKey = { this as FromKey }, noinline valueToToFrom: suspend ToValue.() -> FromValue = { this as FromValue }): ReadKeyValueRepo<FromKey, FromValue>
inline fun <FromKey, FromValue, ToKey, ToValue> WriteKeyValueRepo<ToKey, ToValue>.withMapper(mapper: MapperRepo<FromKey, FromValue, ToKey, ToValue>): WriteKeyValueRepo<FromKey, FromValue>
inline fun <FromKey, FromValue, ToKey, ToValue> WriteKeyValueRepo<ToKey, ToValue>.withMapper(noinline keyFromToTo: suspend FromKey.() -> ToKey = { this as ToKey }, noinline valueFromToTo: suspend FromValue.() -> ToValue = { this as ToValue }, noinline keyToToFrom: suspend ToKey.() -> FromKey = { this as FromKey }, noinline valueToToFrom: suspend ToValue.() -> FromValue = { this as FromValue }): WriteKeyValueRepo<FromKey, FromValue>