Skip to main content

SqliteReplicator

Struct SqliteReplicator 

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

SQLite WAL-based replicator to S3

Monitors a SQLite database’s WAL file and replicates changes to S3 for persistence and disaster recovery.

Implementations§

Source§

impl SqliteReplicator

Source

pub async fn new( config: SqliteReplicatorConfig, s3_config: &LayerStorageConfig, ) -> Result<Self>

Create a new SQLite replicator

§Arguments
  • config - Replicator configuration
  • s3_config - S3/Layer storage configuration for credentials and endpoint
§Errors

Returns an error if the cache directory cannot be created or if S3 client initialization fails.

Source

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

Start the replicator background tasks

This spawns background tasks for:

  • WAL file monitoring and change detection
  • Cache upload worker (handles retries)
  • Periodic snapshot creation
§Errors

Returns an error if the WAL monitor cannot be started (e.g., database file doesn’t exist).

Source

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

Force flush all pending changes to S3

Call this before shutdown to ensure all changes are persisted. This will:

  1. Create a final snapshot
  2. Upload all pending cache entries
  3. Wait for uploads to complete
§Errors

Returns an error if the final snapshot or upload fails.

Source

pub async fn restore(&self) -> Result<bool>

Restore database from S3

Downloads the latest snapshot and any subsequent WAL segments from S3, then applies them to reconstruct the database.

§Returns
  • Ok(true) if a backup was found and restored
  • Ok(false) if no backup was found in S3
  • Err(_) if restore failed
§Errors

Returns an error if downloading the snapshot or WAL segments fails, or if applying them to reconstruct the database fails.

Source

pub fn status(&self) -> ReplicationStatus

Get current replication status

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
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<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more