适用于 Rust 的 chDB

chDB-rust 为 chDB 提供了实验性的 FFI（外部函数接口）绑定，使你可以在 Rust 应用程序中直接运行 ClickHouse 查询，而无需任何外部依赖。

安装

安装 libchdb

安装 libchdb 库：

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

使用方法

chDB Rust 提供无状态和有状态两种查询执行模式。

无状态使用

适用于不需要保存状态的简单查询：

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

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // 执行简单查询
    let result = execute(
        "SELECT version()",
        Some(&[Arg::OutputFormat(OutputFormat::JSONEachRow)])
    )?;
    println!("ClickHouse 版本：{}", result.data_utf8()?);
    
    // 查询 CSV 文件
    let result = execute(
        "SELECT * FROM file('data.csv', 'CSV')",
        Some(&[Arg::OutputFormat(OutputFormat::JSONEachRow)])
    )?;
    println!("CSV 数据：{}", result.data_utf8()?);
    
    Ok(())
}

有状态使用（会话）

对于需要持久状态（例如数据库和数据表）的查询：

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

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // 为数据库存储创建临时目录
    let tmp = TempDir::new("chdb-rust")?;
    
    // 构建配置会话
    let session = SessionBuilder::new()
        .with_data_path(tmp.path())
        .with_arg(Arg::LogLevel(LogLevel::Debug))
        .with_auto_cleanup(true)  // 销毁时自动清理
        .build()?;

    // 创建数据库和表
    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,
    )?;

    // 插入数据
    session.execute(
        "INSERT INTO logs (id, msg) VALUES (1, 'Hello'), (2, 'World')",
        None,
    )?;

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

    println!("查询结果：\n{}", result.data_utf8()?);
    
    // 获取查询统计信息
    println!("读取行数：{}", result.rows_read());
    println!("读取字节数：{}", result.bytes_read());
    println!("查询耗时：{:?}", result.elapsed());

    Ok(())
}

构建与测试

构建项目

cargo build

运行测试

cargo test

开发依赖

该项目包含以下开发依赖项：

• bindgen (v0.70.1) - 从 C 头文件生成 FFI 绑定
• tempdir (v0.3.7) - 用于测试中的临时目录管理
• thiserror (v1) - 错误处理工具库

错误处理

chDB Rust 通过 Error 枚举提供了完善的错误处理机制：

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

match execute("SELECT 1", None) {
    Ok(result) => {
        println!("成功：{}", result.data_utf8()?);
    },
    Err(Error::QueryError(msg)) => {
        eprintln!("查询失败：{}", msg);
    },
    Err(Error::NoResult) => {
        eprintln!("未返回结果");
    },
    Err(Error::NonUtf8Sequence(e)) => {
        eprintln!("无效的 UTF-8：{}", e);
    },
    Err(e) => {
        eprintln!("其他错误：{}", e);
    }
}

GitHub 仓库

该项目的 GitHub 仓库位于 chdb-io/chdb-rust。