Repository files navigation

Live deployment:https://shellwip.duckdb.org/

Trackig issue:duckdb/duckdb-wasm#1202

This is an experimental deployment ofduckdb-wasm's shell that enables extension loading.

Main idea is allow testing with this feature to be able to collect feedback.

Extension are currently build-in duckdb-wasm package, but that's it's not scalable and do not allows flexible deployments.Duckdb extensions are a powerful way to deliver opt-in featues, and the idea is experimenting with this to allow bringing that also to duckdb-wasm.

To stress test extension loading, in the currentshellwip NO extension are pre-loaded at start-up, so "LOAD parquet;" is for example needed to allow accessing Parquet files.

duckdb> set Calendar = 'gregorian';Catalog Error: Setting with name "Calendar" is not in the catalog, but it exists in the icu extension.To install and load the extension, run:INSTALL icu;LOAD icu;duckdb> LOAD icu;┌┐└┘duckdb> set Calendar = 'gregorian';┌┐└┘

or from a (CORS-)reachable URL:

duckdb> LOAD "https://raw.githubusercontent.com/duckdb/duckdb-wasm-wip/main/static/assets/eh/extensions/json.extension.wasm";┌┐└┘

Each extension is delivered as a single WebAssembly file with a custom dynlink section that provides relocation informations. Providing a full path means fetching the extension from there, while providing a short name would look up extension in the extensions folder in the local deployment.

🌳 = in-tree, 🦆 = DuckDB Labs, 🚧 = known problems, ⛔ = blocked

⚙️ = compiles, no real test have been performed✅ = compiles AND seems to work

If you happen to experiment with a given ⚙️-extension, please send a PR adding relevant comments or movign to ✅.

INSTALL is a no-op and unchecked.

Wasm extension signing is currently disabled.

Exposing extension API to JavaScript API, to allow loading at start-up of a given set of extensions.

JavaScript API to register where extensions should be looked up.

While providing an URL, the right one has to be provided for a given bundle (eh or mvp), we haven't settled yet for a naming-schema that allow to provide bundle compatible URLs.

Documentation and instructions.

Creating extensions currently requires using a recent Emscripten providing specific linking time flags (-fPIC -fSIDE_MODULE), and the current target are C/C++ extensions.

Documentation is coming on how to compile your own extensions!

You developed a Rust extension? There are (sketchy) plans on how to make possible, but do get in touch.

The idea for this phase is trying things out and collecting feedback, while working on making this available (opt-in at first) in main duckdb-wasm.