app/lib/backup/d1-backup.server.ts

Functions

Imports

It imports app/lib/backup/policy.mjs. Imported by app/lib/operator/api.server.ts.

Source

1// The nightly D1 dump. The Worker holds DB and BACKUPS; the watchdog's cron reaches it through the
2// operator API (workers/watchdog.ts), because the site Worker has no cron by ruling and the
3// watchdog holds no database binding.
4//
5// BACKUPS is a separate bucket from MEDIA_BACKUP on purpose: check:destructive allows pruneDumps on
6// this binding and no delete at all on the media mirror.
7
8import { readPlan, runCheckedBackup } from "@dustinedwards/d1-dump";
9import { EXCLUDED_TABLES, REQUIRED_TABLES, dumpProblems } from "~/lib/backup/policy.mjs";
10
11type BackupEnv = Pick<Env, "DB" | "BACKUPS">;
12
13export async function backupD1(env: BackupEnv) {
14  // d1-dump's runCheckedBackup: dump without the marker, run its standard checks and this site's
15  // policy, then write the marker and prune. A run that fails keeps its objects as evidence and is
16  // never the newest dump latestDump returns, so a bad run cannot become the restore point; with no
17  // new complete run, nothing is pruned.
18  const { dump, pruned } = await runCheckedBackup(env.DB, env.BACKUPS, {
19    exclude: [...EXCLUDED_TABLES],
20    required: [...REQUIRED_TABLES],
21    check: async (d) => dumpProblems({ tables: d.tables, excluded: d.excluded, schema: (await readPlan(env.DB)).schema }),
22  });
23  return {
24    run_id: dump.run_id,
25    exported_at: dump.exported_at,
26    tables: dump.tables.length,
27    rows: dump.tables.reduce((sum, t) => sum + t.rows, 0),
28    kept: pruned.kept,
29    pruned: pruned.pruned,
30    locked: pruned.locked,
31  };
32}