License	BSD-3-Clause
Safe Haskell	None
Language	GHC2024

Stack.Storage.Project

Description

Work with the SQLite database used for a project's caches.

Synopsis

initProjectStorage :: HasLogFunc env => Path Abs File -> (ProjectStorage -> RIO env a) -> RIO env a
type ConfigCacheKey = Unique ConfigCacheParent
data ConfigCacheParent = ConfigCacheParent {
- configCacheParentDirectory :: !FilePath
- configCacheParentType :: !ConfigCacheType
- configCacheParentPkgSrc :: !CachePkgSrc
- configCacheParentActive :: !Bool
- configCacheParentPathEnvVar :: !Text
- configCacheParentHaddock :: !Bool
}
type ConfigCacheParentId = Key ConfigCacheParent
configCacheKey :: Path Abs Dir -> ConfigCacheType -> ConfigCacheKey
loadConfigCache :: (HasBuildConfig env, HasLogFunc env) => ConfigCacheKey -> RIO env (Maybe ConfigCache)
saveConfigCache :: (HasBuildConfig env, HasLogFunc env) => ConfigCacheKey -> ConfigCache -> RIO env ()
deactiveConfigCache :: HasBuildConfig env => ConfigCacheKey -> RIO env ()

Documentation

initProjectStorage Source #

Arguments

:: HasLogFunc env
=> Path Abs File	The storage file.
-> (ProjectStorage -> RIO env a)	Action, given a SQL database connection to the project database for caches.
-> RIO env a

Initialize the project database for caches.

type ConfigCacheKey = Unique ConfigCacheParent Source #

Type synonym representing keys used to retrieve a record from the Cabal configuration cache or the library or executable Cabal flag cache.

data ConfigCacheParent Source #

Constructors

ConfigCacheParent
Fields configCacheParentDirectory :: !FilePath configCacheParentType :: !ConfigCacheType configCacheParentPkgSrc :: !CachePkgSrc configCacheParentActive :: !Bool configCacheParentPathEnvVar :: !Text configCacheParentHaddock :: !Bool

Instances

Instances details

Show ConfigCacheParent Source #

Instance details

Defined in Stack.Storage.Project

Methods

showsPrec :: Int -> ConfigCacheParent -> ShowS

show :: ConfigCacheParent -> String #

showList :: [ConfigCacheParent] -> ShowS

PersistEntity ConfigCacheParent Source #

Instance details

Defined in Stack.Storage.Project

Associated Types

type PersistEntityBackend ConfigCacheParent
Instance details Defined in Stack.Storage.Project type PersistEntityBackend ConfigCacheParent = SqlBackend
newtype Key ConfigCacheParent
Instance details Defined in Stack.Storage.Project newtype Key ConfigCacheParent = ConfigCacheParentKey { unConfigCacheParentKey :: BackendKey SqlBackend }
data EntityField ConfigCacheParent typ
Instance details Defined in Stack.Storage.Project data EntityField ConfigCacheParent typ = typ ~ ConfigCacheParentId => ConfigCacheParentId \| typ ~ FilePath => ConfigCacheParentDirectory \| typ ~ ConfigCacheType => ConfigCacheParentType \| typ ~ CachePkgSrc => ConfigCacheParentPkgSrc \| typ ~ Bool => ConfigCacheParentActive \| typ ~ Text => ConfigCacheParentPathEnvVar \| typ ~ Bool => ConfigCacheParentHaddock
data Unique ConfigCacheParent
Instance details Defined in Stack.Storage.Project data Unique ConfigCacheParent = UniqueConfigCacheParent FilePath ConfigCacheType

Methods

keyToValues :: Key ConfigCacheParent -> [PersistValue]

keyFromValues :: [PersistValue] -> Either Text (Key ConfigCacheParent)

persistIdField :: EntityField ConfigCacheParent (Key ConfigCacheParent)

entityDef :: proxy ConfigCacheParent -> EntityDef

persistFieldDef :: EntityField ConfigCacheParent typ -> FieldDef

toPersistFields :: ConfigCacheParent -> [PersistValue]

fromPersistValues :: [PersistValue] -> Either Text ConfigCacheParent

tabulateEntityA :: Applicative f => (forall a. EntityField ConfigCacheParent a -> f a) -> f (Entity ConfigCacheParent)

tabulateEntityApply :: Apply f => (forall a. EntityField ConfigCacheParent a -> f a) -> f (Entity ConfigCacheParent)

persistUniqueKeys :: ConfigCacheParent -> [Unique ConfigCacheParent]

persistUniqueToFieldNames :: Unique ConfigCacheParent -> NonEmpty (FieldNameHS, FieldNameDB)

