feat: support Bun bundled SQLite runtime #7878
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| import fs from "node:fs"; | ||
| import type { PreparedStatement, RunResult, SqliteAdapter } from "./types"; | ||
|
|
||
| /** | ||
| * The Bun runtime already ships a SQLite driver. Keep this adapter deliberately | ||
| * small so the rest of the application can use the same driver contract as | ||
| * better-sqlite3, node:sqlite, and sql.js. | ||
| */ | ||
| export interface BunSqliteDatabaseLike { | ||
| query(sql: string): { | ||
| run(...params: unknown[]): { changes: number | bigint; lastInsertRowid: number | bigint }; | ||
| get(...params: unknown[]): unknown; | ||
| all(...params: unknown[]): unknown[]; | ||
| }; | ||
| exec(sql: string): void; | ||
| serialize?(): Uint8Array; | ||
| transaction<T>(fn: (...args: unknown[]) => T): { | ||
| (...args: unknown[]): T; | ||
| immediate?: (...args: unknown[]) => T; | ||
| }; | ||
| close(): void; | ||
| } | ||
|
|
||
| function normalizeRunResult(result: { | ||
| changes?: number | bigint; | ||
| lastInsertRowid?: number | bigint; | ||
| }): RunResult { | ||
| return { | ||
| changes: Number(result.changes ?? 0), | ||
| lastInsertRowid: Number(result.lastInsertRowid ?? 0), | ||
| }; | ||
| } | ||
|
|
||
| function normalizeParams(params: unknown[]): unknown[] { | ||
| if (params.length !== 1) return params; | ||
| const [first] = params; | ||
| if ( | ||
| first === null || | ||
| typeof first !== "object" || | ||
| Array.isArray(first) || | ||
| first instanceof Uint8Array || | ||
| (typeof Buffer !== "undefined" && Buffer.isBuffer(first)) | ||
| ) { | ||
| return params; | ||
| } | ||
|
|
||
| // better-sqlite3 callers use bare object keys for @name, :name, and $name. | ||
| // Bun requires the sigil to match the SQL placeholder, so provide all three | ||
| // aliases just as the sql.js adapter does. | ||
| const expanded: Record<string, unknown> = {}; | ||
| for (const [key, value] of Object.entries(first as Record<string, unknown>)) { | ||
| if (/^[:@$]/.test(key)) { | ||
| expanded[key] = value; | ||
| } else { | ||
| expanded[`@${key}`] = value; | ||
| expanded[`:${key}`] = value; | ||
| expanded[`$${key}`] = value; | ||
| } | ||
| } | ||
| return [expanded]; | ||
| } | ||
|
|
||
| export function createBunSqliteAdapter(db: BunSqliteDatabaseLike, filePath: string): SqliteAdapter { | ||
| let isOpen = true; | ||
|
|
||
| return { | ||
| driver: "bun:sqlite", | ||
|
|
||
| get open() { | ||
| return isOpen; | ||
| }, | ||
|
|
||
| get name() { | ||
| return filePath; | ||
| }, | ||
|
|
||
| prepare(sql: string): PreparedStatement { | ||
| const statement = db.query(sql); | ||
| return { | ||
| run(...params: unknown[]): RunResult { | ||
| return normalizeRunResult(statement.run(...normalizeParams(params))); | ||
| }, | ||
| get(...params: unknown[]): unknown { | ||
| return statement.get(...normalizeParams(params)); | ||
| }, | ||
| all(...params: unknown[]): unknown[] { | ||
| return statement.all(...normalizeParams(params)); | ||
| }, | ||
| }; | ||
| }, | ||
|
|
||
| exec(sql: string): void { | ||
| db.exec(sql); | ||
| }, | ||
|
|
||
| pragma(pragmaStr: string, options?: { simple?: boolean }): unknown { | ||
| const statement = db.query(`PRAGMA ${pragmaStr}`); | ||
| if (options?.simple) { | ||
| const row = statement.get() as Record<string, unknown> | undefined; | ||
| return row ? (Object.values(row)[0] ?? null) : null; | ||
| } | ||
| return statement.all(); | ||
| }, | ||
|
|
||
| transaction<T>(fn: (...args: unknown[]) => T): (...args: unknown[]) => T { | ||
| return db.transaction(fn); | ||
| }, | ||
|
|
||
| immediate(fn: () => void): void { | ||
| const transaction = db.transaction(fn); | ||
| if (typeof transaction.immediate === "function") { | ||
| transaction.immediate(); | ||
| return; | ||
| } | ||
| db.exec("BEGIN IMMEDIATE"); | ||
| try { | ||
| fn(); | ||
| db.exec("COMMIT"); | ||
| } catch (error) { | ||
| try { | ||
| db.exec("ROLLBACK"); | ||
| } catch {} | ||
| throw error; | ||
| } | ||
| }, | ||
|
|
||
| async backup(destination: string): Promise<void> { | ||
| if (filePath === ":memory:") return; | ||
| try { | ||
| db.exec("PRAGMA wal_checkpoint(TRUNCATE)"); | ||
| } catch {} | ||
| fs.copyFileSync(filePath, destination); | ||
| }, | ||
|
Comment on lines
+127
to
+133
Contributor
There was a problem hiding this comment. Using async backup(destination: string): Promise<void> {
if (filePath === ":memory:") return;
try {
db.exec("PRAGMA wal_checkpoint(TRUNCATE)");
} catch {}
fs.copyFileSync(filePath, destination);
}, |
||
|
|
||
| checkpoint(mode = "TRUNCATE"): void { | ||
| try { | ||
| db.exec(`PRAGMA wal_checkpoint(${mode})`); | ||
| } catch {} | ||
| }, | ||
|
|
||
| close(): void { | ||
| if (!isOpen) return; | ||
| db.close(); | ||
| isOpen = false; | ||
| }, | ||
|
|
||
| get raw() { | ||
| return db; | ||
| }, | ||
| }; | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Using
db.serialize()for physical file-backed databases is highly inefficient and poses a significant Out Of Memory (OOM) risk for large databases because it loads the entire database into memory as aUint8Array. SincesourcePathis a physical file, we should perform a standard checkpoint and usefs.copyFileSyncdirectly.