Graphorin API reference v0.14.0
Graphorin API reference / @graphorin/store-sqlite-encrypted / / backupEncryptedDatabase
Function: backupEncryptedDatabase()
ts
function backupEncryptedDatabase(options): Promise<BackupEncryptedDatabaseResult>;Defined in: packages/store-sqlite-encrypted/src/backup.ts:119
Stable
Takes a consistent, still-encrypted backup copy of an encrypted database. Requires a stopped server: throws EncryptedBackupLiveWriterError when another holder is detected at any layer of the guard. Also throws if the file is missing, the cipher peer cannot be loaded, the passphrase is wrong (SQLITE_NOTADB on the first read), or the post-copy integrity check fails.
Parameters
| Parameter | Type |
|---|---|
options | BackupEncryptedDatabaseOptions |
Returns
Promise<BackupEncryptedDatabaseResult>