@keyv/sqlite 4.0.6 → 6.0.0-alpha.1

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

@@ -47,14 +47,12 @@ var toTableString = (input) => {
   return /^[a-zA-Z]/.test(sanitized) ? sanitized : `_${sanitized}`;
 };
 var KeyvSqlite = class extends import_node_events.default {
-  ttlSupport;
   opts;
   namespace;
   close;
   query;
   constructor(keyvOptions) {
     super();
-    this.ttlSupport = 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,
@@ -100,7 +110,10 @@ var KeyvSqlite = class extends import_node_events.default {
     const createTable = `CREATE TABLE IF NOT EXISTS ${this.opts.table}(key VARCHAR(${keySize}) PRIMARY KEY, value TEXT )`;
     const connected = this.opts.connect().then(
       async (database) => database.query(createTable).then(() => database)
-    ).catch((error) => this.emit("error", error));
+    ).catch((error) => {
+      this.emit("error", error);
+      throw error;
+    });
     this.query = async (sqlString, ...parameter) => connected.then(
       async (database) => database.query(sqlString, ...parameter)
     );
@@ -195,3 +208,4 @@ var index_default = KeyvSqlite;
   KeyvSqlite,
   createKeyv
 });
+/* v8 ignore next -- @preserve */

package/dist/index.d.cts

@@ -11,6 +11,8 @@ type KeyvSqliteOptions = {
     keySize?: number;
     db?: string;
     iterationLimit?: number | string;
+    /** Enable WAL (Write-Ahead Logging) mode. */
+    wal?: boolean;
     connect?: () => Promise<{
         query: DbQuery;
         close: DbClose;
@@ -18,7 +20,6 @@ type KeyvSqliteOptions = {
 };
 
 declare class KeyvSqlite extends EventEmitter implements KeyvStoreAdapter {
-    ttlSupport: boolean;
     opts: KeyvSqliteOptions;
     namespace?: string;
     close: DbClose;

package/dist/index.d.ts

@@ -11,6 +11,8 @@ type KeyvSqliteOptions = {
     keySize?: number;
     db?: string;
     iterationLimit?: number | string;
+    /** Enable WAL (Write-Ahead Logging) mode. */
+    wal?: boolean;
     connect?: () => Promise<{
         query: DbQuery;
         close: DbClose;
@@ -18,7 +20,6 @@ type KeyvSqliteOptions = {
 };
 
 declare class KeyvSqlite extends EventEmitter implements KeyvStoreAdapter {
-    ttlSupport: boolean;
     opts: KeyvSqliteOptions;
     namespace?: string;
     close: DbClose;

package/dist/index.js

@@ -11,14 +11,12 @@ var toTableString = (input) => {
   return /^[a-zA-Z]/.test(sanitized) ? sanitized : `_${sanitized}`;
 };
 var KeyvSqlite = class extends EventEmitter {
-  ttlSupport;
   opts;
   namespace;
   close;
   query;
   constructor(keyvOptions) {
     super();
-    this.ttlSupport = 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,
@@ -64,7 +74,10 @@ var KeyvSqlite = class extends EventEmitter {
     const createTable = `CREATE TABLE IF NOT EXISTS ${this.opts.table}(key VARCHAR(${keySize}) PRIMARY KEY, value TEXT )`;
     const connected = this.opts.connect().then(
       async (database) => database.query(createTable).then(() => database)
-    ).catch((error) => this.emit("error", error));
+    ).catch((error) => {
+      this.emit("error", error);
+      throw error;
+    });
     this.query = async (sqlString, ...parameter) => connected.then(
       async (database) => database.query(sqlString, ...parameter)
     );
@@ -159,3 +172,4 @@ export {
   createKeyv,
   index_default as default
 };
+/* v8 ignore next -- @preserve */

package/package.json

@@ -1,15 +1,21 @@
 {
   "name": "@keyv/sqlite",
-  "version": "4.0.6",
+  "version": "6.0.0-alpha.1",
   "description": "SQLite storage adapter for Keyv",
   "type": "module",
-  "main": "dist/index.cjs",
-  "module": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "require": "./dist/index.cjs",
-      "import": "./dist/index.js"
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      },
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
     }
   },
   "repository": {
@@ -38,16 +44,16 @@
     "sqlite3": "^5.1.7"
   },
   "peerDependencies": {
-    "keyv": "^5.5.3"
+    "keyv": "^6.0.0-alpha.1"
   },
   "devDependencies": {
-    "@biomejs/biome": "^2.2.5",
-    "@faker-js/faker": "^10.0.0",
-    "@vitest/coverage-v8": "^3.2.4",
-    "rimraf": "^6.0.1",
+    "@biomejs/biome": "^2.3.11",
+    "@faker-js/faker": "^10.2.0",
+    "@vitest/coverage-v8": "^4.0.17",
+    "rimraf": "^6.1.2",
     "tsd": "^0.33.0",
-    "vitest": "^3.2.4",
-    "@keyv/test-suite": "^2.1.1"
+    "vitest": "^4.0.17",
+    "@keyv/test-suite": "^6.0.0-alpha.1"
   },
   "tsd": {
     "directory": "test"