persistUniqueToValues :: Unique ConfigCacheParent -> [PersistValue]

fieldLens :: EntityField ConfigCacheParent field -> forall (f :: Type -> Type). Functor f => (field -> f field) -> Entity ConfigCacheParent -> f (Entity ConfigCacheParent)

keyFromRecordM :: Maybe (ConfigCacheParent -> Key ConfigCacheParent)

SafeToInsert ConfigCacheParent Source #

Instance details

Defined in Stack.Storage.Project

PersistField ConfigCacheParent Source #

Instance details

Defined in Stack.Storage.Project

Methods

toPersistValue :: ConfigCacheParent -> PersistValue

fromPersistValue :: PersistValue -> Either Text ConfigCacheParent

AtLeastOneUniqueKey ConfigCacheParent Source #

Instance details

Defined in Stack.Storage.Project

Methods

requireUniquesP :: ConfigCacheParent -> NonEmpty (Unique ConfigCacheParent)

OnlyOneUniqueKey ConfigCacheParent Source #

Instance details

Defined in Stack.Storage.Project

Methods

onlyUniqueP :: ConfigCacheParent -> Unique ConfigCacheParent

PersistFieldSql ConfigCacheParent Source #

Instance details

Defined in Stack.Storage.Project

Methods

sqlType :: Proxy ConfigCacheParent -> SqlType

ToBackendKey SqlBackend ConfigCacheParent Source #

Instance details

Defined in Stack.Storage.Project

Methods

toBackendKey :: Key ConfigCacheParent -> BackendKey SqlBackend

fromBackendKey :: BackendKey SqlBackend -> Key ConfigCacheParent

SymbolToField "active" ConfigCacheParent Bool Source #

Instance details

Defined in Stack.Storage.Project

Methods

symbolToField :: EntityField ConfigCacheParent Bool

SymbolToField "directory" ConfigCacheParent FilePath Source #

Instance details

Defined in Stack.Storage.Project

Methods

symbolToField :: EntityField ConfigCacheParent FilePath

SymbolToField "haddock" ConfigCacheParent Bool Source #

Instance details

Defined in Stack.Storage.Project

Methods

symbolToField :: EntityField ConfigCacheParent Bool

SymbolToField "pathEnvVar" ConfigCacheParent Text Source #

Instance details

Defined in Stack.Storage.Project

Methods

symbolToField :: EntityField ConfigCacheParent Text

SymbolToField "pkgSrc" ConfigCacheParent CachePkgSrc Source #

Instance details

Defined in Stack.Storage.Project

Methods

symbolToField :: EntityField ConfigCacheParent CachePkgSrc

SymbolToField "type" ConfigCacheParent ConfigCacheType Source #

Instance details

Defined in Stack.Storage.Project

Methods

symbolToField :: EntityField ConfigCacheParent ConfigCacheType

SymbolToField "id" ConfigCacheParent (Key ConfigCacheParent) Source #

Instance details

Defined in Stack.Storage.Project

Methods

symbolToField :: EntityField ConfigCacheParent (Key ConfigCacheParent)

FromJSON (Key ConfigCacheParent) Source #

Instance details

Defined in Stack.Storage.Project

Methods

parseJSON :: Value -> Parser (Key ConfigCacheParent)

parseJSONList :: Value -> Parser [Key ConfigCacheParent]

omittedField :: Maybe (Key ConfigCacheParent)

ToJSON (Key ConfigCacheParent) Source #

Instance details

Defined in Stack.Storage.Project

Methods

toJSON :: Key ConfigCacheParent -> Value

toEncoding :: Key ConfigCacheParent -> Encoding

toJSONList :: [Key ConfigCacheParent] -> Value

toEncodingList :: [Key ConfigCacheParent] -> Encoding

omitField :: Key ConfigCacheParent -> Bool

Read (Key ConfigCacheParent) Source #

Instance details

Defined in Stack.Storage.Project

Methods

readsPrec :: Int -> ReadS (Key ConfigCacheParent)

readList :: ReadS [Key ConfigCacheParent]

readPrec :: ReadPrec (Key ConfigCacheParent)

readListPrec :: ReadPrec [Key ConfigCacheParent]

Show (Key ConfigCacheParent) Source #

Instance details

Defined in Stack.Storage.Project

Methods

showsPrec :: Int -> Key ConfigCacheParent -> ShowS

show :: Key ConfigCacheParent -> String #

showList :: [Key ConfigCacheParent] -> ShowS

Eq (Key ConfigCacheParent) Source #

Instance details

Defined in Stack.Storage.Project

Methods

(==) :: Key ConfigCacheParent -> Key ConfigCacheParent -> Bool #

