Struct BulkWriterBuilder 

pub struct BulkWriterBuilder { /* private fields */ }

Builder for configuring a bulk writer.

Implementations

impl BulkWriterBuilder

pub fn new_unguarded(backend: BulkBackend) -> Self

Create a bulk writer builder.

Used by Transaction::bulk_writer() and AppenderBuilder — the Transaction already holds the session write guard, so the BulkWriter neither acquires nor releases one.

pub fn defer_vector_indexes(self, defer: bool) -> Self

Set whether to defer vector index building until commit.

pub fn defer_scalar_indexes(self, defer: bool) -> Self

Set whether to defer scalar index building until commit.

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

Set the batch size for buffering before flush.

pub fn on_progress<F: Fn(BulkProgress) + Send + 'static>(self, f: F) -> Self

Set a progress callback for monitoring bulk load progress.

pub fn async_indexes(self, async_: bool) -> Self

Build indexes asynchronously after commit.

When enabled, commit() returns immediately after data is written, and indexes are rebuilt in the background. The data is queryable immediately but queries may use full scans until indexes are ready.

Use Uni::index_rebuild_status() to check progress.

Default: false (blocking index rebuild)

pub fn validate_constraints(self, validate: bool) -> Self

Set whether to validate constraints during bulk load.

When enabled (default), BulkWriter validates NOT NULL, UNIQUE, and CHECK constraints before each flush, matching the behavior of regular Writer. Set to false for trusted data sources to improve performance.

Default: true

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

Set the maximum buffer size before triggering a checkpoint flush.

When the in-memory buffer exceeds this size, a checkpoint is triggered to flush data to storage. This allows bulk loading of arbitrarily large datasets while controlling memory usage.

Default: 1 GB (1_073_741_824 bytes)

pub fn build(self) -> Result<BulkWriter>

Build the bulk writer.

Errors

Returns an error if the database is not writable.