Pular para o conteúdo principal
O chDB-rust oferece bindings FFI (Foreign Function Interface) experimentais para o chDB, permitindo executar consultas do ClickHouse diretamente nas suas aplicações em Rust, sem dependências externas.

Instalação

Instale libchdb

Instale a biblioteca chDB:
curl -sL https://lib.chdb.io | bash

Uso

O chDB Rust oferece modos de execução de consultas sem estado e com estado.

Uso sem estado

Para consultas simples sem manter estado persistente:
use chdb_rust::{execute, arg::Arg, format::OutputFormat};

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Executar uma consulta simples
    let result = execute(
        "SELECT version()",
        Some(&[Arg::OutputFormat(OutputFormat::JSONEachRow)])
    )?;
    println!("ClickHouse version: {}", result.data_utf8()?);
    
    // Consulta com arquivo CSV
    let result = execute(
        "SELECT * FROM file('data.csv', 'CSV')",
        Some(&[Arg::OutputFormat(OutputFormat::JSONEachRow)])
    )?;
    println!("CSV data: {}", result.data_utf8()?);
    
    Ok(())
}

Uso com estado (Sessões)

Para consultas que exigem estado persistente, como bancos de dados e tabelas:
use chdb_rust::{
    session::SessionBuilder,
    arg::Arg,
    format::OutputFormat,
    log_level::LogLevel
};
use tempdir::TempDir;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Cria um diretório temporário para armazenamento do banco de dados
    let tmp = TempDir::new("chdb-rust")?;
    
    // Constrói a sessão com a configuração
    let session = SessionBuilder::new()
        .with_data_path(tmp.path())
        .with_arg(Arg::LogLevel(LogLevel::Debug))
        .with_auto_cleanup(true)  // Limpeza ao descartar
        .build()?;

    // Cria banco de dados e tabela
    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,
    )?;

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

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

    println!("Query results:\n{}", result.data_utf8()?);
    
    // Obtém estatísticas da consulta
    println!("Rows read: {}", result.rows_read());
    println!("Bytes read: {}", result.bytes_read());
    println!("Query time: {:?}", result.elapsed());

    Ok(())
}

Compilação e testes

Compilar o projeto

cargo build

Executar os testes

cargo test

Dependências de desenvolvimento

O projeto inclui estas dependências de desenvolvimento:
  • bindgen (v0.70.1) - Gera bindings de FFI a partir de arquivos de cabeçalho em C
  • tempdir (v0.3.7) - Manipulação de diretórios temporários em testes
  • thiserror (v1) - Utilitários para tratamento de erros

Tratamento de erros

chDB Rust oferece um tratamento de erros abrangente por meio do enum 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);
    }
}

Repositório no GitHub

Você pode encontrar o repositório do projeto no GitHub em chdb-io/chdb-rust.
Última modificação em 10 de junho de 2026