Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs
49.6kGet Started

chDB for Bun

View as MarkdownEdit this pageReport an issueSet up docs MCP

chDB-bunは、chDB向けの実験的なFFI (Foreign Function Interface) バインディングを提供しており、外部依存関係を追加することなく、Bunアプリケーションから直接ClickHouseクエリを実行できます。

インストール

システム依存関係をインストール

まず、必要なシステム依存関係をインストールします。

libchdb をインストール

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

ビルドツールをインストール

システムに gcc または clang のいずれかがインストールされている必要があります。

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 は 2 つのクエリモードをサポートしています。一回限りの操作向けの一時クエリと、データベースの状態を維持するための永続セッションです。

一時クエリ

永続的な状態を必要としない、単純な単発クエリの場合:

import { query } from 'chdb-bun';

// Basic query
const result = query("SELECT version()", "CSV");
console.log(result); // "23.10.1.1"

// Query with different output formats
const jsonResult = query("SELECT 1 as id, 'Hello' as message", "JSON");
console.log(jsonResult);

// Query with calculations
const mathResult = query("SELECT 2 + 2 as sum, pi() as pi_value", "Pretty");
console.log(mathResult);

// Query system information
const systemInfo = query("SELECT * FROM system.functions LIMIT 5", "CSV");
console.log(systemInfo);

永続セッション

クエリ間で状態を維持する必要がある複雑な操作の場合:

import { Session } from 'chdb-bun';

// Create a session with persistent storage
const sess = new Session('./chdb-bun-tmp');

try {
    // Create a database and table
    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");

    // Insert data
    sess.query(`
        INSERT INTO mydb.users VALUES 
        (1, 'Alice', 'alice@example.com'),
        (2, 'Bob', 'bob@example.com'),
        (3, 'Charlie', 'charlie@example.com')
    `, "CSV");

    // Query the data
    const users = sess.query("SELECT * FROM mydb.users ORDER BY id", "JSON");
    console.log("Users:", users);

    // Create and use custom functions
    sess.query("CREATE FUNCTION IF NOT EXISTS hello AS () -> 'Hello chDB'", "CSV");
    const greeting = sess.query("SELECT hello() as message", "Pretty");
    console.log(greeting);

    // Aggregate queries
    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("Statistics:", stats);

} finally {
    // Always cleanup the session to free resources
    sess.cleanup(); // This deletes the database files
}
Navigation