@sqlrooms/motherduck 0.21.0

package/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright 2025 Ilya Boyandin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,8 @@
+[MotherDuck](https://motherduck.com/) is a managed DuckDB-in-the-cloud service that enables you to run DuckDB queries both in your browser and in the cloud.
+
+This package exposes a `createWasmMotherDuckDbConnector` function, which allows SQLRooms to connect to MotherDuck.
+The connector is implemented using the [`@motherduck/wasm-client`](https://motherduck.com/docs/sql-reference/wasm-client/) library which is a customized version of [`@duckdb/duckdb-wasm`](https://github.com/duckdb/duckdb-wasm/tree/main/packages/duckdb-wasm) capable of querying MotherDuck datasets in the cloud from the browser.
+
+## Example
+
+See [`MotherDuck Cloud Query Editor`](/examples#motherduck-cloud-query-editor) for a usage example.

package/dist/WasmMotherDuckDbConnector.d.ts

@@ -0,0 +1,16 @@
+import { MDConnection, MDConnectionParams } from '@motherduck/wasm-client';
+import { DuckDbConnector } from '@sqlrooms/duckdb';
+export type MotherDuckDbConnectorType = 'wasm-motherduck';
+export type MotherDuckDbConnectorOptions = {
+    type: MotherDuckDbConnectorType;
+} & WasmMotherDuckDbConnectorOptions;
+export declare function isWasmMotherDuckDbConnector(connector: DuckDbConnector): connector is WasmMotherDuckDbConnector;
+export interface WasmMotherDuckDbConnectorOptions extends MDConnectionParams {
+    initializationQuery?: string;
+}
+export interface WasmMotherDuckDbConnector extends DuckDbConnector {
+    getConnection(): MDConnection;
+    readonly type: 'wasm-motherduck';
+}
+export declare function createWasmMotherDuckDbConnector(options: WasmMotherDuckDbConnectorOptions): WasmMotherDuckDbConnector;
+//# sourceMappingURL=WasmMotherDuckDbConnector.d.ts.map

package/dist/WasmMotherDuckDbConnector.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WasmMotherDuckDbConnector.d.ts","sourceRoot":"","sources":["../src/WasmMotherDuckDbConnector.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAE,kBAAkB,EAAC,MAAM,yBAAyB,CAAC;AACzE,OAAO,EAGL,eAAe,EAChB,MAAM,kBAAkB,CAAC;AAI1B,MAAM,MAAM,yBAAyB,GAAG,iBAAiB,CAAC;AAE1D,MAAM,MAAM,4BAA4B,GAAG;IACzC,IAAI,EAAE,yBAAyB,CAAC;CACjC,GAAG,gCAAgC,CAAC;AAErC,wBAAgB,2BAA2B,CACzC,SAAS,EAAE,eAAe,GACzB,SAAS,IAAI,yBAAyB,CAExC;AAED,MAAM,WAAW,gCAAiC,SAAQ,kBAAkB;IAC1E,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,yBAA0B,SAAQ,eAAe;IAChE,aAAa,IAAI,YAAY,CAAC;IAC9B,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC;CAClC;AAED,wBAAgB,+BAA+B,CAC7C,OAAO,EAAE,gCAAgC,GACxC,yBAAyB,CAsE3B"}

package/dist/WasmMotherDuckDbConnector.js

@@ -0,0 +1,64 @@
+import { MDConnection } from '@motherduck/wasm-client';
+import { createBaseDuckDbConnector, } from '@sqlrooms/duckdb';
+import * as arrow from 'apache-arrow';
+export function isWasmMotherDuckDbConnector(connector) {
+    return connector.type === 'wasm-motherduck';
+}
+export function createWasmMotherDuckDbConnector(options) {
+    const { initializationQuery = '', ...params } = options;
+    let connection = null;
+    const impl = {
+        async initializeInternal() {
+            connection = MDConnection.create(params);
+            await connection.isInitialized();
+            if (initializationQuery) {
+                await connection.evaluateQuery(initializationQuery);
+            }
+        },
+        async destroyInternal() {
+            if (connection) {
+                await connection.close();
+                connection = null;
+            }
+        },
+        async executeQueryInternal(query, signal, id) {
+            if (!connection) {
+                throw new Error('MotherDuck connection not initialized');
+            }
+            // Check if already cancelled before starting
+            if (signal.aborted) {
+                throw new DOMException('Query was cancelled', 'AbortError');
+            }
+            // Not using evaluateQueuedQuery which supports cancellation
+            // because it doesn't provide arrow results
+            const result = await connection.evaluateStreamingQuery(query);
+            const batches = new Array();
+            for await (const batch of result.arrowStream) {
+                // Check for cancellation before processing each batch
+                if (signal.aborted) {
+                    throw new DOMException('Query was cancelled', 'AbortError');
+                }
+                batches.push(batch);
+            }
+            return new arrow.Table(batches);
+        },
+        async cancelQueryInternal(queryId) {
+            // Cancellation is handled by checking AbortSignal in the stream reading loop
+            // No server-side cancellation is performed since evaluateStreamingQuery doesn't provide queryId
+        },
+    };
+    const base = createBaseDuckDbConnector({ initializationQuery }, impl);
+    return {
+        ...base,
+        getConnection() {
+            if (!connection) {
+                throw new Error('MotherDuck connection not initialized');
+            }
+            return connection;
+        },
+        get type() {
+            return 'wasm-motherduck';
+        },
+    };
+}
+//# sourceMappingURL=WasmMotherDuckDbConnector.js.map

package/dist/WasmMotherDuckDbConnector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WasmMotherDuckDbConnector.js","sourceRoot":"","sources":["../src/WasmMotherDuckDbConnector.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAqB,MAAM,yBAAyB,CAAC;AACzE,OAAO,EAEL,yBAAyB,GAE1B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,KAAK,MAAM,cAAc,CAAC;AAStC,MAAM,UAAU,2BAA2B,CACzC,SAA0B;IAE1B,OAAQ,SAAiB,CAAC,IAAI,KAAK,iBAAiB,CAAC;AACvD,CAAC;AAWD,MAAM,UAAU,+BAA+B,CAC7C,OAAyC;IAEzC,MAAM,EAAC,mBAAmB,GAAG,EAAE,EAAE,GAAG,MAAM,EAAC,GAAG,OAAO,CAAC;IACtD,IAAI,UAAU,GAAwB,IAAI,CAAC;IAE3C,MAAM,IAAI,GAA4B;QACpC,KAAK,CAAC,kBAAkB;YACtB,UAAU,GAAG,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACzC,MAAM,UAAU,CAAC,aAAa,EAAE,CAAC;YACjC,IAAI,mBAAmB,EAAE,CAAC;gBACxB,MAAM,UAAU,CAAC,aAAa,CAAC,mBAAmB,CAAC,CAAC;YACtD,CAAC;QACH,CAAC;QAED,KAAK,CAAC,eAAe;YACnB,IAAI,UAAU,EAAE,CAAC;gBACf,MAAM,UAAU,CAAC,KAAK,EAAE,CAAC;gBACzB,UAAU,GAAG,IAAI,CAAC;YACpB,CAAC;QACH,CAAC;QAED,KAAK,CAAC,oBAAoB,CACxB,KAAa,EACb,MAAmB,EACnB,EAAU;YAEV,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;YAC3D,CAAC;YAED,6CAA6C;YAC7C,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBACnB,MAAM,IAAI,YAAY,CAAC,qBAAqB,EAAE,YAAY,CAAC,CAAC;YAC9D,CAAC;YAED,4DAA4D;YAC5D,2CAA2C;YAC3C,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;YAC9D,MAAM,OAAO,GAAG,IAAI,KAAK,EAAoB,CAAC;YAE9C,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;gBAC7C,sDAAsD;gBACtD,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;oBACnB,MAAM,IAAI,YAAY,CAAC,qBAAqB,EAAE,YAAY,CAAC,CAAC;gBAC9D,CAAC;gBACD,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACtB,CAAC;YAED,OAAO,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAClC,CAAC;QAED,KAAK,CAAC,mBAAmB,CAAC,OAAe;YACvC,6EAA6E;YAC7E,gGAAgG;QAClG,CAAC;KACF,CAAC;IAEF,MAAM,IAAI,GAAG,yBAAyB,CAAC,EAAC,mBAAmB,EAAC,EAAE,IAAI,CAAC,CAAC;IAEpE,OAAO;QACL,GAAG,IAAI;QACP,aAAa;YACX,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;YAC3D,CAAC;YACD,OAAO,UAAU,CAAC;QACpB,CAAC;QACD,IAAI,IAAI;YACN,OAAO,iBAA0B,CAAC;QACpC,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["import {MDConnection, MDConnectionParams} from '@motherduck/wasm-client';\nimport {\n  BaseDuckDbConnectorImpl,\n  createBaseDuckDbConnector,\n  DuckDbConnector,\n} from '@sqlrooms/duckdb';\nimport * as arrow from 'apache-arrow';\nimport {RecordBatch} from 'apache-arrow';\n\nexport type MotherDuckDbConnectorType = 'wasm-motherduck';\n\nexport type MotherDuckDbConnectorOptions = {\n  type: MotherDuckDbConnectorType;\n} & WasmMotherDuckDbConnectorOptions;\n\nexport function isWasmMotherDuckDbConnector(\n  connector: DuckDbConnector,\n): connector is WasmMotherDuckDbConnector {\n  return (connector as any).type === 'wasm-motherduck';\n}\n\nexport interface WasmMotherDuckDbConnectorOptions extends MDConnectionParams {\n  initializationQuery?: string;\n}\n\nexport interface WasmMotherDuckDbConnector extends DuckDbConnector {\n  getConnection(): MDConnection;\n  readonly type: 'wasm-motherduck';\n}\n\nexport function createWasmMotherDuckDbConnector(\n  options: WasmMotherDuckDbConnectorOptions,\n): WasmMotherDuckDbConnector {\n  const {initializationQuery = '', ...params} = options;\n  let connection: MDConnection | null = null;\n\n  const impl: BaseDuckDbConnectorImpl = {\n    async initializeInternal() {\n      connection = MDConnection.create(params);\n      await connection.isInitialized();\n      if (initializationQuery) {\n        await connection.evaluateQuery(initializationQuery);\n      }\n    },\n\n    async destroyInternal() {\n      if (connection) {\n        await connection.close();\n        connection = null;\n      }\n    },\n\n    async executeQueryInternal(\n      query: string,\n      signal: AbortSignal,\n      id: string,\n    ): Promise<arrow.Table> {\n      if (!connection) {\n        throw new Error('MotherDuck connection not initialized');\n      }\n\n      // Check if already cancelled before starting\n      if (signal.aborted) {\n        throw new DOMException('Query was cancelled', 'AbortError');\n      }\n\n      // Not using evaluateQueuedQuery which supports cancellation\n      // because it doesn't provide arrow results\n      const result = await connection.evaluateStreamingQuery(query);\n      const batches = new Array<RecordBatch<any>>();\n\n      for await (const batch of result.arrowStream) {\n        // Check for cancellation before processing each batch\n        if (signal.aborted) {\n          throw new DOMException('Query was cancelled', 'AbortError');\n        }\n        batches.push(batch);\n      }\n\n      return new arrow.Table(batches);\n    },\n\n    async cancelQueryInternal(queryId: string) {\n      // Cancellation is handled by checking AbortSignal in the stream reading loop\n      // No server-side cancellation is performed since evaluateStreamingQuery doesn't provide queryId\n    },\n  };\n\n  const base = createBaseDuckDbConnector({initializationQuery}, impl);\n\n  return {\n    ...base,\n    getConnection() {\n      if (!connection) {\n        throw new Error('MotherDuck connection not initialized');\n      }\n      return connection;\n    },\n    get type() {\n      return 'wasm-motherduck' as const;\n    },\n  };\n}\n"]}

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * {@include ../README.md}
+ * @packageDocumentation
+ */
+export { createWasmMotherDuckDbConnector, isWasmMotherDuckDbConnector, type WasmMotherDuckDbConnector, type WasmMotherDuckDbConnectorOptions, } from './WasmMotherDuckDbConnector';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACL,+BAA+B,EAC/B,2BAA2B,EAC3B,KAAK,yBAAyB,EAC9B,KAAK,gCAAgC,GACtC,MAAM,6BAA6B,CAAC"}

package/dist/index.js

@@ -0,0 +1,6 @@
+/**
+ * {@include ../README.md}
+ * @packageDocumentation
+ */
+export { createWasmMotherDuckDbConnector, isWasmMotherDuckDbConnector, } from './WasmMotherDuckDbConnector';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACL,+BAA+B,EAC/B,2BAA2B,GAG5B,MAAM,6BAA6B,CAAC","sourcesContent":["/**\n * {@include ../README.md}\n * @packageDocumentation\n */\n\nexport {\n  createWasmMotherDuckDbConnector,\n  isWasmMotherDuckDbConnector,\n  type WasmMotherDuckDbConnector,\n  type WasmMotherDuckDbConnectorOptions,\n} from './WasmMotherDuckDbConnector';\n"]}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@sqlrooms/motherduck",
+  "version": "0.21.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "module": "dist/index.js",
+  "type": "module",
+  "author": "Ilya Boyandin <ilya@boyandin.me>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sqlrooms/sqlrooms.git"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@motherduck/wasm-client": "^0.6.6",
+    "@sqlrooms/duckdb": "0.21.0",
+    "apache-arrow": "^17.0.0"
+  },
+  "scripts": {
+    "dev": "tsc -w",
+    "build": "tsc",
+    "lint": "eslint .",
+    "typecheck": "tsc --noEmit",
+    "typedoc": "typedoc"
+  },
+  "gitHead": "8411bc915049f20dbcd48a60493907ddda8b7b38"
+}