API reference › @evolu/sqlite-wasm › SqliteEncryptedFileDatabaseOptions

Defined in: packages/sqlite-wasm/src/Database.ts:664

A database file on a SahPool that Evolu's codec encrypts, in the format of SQLite3 Multiple Ciphers' sqlcipher scheme.

Only the database file and its journal are encrypted. The connection attaches other databases read-only and creates no file, because SQLite ignores the KEY clause of ATTACH, and VACUUM INTO writes a plaintext file, where 2.2.4 encrypted both with the database's key or the KEY of ATTACH.

Extends

Properties

key

readonly key: Uint8Array<ArrayBufferLike> & Brand<"Entropy"> & Brand<"Length32"> & Brand<"EncryptionKey">;

Defined in: packages/sqlite-wasm/src/Database.ts:675

The raw key, which the open stages in wasm memory for the codec, which keeps its own copy until the database is disposed.

path

readonly path: string & Brand<"SqliteVfsPath">;

Defined in: packages/sqlite-wasm/src/Database.ts:670

The path of the file in the pool, as SqliteFileDatabaseOptions.path describes.

type

readonly type: "EncryptedFile";

Defined in: packages/common/dist/src/Type.d.ts:9304

Inherited from

Typed.type

vfs

readonly vfs: SahPool;

Defined in: packages/sqlite-wasm/src/Database.ts:665

Markdown for LLMs