API Reference

Rust API Documentation

The complete Rust API documentation is available on docs.rs:

docs.rs

→ View Full API Documentation on docs.rs


Quick Reference

Core Types

Type Description
Database Main database handle
Transaction MVCC transaction
Table Derive macro for schema

Key Methods

// Database operations
Database::open(path) -> Result<Database>
Database::open_in_memory() -> Result<Database>
db.insert(table, key, value) -> Result<()>
db.get(table, key) -> Result<Option<Vec<u8>>>
db.delete(table, key) -> Result<()>

// SQL interface
db.execute_sql(sql) -> Result<SqlResult>

// Transactions
db.begin_transaction() -> Result<Transaction>
tx.commit() -> Result<()>
tx.rollback() -> Result<()>

Feature Flags

Flag Description
simd SIMD-accelerated operations
gpu GPU acceleration via CUDA
logging Enable tracing output

Other Language Bindings


Copyright © 2026 ByteLogicCore. MIT OR Apache-2.0 License.

This site uses Just the Docs, a documentation theme for Jekyll.