@sqlrooms/duckdb 0.0.1 → 0.0.3

package/dist/arrow-utils.d.ts

@@ -0,0 +1,8 @@
+import * as arrow from 'apache-arrow';
+/**
+ * Converts an Arrow table to a JSON-compatible array of objects
+ * @see https://duckdb.org/docs/api/wasm/query.html#arrow-table-to-json
+ * @see https://github.com/apache/arrow/issues/37856
+ */
+export declare function arrowTableToJson(table: arrow.Table): Record<string, unknown>[];
+//# sourceMappingURL=arrow-utils.d.ts.map

package/dist/arrow-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"arrow-utils.d.ts","sourceRoot":"","sources":["../src/arrow-utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,cAAc,CAAC;AAEtC;;;;GAIG;AACH,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,KAAK,CAAC,KAAK,GACjB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAQ3B"}

package/dist/arrow-utils.js

@@ -0,0 +1,22 @@
+/**
+ * Converts an Arrow table to a JSON-compatible array of objects
+ * @see https://duckdb.org/docs/api/wasm/query.html#arrow-table-to-json
+ * @see https://github.com/apache/arrow/issues/37856
+ */
+export function arrowTableToJson(table) {
+    return table.toArray().map((row) => Object.fromEntries(Object.entries(row).map(([key, value]) => {
+        return [key, convertValue(value)];
+    })));
+}
+function convertValue(value) {
+    if (typeof value === 'bigint') {
+        if (value >= Number.MIN_SAFE_INTEGER && value <= Number.MAX_SAFE_INTEGER) {
+            return Number(value);
+        }
+        return String(value);
+    }
+    if (typeof value === 'number') {
+        return value;
+    }
+    return String(value);
+}

package/dist/duckdb.d.ts

@@ -1,15 +1,49 @@
+import * as arrow from 'apache-arrow';
+/**
+ * Create a table from a query.
+ * @param tableName - The name of the table to create.
+ * @param query - The query to create the table from.
+ * @returns The table that was created.
+ */
 export declare function createTableFromQuery(tableName: string, query: string): Promise<{
     tableName: string;
     rowCount: number;
 }>;
+/**
+ * Create a view from a registered file.
+ * @param filePath - The path to the file to create the view from.
+ * @param schema - The schema to create the view in.
+ * @param tableName - The name of the table to create.
+ * @param opts - The options to create the view with.
+ * @returns The view that was created.
+ */
 export declare function createViewFromRegisteredFile(filePath: string, schema: string, tableName: string, opts?: {
     mode: 'table' | 'view';
 }): Promise<{
     tableName: string;
     rowCount: number;
 }>;
+/**
+ * Create a view from a file.
+ * @param filePath - The path to the file to create the view from.
+ * @param schema - The schema to create the view in.
+ * @param tableName - The name of the table to create.
+ * @param file - The file to create the view from.
+ */
 export declare function createViewFromFile(filePath: string, schema: string, tableName: string, file: File | Uint8Array): Promise<{
     tableName: string;
     rowCount: number;
 }>;
+/**
+ * Create a table from an Arrow table.
+ * @param tableName - The name of the table to create.
+ * @param arrowTable - The Arrow table to create the table from.
+ */
+export declare function createTableFromArrowTable(tableName: string, data: arrow.Table): Promise<void>;
+/**
+ * Create a table from an array of objects.
+ * @param tableName - The name of the table to create.
+ * @param data - The array of objects to create the table from.
+ */
+export declare function createTableFromObjects(tableName: string, data: Record<string, unknown>[]): Promise<void>;
 //# sourceMappingURL=duckdb.d.ts.map

