Struct StandardEngine

Source

pub struct StandardEngine(/* private fields */);

Implementations§

Source §

impl StandardEngine

Source

pub fn new( multi: TransactionMultiVersion, single: TransactionSingleVersion, cdc: TransactionCdc, event_bus: EventBus, interceptors: Box<dyn InterceptorFactory<StandardCommandTransaction>>, catalog: MaterializedCatalog, ) -> Self

Source

pub fn with_functions( multi: TransactionMultiVersion, single: TransactionSingleVersion, cdc: TransactionCdc, event_bus: EventBus, interceptors: Box<dyn InterceptorFactory<StandardCommandTransaction>>, catalog: MaterializedCatalog, custom_functions: Option<Functions>, ) -> Self

Source

pub fn current_version(&self) -> Result<CommitVersion>

Get the current version from the transaction manager

Source

pub fn try_wait_for_watermark( &self, version: CommitVersion, timeout: Duration, ) -> Result<(), AwaitWatermarkError>

Wait for the watermark to reach the specified version. Returns Ok(()) if the watermark reaches the version within the timeout, or Err(AwaitWatermarkError) if the timeout expires.

This is useful for CDC polling to ensure all in-flight commits have completed their storage writes before querying for CDC events.

Source

pub fn done_until(&self) -> CommitVersion

Returns the highest version where ALL prior versions have completed. This is useful for CDC polling to know the safe upper bound for fetching CDC events - all events up to this version are guaranteed to be in storage.

Source

pub fn watermarks(&self) -> (CommitVersion, CommitVersion)

Returns (query_done_until, command_done_until) for debugging watermark state.

Source

pub fn executor(&self) -> Executor

Source

pub fn register_virtual_table<T: TableVirtualUser + Clone>( &self, namespace: &str, name: &str, table: T, ) -> Result<TableVirtualId>

Register a user-defined virtual table.

The virtual table will be available for queries using the given namespace and name.

§Arguments

namespace - The namespace name (e.g., “default”, “my_namespace”)
name - The table name
table - The virtual table implementation

§Returns

The assigned TableVirtualId on success.

§Example

use reifydb_engine::table_virtual::{TableVirtualUser, TableVirtualUserColumnDef};
use reifydb_type::Type;
use reifydb_core::value::Value;

#[derive(Clone)]
struct MyTable;

impl TableVirtualUser for MyTable {
    fn columns(&self) -> Vec<TableVirtualUserColumnDef> {
        vec![TableVirtualUserColumnDef::new("id", Type::Uint8)]
    }
    fn rows(&self) -> Vec<Vec<Value>> {
        vec![vec![Value::Uint8(1)], vec![Value::Uint8(2)]]
    }
}

let id = engine.register_virtual_table("default", "my_table", MyTable)?;

Source

pub fn unregister_virtual_table( &self, namespace: &str, name: &str, ) -> Result<()>

Unregister a user-defined virtual table.

§Arguments

namespace - The namespace name
name - The table name

Source

pub fn register_virtual_table_iterator<F>( &self, namespace: &str, name: &str, creator: F, ) -> Result<TableVirtualId>
where F: Fn() -> Box<dyn TableVirtualUserIterator> + Send + Sync + 'static,

Register a user-defined virtual table using an iterator-based implementation.

This method is for tables that stream data in batches, which is more efficient for large datasets. The creator function is called once per query to create a fresh iterator instance.