Struct LocalStore 

pub struct LocalStore { /* private fields */ }

Local Nix store backed by the filesystem and SQLite database.

Implementations

impl LocalStore

pub async fn open(db_path: impl AsRef<Path>) -> StoreResult<Self>

Open the local store in read-only mode using the existing Nix database.

Default path: /nix/var/nix/db/db.sqlite. Accepts any type convertible to a path (&str, &Path, PathBuf, etc.).

pub async fn open_rw(db_path: impl AsRef<Path>) -> StoreResult<Self>

Open the local store in read-write mode.

The database file must already exist. Use this when you need to register paths, add signatures, or perform garbage collection.

pub async fn open_with_dir( db_path: impl AsRef<Path>, store_dir: impl AsRef<Path>, ) -> StoreResult<Self>

Open with a custom store directory (for testing).

pub async fn open_rw_with_dir( db_path: impl AsRef<Path>, store_dir: impl AsRef<Path>, ) -> StoreResult<Self>

Open with a custom store directory in read-write mode (for testing).

pub fn db(&self) -> &DatabaseConnection

Get the database connection for direct queries.

pub fn store_dir(&self) -> &str

Get the store directory path.

pub async fn create_tables(&self) -> StoreResult<()>

Create the Nix store schema tables in the database.

This is used for testing and for initializing a new store database. Creates ValidPaths, Refs, and DerivationOutputs tables.

pub async fn open_in_memory() -> StoreResult<Self>

Open an in-memory SQLite database with schema created.

Useful for testing. Creates all tables and returns a read-write store.

pub async fn open_in_memory_with_dir(store_dir: &str) -> StoreResult<Self>

Open an in-memory SQLite database with schema and a custom store dir.

Trait Implementations

impl Store for LocalStore

fn query_path_info<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 StorePath, ) -> Pin<Box<dyn Future<Output = StoreResult<Option<PathInfo>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Query information about a store path.

fn is_valid_path<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 StorePath, ) -> Pin<Box<dyn Future<Output = StoreResult<bool>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Check whether a store path is valid (registered in the store).

fn query_all_valid_paths<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = StoreResult<Vec<StorePath>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

List all valid store paths.

fn register_path<'life0, 'life1, 'async_trait>( &'life0 self, info: &'life1 PathInfo, ) -> Pin<Box<dyn Future<Output = StoreResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Register a pre-built path in the store database.

fn add_to_store<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, name: &'life1 str, nar_data: &'life2 [u8], references: &'life3 [String], ) -> Pin<Box<dyn Future<Output = StoreResult<PathInfo>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Add a store path with its NAR content. Returns the registered PathInfo.

fn collect_garbage<'life0, 'life1, 'async_trait>( &'life0 self, options: &'life1 GcOptions, ) -> Pin<Box<dyn Future<Output = StoreResult<GcResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Run garbage collection on the store.

fn verify_store<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = StoreResult<VerifyResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Verify store integrity by checking NAR hashes of all valid paths.

fn delete_path<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 StorePath, ) -> Pin<Box<dyn Future<Output = StoreResult<u64>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Delete a store path from disk and the database.

fn optimise_store<'life0, 'async_trait>( &'life0 self, dry_run: bool, ) -> Pin<Box<dyn Future<Output = StoreResult<OptimiseResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Optimise the store by hard-linking identical files.

fn query_references<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 StorePath, ) -> Pin<Box<dyn Future<Output = StoreResult<Vec<StorePath>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Query the runtime references (dependencies) of a store path.

fn compute_closure<'life0, 'life1, 'async_trait>( &'life0 self, roots: &'life1 [StorePath], ) -> Pin<Box<dyn Future<Output = StoreResult<Vec<StorePath>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Compute the transitive closure of a set of store paths.

fn add_signatures<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _path: &'life1 StorePath, _signatures: &'life2 [String], ) -> Pin<Box<dyn Future<Output = StoreResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Add signatures to an existing store path.

fn query_referrers<'life0, 'life1, 'async_trait>( &'life0 self, _path: &'life1 StorePath, ) -> Pin<Box<dyn Future<Output = StoreResult<Vec<StorePath>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Query paths that refer to the given path (reverse dependencies).