feat: support dispose and using createDatabase() (#178)

Co-authored-by: Pooya Parsa <[email protected]>

Author: RihanArfan

docs/1.guide/1.index.md

@@ -30,6 +30,11 @@ import sqlite from "db0/connectors/better-sqlite3";
 // Initiate database with SQLite connector
 const db = createDatabase(sqlite({}));
 
+// Alternative:
+// `using` automatically closes the database connection
+// once the `db` variable goes out of scope  (for example, the function execution ends)
+// await using db = createDatabase(sqlite({}));
+
 // Create users table
 await db.sql`CREATE TABLE IF NOT EXISTS users ("id" TEXT PRIMARY KEY, "firstName" TEXT, "lastName" TEXT, "email" TEXT)`;
 

src/connectors/better-sqlite3.ts

@@ -38,6 +38,10 @@ export default function sqliteConnector(
     getInstance: () => getDB(),
     exec: (sql) => getDB().exec(sql),
     prepare: (sql) => new StatementWrapper(() => getDB().prepare(sql)),
+    dispose: () => {
+      _db?.close?.();
+      _db = undefined as any;
+    },
   };
 }
 

src/connectors/bun-sqlite.ts

@@ -37,6 +37,10 @@ export default function bunSqliteConnector(
     getInstance: () => getDB(),
     exec: (sql) => getDB().exec(sql),
     prepare: (sql) => new StatementWrapper(getDB().prepare(sql)),
+    dispose: () => {
+      _db?.close?.();
+      _db = undefined as any;
+    },
   };
 }
 

src/connectors/libsql/core.ts

@@ -20,6 +20,9 @@ export default function libSqlCoreConnector(
     getInstance: async () => opts.getClient(),
     exec: (sql) => query(sql),
     prepare: (sql) => new StatementWrapper(sql, query),
+    dispose: () => {
+      opts.getClient()?.close?.();
+    },
   };
 }
 

src/connectors/mysql2.ts

@@ -36,6 +36,10 @@ export default function mysqlConnector(
     getInstance: () => getConnection(),
     exec: (sql) => query(sql),
     prepare: (sql) => new StatementWrapper(sql, query),
+    dispose: async () => {
+      await _connection?.end?.();
+      _connection = undefined;
+    },
   };
 }
 

src/connectors/node-sqlite.ts

@@ -47,6 +47,10 @@ export default function nodeSqlite3Connector(
       return { success: true };
     },
     prepare: (sql) => new StatementWrapper(() => getDB().prepare(sql)),
+    dispose: () => {
+      _db?.close?.();
+      _db = undefined;
+    },
   };
 }
 

src/connectors/pglite.ts

@@ -39,6 +39,10 @@ export default function pgliteConnector<TOptions extends ConnectorOptions>(
     getInstance: () => getClient(),
     exec: (sql) => query(sql),
     prepare: (sql) => new StatementWrapper(sql, query),
+    dispose: async () => {
+      await (await _client)?.close?.();
+      _client = undefined;
+    },
   };
 }
 

src/connectors/planetscale.ts

@@ -35,6 +35,9 @@ export default function planetscaleConnector(
     getInstance: () => getClient(),
     exec: (sql) => query(sql),
     prepare: (sql) => new StatementWrapper(sql, query),
+    dispose: () => {
+      _client = undefined;
+    },
   };
 }
 

src/connectors/postgresql.ts

@@ -38,6 +38,10 @@ export default function postgresqlConnector(
     getInstance: () => getClient(),
     exec: (sql) => query(sql),
     prepare: (sql) => new StatementWrapper(sql, query),
+    dispose: async () => {
+      await (await _client)?.end?.();
+      _client = undefined;
+    },
   };
 }
 

src/connectors/sqlite3.ts

@@ -15,6 +15,8 @@ export default function nodeSqlite3Connector(
   opts: ConnectorOptions,
 ): Connector<sqlite3.Database> {
   let _db: sqlite3.Database;
+  const _activeStatements = new Set<StatementWrapper>();
+
   const getDB = () => {
     if (_db) {
       return _db;
@@ -47,7 +49,25 @@ export default function nodeSqlite3Connector(
     dialect: "sqlite",
     getInstance: () => getDB(),
     exec: (sql: string) => query(sql),
-    prepare: (sql) => new StatementWrapper(sql, getDB()),
+    prepare: (sql) => {
+      const stmt = new StatementWrapper(sql, getDB());
+      _activeStatements.add(stmt);
+      return stmt;
+    },
+    dispose: async () => {
+      await Promise.all(
+        [..._activeStatements].map((s) =>
+          s.finalize().catch((error) => {
+            console.warn("[db0] [sqlite3] failed to finalize statement", error);
+          }),
+        ),
+      );
+      _activeStatements.clear();
+      await new Promise<void>((resolve, reject) =>
+        _db?.close?.((error) => (error ? reject(error) : resolve())),
+      );
+      _db = undefined as any;
+    },
   };
 }
 
@@ -90,4 +110,14 @@ class StatementWrapper extends BoundableStatement<sqlite3.Statement> {
     });
     return row;
   }
+
+  finalize() {
+    try {
+      // TODO: Can we await on finalize cb?
+      this._statement.finalize();
+      return Promise.resolve();
+    } catch (error) {
+      return Promise.reject(error);
+    }
+  }
 }