persistence/com.wire.kalium.persistence.db

Package-level declarations

Types

class DatabaseOptimizer(localDatabase: UserDatabaseBuilder, dispatcher: <Error class: unknown class> = KaliumDispatcherImpl)

DBProfile

sealed interface DBProfile

DebugExtension

class DebugExtension(sqlDriver: <Error class: unknown class>, isEncrypted: Boolean, metaDataDao: MetadataDAO)

DriverConfigurationBuilder

class DriverConfigurationBuilder

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

actual class PlatformDatabaseData

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

actual data class 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

ReadDispatcher

value class ReadDispatcher(val value: <Error class: unknown class>)

Dispatcher for database read operations. Limited to MAX_READ_PARALLELISM (3) concurrent reads to prevent SQLCipher connection pool exhaustion while maintaining good throughput.

StorageData

sealed class StorageData

sealed 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)

UserDBSecret

value class UserDBSecret(val value: ByteArray)

WriteDispatcher

value class WriteDispatcher(val value: <Error class: unknown class>)

Dispatcher for database write operations. Limited to MAX_WRITE_PARALLELISM (1) to serialize writes and aligning with SQLite's single-writer model.

Functions

checkFKViolations

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

clearInMemoryDatabase

fun clearInMemoryDatabase(userId: UserIDEntity): Boolean

createEmptyDatabaseFile

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

internal actual fun createEmptyDatabaseFile(platformDatabaseData: PlatformDatabaseData, userId: <Error class: unknown class>): String?

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

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

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 actual fun getDatabaseAbsoluteFileLocation(platformDatabaseData: PlatformDatabaseData, userId: UserIDEntity): String?

internal actual fun getDatabaseAbsoluteFileLocation(platformDatabaseData: PlatformDatabaseData, userId: <Error class: unknown class>): String?

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

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

globalDatabaseProvider

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

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

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.

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

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: <Error class: unknown class>, platformDatabaseData: PlatformDatabaseData): Boolean

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

platformDatabaseLogger

internal actual fun platformDatabaseLogger(): String

internal expect fun platformDatabaseLogger(): String

internal actual fun platformDatabaseLogger(): String

userDatabaseBuilder

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

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

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

userDatabaseDriverByPath

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

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

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>