Struct Kimberlite 

pub struct Kimberlite { /* private fields */ }

The main Kimberlite database handle.

Provides the top-level API for interacting with the database. Get tenant-scoped access via the tenant() method.

Example

use kimberlite::Kimberlite;

let db = Kimberlite::open("./data")?;
let tenant = db.tenant(TenantId::new(1));

// Use tenant handle for operations
tenant.execute("INSERT INTO users (id, name) VALUES ($1, $2)", &[1.into(), "Alice".into()])?;
let results = tenant.query("SELECT * FROM users WHERE id = $1", &[1.into()])?;

Implementations

impl Kimberlite

pub fn open(data_dir: impl AsRef<Path>) -> Result<Self>

Opens a Kimberlite database at the given path.

If the directory doesn’t exist, it will be created. If the database already exists, it will be opened and state recovered.

pub fn open_with_config(config: KimberliteConfig) -> Result<Self>

Opens a Kimberlite database with custom configuration.

pub fn tenant(&self, id: TenantId) -> TenantHandle

Returns a tenant-scoped handle.

The tenant handle provides operations scoped to a specific tenant ID.

pub fn submit(&self, command: Command) -> Result<()>

Submits a command to the kernel and executes resulting effects.

This is the core write path: command → kernel → effects → I/O.

pub fn log_position(&self) -> Result<Offset>

Returns the current log position.

pub fn projection_position(&self) -> Result<Offset>

Returns the current projection store position.

pub fn sync(&self) -> Result<()>

Syncs all data to disk.

Ensures durability of all written data.

Trait Implementations

impl Clone for Kimberlite

fn clone(&self) -> Kimberlite

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.