Skip to main content

WriteBatch

Struct WriteBatch 

Source
pub struct WriteBatch { /* private fields */ }
Expand description

A write batch that buffers page mutations in memory

Use this to amortize fsync costs across multiple operations:

use sqlitegraph::backend::native::v3::write_batch::WriteBatch;
use sqlitegraph::backend::native::v3::index::IndexPage;

let mut batch = WriteBatch::new();
batch.stage_page(IndexPage::new_leaf(1))?;
batch.stage_page(IndexPage::new_leaf(2))?;
batch.stage_page(IndexPage::new_leaf(3))?;
batch.commit(std::path::Path::new("/tmp/db.graph"))?; // Single fsync for all pages

Implementations§

Source§

impl WriteBatch

Source

pub fn new() -> Self

Create a new empty write batch

Source

pub fn stage_page(&mut self, page: IndexPage) -> NativeResult<()>

Stage a page for writing (in-memory only)

The page is added to the batch but not written to disk yet. Multiple writes to the same page_id will overwrite.

§Arguments
  • page - The IndexPage to stage
§Errors

Returns error if batch is already committed

Source

pub fn len(&self) -> usize

Get the number of pages in this batch

Source

pub fn is_empty(&self) -> bool

Check if batch is empty

Source

pub fn is_committed(&self) -> bool

Check if this batch has been committed

Source

pub fn commit(self, db_path: &Path) -> NativeResult<()>

Commit all staged pages to disk in a single operation

This writes all pages and performs exactly ONE fsync. On failure, partial writes may have occurred but pages remain in dirty state (can be retried).

§Arguments
  • db_path - Path to the database file
§Errors

Returns error if:

  • Batch is empty (nothing to commit)
  • Batch already committed
  • I/O error during write

Trait Implementations§

Source§

impl Debug for WriteBatch

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for WriteBatch

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V