Struct SqliteReplicatorConfig 

pub struct SqliteReplicatorConfig {
    pub db_path: PathBuf,
    pub s3_bucket: String,
    pub s3_prefix: String,
    pub cache_dir: PathBuf,
    pub max_cache_size: u64,
    pub auto_restore: bool,
    pub snapshot_interval_secs: u64,
}

Configuration for SQLite WAL-based replication to S3

This configuration controls how the SQLite replicator monitors database changes and syncs them to S3 for persistence and disaster recovery.

Example

use zlayer_storage::config::SqliteReplicatorConfig;
use std::path::PathBuf;

let config = SqliteReplicatorConfig {
    db_path: PathBuf::from("/var/lib/myapp/data.db"),
    s3_bucket: "my-bucket".to_string(),
    s3_prefix: "sqlite-backups/myapp/".to_string(),
    cache_dir: PathBuf::from("/tmp/zlayer-replicator/cache"),
    max_cache_size: 100 * 1024 * 1024, // 100MB
    auto_restore: true,
    snapshot_interval_secs: 3600,
};

Fields

db_path: PathBuf

Path to the SQLite database file to replicate

s3_bucket: String

S3 bucket for storing backups

s3_prefix: String

S3 key prefix for this database’s backups

The replicator will create the following structure under this prefix:

• {prefix}/snapshots/ - Full database snapshots
• {prefix}/wal/ - WAL segments
• {prefix}/metadata.json - Replication metadata

cache_dir: PathBuf

Local directory for caching WAL segments before upload

This provides network tolerance - if S3 is temporarily unavailable, WAL segments are cached here and uploaded when connectivity returns.

max_cache_size: u64

Maximum size of the local cache in bytes

When the cache exceeds this size, the oldest entries will be evicted (and lost if not yet uploaded). Default: 100MB

auto_restore: bool

Whether to automatically restore from S3 on startup if local DB is missing

When enabled, the replicator will download and restore the database from S3 if the local file doesn’t exist. Default: true

snapshot_interval_secs: u64

Interval between full database snapshots in seconds

Snapshots provide a restore point and allow cleanup of old WAL segments. Default: 3600 (1 hour)

Implementations

impl SqliteReplicatorConfig

pub fn new( db_path: impl Into<PathBuf>, s3_bucket: impl Into<String>, s3_prefix: impl Into<String>, ) -> Self

Create a new config with the required fields

pub fn with_cache_dir(self, cache_dir: impl Into<PathBuf>) -> Self

Set the cache directory

pub fn with_max_cache_size(self, size: u64) -> Self

Set the maximum cache size

pub fn with_auto_restore(self, auto_restore: bool) -> Self

Set whether to auto-restore on startup

pub fn with_snapshot_interval(self, interval_secs: u64) -> Self

Set the snapshot interval

Trait Implementations

impl Clone for SqliteReplicatorConfig

fn clone(&self) -> SqliteReplicatorConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SqliteReplicatorConfig

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

Formats the value using the given formatter.

impl Default for SqliteReplicatorConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SqliteReplicatorConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SqliteReplicatorConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.