feat: add option to disable parsing JSON, remove redundant enableCallback from Statement

Author: DjDeveloperr

doc.md

@@ -15,7 +15,8 @@ pass `create: false` in the options.
 - `memory: boolean` - Whether to open the database in memory. Defaults to
   `false`.
 - `int64: boolean` - Whether to support BigInt columns. False by default, which
-  means integers larger than 32 bit will be inaccurate.
+  means integers larger than 32 bit will be inaccurate. Causes mixed values to
+  be returned like `number | bigint`.
 - `flags: number` - Raw flags to pass to the C API. Normally you don't need
   this. Passing this ignores all other options.
 - `unsafeConcurrency: boolean` - Enable optimizations that will affect
@@ -24,6 +25,7 @@ pass `create: false` in the options.
 - `enableLoadExtension: boolean` - Enables the loading of SQLite extensions from
   a dynamic library, this needs to be set to true for the method `loadExtension`
   to work. Defaults to `false`.
+- `parseJson: boolean` - Enables parsing JSON. True by default.
 
 ### Usage
 

src/database.ts

@@ -35,6 +35,8 @@ export interface DatabaseOpenOptions {
   unsafeConcurrency?: boolean;
   /** Enable or disable extension loading */
   enableLoadExtension?: boolean;
+  /** Whether to parse JSON columns as JS objects. True by default. */
+  parseJson?: boolean;
 }
 
 /** Transaction function created using `Database#transaction`. */
