Skip to content

A self-hostable bookmark-everything app (links, notes and images) with AI-based automatic tagging and full text search

fix(db): open db in readonly mode while in degraded mode

Mohamed Bassemdd518bb3acbf
diff --git a/packages/db/drizzle.ts b/packages/db/drizzle.ts
index cedd35f2..c52b87d5 100644
--- a/packages/db/drizzle.ts
+++ b/packages/db/drizzle.ts
@@ -10,18 +10,12 @@ import serverConfig from "@karakeep/shared/config";
import dbConfig from "./drizzle.config";
import { instrumentDatabase } from "./instrumentation";
import * as schema from "./schema";
+import { openSqliteDatabase } from "./sqlite";
-const sqlite = new Database(dbConfig.dbCredentials.url);
-
-if (serverConfig.database.walMode) {
- sqlite.pragma("journal_mode = WAL");
- sqlite.pragma("synchronous = NORMAL");
-} else {
- sqlite.pragma("journal_mode = DELETE");
-}
-sqlite.pragma("cache_size = -65536");
-sqlite.pragma("foreign_keys = ON");
-sqlite.pragma("temp_store = MEMORY");
+const sqlite = openSqliteDatabase(dbConfig.dbCredentials.url, {
+ readOnly: serverConfig.degradedMode,
+ walMode: serverConfig.database.walMode,
+});
instrumentDatabase(sqlite);
diff --git a/packages/db/migrate.ts b/packages/db/migrate.ts
index 69b4ae80..7a60066a 100644
--- a/packages/db/migrate.ts
+++ b/packages/db/migrate.ts
@@ -1,5 +1,11 @@
import { migrate } from "drizzle-orm/better-sqlite3/migrator";
+import serverConfig from "@karakeep/shared/config";
+
import { db } from "./drizzle";
-migrate(db, { migrationsFolder: "./drizzle" });
+if (serverConfig.degradedMode) {
+ console.log("Skipping database migrations in degraded mode");
+} else {
+ migrate(db, { migrationsFolder: "./drizzle" });
+}
diff --git a/packages/db/sqlite.ts b/packages/db/sqlite.ts
new file mode 100644
index 00000000..9d546b47
--- /dev/null
+++ b/packages/db/sqlite.ts
@@ -0,0 +1,39 @@
+import Database from "better-sqlite3";
+
+interface OpenSqliteOptions {
+ readOnly: boolean;
+ walMode: boolean;
+}
+
+export function openSqliteDatabase(
+ filename: string,
+ options: OpenSqliteOptions,
+) {
+ const sqlite = new Database(
+ filename,
+ options.readOnly
+ ? {
+ readonly: true,
+ fileMustExist: true,
+ }
+ : undefined,
+ );
+
+ if (!options.readOnly) {
+ if (options.walMode) {
+ sqlite.pragma("journal_mode = WAL");
+ sqlite.pragma("synchronous = NORMAL");
+ } else {
+ sqlite.pragma("journal_mode = DELETE");
+ }
+ }
+ sqlite.pragma("cache_size = -65536");
+ sqlite.pragma("foreign_keys = ON");
+ sqlite.pragma("temp_store = MEMORY");
+
+ if (options.readOnly) {
+ sqlite.pragma("query_only = ON");
+ }
+
+ return sqlite;
+}