chDB для Node.js

Как установить и использовать chDB с Node.js

chDB-node предоставляет привязки для Node.js к chDB, позволяя выполнять запросы ClickHouse непосредственно в приложениях Node.js без каких-либо внешних зависимостей.

​

Установка

npm install chdb

​

Использование

chDB-node поддерживает два режима запросов: автономные запросы для простых операций и сеансовые запросы для сохранения состояния базы данных.

​

Автономные запросы

Для простых автономных запросов, не требующих сохранения состояния:

const { query } = require("chdb");

// Простой запрос
const result = query("SELECT version()", "CSV");
console.log("ClickHouse version:", result);

// Запрос с несколькими столбцами
const multiResult = query("SELECT 'Hello' as greeting, 'chDB' as engine, 42 as answer", "CSV");
console.log("Multi-column result:", multiResult);

// Математические операции
const mathResult = query("SELECT 2 + 2 as sum, pi() as pi_value", "JSON");
console.log("Math result:", mathResult);

// Сведения о системе
const systemInfo = query("SELECT * FROM system.functions LIMIT 5", "Pretty");
console.log("System functions:", systemInfo);

​

Сеансовые запросы

const { Session } = require("chdb");

// Создание сеанса с постоянным хранилищем
const session = new Session("./chdb-node-data");

try {
    // Создание базы данных и таблицы
    session.query(`
        CREATE DATABASE IF NOT EXISTS myapp;
        CREATE TABLE IF NOT EXISTS myapp.users (
            id UInt32,
            name String,
            email String,
            created_at DateTime DEFAULT now()
        ) ENGINE = MergeTree() ORDER BY id
    `);

    // Вставка тестовых данных
    session.query(`
        INSERT INTO myapp.users (id, name, email) VALUES 
        (1, 'Alice', '[e-mail]'),
        (2, 'Bob', '[e-mail]'),
        (3, 'Charlie', '[e-mail]')
    `);

    // Запрос данных в разных форматах
    const csvResult = session.query("SELECT * FROM myapp.users ORDER BY id", "CSV");
    console.log("CSV Result:", csvResult);

    const jsonResult = session.query("SELECT * FROM myapp.users ORDER BY id", "JSON");
    console.log("JSON Result:", jsonResult);

    // Агрегирующие запросы
    const stats = session.query(`
        SELECT 
            COUNT(*) as total_users,
            MAX(id) as max_id,
            MIN(created_at) as earliest_signup
        FROM myapp.users
    `, "Pretty");
    console.log("User Statistics:", stats);

} finally {
    // Обязательная очистка сеанса
    session.cleanup(); // Удаляет файлы базы данных
}

​

Обработка внешних данных

const { Session } = require("chdb");

const session = new Session("./data-processing");

try {
    // Обработка CSV-данных по URL
    const result = session.query(`
        SELECT 
            COUNT(*) as total_records,
            COUNT(DISTINCT "UserID") as unique_users
        FROM url('https://datasets.clickhouse.com/hits/hits.csv', 'CSV') 
        LIMIT 1000
    `, "JSON");
    
    console.log("External data analysis:", result);

    // Создание таблицы из внешних данных
    session.query(`
        CREATE TABLE web_analytics AS
        SELECT * FROM url('https://datasets.clickhouse.com/hits/hits.csv', 'CSV')
        LIMIT 10000
    `);

    // Анализ импортированных данных
    const analysis = session.query(`
        SELECT 
            toDate("EventTime") as date,
            COUNT(*) as events,
            COUNT(DISTINCT "UserID") as unique_users
        FROM web_analytics
        GROUP BY date
        ORDER BY date
        LIMIT 10
    `, "Pretty");
    
    console.log("Daily analytics:", analysis);

} finally {
    session.cleanup();
}

​

Обработка ошибок

При работе с chDB всегда корректно обрабатывайте ошибки:

const { query, Session } = require("chdb");

// Обработка ошибок для автономных запросов
function safeQuery(sql, format = "CSV") {
    try {
        const result = query(sql, format);
        return { success: true, data: result };
    } catch (error) {
        console.error("Query error:", error.message);
        return { success: false, error: error.message };
    }
}

// Пример использования
const result = safeQuery("SELECT invalid_syntax");
if (result.success) {
    console.log("Query result:", result.data);
} else {
    console.log("Query failed:", result.error);
}

// Обработка ошибок для сеансов
function safeSessionQuery() {
    const session = new Session("./error-test");
    
    try {
        // Это вызовет ошибку из-за неверного синтаксиса
        const result = session.query("CREATE TABLE invalid syntax", "CSV");
        console.log("Unexpected success:", result);
    } catch (error) {
        console.error("Session query error:", error.message);
    } finally {
        // Всегда выполняйте очистку, даже если произошла ошибка
        session.cleanup();
    }
}

safeSessionQuery();

​

Репозиторий GitHub

• Репозиторий GitHub: chdb-io/chdb-node
• Ошибки и поддержка: Сообщайте об ошибках в репозитории GitHub
• Пакет NPM: chdb on npm