micro_utils.dokka/dev.inmo.micro_utils.repos/ReadKeyValuesRepo

ReadKeyValuesRepo

interface ReadKeyValuesRepo<Key, Value> : Repo(source)

Read part of KeyValuesRepo for one-to-many key-value relationships. This repository type allows multiple values to be associated with a single key.

Type Parameters

Key

The type used as the key in all search operations

Value

The type of values associated with keys

Inheritors

DelegateBasedKeyValuesRepo

MapReadKeyValuesRepo

MapKeyValuesRepo

ReadKeyValuesCacheRepo

AutoRecacheReadKeyValuesRepo

FullReadKeyValuesCacheRepo

DirectFullReadKeyValuesCacheRepo

MapperReadKeyValuesRepo

MapperKeyValuesRepo

ReadKeyValuesFromKeyValueRepo

KtorReadKeyValuesRepoClient

AbstractExposedReadKeyValuesRepo

ExposedReadKeyValuesRepo

Functions

asReadKeyValueRepo

fun <K, V> ReadKeyValuesRepo<K, V>.asReadKeyValueRepo(): ReadKeyValueFromKeyValuesRepo<K, V>

Wraps this ReadKeyValuesRepo as a ReadKeyValueFromKeyValuesRepo, exposing each key mapped to a List of all associated values.

fun <Key, Value> ReadKeyValuesRepo<Key, Value>.cached(kvCache: KVCache<Key, List<Value>>, locker: SmartRWLocker = SmartRWLocker()): ReadKeyValuesCacheRepo<Key, Value>

fun <Key, Value> ReadKeyValuesRepo<Key, Value>.cached(kvCache: KeyValueRepo<Key, List<Value>>, locker: SmartRWLocker = SmartRWLocker()): FullReadKeyValuesCacheRepo<Key, Value>

abstract suspend fun contains(k: Key): Boolean

Checks if the specified key exists in the repository.

abstract suspend fun contains(k: Key, v: Value): Boolean

Checks if the specified key-value pair exists in the repository.

abstract suspend fun count(): Long

Returns the total count of key-value pairs in the repository.

abstract suspend fun count(k: Key): Long

Returns the count of values associated with the specified key.

suspend fun <Id, Registered> ReadKeyValuesRepo<Id, Registered>.diff(other: Map<Id, List<Registered>>): MapDiff<Id, List<Registered>>

Computes the difference between all entries in this ReadKeyValuesRepo and the given other map.

fun <Key, Value> ReadKeyValuesRepo<Key, Value>.directlyCached(kvCache: KeyValueRepo<Key, List<Value>>, locker: SmartRWLocker = SmartRWLocker()): DirectFullReadKeyValuesCacheRepo<Key, Value>

abstract suspend fun get(k: Key, pagination: Pagination, reversed: Boolean = false): PaginationResult<Value>

Retrieves a paginated list of values associated with the given key.

open suspend fun getAll(reverseLists: Boolean = false): Map<Key, List<Value>>

WARNING!!! THIS METHOD PROBABLY IS NOT EFFICIENT, USE WITH CAUTION

open suspend fun getAll(k: Key, reversed: Boolean = false): List<Value>

abstract suspend fun keys(pagination: Pagination, reversed: Boolean = false): PaginationResult<Key>

Retrieves a paginated list of keys.

abstract suspend fun keys(v: Value, pagination: Pagination, reversed: Boolean = false): PaginationResult<Key>

Retrieves keys that have the specified value associated with them.

maxPagePagination

inline suspend fun ReadKeyValuesRepo<*, *>.maxPagePagination(): SimplePagination

Creates a pagination starting from the first page with size equal to the total count of items in this ReadKeyValuesRepo. This effectively creates a single page containing all items.

inline fun <FromKey, FromValue, ToKey, ToValue> ReadKeyValuesRepo<ToKey, ToValue>.withMapper(mapper: MapperRepo<FromKey, FromValue, ToKey, ToValue>): ReadKeyValuesRepo<FromKey, FromValue>

Wraps this ReadKeyValuesRepo with a MapperRepo to expose a mapped ReadKeyValuesRepo.

inline fun <FromKey, FromValue, ToKey, ToValue> ReadKeyValuesRepo<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 }): ReadKeyValuesRepo<FromKey, FromValue>

Wraps this ReadKeyValuesRepo with inline conversion lambdas to expose a mapped ReadKeyValuesRepo.