persistence/com.wire.kalium.persistence.db

Package-level declarations

Types

Fine tuning configuration for the driver. This is useful if we want to squeeze the last bit of performance out of the database. Or if we want to enable some SQLite specific features.

GlobalDatabaseBuilder

class GlobalDatabaseBuilder(sqlDriver: <Error class: unknown class>, platformDatabaseData: PlatformDatabaseData, queriesContext: <Error class: unknown class> = KaliumDispatcherImpl.io)

GlobalDatabaseSecret

value class GlobalDatabaseSecret(val value: ByteArray)

InMemoryDatabaseCache

internal object InMemoryDatabaseCache

Provides an in-memory cache for in-memory databases.

PlatformDatabaseData

expect class PlatformDatabaseData

Platform-specific data used to create the database that might be necessary for future operations in the future like nuke

actual class PlatformDatabaseData

actual data class PlatformDatabaseData

StorageData

sealed class StorageData

interface StorageData

TableMapper

internal object TableMapper

UserDatabaseBuilder

class UserDatabaseBuilder(userId: UserIDEntity, val sqlDriver: <Error class: unknown class>, dispatcher: <Error class: unknown class>, platformDatabaseData: PlatformDatabaseData, isEncrypted: Boolean, queriesContext: <Error class: unknown class> = KaliumDispatcherImpl.io)

UserDBSecret

value class UserDBSecret(val value: ByteArray)

Functions

checkFKViolations

fun <Error class: unknown class>.checkFKViolations(): Boolean

clearInMemoryDatabase

fun clearInMemoryDatabase(userId: UserIDEntity): Boolean

createGlobalInMemoryDatabase

fun createGlobalInMemoryDatabase(dispatcher: <Error class: unknown class>): GlobalDatabaseBuilder

databaseDriver

fun databaseDriver(context: <Error class: unknown class>, dbName: String, passphrase: ByteArray? = null, schema: <Error class: unknown class><<Error class: unknown class><Unit>>, config: DriverConfigurationBuilder.() -> Unit = {}): <Error class: unknown class>

fun databaseDriver(driverUri: String?, dbName: String, schema: <Error class: unknown class><<Error class: unknown class><Unit>>, config: <Error class: unknown class>.() -> Unit = {}): <Error class: unknown class>

fun databaseDriver(uri: String, config: DriverConfigurationBuilder.() -> Unit = {}): <Error class: unknown class>

getDatabaseAbsoluteFileLocation

internal expect fun getDatabaseAbsoluteFileLocation(platformDatabaseData: PlatformDatabaseData, userId: UserIDEntity): String?

internal actual fun getDatabaseAbsoluteFileLocation(platformDatabaseData: PlatformDatabaseData, userId: UserIDEntity): String?

globalDatabaseProvider

expect fun globalDatabaseProvider(platformDatabaseData: PlatformDatabaseData, queriesContext: <Error class: unknown class> = KaliumDispatcherImpl.io, passphrase: GlobalDatabaseSecret?, enableWAL: Boolean = false): GlobalDatabaseBuilder

Creates a new instance of the GlobalDatabaseBuilder.

actual fun globalDatabaseProvider(platformDatabaseData: PlatformDatabaseData, queriesContext: <Error class: unknown class>, passphrase: GlobalDatabaseSecret?, enableWAL: Boolean): GlobalDatabaseBuilder

inMemoryDatabase

fun inMemoryDatabase(context: <Error class: unknown class>, userId: UserIDEntity, dispatcher: <Error class: unknown class>): UserDatabaseBuilder

fun inMemoryDatabase(userId: <Error class: unknown class>, dispatcher: <Error class: unknown class>): <Error class: unknown class>

fun inMemoryDatabase(userId: UserIDEntity, dispatcher: <Error class: unknown class>): UserDatabaseBuilder

Creates an in-memory user database, or returns an existing one if it already exists.

migrate

fun <Error class: unknown class>.migrate(sqlSchema: <Error class: unknown class><<Error class: unknown class><Unit>>): Boolean

nuke

expect fun nuke(platformDatabaseData: PlatformDatabaseData): Boolean

internal expect fun nuke(userId: UserIDEntity, platformDatabaseData: PlatformDatabaseData): Boolean

actual fun nuke(platformDatabaseData: PlatformDatabaseData): Boolean

internal actual fun nuke(userId: UserIDEntity, platformDatabaseData: PlatformDatabaseData): Boolean

actual fun nuke(platformDatabaseData: PlatformDatabaseData): Boolean

internal actual fun nuke(userId: UserIDEntity, platformDatabaseData: PlatformDatabaseData): Boolean

userDatabaseBuilder

expect fun userDatabaseBuilder(platformDatabaseData: PlatformDatabaseData, userId: UserIDEntity, passphrase: UserDBSecret?, dispatcher: <Error class: unknown class>, enableWAL: Boolean = true): UserDatabaseBuilder

Creates a UserDatabaseBuilder for the given userId and passphrase

actual fun userDatabaseBuilder(platformDatabaseData: PlatformDatabaseData, userId: UserIDEntity, passphrase: UserDBSecret?, dispatcher: <Error class: unknown class>, enableWAL: Boolean): UserDatabaseBuilder

userDatabaseDriverByPath

internal expect fun userDatabaseDriverByPath(platformDatabaseData: PlatformDatabaseData, path: String, passphrase: UserDBSecret?, enableWAL: Boolean): <Error class: unknown class>

actual fun userDatabaseDriverByPath(platformDatabaseData: PlatformDatabaseData, path: String, passphrase: UserDBSecret?, enableWAL: Boolean): <Error class: unknown class>