@keyv/sqlite 4.0.8 → 6.0.0-alpha.2

package/README.md

@@ -25,7 +25,7 @@ const keyv = new Keyv(new KeyvSqlite('sqlite://path/to/database.sqlite'));
 keyv.on('error', handleConnectionError);
 ```
 
-You can specify the `table` and [`busyTimeout`](https://sqlite.org/c3ref/busy_timeout.html) option.
+You can specify the `table`, [`busyTimeout`](https://sqlite.org/c3ref/busy_timeout.html), and `wal` options.
 
 e.g:
 
@@ -35,12 +35,22 @@ import KeyvSqlite from '@keyv/sqlite';
 
 const keyvSqlite = new KeyvSqlite('sqlite://path/to/database.sqlite', {
   table: 'cache',
-  busyTimeout: 10000
+  busyTimeout: 10000,
+  wal: true // Enable WAL mode for better concurrency
 });
 
-const keyv = new Keyv({ store: keyvSqlite }); 
+const keyv = new Keyv({ store: keyvSqlite });
 ```
 
+### Options
+
+- `uri` - The SQLite database URI (default: `'sqlite://:memory:'`)
+- `table` - The table name to use for storage (default: `'keyv'`)
+- `busyTimeout` - Sets a busy handler that sleeps for a specified amount of time when a table is locked
+- `wal` - Enable [Write-Ahead Logging](https://sqlite.org/wal.html) mode for better concurrency and performance (default: `false`)
+  - **Note:** WAL mode is not supported for in-memory databases (`:memory:`). A warning will be logged and the option will be ignored.
+- `keySize` - The maximum key size in bytes (default: `255`, max: `65535`)
+
 You can also use a helper function to create `Keyv` with `KeyvSqlite` store.
 
 ```js

package/dist/index.cjs

@@ -35,8 +35,8 @@ __export(index_exports, {
   default: () => index_default
 });
 module.exports = __toCommonJS(index_exports);
-var import_node_events = __toESM(require("events"), 1);
 var import_node_util = require("util");
+var import_hookified = require("hookified");
 var import_keyv = __toESM(require("keyv"), 1);
 var import_sqlite3 = __toESM(require("sqlite3"), 1);
 var toTableString = (input) => {
@@ -46,15 +46,13 @@ var toTableString = (input) => {
   }
   return /^[a-zA-Z]/.test(sanitized) ? sanitized : `_${sanitized}`;
 };
-var KeyvSqlite = class extends import_node_events.default {
-  ttlSupport;
+var KeyvSqlite = class extends import_hookified.Hookified {
   opts;
   namespace;
   close;
   query;
   constructor(keyvOptions) {
-    super();
-    this.ttlSupport = false;
+    super({ throwOnEmptyListeners: false });
     let options = {
       dialect: "sqlite",
       uri: "sqlite://:memory:"
@@ -79,12 +77,24 @@ var KeyvSqlite = class extends import_node_events.default {
           resolve(database);
         }
       });
-    }).then((database) => ({
-      // @ts-expect-error
-      query: (0, import_node_util.promisify)(database.all).bind(database),
-      // @ts-expect-error
-      close: (0, import_node_util.promisify)(database.close).bind(database)
-    }));
+    }).then(async (database) => {
+      const query = (0, import_node_util.promisify)(database.all).bind(database);
+      const close = (0, import_node_util.promisify)(database.close).bind(database);
+      if (options.wal) {
+        const isInMemory = options.db === ":memory:" || options.db === "";
+        if (isInMemory) {
+          console.warn(
+            "@keyv/sqlite: WAL mode is not supported for in-memory databases. The wal option will be ignored."
+          );
+        } else {
+          await query("PRAGMA journal_mode=WAL");
+        }
+      }
+      return {
+        query,
+        close
+      };
+    });
     this.opts = {
       table: "keyv",
       keySize: 255,

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import EventEmitter from 'node:events';
+import { Hookified } from 'hookified';
 import Keyv, { KeyvStoreAdapter, StoredData } from 'keyv';
 
 type DbQuery = (sqlString: string, ...parameter: unknown[]) => Promise<any>;
@@ -11,14 +11,15 @@ type KeyvSqliteOptions = {
     keySize?: number;
     db?: string;
     iterationLimit?: number | string;
+    /** Enable WAL (Write-Ahead Logging) mode. */
+    wal?: boolean;
     connect?: () => Promise<{
         query: DbQuery;
         close: DbClose;
     }>;
 };
 
-declare class KeyvSqlite extends EventEmitter implements KeyvStoreAdapter {
-    ttlSupport: boolean;
+declare class KeyvSqlite extends Hookified implements KeyvStoreAdapter {
     opts: KeyvSqliteOptions;
     namespace?: string;
     close: DbClose;

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import EventEmitter from 'node:events';
+import { Hookified } from 'hookified';
 import Keyv, { KeyvStoreAdapter, StoredData } from 'keyv';
 
 type DbQuery = (sqlString: string, ...parameter: unknown[]) => Promise<any>;
@@ -11,14 +11,15 @@ type KeyvSqliteOptions = {
     keySize?: number;
     db?: string;
     iterationLimit?: number | string;
+    /** Enable WAL (Write-Ahead Logging) mode. */
+    wal?: boolean;
     connect?: () => Promise<{
         query: DbQuery;
         close: DbClose;
     }>;
 };
 
-declare class KeyvSqlite extends EventEmitter implements KeyvStoreAdapter {
-    ttlSupport: boolean;
+declare class KeyvSqlite extends Hookified implements KeyvStoreAdapter {
     opts: KeyvSqliteOptions;
     namespace?: string;
     close: DbClose;

package/dist/index.js

@@ -1,6 +1,6 @@
 // src/index.ts
-import EventEmitter from "events";
 import { promisify } from "util";
+import { Hookified } from "hookified";
 import Keyv from "keyv";
 import sqlite3 from "sqlite3";
 var toTableString = (input) => {
@@ -10,15 +10,13 @@ var toTableString = (input) => {
   }
   return /^[a-zA-Z]/.test(sanitized) ? sanitized : `_${sanitized}`;
 };
-var KeyvSqlite = class extends EventEmitter {
-  ttlSupport;
+var KeyvSqlite = class extends Hookified {
   opts;
   namespace;
   close;
   query;
   constructor(keyvOptions) {
-    super();
-    this.ttlSupport = false;
+    super({ throwOnEmptyListeners: false });
     let options = {
       dialect: "sqlite",
       uri: "sqlite://:memory:"
@@ -43,12 +41,24 @@ var KeyvSqlite = class extends EventEmitter {
           resolve(database);
         }
       });
-    }).then((database) => ({
-      // @ts-expect-error
-      query: promisify(database.all).bind(database),
-      // @ts-expect-error
-      close: promisify(database.close).bind(database)
-    }));
+    }).then(async (database) => {
+      const query = promisify(database.all).bind(database);
+      const close = promisify(database.close).bind(database);
+      if (options.wal) {
+        const isInMemory = options.db === ":memory:" || options.db === "";
+        if (isInMemory) {
+          console.warn(
+            "@keyv/sqlite: WAL mode is not supported for in-memory databases. The wal option will be ignored."
+          );
+        } else {
+          await query("PRAGMA journal_mode=WAL");
+        }
+      }
+      return {
+        query,
+        close
+      };
+    });
     this.opts = {
       table: "keyv",
       keySize: 255,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@keyv/sqlite",
-  "version": "4.0.8",
+  "version": "6.0.0-alpha.2",
   "description": "SQLite storage adapter for Keyv",
   "type": "module",
   "main": "./dist/index.js",
@@ -41,10 +41,11 @@
   },
   "homepage": "https://github.com/jaredwray/keyv",
   "dependencies": {
+    "hookified": "^2.0.0",
     "sqlite3": "^5.1.7"
   },
   "peerDependencies": {
-    "keyv": "^5.6.0"
+    "keyv": "^6.0.0-alpha.2"
   },
   "devDependencies": {
     "@biomejs/biome": "^2.3.11",
@@ -53,7 +54,7 @@
     "rimraf": "^6.1.2",
     "tsd": "^0.33.0",
     "vitest": "^4.0.17",
-    "@keyv/test-suite": "^2.1.2"
+    "@keyv/test-suite": "^6.0.0-alpha.2"
   },
   "tsd": {
     "directory": "test"