sqlite: support ArrayBuffer and TypedArray in StatementSync

nodejs · Dec 28, 2024 · aa1218f · aa1218f
1 parent ca3c8f1
commit aa1218f
Show file tree

Hide file tree

Showing 3 changed files with 69 additions and 6 deletions.
diff --git a/doc/api/sqlite.md b/doc/api/sqlite.md
@@ -326,7 +326,7 @@ added: v22.5.0
 
 * `namedParameters` {Object} An optional object used to bind named parameters.
   The keys of this object are used to configure the mapping.
-* `...anonymousParameters` {null|number|bigint|string|Buffer|Uint8Array} Zero or
+* `...anonymousParameters` {null|number|bigint|string|Buffer|Uint8Array|TypedArray} Zero or
   more values to bind to anonymous parameters.
 * Returns: {Array} An array of objects. Each object corresponds to a row
   returned by executing the prepared statement. The keys and values of each
@@ -358,7 +358,7 @@ added: v22.5.0
 
 * `namedParameters` {Object} An optional object used to bind named parameters.
   The keys of this object are used to configure the mapping.
-* `...anonymousParameters` {null|number|bigint|string|Buffer|Uint8Array} Zero or
+* `...anonymousParameters` {null|number|bigint|string|Buffer|Uint8Array|TypedArray} Zero or
   more values to bind to anonymous parameters.
 * Returns: {Object|undefined} An object corresponding to the first row returned
   by executing the prepared statement. The keys and values of the object
@@ -378,7 +378,7 @@ added: v23.4.0
 
 * `namedParameters` {Object} An optional object used to bind named parameters.
   The keys of this object are used to configure the mapping.
-* `...anonymousParameters` {null|number|bigint|string|Buffer|Uint8Array} Zero or
+* `...anonymousParameters` {null|number|bigint|string|Buffer|Uint8Array|TypedArray} Zero or
   more values to bind to anonymous parameters.
 * Returns: {Iterator} An iterable iterator of objects. Each object corresponds to a row
   returned by executing the prepared statement. The keys and values of each
@@ -397,7 +397,7 @@ added: v22.5.0
 
 * `namedParameters` {Object} An optional object used to bind named parameters.
   The keys of this object are used to configure the mapping.
-* `...anonymousParameters` {null|number|bigint|string|Buffer|Uint8Array} Zero or
+* `...anonymousParameters` {null|number|bigint|string|Buffer|Uint8Array|TypedArray} Zero or
   more values to bind to anonymous parameters.
 * Returns: {Object}
   * `changes`: {number|bigint} The number of rows modified, inserted, or deleted

diff --git a/src/node_sqlite.cc b/src/node_sqlite.cc
@@ -930,7 +930,8 @@ bool StatementSync::BindParams(const FunctionCallbackInfo<Value>& args) {
   int anon_idx = 1;
   int anon_start = 0;
 
-  if (args[0]->IsObject() && !args[0]->IsUint8Array()) {
+  if (args[0]->IsObject() && !args[0]->IsUint8Array() &&
+      !args[0]->IsTypedArray() && !args[0]->IsArrayBuffer()) {
     Local<Object> obj = args[0].As<Object>();
     Local<Context> context = obj->GetIsolate()->GetCurrentContext();
     Local<Array> keys;
@@ -1035,7 +1036,8 @@ bool StatementSync::BindValue(const Local<Value>& value, const int index) {
         statement_, index, *val, val.length(), SQLITE_TRANSIENT);
   } else if (value->IsNull()) {
     r = sqlite3_bind_null(statement_, index);
-  } else if (value->IsUint8Array()) {
+  } else if (value->IsUint8Array() || value->IsArrayBufferView() ||
+             value->IsArrayBuffer()) {
     ArrayBufferViewContents<uint8_t> buf(value);
     r = sqlite3_bind_blob(
         statement_, index, buf.data(), buf.length(), SQLITE_TRANSIENT);

diff --git a/test/parallel/test-sqlite-typed-array.js b/test/parallel/test-sqlite-typed-array.js
@@ -0,0 +1,61 @@
+'use strict';
+require('../common');
+const tmpdir = require('../common/tmpdir');
+const { join } = require('node:path');
+const { DatabaseSync } = require('node:sqlite');
+const { suite, test } = require('node:test');
+let cnt = 0;
+
+tmpdir.refresh();
+
+function nextDb() {
+  return join(tmpdir.path, `database-${cnt++}.db`);
+}
+
+const arrayBuffer = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]).buffer;
+const TypedArrays = [
+  ['Int8Array', Int8Array],
+  ['Uint8Array', Uint8Array],
+  ['Uint8ClampedArray', Uint8ClampedArray],
+  ['Int16Array', Int16Array],
+  ['Uint16Array', Uint16Array],
+  ['Int32Array', Int32Array],
+  ['Uint32Array', Uint32Array],
+  ['Float32Array', Float32Array],
+  ['Float64Array', Float64Array],
+  ['BigInt64Array', BigInt64Array],
+  ['BigUint64Array', BigUint64Array],
+  ['DataView', DataView],
+];
+
+suite('StatementSync with TypedArray', () => {
+  for (const [displayName, TypedArray] of TypedArrays) {
+    test(displayName, (t) => {
+      const db = new DatabaseSync(nextDb());
+      t.after(() => { db.close(); });
+      db.exec('CREATE TABLE test (data BLOB)');
+      // insert
+      {
+        const stmt = db.prepare('INSERT INTO test VALUES (?)');
+        stmt.run(new TypedArray(arrayBuffer));
+      }
+      // select all
+      {
+        const stmt = db.prepare('SELECT * FROM test');
+        const row = stmt.get();
+        t.assert.ok(row.data instanceof Uint8Array);
+        t.assert.strictEqual(row.data.length, 8);
+        t.assert.deepStrictEqual(row.data, new Uint8Array(arrayBuffer));
+      }
+      // query
+      {
+        const stmt = db.prepare('SELECT * FROM test WHERE data = ?');
+        const rows = stmt.all(new TypedArray(arrayBuffer));
+        t.assert.strictEqual(rows.length, 1);
+        t.assert.ok(rows[0].data instanceof Uint8Array);
+        t.assert.strictEqual(rows[0].data.length, 8);
+        t.assert.deepStrictEqual(rows[0].data, new Uint8Array(arrayBuffer));
+      }
+    });
+  }
+});