Struct LaminarDbBuilder 

pub struct LaminarDbBuilder { /* private fields */ }

Fluent builder for constructing a LaminarDB instance.

Example

let db = LaminarDB::builder()
    .config_var("KAFKA_BROKERS", "localhost:9092")
    .buffer_size(131072)
    .build()
    .await?;

Implementations

impl LaminarDbBuilder

pub fn new() -> Self

Create a new builder with default settings.

pub fn ai(self, runtime: Arc<AiRuntime>) -> Self

Install the AI subsystem; required for ai_* SQL functions.

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

Override target_partitions.

pub fn physical_optimizer_rule( self, rule: Arc<dyn PhysicalOptimizerRule + Send + Sync>, ) -> Self

Register an additional PhysicalOptimizerRule on the session state.

pub fn vnode_registry(self, registry: Arc<VnodeRegistry>) -> Self

Install the vnode topology and ownership registry.

pub fn key_groups(self, key_groups: KeyGroupCount) -> Self

Set the stable key-group topology for a local runtime.

When no registry is injected, the local node owns every configured key group.

pub fn cluster_controller(self, controller: Arc<ClusterController>) -> Self

Install the cluster control facade; selects cluster runtime semantics when the profile is inferred. An explicitly selected profile must be Profile::Cluster.

pub fn shuffle_sender(self, sender: Arc<ShuffleSender>) -> Self

Install the outbound shuffle handle; pair with Self::shuffle_receiver.

pub fn shuffle_receiver(self, receiver: Arc<ShuffleReceiver>) -> Self

Install the inbound shuffle handle; pair with Self::shuffle_sender.

pub fn decision_store(self, store: Arc<CheckpointDecisionStore>) -> Self

Install the commit-marker store for cross-instance 2PC.

pub fn assignment_snapshot_store( self, store: Arc<AssignmentSnapshotStore>, ) -> Self

Install the assignment-snapshot store for dynamic rebalance.

pub fn catalog_manifest_store(self, store: Arc<CatalogManifestStore>) -> Self

Install the catalog-manifest store for cluster-wide DDL replay.

pub fn verified_cluster_namespaces( self, namespaces: VerifiedClusterNamespaces, ) -> Self

Install the exact checkpoint handle admitted by the cluster namespace proof.

pub fn config_var(self, key: &str, value: &str) -> Self

Set a config variable for ${VAR} substitution in SQL.

pub fn http_auth_token(self, token: impl Into<String>) -> Self

Set the bearer token presented when forwarding requests to the cluster leader’s HTTP API.

pub fn buffer_size(self, size: usize) -> Self

Set the default buffer size for streaming channels.

pub fn backpressure(self, strategy: BackpressureStrategy) -> Self

Set the default backpressure strategy.

pub fn storage_dir(self, path: impl Into<PathBuf>) -> Self

Set the storage directory for WAL and checkpoints.

pub fn checkpoint(self, config: StreamCheckpointConfig) -> Self

Set checkpoint configuration.

pub fn profile(self, profile: Profile) -> Self

Set the deployment profile.

See Profile for the available tiers. Profile::Cluster also requires a cluster controller at build time.

pub fn object_store_url(self, url: impl Into<String>) -> Self

Set the object-store URL for durable checkpoints.

Required when using Profile::Durable or Profile::Cluster.

pub fn object_store_options(self, opts: HashMap<String, String>) -> Self

Set explicit credential/config overrides for the object store.

Keys are backend-specific (e.g., aws_access_key_id, aws_region). These supplement environment-variable-based credential resolution.

pub fn delivery_guarantee(self, guarantee: DeliveryGuarantee) -> Self

Set the end-to-end delivery guarantee for the pipeline.

pub fn register_udf(self, udf: ScalarUDF) -> Self

Register a custom scalar UDF; available in SQL after build().

pub fn register_udaf(self, udaf: AggregateUDF) -> Self