package/dist/duckdb.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"duckdb.d.ts","sourceRoot":"","sources":["../src/duckdb.ts"],"names":[],"mappings":"AAOA,wBAAsB,oBAAoB,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;;;GAU1E;AAED,wBAAsB,4BAA4B,CAChD,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,IAAI,CAAC,EAAE;IAEL,IAAI,EAAE,OAAO,GAAG,MAAM,CAAC;CACxB,GACA,OAAO,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAC,CAAC,CAsChD;AAED,wBAAsB,kBAAkB,CACtC,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,IAAI,GAAG,UAAU,GACtB,OAAO,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAC,CAAC,CAqDhD"}
+{"version":3,"file":"duckdb.d.ts","sourceRoot":"","sources":["../src/duckdb.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,KAAK,MAAM,cAAc,CAAC;AAGtC;;;;;GAKG;AACH,wBAAsB,oBAAoB,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;;;GAU1E;AAED;;;;;;;GAOG;AACH,wBAAsB,4BAA4B,CAChD,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,IAAI,CAAC,EAAE;IAEL,IAAI,EAAE,OAAO,GAAG,MAAM,CAAC;CACxB,GACA,OAAO,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAC,CAAC,CAwBhD;AAED;;;;;;GAMG;AACH,wBAAsB,kBAAkB,CACtC,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,IAAI,GAAG,UAAU,GACtB,OAAO,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAC,CAAC,CAgBhD;AAED;;;;GAIG;AACH,wBAAsB,yBAAyB,CAC7C,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,KAAK,CAAC,KAAK,iBAIlB;AAED;;;;GAIG;AACH,wBAAsB,sBAAsB,CAC1C,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,iBAKhC"}

package/dist/duckdb.js

@@ -1,8 +1,12 @@
 import { DuckDBDataProtocol } from '@duckdb/duckdb-wasm';
 import { escapeVal, getColValAsNumber, getDuckDb } from './useDuckDb';
-// export function makeTableName(inputFileName: string): string {
-//   return inputFileName.replace(/\.[^\.]*$/, '').replace(/\W/g, '_');
-// }
+import { sqlFrom } from './sql-from';
+/**
+ * Create a table from a query.
+ * @param tableName - The name of the table to create.
+ * @param query - The query to create the table from.
+ * @returns The table that was created.
+ */
 export async function createTableFromQuery(tableName, query) {
     const { conn } = await getDuckDb();
     const rowCount = getColValAsNumber(await conn.query(`CREATE OR REPLACE TABLE main.${tableName} AS (
@@ -10,20 +14,18 @@ export async function createTableFromQuery(tableName, query) {
       )`));
     return { tableName, rowCount };
 }
+/**
+ * Create a view from a registered file.
+ * @param filePath - The path to the file to create the view from.
+ * @param schema - The schema to create the view in.
+ * @param tableName - The name of the table to create.
+ * @param opts - The options to create the view with.
+ * @returns The view that was created.
+ */
 export async function createViewFromRegisteredFile(filePath, schema, tableName, opts) {
     const { mode = 'table' } = opts ?? {};
     const { conn } = await getDuckDb();
     const fileNameLower = filePath.toLowerCase();
-    // let rowCount: number;
-    // if (fileNameLower.endsWith('.json')) {
-    //   await conn.insertJSONFromPath(filePath, {schema, name: tableName});
-    //   // TODO: for JSON we can use insertJSONFromPath https://github.com/duckdb/duckdb-wasm/issues/1262
-    //   // fileNameLower.endsWith('.json') || fileNameLower.endsWith('.ndjson')
-    //   // ? `read_json_auto(${escapeVal(fileName)})`
-    //   rowCount = getColValAsNumber(
-    //     await conn.query(`SELECT COUNT(*) FROM ${schema}.${tableName}`),
-    //   );
-    // } else {
     const quotedFileName = escapeVal(filePath);
     const readFileQuery = fileNameLower.endsWith('.json') ||
         fileNameLower.endsWith('.geojson') ||
@@ -34,30 +36,21 @@ export async function createViewFromRegisteredFile(filePath, schema, tableName,
             : fileNameLower.endsWith('.csv') || fileNameLower.endsWith('.tsv')
                 ? `read_csv(${quotedFileName}, SAMPLE_SIZE=-1, AUTO_DETECT=TRUE)`
                 : quotedFileName;
-    // const readFileQuery = fileNameLower.endsWith('.csv')
-    //   ? `read_csv(${quotedFileName}, SAMPLE_SIZE=-1, AUTO_DETECT=TRUE)`
-    //   : quotedFileName;
     // TODO: tableName generate
     const rowCount = getColValAsNumber(await conn.query(`CREATE OR REPLACE ${mode} ${schema}.${tableName} AS
           SELECT * FROM ${readFileQuery}`));
     // }
     return { tableName, rowCount };
 }
+/**
+ * Create a view from a file.
+ * @param filePath - The path to the file to create the view from.
+ * @param schema - The schema to create the view in.
+ * @param tableName - The name of the table to create.
+ * @param file - The file to create the view from.
+ */
 export async function createViewFromFile(filePath, schema, tableName, file) {
     const duckConn = await getDuckDb();
-    // const fileName = file.name;
-    // await duckConn.db.dropFile(fileName);
-    // await duckConn.db.registerFileHandle(
-    //   fileName,
-    //   file,
-    //   DuckDBDataProtocol.BROWSER_FILEREADER,
-    //   true,
-    // );
-    // const tableName = makeTableName(fileName);
-    // await duckConn.conn.query(`
-    //     CREATE OR REPLACE VIEW ${tableName} AS SELECT * FROM '${fileName}'
-    // `);
-    //const fileName = file.name;
     await duckConn.db.dropFile(filePath);
     if (file instanceof File) {
         await duckConn.db.registerFileHandle(filePath, file, DuckDBDataProtocol.BROWSER_FILEREADER, true);
@@ -66,91 +59,23 @@ export async function createViewFromFile(filePath, schema, tableName, file) {
         await duckConn.db.registerFileBuffer(filePath, file);
     }
     return createViewFromRegisteredFile(filePath, schema, tableName);
-    // const res = await duckConn.conn.query(
-    //   `SELECT count(*) FROM ${inputTableName}`,
-    // );
-    // const inputRowCount = getColValAsNumber(res, 0);
-    // const tableMeta = await duckConn.conn.query(
-    //   `DESCRIBE TABLE ${inputTableName}`,
-    // );
-    // const inputTableFields = Array.from(tableMeta).map((row) => ({
-    //   name: String(row?.column_name),
-    //   type: String(row?.column_type),
-    // }));
-    // const nextResult: DataTable = {
-    //   inputFileName,
-    //   tableName: inputTableName,
-    //   rowCount: inputRowCount,
-    //   // outputRowCount: undefined,
-    //   columns: inputTableFields,
-    // };
-    // // setResult(nextResult);
-    // return nextResult;
 }
-// async function createViewFromFile2(
-//   file: File,
-//   duckConn: DuckDb,
-//   onTableCreated: (
-//     inputTableName: string,
-//     result: CreateTableDropzoneResult,
-//   ) => void,
-//   onError: (status:'error', message: string) => void,
-// ) {
-//   try {
-//     const inputFileName = file.name;
-//     await duckConn.db.dropFile(inputFileName);
-//     await duckConn.db.registerFileHandle(
-//       inputFileName,
-//       file,
-//       DuckDBDataProtocol.BROWSER_FILEREADER,
-//       true,
-//     );
-//     const inputTableName = genRandomStr(10, inputFileName).toLowerCase();
-//     await duckConn.conn.query(`DROP TABLE IF EXISTS ${inputTableName}`);
-//     const readFileQuery = inputFileName.endsWith('.parquet')
-//       ? `parquet_scan(${escapeVal(inputFileName)})`
-//       : `read_csv(${escapeVal(
-//           inputFileName,
-//         )}, SAMPLE_SIZE=-1, AUTO_DETECT=TRUE)`;
-//     await duckConn.conn.query(
-//       `CREATE TABLE ${inputTableName} AS
-//             SELECT * FROM ${readFileQuery}`,
-//     );
-//     const res = await duckConn.conn.query(
-//       `SELECT count(*) FROM ${inputTableName}`,
-//     );
-//     const inputRowCount = getColValAsNumber(res, 0);
-//     const tableMeta = await duckConn.conn.query(
-//       `DESCRIBE TABLE ${inputTableName}`,
-//     );
-//     const inputTableFields = Array.from(tableMeta).map((row) => ({
-//       name: String(row?.column_name),
-//       type: String(row?.column_type),
-//     }));
-//     const nextResult: CreateTableDropzoneResult = {
-//       inputFileName,
-//       inputTableName,
-//       inputRowCount,
-//       // outputRowCount: undefined,
-//       inputTableFields,
-//       columns: {},
-//     };
-//     // setResult(nextResult);
-//     onTableCreated(inputTableName, nextResult);
-//   } catch (e) {
-//     console.error(e);
-//     onError(e instanceof Error ? e.message : String(e));
-//   }
-// }
-// async function maybeDropTable(
-//   value: CreateTableDropzoneResult,
-//   duckConn: DuckDb,
-// ) {
-//   const {inputFileName, inputTableName} = value || {};
-//   if (inputFileName) {
-//     await duckConn.db.dropFile(inputFileName);
-//   }
-//   if (inputTableName) {
-//     await duckConn.conn.query(`DROP TABLE IF EXISTS ${inputTableName};`);
-//   }
-// }
+/**
+ * Create a table from an Arrow table.
+ * @param tableName - The name of the table to create.
+ * @param arrowTable - The Arrow table to create the table from.
+ */
+export async function createTableFromArrowTable(tableName, data) {
+    const { conn } = await getDuckDb();
+    await conn.insertArrowTable(data, { name: tableName });
+}
+/**
+ * Create a table from an array of objects.
+ * @param tableName - The name of the table to create.
+ * @param data - The array of objects to create the table from.
+ */
+export async function createTableFromObjects(tableName, data) {
+    const { conn } = await getDuckDb();
+    const query = sqlFrom(data);
+    await conn.query(`CREATE OR REPLACE TABLE ${tableName} AS ${query}`);
+}

package/dist/index.d.ts

@@ -2,4 +2,5 @@ export * from './duckdb';
 export * from './types';
 export * from './useDuckDb';
 export * from './exportToCsv';
+export * from './arrow-utils';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC"}

package/dist/index.js

@@ -2,3 +2,4 @@ export * from './duckdb';
 export * from './types';
 export * from './useDuckDb';
 export * from './exportToCsv';
+export * from './arrow-utils';

package/dist/sql-from.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Create a SQL query that embeds the given data for loading.
+ * @param {*} data The dataset as an array of objects.
+ * @param {object} [options] Loading options.
+ * @param {string[]|Record<string,string>} [options.columns] The columns to include.
+ *   If not specified, the keys of the first data object are used.
+ * @returns {string} SQL query string to load data.
+ */
+export declare function sqlFrom(data: Record<string, unknown>[], { columns, }?: {
+    columns?: string[] | Record<string, string>;
+}): string;
+/**
+ * Convert a value to a SQL literal.
+ * @param {*} value The value to convert.
+ * @returns {string} The SQL literal.
+ */
+export declare function literalToSQL(value: unknown): string;
+//# sourceMappingURL=sql-from.d.ts.map

package/dist/sql-from.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sql-from.d.ts","sourceRoot":"","sources":["../src/sql-from.ts"],"names":[],"mappings":"AAGA;;;;;;;GAOG;AACH,wBAAgB,OAAO,CACrB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,EAC/B,EACE,OAAsC,GACvC,GAAE;IAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAAM,UAsBtD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,UA2B1C"}

package/dist/sql-from.js

@@ -0,0 +1,68 @@
+// Adapted from https://github.com/uwdata/mosaic/blob/main/packages/sql/src/load/sql-from.js
+// BSD 3-Clause License Copyright (c) 2023, UW Interactive Data Lab
+/**
+ * Create a SQL query that embeds the given data for loading.
+ * @param {*} data The dataset as an array of objects.
+ * @param {object} [options] Loading options.
+ * @param {string[]|Record<string,string>} [options.columns] The columns to include.
+ *   If not specified, the keys of the first data object are used.
+ * @returns {string} SQL query string to load data.
+ */
+export function sqlFrom(data, { columns = Object.keys(data?.[0] || {}), } = {}) {
+    let keys = [];
+    let columnMap;
+    if (Array.isArray(columns)) {
+        keys = columns;
+        columnMap = keys.reduce((m, k) => ({ ...m, [k]: k }), {});
+    }
+    else {
+        columnMap = columns;
+        keys = Object.keys(columns);
+    }
+    if (!keys.length) {
+        throw new Error('Can not create table from empty column set.');
+    }
+    const subq = [];
+    for (const datum of data) {
+        const sel = keys.map((k) => `${literalToSQL(datum[k])} AS "${columnMap[k]}"`);
+        subq.push(`(SELECT ${sel.join(', ')})`);
+    }
+    return subq.join(' UNION ALL ');
+}
+/**
+ * Convert a value to a SQL literal.
+ * @param {*} value The value to convert.
+ * @returns {string} The SQL literal.
+ */
+export function literalToSQL(value) {
+    switch (typeof value) {
+        case 'number':
+            return Number.isFinite(value) ? `${value}` : 'NULL';
+        case 'string':
+            return `'${value.replace(`'`, `''`)}'`;
+        case 'boolean':
+            return value ? 'TRUE' : 'FALSE';
+        default:
+            if (value == null) {
+                return 'NULL';
+            }
+            else if (value instanceof Date) {
+                const ts = +value;
+                if (Number.isNaN(ts))
+                    return 'NULL';
+                const y = value.getUTCFullYear();
+                const m = value.getUTCMonth();
+                const d = value.getUTCDate();
+                return ts === Date.UTC(y, m, d)
+                    ? `DATE '${y}-${m + 1}-${d}'` // utc date
+                    : `epoch_ms(${ts})`; // timestamp
+            }
+            else if (value instanceof RegExp) {
+                return `'${value.source}'`;
+            }
+            else {
+                // otherwise rely on string coercion
+                return `${value}`;
+            }
+    }
+}

package/package.json

@@ -1,23 +1,42 @@
 {
   "name": "@sqlrooms/duckdb",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "module": "dist/index.js",
   "type": "module",
   "private": false,
+  "author": "Ilya Boyandin <ilya@boyandin.me>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sqlrooms/sqlrooms.git"
+  },
+  "files": [
+    "dist",
+    "!dist/__tests__"
+  ],
   "publishConfig": {
     "access": "public"
   },
-  "peerDependencies": {
-    "@duckdb/duckdb-wasm": "*",
-    "apache-arrow": "*"
+  "dependencies": {
+    "@duckdb/duckdb-wasm": "^1.29.0",
+    "apache-arrow": "^18.1.0"
+  },
+  "devDependencies": {
+    "@sqlrooms/jest-config": "0.0.3",
+    "@types/jest": "^29.5.12",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.2"
   },
   "scripts": {
     "dev": "tsc -w",
     "build": "tsc",
     "lint": "eslint .",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "tsc --noEmit",
+    "typedoc": "typedoc",
+    "test": "jest",
+    "test:watch": "jest --watch"
   },
-  "gitHead": "5d8893a604a91d109dc5b5f80b4a3e937b4cf520"
+  "gitHead": "4269a3efdb5a903cb2498c126e9c36683b3bbae0"
 }

package/CHANGELOG.md

@@ -1,14 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-## [0.0.1](https://github.com/ilyabo/sqlrooms/compare/v0.0.1-alpha.0...v0.0.1) (2025-01-30)
-
-**Note:** Version bump only for package @sqlrooms/duckdb
-
-## 0.0.1-alpha.0 (2025-01-30)
-
-**Note:** Version bump only for package @sqlrooms/duckdb
-
-**Note:** Version bump only for package @sqlrooms/duckdb