Skip to content

Latest commit

 

History

History
110 lines (87 loc) · 7.34 KB

README.md

File metadata and controls

110 lines (87 loc) · 7.34 KB
Raw
The DuckDB WASM logo.

DuckDB-Wasm

DuckDB is an in-process SQL OLAP Database Management System.

DuckDB-Wasm brings DuckDB to every browser thanks to WebAssembly.

Duckdb-Wasm 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. Learn more about DuckDB-Wasm from our VLDB publication or the recorded talk.

Try it out at shell.duckdb.org or external third party embedding of DuckDB-Wasm, read the API documentation, check out the web-app examples, and chat with us on Discord.

DuckDB and DuckDB-Wasm

DuckDB-Wasm is currently based on DuckDB v1.1.1.

Relevant differences:

  • HTTP stack is different between native and Wasm versions of DuckDB. Most relevant are:
    • Requests are always upgraded to HTTPS
    • Requests needs server to allow Cross Origin access on a given resource
    • File system implementation (eg. S3) is different and this might cause some differences
  • Extension install is lazy, meaning that INSTALL extension_name FROM 'https://repository.endpoint.org'; defer fetching the extension to the first LOAD extension_name; instruction. INSTALL x FROM community; shorthands are also supported.
  • DuckDB-Wasm builds are optimized for download speed. Core extensions like autocomplete, JSON, Parquet and ICU are usually bundled DuckDB binaries, while in duckdb-wasm they are autoloaded (including fetching them) at runtime. In particular for ICU autoloading do not work corrently in all cases, explicit LOAD icu; might be needed to reproduce same behaviour.
  • DuckDB-Wasm is sandboxed and migth not have the same level of support for out-of-core operations and access to file system
  • DuckDB-Wasm default mode is single threaded. Multithreading is at the moment still experimental.

Supported DuckDB features:

  • DuckDB databases files are compatible to be read from DuckDB-Wasm.
  • Databases files can be made available as simple as: ATTACH 'https://blobs.duckdb.org/data/test.db'; FROM db.t; demo
  • Spatial support via LOAD spatial spatial demo
  • A growing subset of extensions, either core, community or external, are supported for DuckDB-Wasm
  • Multithreading work but it's still experimental and by default not enabled

DuckDB-Wasm and DuckDB Extension

DuckDB is extensible and this allows to delegate functionality to extensions.

Core extensions are available at https://extensions.duckdb.org, and community extensions are available at https://community-extensions.duckdb.org.

--- Excplicitly load extensions
LOAD icu;

--- Or have them autoloaded when using relevant functions or settings
DESCRIBE FROM read_parquet('https://blobs.duckdb.org/stations.parquet');  -- (this autoloads JSON)

--- Or register extensions
INSTALL h3 FROM community;
INSTALL sqlite_scanner FROM 'https://extensions.duckdb.org';
INSTALL quack FROM 'https://community-extensions.duckdb.org';

--- And then load them
LOAD h3;
LOAD sqlite_scanner;
LOAD quack;
FROM duckdb_extensions() WHERE loaded;

Will show that h3, icu, parquet, quack and sqlite_scanner have been loaded.

You can try the Shell demo with loading of extensions but this do require about 3.2 MB of compressed Wasm files to be transfered over the network (on first visit, caching might help).

Extension sizes will vary depending, among other things, on provided functionality or toolchain used.

Build from source

git clone https://github.com/duckdb/duckdb-wasm.git
cd duckdb-wasm
git submodule init
git submodule update
make apply_patches
make serve

Repository Structure

Subproject Description Language
duckdb_wasm Wasm Library C++
@duckdb/duckdb-wasm Typescript API Typescript
@duckdb/duckdb-wasm-shell SQL Shell Rust
@duckdb/duckdb-wasm-app GitHub Page Typescript
@duckdb/react-duckdb React Hooks Typescript