Struct UniBuilder 

pub struct UniBuilder { /* private fields */ }

Builder for configuring and opening a Uni database instance.

Implementations

impl UniBuilder

pub fn new(uri: String) -> Self

Creates a new builder for the given URI.

pub fn schema_file(self, path: impl AsRef<Path>) -> Self

Load schema from JSON file on initialization.

pub fn xervo_catalog(self, catalog: Vec<ModelAliasSpec>) -> Self

Set Uni-Xervo catalog explicitly.

pub fn xervo_catalog_from_str(self, json: &str) -> Result<Self>

Parse Uni-Xervo catalog from JSON string.

pub fn xervo_catalog_from_file(self, path: impl AsRef<Path>) -> Result<Self>

Parse Uni-Xervo catalog from a JSON file.

pub fn hybrid(self, local_path: impl AsRef<Path>, remote_url: &str) -> Self

Configure hybrid storage with a local path for WAL/IDs and a remote URL for data.

This allows fast local writes and metadata operations while storing bulk data in object storage (e.g., S3, GCS, Azure Blob Storage).

Examples

let db = Uni::open("./local_meta")
    .hybrid("./local_meta", "s3://my-bucket/graph-data")
    .build()
    .await?;

pub fn cloud_config(self, config: CloudStorageConfig) -> Self

Configure cloud storage with explicit credentials.

Use this method when you need fine-grained control over cloud storage credentials instead of relying on environment variables.

Examples

use uni_common::CloudStorageConfig;

let config = CloudStorageConfig::S3 {
    bucket: "my-bucket".to_string(),
    region: Some("us-east-1".to_string()),
    endpoint: Some("http://localhost:4566".to_string()), // LocalStack
    access_key_id: Some("test".to_string()),
    secret_access_key: Some("test".to_string()),
    session_token: None,
    virtual_hosted_style: false,
};

let db = Uni::open("./local_meta")
    .hybrid("./local_meta", "s3://my-bucket/data")
    .cloud_config(config)
    .build()
    .await?;

pub fn config(self, config: UniConfig) -> Self

Configure database options using UniConfig.

pub fn cache_size(self, bytes: usize) -> Self

Set maximum adjacency cache size in bytes.

pub fn parallelism(self, n: usize) -> Self

Set query parallelism (number of worker threads).

pub async fn build(self) -> Result<Uni>

Open the database (async).

pub fn build_sync(self) -> Result<Uni>

Open the database (blocking)