Module backup 

Structs

BackupEntry

Metadata for a single database backup.

BackupManifest

Manifest that tracks all database backups.

DbBackupManager

Manages versioned SQLite database backups.

Enums

RestoreError

Errors that can occur when restoring a database backup.

Constants

BACKUP_BUSY_SLEEP_MS 🔒

Milliseconds to sleep when the backup step returns SQLITE_BUSY or SQLITE_LOCKED.

BACKUP_DIR 🔒

Subdirectory under the database directory where backups are stored.

BACKUP_PAGE_COUNT 🔒

Number of pages copied per sqlite3_backup_step iteration.

MAIN_DB_NAME 🔒

SQLite database name passed to the online backup API ("main").

MANIFEST_FILE 🔒

Filename of the TOML manifest that tracks all known backups.

SQLITE_BUSY 🔒

SQLite result code indicating the database is busy.

SQLITE_COMPANION_SUFFIXES 🔒

File suffixes for SQLite companion files (WAL and shared-memory).

SQLITE_DONE 🔒

SQLite result code indicating the backup has finished.

SQLITE_LOCKED 🔒

SQLite result code indicating a table-level lock conflict.

SQLITE_OK 🔒

SQLite result code indicating success.

Functions

add_suffix 🔒

Adds a suffix to a path before the file extension.

copy_sqlite_files 🔒

Copies an SQLite database file and its WAL/SHM companions.

online_backup 🔒

Creates an online backup of src_pool at dest_path.

remove_sqlite_files 🔒

Removes an SQLite database file and its WAL/SHM companions.

rename_sqlite_files 🔒

Renames an SQLite database file and its WAL/SHM companions.

run_backup_steps 🔒

Synchronous backup step loop using the SQLite C API.

sqlite_error_message 🔒 ^⚠

Returns the SQLite error message for a database handle.