Bun 上的 chDB

chDB-bun 为 chDB 提供了实验性的 FFI（Foreign Function Interface，外部函数接口）绑定，使你能够在你的 Bun 应用中直接运行 ClickHouse 查询，而无需任何外部依赖。

安装

步骤 1：安装系统依赖项

首先安装所需的系统依赖项：

安装 libchdb

curl -sL https://lib.chdb.io | bash

安装构建工具

你需要在系统上安装 gcc 或 clang 中的一个：

步骤 2：安装 chDB-bun

# 从 GitHub 仓库安装
bun add github:chdb-io/chdb-bun

或者在本地克隆并构建

git clone https://github.com/chdb-io/chdb-bun.git cd chdb-bun bun install bun run build

用法

chDB-bun 支持两种查询模式：用于一次性操作的临时查询，以及用于维护数据库状态的持久会话。

临时查询

适用于不需要保留状态的简单一次性查询：

import { query } from 'chdb-bun';

// 基本查询
const result = query("SELECT version()", "CSV");
console.log(result); // "23.10.1.1"

// 使用不同输出格式查询
const jsonResult = query("SELECT 1 as id, 'Hello' as message", "JSON");
console.log(jsonResult);

// 执行计算查询
const mathResult = query("SELECT 2 + 2 as sum, pi() as pi_value", "Pretty");
console.log(mathResult);

// 查询系统信息
const systemInfo = query("SELECT * FROM system.functions LIMIT 5", "CSV");
console.log(systemInfo);

持久化会话

对于需要在多个查询之间保持状态的复杂操作：

import { Session } from 'chdb-bun';

// 创建持久化存储会话
const sess = new Session('./chdb-bun-tmp');

try {
    // 创建数据库和表
    sess.query(`
        CREATE DATABASE IF NOT EXISTS mydb;
        CREATE TABLE IF NOT EXISTS mydb.users (
            id UInt32,
            name String,
            email String
        ) ENGINE = MergeTree() ORDER BY id
    `, "CSV");

    // 插入数据
    sess.query(`
        INSERT INTO mydb.users VALUES 
        (1, 'Alice', '[email protected]'),
        (2, 'Bob', '[email protected]'),
        (3, 'Charlie', '[email protected]')
    `, "CSV");

    // 查询数据
    const users = sess.query("SELECT * FROM mydb.users ORDER BY id", "JSON");
    console.log("用户:", users);

    // 创建并使用自定义函数
    sess.query("CREATE FUNCTION IF NOT EXISTS hello AS () -> 'Hello chDB'", "CSV");
    const greeting = sess.query("SELECT hello() as message", "Pretty");
    console.log(greeting);

    // 聚合查询
    const stats = sess.query(`
        SELECT 
            COUNT(*) as total_users,
            MAX(id) as max_id,
            MIN(id) as min_id
        FROM mydb.users
    `, "JSON");
    console.log("统计信息:", stats);

} finally {
    // 务必清理会话以释放资源
    sess.cleanup(); // 此操作将删除数据库文件
}