@@ -153,6 +155,9 @@ export class Database {
   /** Whether to support BigInt columns. False by default, integers larger than 32 bit will be inaccurate. */
   int64: boolean;
 
+  /** Whether to parse JSON columns as JS objects. True by default. */
+  parseJson: boolean;
+
   unsafeConcurrency: boolean;
 
   /** Whether DB connection is open */
@@ -214,6 +219,7 @@ export class Database {
     this.#path = path instanceof URL ? fromFileUrl(path) : path;
     let flags = 0;
     this.int64 = options.int64 ?? false;
+    this.parseJson = options.parseJson ?? true;
     this.unsafeConcurrency = options.unsafeConcurrency ?? false;
     if (options.flags !== undefined) {
       flags = options.flags;

src/statement.ts

@@ -77,7 +77,12 @@ const JSON_SUBTYPE = 74;
 
 const BIG_MAX = BigInt(Number.MAX_SAFE_INTEGER);
 
-function getColumn(handle: Deno.PointerValue, i: number, int64: boolean): any {
+function getColumn(
+  handle: Deno.PointerValue,
+  i: number,
+  int64: boolean,
+  parseJson: boolean,
+): any {
   const ty = sqlite3_column_type(handle, i);
 
   if (ty === SQLITE_INTEGER && !int64) return sqlite3_column_int(handle, i);
@@ -89,7 +94,7 @@ function getColumn(handle: Deno.PointerValue, i: number, int64: boolean): any {
       const text = readCstr(ptr, 0);
       const value = sqlite3_column_value(handle, i);
       const subtype = sqlite3_value_subtype(value);
-      if (subtype === JSON_SUBTYPE) {
+      if (subtype === JSON_SUBTYPE && parseJson) {
         try {
           return JSON.parse(text);
         } catch (_error) {
@@ -142,16 +147,6 @@ export class Statement<TStatement extends object = Record<string, any>> {
   #hasNoArgs = false;
   #unsafeConcurrency;
 
-  /**
-   * Whether the query might call into JavaScript or not.
-   *
-   * Must enable if the query makes use of user defined functions,
-   * otherwise there can be V8 crashes.
-   *
-   * Off by default. Causes performance degradation.
-   */
-  callback = false;
-
   /** Unsafe Raw (pointer) to the sqlite object */
   get unsafeHandle(): Deno.PointerValue {
     return this.#handle;
@@ -233,12 +228,6 @@ export class Statement<TStatement extends object = Record<string, any>> {
     }
   }
 
-  /** Shorthand for `this.callback = true`. Enables calling user defined functions. */
-  enableCallback(): this {
-    this.callback = true;
-    return this;
-  }
-
   /** Get bind parameter name by index */
   bindParameterName(i: number): string {
     return readCstr(sqlite3_bind_parameter_name(this.#handle, i)!);
@@ -437,7 +426,7 @@ export class Statement<TStatement extends object = Record<string, any>> {
       return function(h) {
         return [${
         Array.from({ length: columnCount }).map((_, i) =>
-          `getColumn(h, ${i}, ${this.db.int64})`
+          `getColumn(h, ${i}, ${this.db.int64}, ${this.db.parseJson})`
         )
           .join(", ")
       }];
@@ -470,7 +459,7 @@ export class Statement<TStatement extends object = Record<string, any>> {
       return function(h) {
         return [${
         Array.from({ length: columnCount }).map((_, i) =>
-          `getColumn(h, ${i}, ${this.db.int64})`
+          `getColumn(h, ${i}, ${this.db.int64}, ${this.db.parseJson})`
         )
           .join(", ")
       }];
@@ -504,7 +493,7 @@ export class Statement<TStatement extends object = Record<string, any>> {
           return {
             ${
           columnNames.map((name, i) =>
-            `"${name}": getColumn(h, ${i}, ${this.db.int64})`
+            `"${name}": getColumn(h, ${i}, ${this.db.int64}, ${this.db.parseJson})`
           ).join(",\n")
         }
           };
@@ -562,6 +551,7 @@ export class Statement<TStatement extends object = Record<string, any>> {
   ): T | undefined {
     const handle = this.#handle;
     const int64 = this.db.int64;
+    const parseJson = this.db.parseJson;
     const arr = new Array(sqlite3_column_count(handle));
     sqlite3_reset(handle);
     if (!this.#hasNoArgs && !this.#bound) {
@@ -580,7 +570,7 @@ export class Statement<TStatement extends object = Record<string, any>> {
 
     if (status === SQLITE3_ROW) {
       for (let i = 0; i < arr.length; i++) {
-        arr[i] = getColumn(handle, i, int64);
+        arr[i] = getColumn(handle, i, int64, parseJson);
       }
       sqlite3_reset(this.#handle);
       return arr as T;
@@ -594,13 +584,14 @@ export class Statement<TStatement extends object = Record<string, any>> {
   #valueNoArgs<T extends Array<unknown>>(): T | undefined {
     const handle = this.#handle;
     const int64 = this.db.int64;
+    const parseJson = this.db.parseJson;
     const cc = sqlite3_column_count(handle);
     const arr = new Array(cc);
     sqlite3_reset(handle);
     const status = sqlite3_step(handle);
     if (status === SQLITE3_ROW) {
       for (let i = 0; i < cc; i++) {
-        arr[i] = getColumn(handle, i, int64);
+        arr[i] = getColumn(handle, i, int64, parseJson);
       }
       sqlite3_reset(this.#handle);
       return arr as T;
@@ -636,7 +627,7 @@ export class Statement<TStatement extends object = Record<string, any>> {
   ): T | undefined {
     const handle = this.#handle;
     const int64 = this.db.int64;
-
+    const parseJson = this.db.parseJson;
     const columnNames = this.columnNames();
 
     const row: Record<string, unknown> = {};
@@ -657,7 +648,7 @@ export class Statement<TStatement extends object = Record<string, any>> {
 
     if (status === SQLITE3_ROW) {
       for (let i = 0; i < columnNames.length; i++) {
-        row[columnNames[i]] = getColumn(handle, i, int64);
+        row[columnNames[i]] = getColumn(handle, i, int64, parseJson);
       }
       sqlite3_reset(this.#handle);
       return row as T;
@@ -671,13 +662,14 @@ export class Statement<TStatement extends object = Record<string, any>> {
   #getNoArgs<T extends object>(): T | undefined {
     const handle = this.#handle;
     const int64 = this.db.int64;
+    const parseJson = this.db.parseJson;
     const columnNames = this.columnNames();
     const row: Record<string, unknown> = this.#rowObject;
     sqlite3_reset(handle);
     const status = sqlite3_step(handle);
     if (status === SQLITE3_ROW) {
       for (let i = 0; i < columnNames?.length; i++) {
-        row[columnNames[i]] = getColumn(handle, i, int64);
+        row[columnNames[i]] = getColumn(handle, i, int64, parseJson);
       }
       sqlite3_reset(handle);
       return row as T;

test/test.ts

@@ -461,19 +461,16 @@ Deno.test("sqlite", async (t) => {
   await t.step("test functions", () => {
     const [result] = db
       .prepare("select deno_add(?, ?)")
-      .enableCallback()
       .value<[number]>(1, 2)!;
     assertEquals(result, 3);
 
     const [result2] = db
       .prepare("select deno_uppercase(?)")
-      .enableCallback()
       .value<[string]>("hello")!;
     assertEquals(result2, "HELLO");
 
     const [result3] = db
       .prepare("select deno_buffer_add_1(?)")
-      .enableCallback()
       .value<[Uint8Array]>(new Uint8Array([1, 2, 3]))!;
     assertEquals(result3, new Uint8Array([2, 3, 4]));
 
@@ -485,13 +482,11 @@ Deno.test("sqlite", async (t) => {
 
     const [result5] = db
       .prepare("select regexp(?, ?)")
-      .enableCallback()
       .value<[number]>("hello", "h.*")!;
     assertEquals(result5, 1);
 
     const [result6] = db
       .prepare("select regexp(?, ?)")
-      .enableCallback()
       .value<[number]>("hello", "x.*")!;
     assertEquals(result6, 0);
 
@@ -501,7 +496,6 @@ Deno.test("sqlite", async (t) => {
     db.exec("insert into aggr_test (value) values (3)");
 
     const stmt = db.prepare("select deno_sum_2x(value) from aggr_test");
-    stmt.callback = true;
     const [result7] = stmt.value<[number]>()!;
     assertEquals(result7, 12);
     // Releases lock from table.