Skip to content

Rust FFI example binding for chDB, an embedded SQL Engine powered by ClickHouse

License

Notifications You must be signed in to change notification settings

chdb-io/chdb-rust

Repository files navigation

Rust

chdb-rust

Experimental chDB FFI bindings for Rust

Status

  • Experimental, unstable, subject to changes
  • Automatically downloads and manages libchdb dependencies during build

Usage

The library automatically downloads the required libchdb binary during the build process.

Supported platforms:

  • Linux x86_64
  • Linux aarch64
  • macOS x86_64
  • macOS arm64 (Apple Silicon)

Manual Installation (Optional)

If you prefer to install libchdb manually, you can:

Install it system-wide:

./update_libchdb.sh --global

Or use it in a local directory:

./update_libchdb.sh --local

Build

RUST_BACKTRACE=full cargo build --verbose

Run tests

cargo test

Examples

  • Runnable examples: See the examples/ directory. Run them with cargo run --example <name>
  • Documentation: See docs/examples.md for detailed examples and explanations
  • Tests: See tests/ directory for test examples

About

Rust FFI example binding for chDB, an embedded SQL Engine powered by ClickHouse

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Contributors 9