Struct SqliteStore 

pub struct SqliteStore { /* private fields */ }

SQLite-backed storage backend for Prolly Trees.

This store persists content-addressed nodes in a single SQLite table and supports atomic batch operations through transactions.

Implementations

impl SqliteStore

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self, SqliteStoreError>

Open or create a SQLite database at the given path with default config.

pub fn open_with_config<P: AsRef<Path>>( path: P, config: SqliteStoreConfig, ) -> Result<Self, SqliteStoreError>

Open or create a SQLite database with custom configuration.

pub fn open_existing<P: AsRef<Path>>(path: P) -> Result<Self, SqliteStoreError>

Open an existing SQLite database with default runtime configuration.

Unlike Self::open, this never creates the database file and does not execute schema DDL. Callers must validate the required schema before using this path.

pub fn open_existing_with_config<P: AsRef<Path>>( path: P, config: SqliteStoreConfig, ) -> Result<Self, SqliteStoreError>

Open an existing database with explicit runtime configuration.

pub fn open_existing_verified<P, F>( path: P, verifier: F, ) -> Result<Self, SqliteStoreError>

where P: AsRef<Path>, F: FnOnce(SqliteMainFileIdentity) -> Result<(), SqliteStoreError>,

Open an existing database and verify SQLite’s actual main-file handle before executing any pragma, schema statement, or other SQL.

pub fn open_existing_verified_with_config<P, F>( path: P, config: SqliteStoreConfig, verifier: F, ) -> Result<Self, SqliteStoreError>

where P: AsRef<Path>, F: FnOnce(SqliteMainFileIdentity) -> Result<(), SqliteStoreError>,

Open and verify an existing database with explicit runtime tuning.

pub fn open_in_memory() -> Result<Self, SqliteStoreError>

Create an in-memory SQLite store.

pub fn reader_connection_count(&self) -> usize

Number of read-only connections available for concurrent reads.

pub fn metrics(&self) -> Result<SqliteStoreMetrics, SqliteStoreError>

Return adapter and SQLite pager counters without resetting them.

pub fn checkpoint( &self, mode: SqliteCheckpointMode, ) -> Result<SqliteCheckpointStats, SqliteStoreError>

Run an explicit WAL checkpoint and return SQLite’s frame counters.

pub fn storage_stats(&self) -> Result<SqliteStorageStats, SqliteStoreError>

Return database size, freelist, and WAL allocation statistics.

pub fn backup_to<P: AsRef<Path>>(&self, path: P) -> Result<(), SqliteStoreError>

Create a consistent online backup using SQLite’s backup API.

pub fn compact(&self) -> Result<(), SqliteStoreError>

Rebuild the database to reclaim free pages and reduce fragmentation. Callers should quiesce application traffic before invoking this method.

pub fn optimize(&self) -> Result<(), SqliteStoreError>

Ask SQLite to perform bounded planner and connection maintenance.

pub fn quick_check(&self) -> Result<(), SqliteStoreError>

Run SQLite’s fast structural consistency check.

Trait Implementations

impl ManifestStore for SqliteStore

type Error = SqliteStoreError

Error type for manifest operations.

fn get_root(&self, name: &[u8]) -> Result<Option<RootManifest>, Self::Error>

Load a named root manifest.

fn put_root( &self, name: &[u8], manifest: &RootManifest, ) -> Result<(), Self::Error>

Unconditionally insert or replace a named root manifest.

fn delete_root(&self, name: &[u8]) -> Result<(), Self::Error>

Delete a named root manifest. Deleting a missing name is not an error.

fn compare_and_swap_root( &self, name: &[u8], expected: Option<&RootManifest>, new: Option<&RootManifest>, ) -> Result<ManifestUpdate, Self::Error>

Atomically update a named root if the current manifest matches expected.

impl ManifestStoreScan for SqliteStore

fn list_roots(&self) -> Result<Vec<NamedRootManifest>, Self::Error>

List all durable named root manifests.

impl NodeStoreScan for SqliteStore

type Error = SqliteStoreError

Error type for scan operations.

fn list_node_cids(&self) -> Result<Vec<Cid>, Self::Error>

List all content-addressed node CIDs currently known to the store.

impl Store for SqliteStore

type Error = SqliteStoreError

Error type for storage operations

fn get(&self, key: &[u8]) -> Result<Option<Vec<u8>>, Self::Error>

Get value by key

fn get_shared(&self, key: &[u8]) -> Result<Option<Arc<[u8]>>, Self::Error>

Get immutable shared bytes without requiring the engine to copy an already-retained cache value. Stores that cannot retain values may use the default owned-read adapter.

fn has_native_shared_reads(&self) -> bool

Whether shared reads return an already-retained immutable allocation.

fn put(&self, key: &[u8], value: &[u8]) -> Result<(), Self::Error>

Store key-value pair

fn delete(&self, key: &[u8]) -> Result<(), Self::Error>

Delete key

fn batch(&self, ops: &[BatchOp<'_>]) -> Result<(), Self::Error>

Batch write operations (atomic if supported by backend)

fn batch_get( &self, keys: &[&[u8]], ) -> Result<HashMap<Vec<u8>, Vec<u8>>, Self::Error>

Retrieve multiple keys in a single operation

fn batch_get_ordered( &self, keys: &[&[u8]], ) -> Result<Vec<Option<Vec<u8>>>, Self::Error>

Retrieve multiple keys in a single operation with order preservation

fn batch_get_ordered_unique( &self, keys: &[&[u8]], ) -> Result<Vec<Option<Vec<u8>>>, Self::Error>

Retrieve unique keys in input order.

fn batch_get_shared_ordered_unique( &self, keys: &[&[u8]], ) -> Result<Vec<Option<Arc<[u8]>>>, Self::Error>

Retrieve unique keys in order as retained immutable byte buffers.

fn prefers_batch_reads(&self) -> bool

Whether this store has an efficient batched-read implementation.

fn batch_put(&self, entries: &[(&[u8], &[u8])]) -> Result<(), Self::Error>

Store multiple key-value pairs in a single operation

fn supports_hints(&self) -> bool

Whether this store persists performance hints.

fn get_hint( &self, namespace: &[u8], key: &[u8], ) -> Result<Option<Vec<u8>>, Self::Error>

Retrieve an optional performance hint for a logical namespace and key.

fn put_hint( &self, namespace: &[u8], key: &[u8], value: &[u8], ) -> Result<(), Self::Error>

Persist an optional performance hint for a logical namespace and key.

fn batch_put_with_hint( &self, entries: &[(&[u8], &[u8])], namespace: &[u8], key: &[u8], value: &[u8], ) -> Result<(), Self::Error>

Store content-addressed nodes and one hint atomically when supported.

fn publish_nodes( &self, publication: NodePublication<'_>, ) -> Result<(), Self::Error>

Publish canonical immutable nodes with advisory logical context.

fn prefers_rightmost_path_hints(&self) -> bool

Whether append-heavy writes should maintain the engine’s rightmost-path hint.

impl TransactionalStore for SqliteStore

fn supports_transactions(&self) -> bool

Whether this backend can atomically commit staged nodes and roots.

fn commit_transaction( &self, node_writes: &[TransactionNodeWrite], root_conditions: &[RootCondition], root_writes: &[RootWrite], ) -> Result<TransactionUpdate, Error>

Atomically validate root conditions, write nodes, and apply root writes.