cloudflare-d1-backups

This is a package based heavily on sqlite-dump for Python by simonw but modified to be suitable for the current state of the open alpha, experimental backend (beta), databases.

This script has only been tested on a 660kb database, with 634 statements; from an experimental backend to an experimental backend.

Create a backup

Creating a backup creates a SQL file in the destination R2 bucket.

• Install the package: npm install @nora-soderlund/cloudflare-d1-backups.
• Call createBackup(D1Database, R2Bucket, CreateBackupOptions | undefined) from an execution context.

CreateBackupOptions

• hourFormat: either (true): "09:00:52PM"|(false | undefined): "20:00:52", defaults to (false | undefined): "20:00:52".
• fileName: the file name for the SQL file in the R2 bucket, default is backups/${(new Date()).toUTCString()}.sql.
• cloudflarePlan: any of "Free" | "Pro" | "Business" | "Enterprise", this sets the respective maxBodySize, defaults to "Free" (100 MB).
• maxBodySize: the maximum body size for R2 bucket uploads in MB, this depends on your plan, unless you're using Enterprise with a custom size, leave this unset.

Restoring a backup

Assuming you've downloaded the backed up SQL file from your R2 bucket: npx wrangler d1 execute <database> --file=<backup.sql>

Example

See /example for an example worker.