chDB for Rust

chDB-rustは、chDBの実験的なFFI（Foreign Function Interface）バインディングを提供し、ClickHouseクエリをRustアプリケーションで外部依存関係なしに直接実行できるようにします。

Installation

Install libchdb

chDBライブラリをインストールします：

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

Usage

chDB Rustは、ステートレスおよびステートフルなクエリ実行モードの両方を提供します。

Stateless usage

永続的な状態なしでのシンプルなクエリの場合：

use chdb_rust::{execute, arg::Arg, format::OutputFormat};

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Execute a simple query
    let result = execute(
        "SELECT version()",
        Some(&[Arg::OutputFormat(OutputFormat::JSONEachRow)])
    )?;
    println!("ClickHouse version: {}", result.data_utf8()?);

    // Query with CSV file
    let result = execute(
        "SELECT * FROM file('data.csv', 'CSV')",
        Some(&[Arg::OutputFormat(OutputFormat::JSONEachRow)])
    )?;
    println!("CSV data: {}", result.data_utf8()?);

    Ok(())
}

Stateful usage (Sessions)

データベースやテーブルのような永続的な状態を必要とするクエリの場合：

use chdb_rust::{
    session::SessionBuilder,
    arg::Arg,
    format::OutputFormat,
    log_level::LogLevel
};
use tempdir::TempDir;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Create a temporary directory for database storage
    let tmp = TempDir::new("chdb-rust")?;

    // Build session with configuration
    let session = SessionBuilder::new()
        .with_data_path(tmp.path())
        .with_arg(Arg::LogLevel(LogLevel::Debug))
        .with_auto_cleanup(true)  // Cleanup on drop
        .build()?;

    // Create database and table
    session.execute(
        "CREATE DATABASE demo; USE demo", 
        Some(&[Arg::MultiQuery])
    )?;

    session.execute(
        "CREATE TABLE logs (id UInt64, msg String) ENGINE = MergeTree() ORDER BY id",
        None,
    )?;

    // Insert data
    session.execute(
        "INSERT INTO logs (id, msg) VALUES (1, 'Hello'), (2, 'World')",
        None,
    )?;

    // Query data
    let result = session.execute(
        "SELECT * FROM logs ORDER BY id",
        Some(&[Arg::OutputFormat(OutputFormat::JSONEachRow)]),
    )?;

    println!("Query results:\n{}", result.data_utf8()?);

    // Get query statistics
    println!("Rows read: {}", result.rows_read());
    println!("Bytes read: {}", result.bytes_read());
    println!("Query time: {:?}", result.elapsed());

    Ok(())
}

Building and testing

Build the project

cargo build

Run tests

cargo test

Development dependencies

プロジェクトには以下の開発依存関係が含まれています：

• bindgen (v0.70.1) - CヘッダーからFFIバインディングを生成
• tempdir (v0.3.7) - テストにおける一時ディレクトリの処理
• thiserror (v1) - エラーハンドリングユーティリティ

Error handling

chDB Rustは、Error列挙型を通じて包括的なエラーハンドリングを提供します：

use chdb_rust::{execute, error::Error};

match execute("SELECT 1", None) {
    Ok(result) => {
        println!("Success: {}", result.data_utf8()?);
    },
    Err(Error::QueryError(msg)) => {
        eprintln!("Query failed: {}", msg);
    },
    Err(Error::NoResult) => {
        eprintln!("No result returned");
    },
    Err(Error::NonUtf8Sequence(e)) => {
        eprintln!("Invalid UTF-8: {}", e);
    },
    Err(e) => {
        eprintln!("Other error: {}", e);
    }
}

GitHub repository

プロジェクトのGitHubリポジトリは、chdb-io/chdb-rustで見つけることができます。