Register a custom aggregate UDF; available in SQL after build().

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

Per-source Arrow-byte cap for embedded push queues (default 64 MiB). Each source’s snapshot history has an independent cap of the same size. Typed handles are checked after Arrow conversion. Zero and values above laminar_core::streaming::MAX_SOURCE_QUEUED_BYTES are rejected at build time.

pub fn pipeline_channel_capacity(self, capacity: usize) -> Self

Source → coordinator channel capacity (default 64).

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

Shared connector FIFO Arrow-byte budget (default 64 MiB), including parked messages. Also caps each producer’s waiting batch; excludes decoder scratch and downstream buffers. Zero and values above crate::MAX_SOURCE_QUEUE_BYTES are rejected at build time.

pub fn pipeline_batch_window(self, window: Duration) -> Self

Micro-batch coalescing window (default 5ms for connectors, 0 for embedded).

pub fn pipeline_drain_budget_ns(self, ns: u64) -> Self

Max drain time per cycle in nanoseconds (default 1ms).

pub fn pipeline_query_budget_ns(self, ns: u64) -> Self

Per-query execution budget in nanoseconds (default 8ms).

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

Shared per-DB limit for participating DataFusion reservations in bytes (default 256 MiB).

Zero is rejected at build time. DB-owned contexts disable disk spilling. This does not bound direct Arrow allocations, managed state, connector I/O or process RSS.

pub fn reference_table_max_rows(self, rows: usize) -> Self

Set the maximum live row count of each local reference table (default 1,000,000). Zero is rejected at build time. Over-limit updates and snapshots fail atomically.

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

Set each local reference table’s retained-memory charge limit (default 256 MiB). See LaminarConfig::reference_table_max_bytes for the accounting boundary. Zero is rejected at build time.

pub fn materialized_view_max_rows(self, rows: usize) -> Self

Set the live row limit for each local materialized view; must be nonzero. Multisets count distinct rows. Defaults to 1,000,000.

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

Set each local MV’s retained-memory charge limit; must be nonzero. See LaminarConfig::materialized_view_max_bytes for the accounting boundary.

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

Set the byte budget of committed view state decoded for reads and cached by digest (default 256 MiB). Zero disables the cache.

pub fn pipeline_max_input_buf_batches(self, batches: usize) -> Self

Per-port operator input-buffer cap in batches (default 256).

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

Per-port retained Arrow-byte cap, including source priming (disabled by default). Each fan-out port charges shared backing storage independently. An executed result that cannot fit halts the pipeline before publication; it is never rerun in place.

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

Pipeline-wide charged-byte limit for managed operator working state.

This execution-memory envelope is independent of checkpoint storage.

pub fn temporal_join_idle_history_retention(self, retention: Duration) -> Self

Retain temporal right-side history across idle periods for at least this duration.

pub fn source_idle_timeout(self, timeout: Duration) -> Self

Mark inactive watermarked sources and input channels idle after this duration.

pub fn event_time_max_future_skew(self, skew: Duration) -> Self

Event timestamps farther ahead of wall clock do not advance source watermarks. Zero disables the guard.

pub fn pipeline_backpressure_policy(self, policy: BackpressurePolicy) -> Self

Backpressure policy (default Backpressure). ShedOldest is BestEffort only.

pub fn restart_policy(self, policy: RestartPolicy) -> Self

Auto-restart policy used when supervision is enabled.

pub fn register_connector( self, f: impl FnOnce(&ConnectorRegistry) -> Result<(), ConnectorError> + Send + 'static, ) -> Self

Register custom connectors; the callback runs after built-ins are wired and must propagate registration errors. The registry is frozen before Self::build returns.

pub async fn build(self) -> Result<Arc<LaminarDB>, DbError>

Build the LaminarDB instance.

Errors

Returns DbError if database creation fails.

Trait Implementations

impl Debug for LaminarDbBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for LaminarDbBuilder

fn default() -> Self

Returns the “default value” for a type.