First pass at introducing kestrel and refactoring to make the RESTAPI be its own package.

2022-12-30 10:59:29 -08:00
parent 83cc35664b
commit 235568dade
79 changed files with 11412 additions and 11074 deletions
@@ -0,0 +1,158 @@
+/*
+ * The primary table that stores all backups.
+ *
+ * The name and tag are free form user strings.
+ * The tags are comma separated
+ * the TargetURL is the url to remote storage,
+ * and the DBPath is the path to the local database
+ */
+CREATE TABLE "Backup" (
+    "ID" INTEGER PRIMARY KEY AUTOINCREMENT,
+    "Name" TEXT NOT NULL,
+    "Description" TEXT NOT NULL DEFAULT '',
+    "Tags" TEXT NOT NULL,
+    "TargetURL" TEXT NOT NULL,
+    "DBPath" TEXT NOT NULL
+);
+
+/*
+ * The table that stores all schedules
+ * 
+ * Tags is a comma separated parsed field that indicates 
+ * which backups to run when activated.
+ * special tags are ID:1 which means backup with ID = 1
+ * 
+ * Time is the scheduled time, and lastRun is the last time the backup was executed
+ *
+ * Rule is a special parsed field
+ */
+CREATE TABLE "Schedule" (
+    "ID" INTEGER PRIMARY KEY,
+    "Tags" TEXT NOT NULL,
+    "Time" INTEGER NOT NULL,
+    "Repeat" TEXT NOT NULL,
+    "LastRun" INTEGER NOT NULL,
+    "Rule" TEXT NOT NULL
+);
+
+/*
+ * The source table is a list of source folders and files
+ */
+CREATE TABLE "Source" (
+    "BackupID" INTEGER NOT NULL,
+    "Path" TEXT NOT NULL
+);
+
+/*
+ * The filter table contains all filters associated with a backup.
+ * The special backupID -1 means "applied to all backups"
+ * The expression is the filter, if the filter is a regular
+ * expression, it is surrounded by hard brackets [ ]
+ */
+CREATE TABLE "Filter" (
+    "BackupID" INTEGER NOT NULL,
+    "Order" INTEGER NOT NULL,
+    "Include" INTEGER NOT NULL,
+    "Expression" TEXT NOT NULL
+);
+
+/*
+ * All options are stored in this table
+ *
+ * The special backupID -1 means "applied to all backups".
+ *
+ * The filter is used to indicate what the option applies to,
+ * for instance backend:s3 will only apply to backends of type S3
+ *
+ * The name and value are the option name and value
+ */
+CREATE TABLE "Option" (
+    "BackupID" INTEGER NOT NULL,
+    "Filter" TEXT NOT NULL,
+    "Name" TEXT NOT NULL,
+    "Value" TEXT NOT NULL
+);
+
+/*
+ * Recorded metadata about a backup
+ * This table contains metadata, such as when the backup was last started,
+ * how long it took, how many files there were, how big the backup set was,
+ * how much data was uploaded, downloaded, how fast, how much space is left,
+ * and similar data. Programs can use this information to improve the display,
+ * but cannot count on these values being present
+ */
+CREATE TABLE "Metadata" (
+    "BackupID" INTEGER NOT NULL,
+    "Name" TEXT NOT NULL,
+    "Value" TEXT NOT NULL
+);
+
+/*
+ * The log of operations initiated by the scheduler/user
+ */
+CREATE TABLE "Log" (
+    "BackupID" INTEGER NOT NULL,
+    "Description" TEXT NOT NULL,
+    "Start" INTEGER NOT NULL,
+    "Finish" INTEGER NOT NULL,
+    "Result" TEXT NOT NULL,
+    "SuggestedIcon" TEXT NOT NULL
+);
+
+/*
+ * The log of errors
+ */
+CREATE TABLE "ErrorLog" (
+    "BackupID" INTEGER,
+    "Message" TEXT NOT NULL,
+    "Exception" TEXT,
+    "Timestamp" INTEGER NOT NULL
+);
+
+/*
+Internal version tracking
+*/
+CREATE TABLE "Version" (
+    "ID" INTEGER PRIMARY KEY,
+    "Version" INTEGER NOT NULL
+);
+
+/*
+Notifications not yet acknowledged by the user
+*/
+CREATE TABLE "Notification" (
+    "ID" INTEGER PRIMARY KEY,
+    "Type" TEXT NOT NULL,
+    "Title" TEXT NOT NULL,
+    "Message" TEXT NOT NULL, 
+    "Exception" TEXT NOT NULL, 
+    "BackupID" TEXT NULL,
+    "Action" TEXT NOT NULL,
+    "Timestamp" INTEGER NOT NULL,
+    "LogEntryID" TEXT NULL,
+    "MessageID" TEXT NULL,
+    "MessageLogTag" TEXT NULL
+);
+
+/*
+Key/value storage for frontends
+*/
+CREATE TABLE "UIStorage" (
+    "Scheme" TEXT NOT NULL, 
+    "Key" TEXT NOT NULL, 
+    "Value" TEXT NOT NULL
+);
+
+/*
+Long-term temporary file records
+*/
+CREATE TABLE "TempFile" (
+    "ID" INTEGER PRIMARY KEY,
+    "Origin" TEXT NOT NULL, 
+    "Path" TEXT NOT NULL, 
+    "Timestamp" INTEGER NOT NULL,
+    "Expires" INTEGER NOT NULL
+);
+
+INSERT INTO "Version" ("Version") VALUES (6);
+