Backup

A backup is the whole store as one zip: every engine's files, each copied as one moment of itself while the store keeps working, with a manifest of each file's size and SHA-256. A restore puts it back into an empty directory, checking every byte, or leaves nothing.

const backup = await store.backup('backups/chat-2026-10-19.zip') // { files, bytes, keyLeftOut }

backup = await store.backup("backups/chat-2026-10-19.zip")  # Backup(files, bytes, key_left_out)

backup, err := store.Backup(ctx, "backups/chat-2026-10-19.zip") // tinystore.Backup{Files, Bytes, KeyLeftOut}

let backup = store.backup().write("backups/chat-2026-10-19.zip")?;

tinystore backup ./data backups/chat-2026-10-19.zip
tinystore restore backups/chat-2026-10-19.zip ./restored

#What it guarantees

• A backup holds one moment of each engine while the store keeps working (contract BAK-01).
• A restore checks every byte against the manifest and the zip, writes only into an empty directory, and leaves nothing when it fails (contract BAK-02).
• The store's encryption key and the program's own files are left out unless asked for, and a backup without the key says so (contract BAK-03).
• A backup that fails leaves no zip and no snapshot (contract BAK-04).

#In these guides

New to backups? Keeping it in the Handbook backs up every night with a schedule and restores on another machine.

#Reference

Bun and Node · Python · Go · Rust