DuckDB-Wasm 技术文档

DuckDB-Wasm 技术文档

duckdb-wasm WebAssembly version of DuckDB 项目地址: https://gitcode.com/gh_mirrors/du/duckdb-wasm

安装指南

通过NPM安装（适用于Node.js环境）

在Node.js项目中，您可以轻松地通过NPM来安装duckdb-wasm包：

npm install @duckdb/duckdb-wasm --save

使用cdn加载（浏览器环境）

如果您希望在浏览器环境中使用DuckDB-Wasm，可以利用jsDelivr服务：

<script src="https://cdn.jsdelivr.net/npm/@duckdb/duckdb-wasm@latest/dist/duckdb.min.js"></script>

项目的使用说明

DuckDB-Wasm允许您在Web应用中执行SQL查询，处理箭头数据流，读取Parquet、CSV以及JSON文件。以下是如何开始使用它的基本步骤：

初始化DuckDB-Wasm库

对于Node.js，您需要这样初始化：

const { DuckDB } = require('@duckdb/duckdb-wasm');
let db = await DuckDB.open();

在浏览器环境下，假设您已经通过<script>标签引入了库，可以直接调用全局对象的方法：

<script>
window.onload = async function() {
    let db = await window.DuckDB.open();
};
</script>

项目API使用文档

DuckDB-Wasm提供了丰富的API来交互数据库。例如，创建表并插入数据：

// 创建一个新表
await db.execute('CREATE TABLE users (id INTEGER, name VARCHAR)');
// 插入数据
await db.execute("INSERT INTO users VALUES (1, 'Alice')");

执行查询并获取结果：

let result = await db.query("SELECT * FROM users");
for await (const row of result) {
    console.log(row);
}

请注意，具体的API详情和更多操作方法，请参考API文档，它提供了每个函数的详细说明。

项目构建自定义方式

如果您想从源码构建DuckDB-Wasm，按照以下步骤进行：

1. 克隆仓库:

   git clone https://github.com/duckdb/duckdb-wasm.git
   

2. 初始化并更新子模块:

   cd duckdb-wasm
   git submodule init
   git submodule update
   

3. 编译项目:

   执行make命令开始构建过程。

   make
   

完成以上步骤后，DuckDB-Wasm的编译产物将生成在指定的输出目录中，准备在您的项目中使用。

加入DuckDB社区，在遇到问题时，记得访问Discord寻求帮助，或者探索web-app例子来加深理解。祝您使用愉快！

duckdb-wasm WebAssembly version of DuckDB 项目地址: https://gitcode.com/gh_mirrors/du/duckdb-wasm