System.Nix.Store.Remote.Client

Documentation

addToStore

Arguments

:: MonadRemoteStore m

=> StorePathName

Name part of the newly created StorePath

-> NarSource IO

Provide nar stream

-> FileIngestionMethod

Add target directory recursively

-> Some HashAlgo

-> RepairMode

Only used by local store backend

-> m StorePath

Add NarSource to the store

addToStoreNar :: MonadRemoteStore m => StorePath -> Metadata StorePath -> RepairMode -> CheckMode -> (Word64 -> IO (Maybe ByteString)) -> m ()

addTextToStore

Arguments

:: MonadRemoteStore m

=> StoreText

-> HashSet StorePath

Set of StorePaths that the added text references

-> RepairMode

Repair mode, must be RepairMode_DontRepair for remote backend (only valid for local store)

-> m StorePath

Add StoreText to the store Reference accepts repair but only uses it to throw error in case of remote talking to nix-daemon.

addSignatures :: MonadRemoteStore m => StorePath -> Set Signature -> m ()

Add Signatures to a store path

addTempRoot :: MonadRemoteStore m => StorePath -> m ()

Add temporary garbage collector root.

This root is removed as soon as the client exits.

addIndirectRoot :: MonadRemoteStore m => StorePath -> m ()

Add indirect garbage collector root.

buildPaths :: MonadRemoteStore m => Set DerivedPath -> BuildMode -> m ()

Build paths if they are an actual derivations.

If derivation output paths are already valid, do nothing.

buildDerivation :: MonadRemoteStore m => StorePath -> BuildMode -> m BuildResult

Build a derivation available at StorePath

collectGarbage :: MonadRemoteStore m => GCOptions -> m GCResult

ensurePath :: MonadRemoteStore m => StorePath -> m ()

findRoots :: MonadRemoteStore m => m (Map GCRoot StorePath)

Find garbage collector roots.

isValidPath :: MonadRemoteStore m => StorePath -> m Bool

narFromPath

Arguments

:: MonadRemoteStore m

=> StorePath

Path to generate a NAR for

-> Word64

Byte length of NAR

-> (ByteString -> IO ())

Data sink where NAR bytes will be written

-> m ()

Download a NAR file.

queryValidPaths

Arguments

:: MonadRemoteStore m

=> HashSet StorePath

Set of StorePaths to query

-> SubstituteMode

Try substituting missing paths when SubstituteMode_DoSubstitute

-> m (HashSet StorePath)

Query valid paths from a set, optionally try to use substitutes

queryAllValidPaths :: MonadRemoteStore m => m (HashSet StorePath)

Query all valid paths

querySubstitutablePaths :: MonadRemoteStore m => HashSet StorePath -> m (HashSet StorePath)

Query a set of paths substituable from caches

queryPathInfo :: MonadRemoteStore m => StorePath -> m (Maybe (Metadata StorePath))

Query path metadata

queryReferrers :: MonadRemoteStore m => StorePath -> m (HashSet StorePath)

queryValidDerivers :: MonadRemoteStore m => StorePath -> m (HashSet StorePath)

queryDerivationOutputs :: MonadRemoteStore m => StorePath -> m (HashSet StorePath)

queryDerivationOutputNames :: MonadRemoteStore m => StorePath -> m (HashSet StorePathName)

queryPathFromHashPart :: MonadRemoteStore m => StorePathHashPart -> m StorePath

queryMissing :: MonadRemoteStore m => Set DerivedPath -> m Missing

optimiseStore :: MonadRemoteStore m => m ()

syncWithGC :: MonadRemoteStore m => m ()

verifyStore :: MonadRemoteStore m => CheckMode -> RepairMode -> m Bool

module System.Nix.Store.Remote.Client.Core