Sealite/io.github.pasichdev.sealite/SealiteConfig

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.

The configuration must describe the file: a database written with other settings fails to open with SealiteError.WRONG_KEY, exactly like a wrong key.

val legacy = SealiteConfig { compatibility = SealiteConfig.Compatibility.SQLCIPHER_3 }
// Java: SealiteConfig.builder().compatibility(Compatibility.SQLCIPHER_3).build()

Built only through Builder, so options can be added in minor releases without breaking binaries.

Types

Builder

class Builder

Builds a SealiteConfig; every option starts at the SQLCipher 4 default.

Companion

object Companion

Compatibility

enum Compatibility : Enum<SealiteConfig.Compatibility>

SQLCipher major-version defaults (cipher, KDF, HMAC, page size). New versions may be added in minor releases: keep an else branch when matching.

Properties

compatibility

val compatibility: SealiteConfig.Compatibility

The SQLCipher major version whose defaults apply.

kdfIterations

val kdfIterations: Int?

PBKDF2 iterations for SealiteKey.passphrase keys; null keeps the compatibility default. Raw keys do not run a key derivation. Lowering it weakens passphrase keys.

pageSize

val pageSize: Int?

Page size in bytes, a power of two from 512 to 65536; null keeps the compatibility default.

Functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toBuilder

fun toBuilder(): SealiteConfig.Builder

A copy of this configuration to change.

toString

open override fun toString(): String