Struct VbrEngine 

pub struct VbrEngine { /* private fields */ }

Main VBR engine

Implementations

impl VbrEngine

pub async fn new(config: VbrConfig) -> Result<Self>

Create a new VBR engine with the given configuration

pub fn config(&self) -> &VbrConfig

Get the configuration

pub fn database_arc(&self) -> Arc<dyn VirtualDatabase + Send + Sync>

Get the virtual database as Arc for sharing

pub fn database(&self) -> &dyn VirtualDatabase

Get a reference to the virtual database

pub fn registry(&self) -> &EntityRegistry

Get the entity registry

pub fn registry_mut(&mut self) -> &mut EntityRegistry

Get mutable access to the entity registry

pub async fn from_openapi( config: VbrConfig, openapi_content: &str, ) -> Result<(Self, OpenApiConversionResult)>

Create VBR engine from an OpenAPI specification

This method automatically:

• Parses the OpenAPI 3.x specification
• Extracts entity schemas from components/schemas
• Auto-detects primary keys and foreign keys
• Registers all entities in the engine
• Creates database tables for all entities

Arguments

• config - VBR configuration
• openapi_content - OpenAPI specification content (JSON or YAML)

Returns

VBR engine with entities registered and database initialized

pub async fn from_openapi_file<P: AsRef<Path>>( config: VbrConfig, file_path: P, ) -> Result<(Self, OpenApiConversionResult)>

Load VBR engine from an OpenAPI file

Arguments

• config - VBR configuration
• file_path - Path to OpenAPI specification file (JSON or YAML)

Returns

VBR engine with entities registered and database initialized

pub async fn seed_entity( &self, entity_name: &str, records: &[HashMap<String, Value>], ) -> Result<usize>

Seed entity with data

Arguments

• entity_name - Name of the entity to seed
• records - Records to insert

pub async fn seed_all( &self, seed_data: &SeedData, ) -> Result<HashMap<String, usize>>

Seed all entities with data (respects dependencies)

Arguments

• seed_data - Seed data organized by entity name

pub async fn seed_from_file<P: AsRef<Path>>( &self, file_path: P, ) -> Result<HashMap<String, usize>>

Load and seed from a file

Arguments

• file_path - Path to seed file (JSON or YAML)

pub async fn clear_entity(&self, entity_name: &str) -> Result<()>

Clear all data from an entity

Arguments

• entity_name - Name of the entity to clear

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

Clear all data from all entities

pub async fn create_snapshot<P: AsRef<Path>>( &self, name: &str, description: Option<String>, snapshots_dir: P, ) -> Result<SnapshotMetadata>

Create a snapshot of the current database state

Arguments

• name - Name for the snapshot
• description - Optional description
• snapshots_dir - Directory to store snapshots

pub async fn create_snapshot_with_time_travel<P: AsRef<Path>>( &self, name: &str, description: Option<String>, snapshots_dir: P, include_time_travel: bool, time_travel_state: Option<TimeTravelSnapshotState>, ) -> Result<SnapshotMetadata>

Create a snapshot with time travel state

Arguments

• name - Name for the snapshot
• description - Optional description
• snapshots_dir - Directory to store snapshots
• include_time_travel - Whether to include time travel state
• time_travel_state - Optional time travel state to include

pub async fn restore_snapshot<P: AsRef<Path>>( &self, name: &str, snapshots_dir: P, ) -> Result<()>

Restore a snapshot

Arguments

• name - Name of the snapshot to restore
• snapshots_dir - Directory where snapshots are stored

pub async fn restore_snapshot_with_time_travel<P, F>( &self, name: &str, snapshots_dir: P, restore_time_travel: bool, time_travel_restore_callback: Option<F>, ) -> Result<()>

where P: AsRef<Path>, F: FnOnce(TimeTravelSnapshotState) -> Result<()>,

Restore a snapshot with time travel state

Arguments

• name - Name of the snapshot to restore
• snapshots_dir - Directory where snapshots are stored
• restore_time_travel - Whether to restore time travel state
• time_travel_restore_callback - Optional callback to restore time travel state

pub async fn list_snapshots<P: AsRef<Path>>( snapshots_dir: P, ) -> Result<Vec<SnapshotMetadata>>

List all snapshots

Arguments

• snapshots_dir - Directory where snapshots are stored

pub async fn delete_snapshot<P: AsRef<Path>>( name: &str, snapshots_dir: P, ) -> Result<()>

Delete a snapshot

Arguments

• name - Name of the snapshot to delete
• snapshots_dir - Directory where snapshots are stored

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

Reset database to empty state