@duckdb/duckdb-wasm 1.10.0 → 1.11.1-dev.0

package/README.md

@@ -1,49 +1,104 @@
-<img src="https://github.com/duckdb/duckdb-wasm/blob/447dd9fc3c4f969b2e1d1379f95331e27d622e05/misc/duckdb_wasm.svg" height="64">
+<img src="https://cdn.jsdelivr.net/npm/@duckdb/duckdb-wasm@latest/dist/img/duckdb_wasm.svg" height="64">
 
 [![Main](https://github.com/duckdb/duckdb-wasm/actions/workflows/main.yml/badge.svg)](https://github.com/duckdb/duckdb-wasm/actions/workflows/main.yml)
 [![Benchmarks](https://github.com/duckdb/duckdb-wasm/actions/workflows/benchmarks.yml/badge.svg)](https://github.com/duckdb/duckdb-wasm/actions/workflows/benchmarks.yml)
+[![duckdb](https://cdn.jsdelivr.net/npm/@duckdb/duckdb-wasm@latest/dist/img/duckdb_version_badge.svg)](https://github.com/duckdb/duckdb)
 [![npm](https://img.shields.io/npm/v/@duckdb/duckdb-wasm?logo=npm)](https://www.npmjs.com/package/@duckdb/duckdb-wasm/v/latest)
+[![JSDevlivr](https://data.jsdelivr.com/v1/package/npm/@duckdb/duckdb-wasm/badge?style=rounded)](https://www.jsdelivr.com/package/npm/@duckdb/duckdb-wasm)
 
 **DuckDB-Wasm**
 
-is an embedded analytical SQL database for the browser. It is powered by WebAssembly, speaks Arrow fluently, reads Parquet, CSV and JSON files backed by Filesystem APIs or HTTP requests and has been tested with Chrome, Firefox, Safari and Node.js. Try it out at [shell.duckdb.org](https://shell.duckdb.org) and read the [API documentation](https://shell.duckdb.org/docs/modules/index.html).
+DuckDB-Wasm is an in-process analytical SQL database for the browser. It is powered by WebAssembly, speaks Arrow fluently, reads Parquet, CSV and JSON files backed by Filesystem APIs or HTTP requests and has been tested with Chrome, Firefox, Safari and Node.js. Read the [launch blog post](https://duckdb.org/2021/10/29/duckdb-wasm.html).
 
-_DuckDB-Wasm is fast! If you're here for performance numbers, head over to our benchmarks at [shell.duckdb.org/versus](https://shell.duckdb.org/versus)._
+Try it out at [shell.duckdb.org](https://shell.duckdb.org) and on [Observable](https://observablehq.com/@cmudig/duckdb) and read the [API documentation](https://shell.duckdb.org/docs/modules/index.html).
+
+_DuckDB-Wasm is fast! If you're here for performance numbers, head over to [our benchmarks](https://shell.duckdb.org/versus)._
 
 ## Instantiation
+cdn(jsdelivr)  
+```ts
+import * as duckdb from '@duckdb/duckdb-wasm';
+
+const JSDELIVR_BUNDLES = duckdb.getJsDelivrBundles();
 
+// Select a bundle based on browser checks
+const bundle = await duckdb.selectBundle(JSDELIVR_BUNDLES);
+
+const worker_url = URL.createObjectURL(
+  new Blob([`importScripts("${bundle.mainWorker!}");`], {type: 'text/javascript'})
+);
+
+// Instantiate the asynchronus version of DuckDB-wasm
+const worker = new Worker(worker_url);
+const logger = new duckdb.ConsoleLogger();
+const db = new duckdb.AsyncDuckDB(logger, worker);
+await db.instantiate(bundle.mainModule, bundle.pthreadWorker);
+URL.revokeObjectURL(worker_url);
+```
+
+webpack  
 ```ts
-// Import the ESM bundle (supports tree-shaking)
-import * as duckdb from '@duckdb/duckdb-wasm/dist/duckdb-esm.js';
-
-// Either bundle them manually, for example as Webpack assets
-import duckdb_wasm from '@duckdb/duckdb-wasm/dist/duckdb.wasm';
-import duckdb_wasm_next from '@duckdb/duckdb-wasm/dist/duckdb-next.wasm';
-import duckdb_wasm_next_coi from '@duckdb/duckdb-wasm/dist/duckdb-next-coi.wasm';
-const WEBPACK_BUNDLES: duckdb.DuckDBBundles = {
-    asyncDefault: {
+import * as duckdb from '@duckdb/duckdb-wasm';
+import duckdb_wasm from '@duckdb/duckdb-wasm/dist/duckdb-mvp.wasm';
+import duckdb_wasm_next from '@duckdb/duckdb-wasm/dist/duckdb-eh.wasm';
+const MANUAL_BUNDLES: duckdb.DuckDBBundles = {
+    mvp: {
         mainModule: duckdb_wasm,
-        mainWorker: new URL('@duckdb/duckdb-wasm/dist/duckdb-browser-async.worker.js', import.meta.url).toString(),
+        mainWorker: new URL('@duckdb/duckdb-wasm/dist/duckdb-browser-mvp.worker.js', import.meta.url).toString(),
     },
-    asyncNext: {
+    eh: {
         mainModule: duckdb_wasm_next,
-        mainWorker: new URL('@duckdb/duckdb-wasm/dist/duckdb-browser-async-next.worker.js', import.meta.url).toString(),
+        mainWorker: new URL('@duckdb/duckdb-wasm/dist/duckdb-browser-eh.worker.js', import.meta.url).toString(),
+    },
+};
+// Select a bundle based on browser checks
+const bundle = await duckdb.selectBundle(MANUAL_BUNDLES);
+// Instantiate the asynchronus version of DuckDB-wasm
+const worker = new Worker(bundle.mainWorker!);
+const logger = new duckdb.ConsoleLogger();
+const db = new duckdb.AsyncDuckDB(logger, worker);
+await db.instantiate(bundle.mainModule, bundle.pthreadWorker);
+```
+vite  
+```ts
+import * as duckdb from '@duckdb/duckdb-wasm';
+import duckdb_wasm from '@duckdb/duckdb-wasm/dist/duckdb-mvp.wasm?url';
+import mvp_worker from '@duckdb/duckdb-wasm/dist/duckdb-browser-mvp.worker.js?url';
+import duckdb_wasm_eh from '@duckdb/duckdb-wasm/dist/duckdb-eh.wasm?url';
+import eh_worker from '@duckdb/duckdb-wasm/dist/duckdb-browser-eh.worker.js?url';
+
+const MANUAL_BUNDLES: duckdb.DuckDBBundles = {
+    mvp: {
+        mainModule: duckdb_wasm,
+        mainWorker: mvp_worker,
     },
-    asyncNextCOI: {
-        mainModule: duckdb_wasm_next_coi,
-        mainWorker: new URL(
-            '@duckdb/duckdb-wasm/dist/duckdb-browser-async-next-coi.worker.js',
-            import.meta.url,
-        ).toString(),
-        pthreadWorker: new URL(
-            '@duckdb/duckdb-wasm/dist/duckdb-browser-async-next-coi.pthread.worker.js',
-            import.meta.url,
-        ).toString(),
+    eh: {
+        mainModule: duckdb_wasm_eh,
+        mainWorker: eh_worker,
     },
 };
-// ..., or load the bundles from jsdelivr
-const JSDELIVR_BUNDLES = duckdb.getJsDelivrBundles();
+// Select a bundle based on browser checks
+const bundle = await duckdb.selectBundle(MANUAL_BUNDLES);
+// Instantiate the asynchronus version of DuckDB-wasm
+const worker = new Worker(bundle.mainWorker!);
+const logger = new duckdb.ConsoleLogger();
+const db = new duckdb.AsyncDuckDB(logger, worker);
+await db.instantiate(bundle.mainModule, bundle.pthreadWorker);
+```
+static served(manually download the files from https://cdn.jsdelivr.net/npm/@duckdb/duckdb-wasm@1.13.0/dist/)  
+```ts
+import * as duckdb from '@duckdb/duckdb-wasm';
 
+const MANUAL_BUNDLES: duckdb.DuckDBBundles = {
+    mvp: {
+        mainModule: 'change/me/../duckdb-mvp.wasm',
+        mainWorker: 'change/me/../duckdb-browser-mvp.worker.js',
+    },
+    eh: {
+        mainModule: 'change/m/../duckdb-eh.wasm',
+        mainWorker: 'change/m/../duckdb-browser-eh.worker.js',
+    },
+};
 // Select a bundle based on browser checks
 const bundle = await duckdb.selectBundle(JSDELIVR_BUNDLES);
 // Instantiate the asynchronus version of DuckDB-wasm
@@ -51,23 +106,13 @@ const worker = new Worker(bundle.mainWorker!);
 const logger = new duckdb.ConsoleLogger();
 const db = new duckdb.AsyncDuckDB(logger, worker);
 await db.instantiate(bundle.mainModule, bundle.pthreadWorker);
-```
+```  
 
 ## Data Import
 
 ```ts
 // Data can be inserted from an existing arrow.Table
 await c.insertArrowTable(existingTable, { name: 'arrow_table' });
-// ..., from Arrow vectors
-await c.insertArrowVectors(
-    {
-        col1: arrow.Int32Vector.from([1, 2]),
-        col2: arrow.Utf8Vector.from(['foo', 'bar']),
-    },
-    {
-        name: 'arrow_vectors',
-    },
-);
 // ..., from a raw Arrow IPC stream
 const c = await db.connect();
 const streamResponse = await fetch(`someapi`);
@@ -84,7 +129,7 @@ await Promise.all(streamInserts);
 // (interchangeable: registerFile{Text,Buffer,URL,Handle})
 await db.registerFileText(`data.csv`, '1|foo\n2|bar\n');
 // ... with typed insert options
-await db.importCSVFromPath('data.csv', {
+await db.insertCSVFromPath('data.csv', {
     schema: 'main',
     name: 'foo',
     detect: false,
@@ -100,26 +145,28 @@ await db.importCSVFromPath('data.csv', {
 await db.registerFileText(
     'rows.json',
     `[
-    { “col1”: 1, “col2”: “foo” },
-    { “col1”: 2, “col2”: “bar” },
+    { "col1": 1, "col2": "foo" },
+    { "col1": 2, "col2": "bar" },
 ]`,
 );
 // ... or column-major format
 await db.registerFileText(
     'columns.json',
     `{
-    “col1”: [1, 2],
-    “col2”: [“foo”, “bar”]
+    "col1": [1, 2],
+    "col2": ["foo", "bar"]
 }`,
 );
 // ... with typed insert options
-await db.importJSONFromPath('rows.json', { name: 'rows' });
-await db.importJSONFromPath('columns.json', { name: 'columns' });
+await c.insertJSONFromPath('rows.json', { name: 'rows' });
+await c.insertJSONFromPath('columns.json', { name: 'columns' });
 
 // ..., from Parquet files
 const pickedFile: File = letUserPickFile();
-await db.registerFileHandle('local.parquet', pickedFile);
-await db.registerFileURL('remote.parquet', 'https://origin/remote.parquet');
+await db.registerFileHandle('local.parquet', pickedFile, DuckDBDataProtocol.BROWSER_FILEREADER, true);
+await db.registerFileURL('remote.parquet', 'https://origin/remote.parquet', DuckDBDataProtocol.HTTP, false);
+const res = await fetch('https://origin/remote.parquet');
+await db.registerFileBuffer('buffer.parquet', new Uint8Array(await res.arrayBuffer()));
 
 // ..., by specifying URLs in the SQL text
 await c.query(`