Sealite/io.github.pasichdev.sealite

Package-level declarations

The public API of the library: the driver, its keys and configuration, and the maintenance functions. Everything else is internal and carries no compatibility promise.

Types

Sealite

object Sealite

Maintenance operations: a pre-flight check before Room opens a file, rekey to change the key, encryptPlaintext to migrate an unencrypted database, errorOf to tell why an open failed, and versions to see what is linked in.

SealiteConfig

class SealiteConfig

How SQLCipher reads and writes the file. DEFAULT matches SQLCipher 4, so files are interchangeable with net.zetetic:sqlcipher-android 4.x, SQLCipher for Apple platforms and the sqlcipher command line tool.

SealiteDriver

class SealiteDriver(key: SealiteKey, config: SealiteConfig) : SQLiteDriver, AutoCloseable

An SQLiteDriver whose every connection is SQLCipher-encrypted with a SealiteKey.

SealiteError

enum SealiteError : Enum<SealiteError>

Why Sealite refused a database: SealiteException.error, or Sealite.errorOf on any exception (Room may wrap it).

SealiteException

class SealiteException : RuntimeException

Sealite refused a database or could not finish a maintenance operation; error says why.

SealiteKey

class SealiteKey : AutoCloseable

The key a SealiteDriver opens databases with.

Functions

SealiteConfig

fun SealiteConfig(block: SealiteConfig.Builder.() -> Unit): SealiteConfig

Builds a SealiteConfig: SealiteConfig { compatibility = SealiteConfig.Compatibility.SQLCIPHER_3 }.