(/=) :: Key ConfigCacheParent -> Key ConfigCacheParent -> Bool #

Ord (Key ConfigCacheParent) Source #

Instance details

Defined in Stack.Storage.Project

Methods

compare :: Key ConfigCacheParent -> Key ConfigCacheParent -> Ordering #

(<) :: Key ConfigCacheParent -> Key ConfigCacheParent -> Bool #

(<=) :: Key ConfigCacheParent -> Key ConfigCacheParent -> Bool #

(>) :: Key ConfigCacheParent -> Key ConfigCacheParent -> Bool #

(>=) :: Key ConfigCacheParent -> Key ConfigCacheParent -> Bool #

max :: Key ConfigCacheParent -> Key ConfigCacheParent -> Key ConfigCacheParent #

min :: Key ConfigCacheParent -> Key ConfigCacheParent -> Key ConfigCacheParent #

FromHttpApiData (Key ConfigCacheParent) Source #

Instance details

Defined in Stack.Storage.Project

Methods

parseUrlPiece :: Text -> Either Text (Key ConfigCacheParent)

parseHeader :: ByteString -> Either Text (Key ConfigCacheParent)

parseQueryParam :: Text -> Either Text (Key ConfigCacheParent)

ToHttpApiData (Key ConfigCacheParent) Source #

Instance details

Defined in Stack.Storage.Project

Methods

toUrlPiece :: Key ConfigCacheParent -> Text

toEncodedUrlPiece :: Key ConfigCacheParent -> Builder

toHeader :: Key ConfigCacheParent -> ByteString

toQueryParam :: Key ConfigCacheParent -> Text

toEncodedQueryParam :: Key ConfigCacheParent -> Builder

PathPiece (Key ConfigCacheParent) Source #

Instance details

Defined in Stack.Storage.Project

Methods

fromPathPiece :: Text -> Maybe (Key ConfigCacheParent)

toPathPiece :: Key ConfigCacheParent -> Text

PersistField (Key ConfigCacheParent) Source #

Instance details

Defined in Stack.Storage.Project

Methods

toPersistValue :: Key ConfigCacheParent -> PersistValue

fromPersistValue :: PersistValue -> Either Text (Key ConfigCacheParent)

PersistFieldSql (Key ConfigCacheParent) Source #

Instance details

Defined in Stack.Storage.Project

Methods

sqlType :: Proxy (Key ConfigCacheParent) -> SqlType

data EntityField ConfigCacheParent typ Source #

Instance details

Defined in Stack.Storage.Project

data EntityField ConfigCacheParent typ

= typ ~ ConfigCacheParentId => ConfigCacheParentId
| typ ~ FilePath => ConfigCacheParentDirectory
| typ ~ ConfigCacheType => ConfigCacheParentType
| typ ~ CachePkgSrc => ConfigCacheParentPkgSrc
| typ ~ Bool => ConfigCacheParentActive
| typ ~ Text => ConfigCacheParentPathEnvVar
| typ ~ Bool => ConfigCacheParentHaddock

newtype Key ConfigCacheParent Source #

Instance details

Defined in Stack.Storage.Project

newtype Key ConfigCacheParent = ConfigCacheParentKey {

unConfigCacheParentKey :: BackendKey SqlBackend

}

type PersistEntityBackend ConfigCacheParent Source #

Instance details

Defined in Stack.Storage.Project

type PersistEntityBackend ConfigCacheParent = SqlBackend

data Unique ConfigCacheParent Source #

Instance details

Defined in Stack.Storage.Project

data Unique ConfigCacheParent = UniqueConfigCacheParent FilePath ConfigCacheType

type ConfigCacheParentId = Key ConfigCacheParent Source #

configCacheKey Source #

Arguments

:: Path Abs Dir	Directory.
-> ConfigCacheType	Type of cache.
-> ConfigCacheKey

For the given directory and type of cache, yields the key used to retrieve a record from the Cabal configuration cache or the library or executable Cabal flag cache.

loadConfigCache :: (HasBuildConfig env, HasLogFunc env) => ConfigCacheKey -> RIO env (Maybe ConfigCache) Source #

Load a ConfigCache value from the project database for caches.

saveConfigCache :: (HasBuildConfig env, HasLogFunc env) => ConfigCacheKey -> ConfigCache -> RIO env () Source #

Insert or update a ConfigCache value to the project database for caches.

deactiveConfigCache :: HasBuildConfig env => ConfigCacheKey -> RIO env () Source #

Mark ConfigCache as inactive in the database. We use a flag instead of deleting the records since, in most cases, the same cache will be written again within in a few seconds (after `cabal configure`), so this avoids unnecessary database churn.