Struct Uni 

pub struct Uni { /* private fields */ }

Main entry point for Uni embedded database.

Uni is the lifecycle and admin handle. All data access goes through Session (reads) and Transaction (writes).

Examples

use uni_db::Uni;

#[tokio::main]
async fn main() -> Result<(), uni_db::UniError> {
    let db = Uni::open("./my_db").build().await?;

    // All data access goes through sessions
    let session = db.session();
    let results = session.query("MATCH (n) RETURN count(n)").await?;
    println!("Count: {:?}", results);
    Ok(())
}

Implementations

impl Uni

pub fn schema(&self) -> SchemaBuilder<'_>

pub async fn load_schema(&self, path: impl AsRef<Path>) -> Result<()>

pub async fn save_schema(&self, path: impl AsRef<Path>) -> Result<()>

impl Uni

pub fn xervo(&self) -> UniXervo

Access Uni-Xervo runtime facade configured for this database.

Always succeeds — returns a facade even when no Xervo catalog is configured. Individual methods (embed, generate, etc.) will return an error in that case. Use UniXervo::is_available() to check upfront.

impl Uni

pub fn open(uri: impl Into<String>) -> UniBuilder

Open or create a database at the given path.

If the database does not exist, it will be created.

Arguments

• uri - Local path or object store URI.

Returns

A UniBuilder to configure and build the database instance.

pub fn open_existing(uri: impl Into<String>) -> UniBuilder

Open an existing database at the given path. Fails if it does not exist.

pub fn create(uri: impl Into<String>) -> UniBuilder

Create a new database at the given path. Fails if it already exists.

pub fn temporary() -> UniBuilder

Create a temporary database that is deleted when dropped.

Useful for tests and short-lived processing. Note: Currently uses a temporary directory on the filesystem.

pub fn in_memory() -> UniBuilder

Open an in-memory database (alias for temporary).

pub fn session(&self) -> Session

Create a new Session for data access.

Sessions are cheap, synchronous, and infallible. All reads go through sessions, and sessions are the factory for transactions (writes).

Examples

let session = db.session();
let rows = session.query("MATCH (n) RETURN n LIMIT 10").await?;

pub fn session_template(&self) -> SessionTemplateBuilder

Create a session template builder for pre-configured session factories.

Templates pre-compile Locy rules, bind parameters, and attach hooks once, then cheaply stamp out sessions per-request.

pub fn metrics(&self) -> DatabaseMetrics

Snapshot the database-level metrics.

This is a cheap, synchronous read of cached atomic values. L0 metrics (l0_mutation_count, l0_estimated_size_bytes, wal_lsn) reflect the state as of the last successful commit.

pub fn write_lease(&self) -> Option<&WriteLease>

Returns the write lease configuration, if any. Write lease enforcement is Phase 2.

pub fn rules(&self) -> RuleRegistry<'_>

Access the global rule registry for managing pre-compiled Locy rules.

Rules registered here are cloned into every new Session.

pub fn config(&self) -> &UniConfig

Get configuration.

pub async fn flush(&self) -> Result<()>

Flush all uncommitted changes to persistent storage (L1).

This forces a write of the current in-memory buffer (L0) to columnar files. It also creates a new snapshot.

pub async fn create_snapshot(&self, name: &str) -> Result<String>

Create a named point-in-time snapshot of the database.

Flushes current changes, records the state, and persists the snapshot under the given name so it can be retrieved later. Returns the snapshot ID.

pub async fn list_snapshots(&self) -> Result<Vec<SnapshotManifest>>

List all available snapshots.

pub async fn restore_snapshot(&self, snapshot_id: &str) -> Result<()>

Restore the database to a specific snapshot.

Note: This currently requires a restart or re-opening of Uni to fully take effect as it only updates the latest pointer.

pub async fn label_exists(&self, name: &str) -> Result<bool>

Check if a label exists in the schema.

pub async fn edge_type_exists(&self, name: &str) -> Result<bool>

Check if an edge type exists in the schema.

pub async fn list_labels(&self) -> Result<Vec<String>>

Get all label names. Returns the union of schema-registered labels (Active state) and labels discovered from data (for schemaless mode where labels may not be in the schema). This is consistent with list_edge_types() for schema labels while also supporting schemaless workflows.

pub async fn list_edge_types(&self) -> Result<Vec<String>>

Get all edge type names.

pub async fn get_label_info(&self, name: &str) -> Result<Option<LabelInfo>>

Get detailed information about a label.

pub async fn get_edge_type_info( &self, name: &str, ) -> Result<Option<EdgeTypeInfo>>

Get detailed information about an edge type.

pub fn compaction(&self) -> Compaction<'_>

Access compaction operations.

pub fn indexes(&self) -> Indexes<'_>

Access index management operations.

pub fn functions(&self) -> Functions<'_>

Access custom Cypher function management.

pub async fn shutdown(self) -> Result<()>

Shutdown the database gracefully, flushing pending data and stopping background tasks.

This method flushes any pending data and waits for all background tasks to complete (with a timeout). After calling this method, the database instance should not be used.

Trait Implementations

impl Drop for Uni

fn drop(&mut self)

Executes the destructor for this type.