chDB for Bun

Как установить и использовать chDB в среде выполнения Bun

chDB-bun предоставляет экспериментальные FFI-привязки (Foreign Function Interface) для chDB, позволяя выполнять запросы ClickHouse напрямую в приложениях Bun без каких-либо внешних зависимостей.

​

Установка

​

Шаг 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', '[e-mail]'),
        (2, 'Bob', '[e-mail]'),
        (3, 'Charlie', '[e-mail]')
    `, "CSV");

    // Запрос данных
    const users = sess.query("SELECT * FROM mydb.users ORDER BY id", "JSON");
    console.log("Users:", 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("Statistics:", stats);

} finally {
    // Всегда завершайте сеанс для освобождения ресурсов
    sess.cleanup(); // Удаляет файлы базы данных
}