Pantry.Internal.Stackage

All types and functions exported from this module are for advanced usage only. They are needed for stackage-server integration with pantry.

Documentation

data family Unique record

Unique keys besides the Key.

Instances

data Unique Tree

Defined in Pantry.Storage

data Unique Tree = UniqueTree BlobId

data Unique Version

Defined in Pantry.Storage

data Unique Version = UniqueVersion VersionP

data Unique PackageName

Defined in Pantry.Storage

data Unique PackageName = UniquePackageName PackageNameP

data family EntityField record :: Type -> Type

An EntityField is parameterised by the Haskell record it belongs to and the additional type of that field.

As of persistent-2.11.0.0, it's possible to use the OverloadedLabels language extension to refer to EntityField values polymorphically. See the documentation on SymbolToField for more information.

Instances

SymbolToField sym rec typ => IsLabel sym (EntityField rec typ)

This instance delegates to SymbolToField to provide OverloadedLabels support to the EntityField type.

Since: persistent-2.11.0.0

Defined in Database.Persist.Class.PersistEntity

Methods

fromLabel :: EntityField rec typ

data EntityField Tree typ

Defined in Pantry.Storage

data EntityField Tree typ

• = typ ~ TreeId => TreeId
• | typ ~ BlobId => TreeKey
• | typ ~ Maybe BlobId => TreeCabal
• | typ ~ FileType => TreeCabalType
• | typ ~ PackageNameId => TreeName
• | typ ~ VersionId => TreeVersion

data EntityField Version typ

Defined in Pantry.Storage

data EntityField Version typ

• = typ ~ VersionId => VersionId
• | typ ~ VersionP => VersionVersion

data EntityField PackageName typ

Defined in Pantry.Storage

data EntityField PackageName typ

• = typ ~ PackageNameId => PackageNameId
• | typ ~ PackageNameP => PackageNameName

data family Key record

By default, a backend will automatically generate the key Instead you can specify a Primary key made up of unique values.

Instances

SymbolToField "key" Tree BlobId

Defined in Pantry.Storage

Methods

symbolToField :: EntityField Tree BlobId

SymbolToField "name" Tree PackageNameId

Defined in Pantry.Storage

Methods

symbolToField :: EntityField Tree PackageNameId

SymbolToField "version" Tree VersionId

Defined in Pantry.Storage

Methods

symbolToField :: EntityField Tree VersionId

SymbolToField "cabal" Tree (Maybe BlobId)

Defined in Pantry.Storage

Methods

symbolToField :: EntityField Tree (Maybe BlobId)

SymbolToField "id" Tree (Key Tree)

Defined in Pantry.Storage

Methods

symbolToField :: EntityField Tree (Key Tree)

SymbolToField "id" Version (Key Version)

Defined in Pantry.Storage

Methods

symbolToField :: EntityField Version (Key Version)

SymbolToField "id" PackageName (Key PackageName)

Defined in Pantry.Storage

Methods

symbolToField :: EntityField PackageName (Key PackageName)

Eq (Key Tree)

Defined in Pantry.Storage

Methods

(==) :: Key Tree -> Key Tree -> Bool

(/=) :: Key Tree -> Key Tree -> Bool

Eq (Key Version)

Defined in Pantry.Storage

Methods

(==) :: Key Version -> Key Version -> Bool

(/=) :: Key Version -> Key Version -> Bool

Eq (Key PackageName)

Defined in Pantry.Storage

Methods

(==) :: Key PackageName -> Key PackageName -> Bool

(/=) :: Key PackageName -> Key PackageName -> Bool

Ord (Key Tree)

Defined in Pantry.Storage

Methods

compare :: Key Tree -> Key Tree -> Ordering

(<) :: Key Tree -> Key Tree -> Bool

(<=) :: Key Tree -> Key Tree -> Bool

(>) :: Key Tree -> Key Tree -> Bool

(>=) :: Key Tree -> Key Tree -> Bool

max :: Key Tree -> Key Tree -> Key Tree

min :: Key Tree -> Key Tree -> Key Tree

Ord (Key Version)

Defined in Pantry.Storage

Methods

compare :: Key Version -> Key Version -> Ordering

(<) :: Key Version -> Key Version -> Bool

(<=) :: Key Version -> Key Version -> Bool

(>) :: Key Version -> Key Version -> Bool

(>=) :: Key Version -> Key Version -> Bool

max :: Key Version -> Key Version -> Key Version

min :: Key Version -> Key Version -> Key Version

Ord (Key PackageName)

Defined in Pantry.Storage

Methods

compare :: Key PackageName -> Key PackageName -> Ordering

(<) :: Key PackageName -> Key PackageName -> Bool

(<=) :: Key PackageName -> Key PackageName -> Bool

(>) :: Key PackageName -> Key PackageName -> Bool

(>=) :: Key PackageName -> Key PackageName -> Bool

max :: Key PackageName -> Key PackageName -> Key PackageName

min :: Key PackageName -> Key PackageName -> Key PackageName

Read (Key Tree)

Defined in Pantry.Storage

Methods

readsPrec :: Int -> ReadS (Key Tree)

readList :: ReadS [Key Tree]

readPrec :: ReadPrec (Key Tree)

readListPrec :: ReadPrec [Key Tree]

Read (Key Version)

Defined in Pantry.Storage

Methods

readsPrec :: Int -> ReadS (Key Version)

readList :: ReadS [Key Version]

readPrec :: ReadPrec (Key Version)

readListPrec :: ReadPrec [Key Version]

Read (Key PackageName)

Defined in Pantry.Storage

Methods

readsPrec :: Int -> ReadS (Key PackageName)

readList :: ReadS [Key PackageName]

readPrec :: ReadPrec (Key PackageName)

readListPrec :: ReadPrec [Key PackageName]

Show (Key Tree)

Defined in Pantry.Storage

Methods

showsPrec :: Int -> Key Tree -> ShowS

show :: Key Tree -> String

showList :: [Key Tree] -> ShowS

Show (Key Version)

Defined in Pantry.Storage

Methods

showsPrec :: Int -> Key Version -> ShowS

show :: Key Version -> String

showList :: [Key Version] -> ShowS

Show (Key PackageName)

Defined in Pantry.Storage

Methods

showsPrec :: Int -> Key PackageName -> ShowS

show :: Key PackageName -> String

showList :: [Key PackageName] -> ShowS

ToJSON (Key Tree)

Defined in Pantry.Storage

Methods

toJSON :: Key Tree -> Value

toEncoding :: Key Tree -> Encoding

toJSONList :: [Key Tree] -> Value

toEncodingList :: [Key Tree] -> Encoding

ToJSON (Key Version)

Defined in Pantry.Storage

Methods

toJSON :: Key Version -> Value

toEncoding :: Key Version -> Encoding

toJSONList :: [Key Version] -> Value

toEncodingList :: [Key Version] -> Encoding

ToJSON (Key PackageName)

Defined in Pantry.Storage

Methods

toJSON :: Key PackageName -> Value

toEncoding :: Key PackageName -> Encoding

toJSONList :: [Key PackageName] -> Value

toEncodingList :: [Key PackageName] -> Encoding

FromJSON (Key Tree)

Defined in Pantry.Storage

Methods

parseJSON :: Value -> Parser (Key Tree)

parseJSONList :: Value -> Parser [Key Tree]

FromJSON (Key Version)

Defined in Pantry.Storage

Methods

parseJSON :: Value -> Parser (Key Version)

parseJSONList :: Value -> Parser [Key Version]

FromJSON (Key PackageName)

Defined in Pantry.Storage

Methods

parseJSON :: Value -> Parser (Key PackageName)

parseJSONList :: Value -> Parser [Key PackageName]

ToHttpApiData (Key Tree)

Defined in Pantry.Storage

Methods

toUrlPiece :: Key Tree -> Text

toEncodedUrlPiece :: Key Tree -> Builder

toHeader :: Key Tree -> ByteString

toQueryParam :: Key Tree -> Text

ToHttpApiData (Key Version)

Defined in Pantry.Storage

Methods

toUrlPiece :: Key Version -> Text

toEncodedUrlPiece :: Key Version -> Builder

toHeader :: Key Version -> ByteString

toQueryParam :: Key Version -> Text

ToHttpApiData (Key PackageName)

Defined in Pantry.Storage

Methods

toUrlPiece :: Key PackageName -> Text

toEncodedUrlPiece :: Key PackageName -> Builder

toHeader :: Key PackageName -> ByteString

toQueryParam :: Key PackageName -> Text

FromHttpApiData (Key Tree)

Defined in Pantry.Storage

Methods

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

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

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

FromHttpApiData (Key Version)

Defined in Pantry.Storage

Methods

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

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

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

FromHttpApiData (Key PackageName)

Defined in Pantry.Storage

Methods

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

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

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

PathPiece (Key Tree)

Defined in Pantry.Storage

Methods

fromPathPiece :: Text -> Maybe (Key Tree)

toPathPiece :: Key Tree -> Text

PathPiece (Key Version)

Defined in Pantry.Storage

Methods

fromPathPiece :: Text -> Maybe (Key Version)

toPathPiece :: Key Version -> Text

PathPiece (Key PackageName)

Defined in Pantry.Storage

Methods

fromPathPiece :: Text -> Maybe (Key PackageName)

toPathPiece :: Key PackageName -> Text

(PersistEntity a, PersistEntityBackend a ~ backend, IsPersistBackend backend) => RawSql (Key a)

Defined in Database.Persist.Sql.Class

Methods

rawSqlCols :: (Text -> Text) -> Key a -> (Int, [Text])

rawSqlColCountReason :: Key a -> String

rawSqlProcessRow :: [PersistValue] -> Either Text (Key a)

PersistFieldSql (Key Tree)

Defined in Pantry.Storage

Methods

sqlType :: Proxy (Key Tree) -> SqlType

PersistFieldSql (Key Version)

Defined in Pantry.Storage

Methods

sqlType :: Proxy (Key Version) -> SqlType

PersistFieldSql (Key PackageName)

Defined in Pantry.Storage

Methods

sqlType :: Proxy (Key PackageName) -> SqlType

PersistField (Key Tree)

Defined in Pantry.Storage

Methods

toPersistValue :: Key Tree -> PersistValue

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

PersistField (Key Version)

Defined in Pantry.Storage

Methods

toPersistValue :: Key Version -> PersistValue

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

PersistField (Key PackageName)

Defined in Pantry.Storage

Methods

toPersistValue :: Key PackageName -> PersistValue

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

newtype Key Tree

Defined in Pantry.Storage

newtype Key Tree = TreeKey' {

• unTreeKey :: BackendKey SqlBackend

}

newtype Key Version

Defined in Pantry.Storage

newtype Key Version = VersionKey {

• unVersionKey :: BackendKey SqlBackend

}

newtype Key PackageName

Defined in Pantry.Storage

newtype Key PackageName = PackageNameKey {

• unPackageNameKey :: BackendKey SqlBackend

}

data SafeFilePath

Instances

Eq SafeFilePath

Defined in Pantry.Types

Methods

(==) :: SafeFilePath -> SafeFilePath -> Bool

(/=) :: SafeFilePath -> SafeFilePath -> Bool

Ord SafeFilePath

Defined in Pantry.Types

Methods

compare :: SafeFilePath -> SafeFilePath -> Ordering

(<) :: SafeFilePath -> SafeFilePath -> Bool

(<=) :: SafeFilePath -> SafeFilePath -> Bool

(>) :: SafeFilePath -> SafeFilePath -> Bool

(>=) :: SafeFilePath -> SafeFilePath -> Bool

max :: SafeFilePath -> SafeFilePath -> SafeFilePath

min :: SafeFilePath -> SafeFilePath -> SafeFilePath

Show SafeFilePath

Defined in Pantry.Types

Methods

showsPrec :: Int -> SafeFilePath -> ShowS

show :: SafeFilePath -> String

showList :: [SafeFilePath] -> ShowS

PersistFieldSql SafeFilePath

Defined in Pantry.Types

Methods

sqlType :: Proxy SafeFilePath -> SqlType

PersistField SafeFilePath

Defined in Pantry.Types

Methods

toPersistValue :: SafeFilePath -> PersistValue

fromPersistValue :: PersistValue -> Either Text SafeFilePath

Display SafeFilePath

Defined in Pantry.Types

Methods

display :: SafeFilePath -> Utf8Builder

textDisplay :: SafeFilePath -> Text

newtype ModuleNameP

Constructors

ModuleNameP

Fields

• unModuleNameP :: ModuleName

Instances

Eq ModuleNameP

Defined in Pantry.Types

Methods

(==) :: ModuleNameP -> ModuleNameP -> Bool

(/=) :: ModuleNameP -> ModuleNameP -> Bool

Ord ModuleNameP

Defined in Pantry.Types

Methods

compare :: ModuleNameP -> ModuleNameP -> Ordering

(<) :: ModuleNameP -> ModuleNameP -> Bool

(<=) :: ModuleNameP -> ModuleNameP -> Bool

(>) :: ModuleNameP -> ModuleNameP -> Bool

(>=) :: ModuleNameP -> ModuleNameP -> Bool

max :: ModuleNameP -> ModuleNameP -> ModuleNameP

min :: ModuleNameP -> ModuleNameP -> ModuleNameP

Show ModuleNameP

Defined in Pantry.Types

Methods

showsPrec :: Int -> ModuleNameP -> ShowS

show :: ModuleNameP -> String

showList :: [ModuleNameP] -> ShowS

NFData ModuleNameP

Defined in Pantry.Types

Methods

rnf :: ModuleNameP -> ()

PersistFieldSql ModuleNameP

Defined in Pantry.Types

Methods

sqlType :: Proxy ModuleNameP -> SqlType

PersistField ModuleNameP

Defined in Pantry.Types

Methods

toPersistValue :: ModuleNameP -> PersistValue

fromPersistValue :: PersistValue -> Either Text ModuleNameP

Display ModuleNameP

Defined in Pantry.Types

Methods

display :: ModuleNameP -> Utf8Builder

textDisplay :: ModuleNameP -> Text

newtype VersionP

Constructors

VersionP

Fields

• unVersionP :: Version

Instances

Eq VersionP

Defined in Pantry.Types

Methods

(==) :: VersionP -> VersionP -> Bool

(/=) :: VersionP -> VersionP -> Bool

Ord VersionP

Defined in Pantry.Types

Methods

compare :: VersionP -> VersionP -> Ordering

(<) :: VersionP -> VersionP -> Bool

(<=) :: VersionP -> VersionP -> Bool

(>) :: VersionP -> VersionP -> Bool

(>=) :: VersionP -> VersionP -> Bool

max :: VersionP -> VersionP -> VersionP

min :: VersionP -> VersionP -> VersionP

Read VersionP

Defined in Pantry.Types

Methods

readsPrec :: Int -> ReadS VersionP

readList :: ReadS [VersionP]

readPrec :: ReadPrec VersionP

readListPrec :: ReadPrec [VersionP]

Show VersionP

Defined in Pantry.Types

Methods

showsPrec :: Int -> VersionP -> ShowS

show :: VersionP -> String

showList :: [VersionP] -> ShowS

NFData VersionP

Defined in Pantry.Types

Methods

rnf :: VersionP -> ()

ToJSON VersionP

Defined in Pantry.Types

Methods

toJSON :: VersionP -> Value

toEncoding :: VersionP -> Encoding

toJSONList :: [VersionP] -> Value

toEncodingList :: [VersionP] -> Encoding

FromJSON VersionP

Defined in Pantry.Types

Methods

parseJSON :: Value -> Parser VersionP

parseJSONList :: Value -> Parser [VersionP]

PersistFieldSql VersionP

Defined in Pantry.Types

Methods

sqlType :: Proxy VersionP -> SqlType

PersistField VersionP

Defined in Pantry.Types

Methods

toPersistValue :: VersionP -> PersistValue

fromPersistValue :: PersistValue -> Either Text VersionP

Display VersionP

Defined in Pantry.Types

Methods

display :: VersionP -> Utf8Builder

textDisplay :: VersionP -> Text

SymbolToField "version" Version VersionP

Defined in Pantry.Storage

Methods

symbolToField :: EntityField Version VersionP

newtype PackageNameP

Constructors

PackageNameP

Fields

• unPackageNameP :: PackageName

Instances

Eq PackageNameP

Defined in Pantry.Types

Methods

(==) :: PackageNameP -> PackageNameP -> Bool

(/=) :: PackageNameP -> PackageNameP -> Bool

Ord PackageNameP

Defined in Pantry.Types

Methods

compare :: PackageNameP -> PackageNameP -> Ordering

(<) :: PackageNameP -> PackageNameP -> Bool

(<=) :: PackageNameP -> PackageNameP -> Bool

(>) :: PackageNameP -> PackageNameP -> Bool

(>=) :: PackageNameP -> PackageNameP -> Bool

max :: PackageNameP -> PackageNameP -> PackageNameP

min :: PackageNameP -> PackageNameP -> PackageNameP

Read PackageNameP

Defined in Pantry.Types

Methods

readsPrec :: Int -> ReadS PackageNameP

readList :: ReadS [PackageNameP]

readPrec :: ReadPrec PackageNameP

readListPrec :: ReadPrec [PackageNameP]

Show PackageNameP

Defined in Pantry.Types

Methods

showsPrec :: Int -> PackageNameP -> ShowS

show :: PackageNameP -> String

showList :: [PackageNameP] -> ShowS

NFData PackageNameP

Defined in Pantry.Types

Methods

rnf :: PackageNameP -> ()

ToJSON PackageNameP

Defined in Pantry.Types

Methods

toJSON :: PackageNameP -> Value

toEncoding :: PackageNameP -> Encoding

toJSONList :: [PackageNameP] -> Value

toEncodingList :: [PackageNameP] -> Encoding

ToJSONKey PackageNameP

Defined in Pantry.Types

Methods

toJSONKey :: ToJSONKeyFunction PackageNameP

toJSONKeyList :: ToJSONKeyFunction [PackageNameP]

FromJSON PackageNameP

Defined in Pantry.Types

Methods

parseJSON :: Value -> Parser PackageNameP

parseJSONList :: Value -> Parser [PackageNameP]

FromJSONKey PackageNameP

Defined in Pantry.Types

Methods

fromJSONKey :: FromJSONKeyFunction PackageNameP

fromJSONKeyList :: FromJSONKeyFunction [PackageNameP]

PersistFieldSql PackageNameP

Defined in Pantry.Types

Methods

sqlType :: Proxy PackageNameP -> SqlType

PersistField PackageNameP

Defined in Pantry.Types

Methods

toPersistValue :: PackageNameP -> PersistValue

fromPersistValue :: PersistValue -> Either Text PackageNameP

Display PackageNameP

Defined in Pantry.Types

Methods

display :: PackageNameP -> Utf8Builder

textDisplay :: PackageNameP -> Text

SymbolToField "name" PackageName PackageNameP

Defined in Pantry.Storage

Methods

symbolToField :: EntityField PackageName PackageNameP

data PantryConfig

Configuration value used by the entire pantry package. Create one using withPantryConfig. See also PantryApp for a convenience approach to using pantry.

Since: 0.1.0.0

Constructors

PantryConfig

Fields

• pcHackageSecurity :: !HackageSecurityConfig
• pcHpackExecutable :: !HpackExecutable
• pcRootDir :: !(Path Abs Dir)
• pcStorage :: !Storage
• pcUpdateRef :: !(MVar Bool)

  Want to try updating the index once during a single run for missing package identifiers. We also want to ensure we only update once at a time. Start at True.

• pcParsedCabalFilesRawImmutable :: !(IORef (Map RawPackageLocationImmutable GenericPackageDescription))

  Cache of previously parsed cabal files, to save on slow parsing time.

• pcParsedCabalFilesMutable :: !(IORef (Map (Path Abs Dir) (PrintWarnings -> IO GenericPackageDescription, PackageName, Path Abs File)))

  Cache for mutable packages. We want to allow for an optimization: deferring parsing of the GenericPackageDescription until its actually needed. Therefore, we keep the filepath and the PackageName derived from that filepath. When the IO GenericPackageDescription is run, it will ensure that the PackageName matches the value inside the cabal file, and print out any warnings that still need to be printed.

• pcConnectionCount :: !Int

  concurrently open downloads

• pcCasaRepoPrefix :: !CasaRepoPrefix

  The pull URL e.g. https://casa.fpcomplete.com/v1/pull

• pcCasaMaxPerRequest :: !Int

  Maximum blobs sent per pull request.

• pcSnapshotLocation :: SnapName -> RawSnapshotLocation

  The location of snapshot synonyms

data Storage

Represents a SQL database connection. This used to be a newtype wrapper around a connection pool. However, when investigating https://github.com/commercialhaskell/stack/issues/4471, it appeared that holding a pool resulted in overly long write locks being held on the database. As a result, we now abstract away whether a pool is used, and the default implementation in Pantry.Storage does not use a pool.

Constructors

Storage

Fields

• withStorage_ :: forall env a. HasLogFunc env => ReaderT SqlBackend (RIO env) a -> RIO env a
• withWriteLock_ :: forall env a. HasLogFunc env => RIO env a -> RIO env a

packageTreeKey :: Package -> TreeKey

The TreeKey containing this package.

This is a hash of the binary representation of packageTree.

Since: 0.1.0.0

unSafeFilePath :: SafeFilePath -> Text

mkSafeFilePath :: Text -> Maybe SafeFilePath

type ModuleNameId = Key ModuleName

type TreeEntryId = Key TreeEntry

type TreeId = Key Tree

data Tree

Constructors

Tree

Fields

• treeKey :: !BlobId
• treeCabal :: !(Maybe BlobId)
• treeCabalType :: !FileType
• treeName :: !PackageNameId
• treeVersion :: !VersionId

Instances

PersistFieldSql Tree

Defined in Pantry.Storage

Methods

sqlType :: Proxy Tree -> SqlType

OnlyOneUniqueKey Tree

Defined in Pantry.Storage

Methods

onlyUniqueP :: Tree -> Unique Tree

AtLeastOneUniqueKey Tree

Defined in Pantry.Storage

Methods

requireUniquesP :: Tree -> NonEmpty (Unique Tree)

PersistEntity Tree

Defined in Pantry.Storage

Associated Types

type PersistEntityBackend Tree

data Key Tree

data EntityField Tree :: Type -> Type

data Unique Tree

Methods

keyToValues :: Key Tree -> [PersistValue]

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

persistIdField :: EntityField Tree (Key Tree)

entityDef :: proxy Tree -> EntityDef

persistFieldDef :: EntityField Tree typ -> FieldDef

toPersistFields :: Tree -> [PersistValue]

fromPersistValues :: [PersistValue] -> Either Text Tree

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

persistUniqueKeys :: Tree -> [Unique Tree]

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

persistUniqueToValues :: Unique Tree -> [PersistValue]

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

keyFromRecordM :: Maybe (Tree -> Key Tree)

SafeToInsert Tree

Defined in Pantry.Storage

PersistField Tree

Defined in Pantry.Storage

Methods

toPersistValue :: Tree -> PersistValue

fromPersistValue :: PersistValue -> Either Text Tree

ToBackendKey SqlBackend Tree

Defined in Pantry.Storage

Methods

toBackendKey :: Key Tree -> BackendKey SqlBackend

fromBackendKey :: BackendKey SqlBackend -> Key Tree

SymbolToField "cabalType" Tree FileType

Defined in Pantry.Storage

Methods

symbolToField :: EntityField Tree FileType

SymbolToField "key" Tree BlobId

Defined in Pantry.Storage

Methods

symbolToField :: EntityField Tree BlobId

SymbolToField "name" Tree PackageNameId

Defined in Pantry.Storage

Methods

symbolToField :: EntityField Tree PackageNameId

SymbolToField "version" Tree VersionId

Defined in Pantry.Storage

Methods

symbolToField :: EntityField Tree VersionId

SymbolToField "cabal" Tree (Maybe BlobId)

Defined in Pantry.Storage

Methods

symbolToField :: EntityField Tree (Maybe BlobId)

SymbolToField "id" Tree (Key Tree)

Defined in Pantry.Storage

Methods

symbolToField :: EntityField Tree (Key Tree)

Eq (Key Tree)

Defined in Pantry.Storage

Methods

(==) :: Key Tree -> Key Tree -> Bool

(/=) :: Key Tree -> Key Tree -> Bool

Ord (Key Tree)

Defined in Pantry.Storage

Methods

compare :: Key Tree -> Key Tree -> Ordering

(<) :: Key Tree -> Key Tree -> Bool

(<=) :: Key Tree -> Key Tree -> Bool

(>) :: Key Tree -> Key Tree -> Bool

(>=) :: Key Tree -> Key Tree -> Bool

max :: Key Tree -> Key Tree -> Key Tree

min :: Key Tree -> Key Tree -> Key Tree

Read (Key Tree)

Defined in Pantry.Storage

Methods

readsPrec :: Int -> ReadS (Key Tree)

readList :: ReadS [Key Tree]

readPrec :: ReadPrec (Key Tree)

readListPrec :: ReadPrec [Key Tree]

Show (Key Tree)

Defined in Pantry.Storage

Methods

showsPrec :: Int -> Key Tree -> ShowS

show :: Key Tree -> String

showList :: [Key Tree] -> ShowS

ToJSON (Key Tree)

Defined in Pantry.Storage

Methods

toJSON :: Key Tree -> Value

toEncoding :: Key Tree -> Encoding

toJSONList :: [Key Tree] -> Value

toEncodingList :: [Key Tree] -> Encoding

FromJSON (Key Tree)

Defined in Pantry.Storage

Methods

parseJSON :: Value -> Parser (Key Tree)

parseJSONList :: Value -> Parser [Key Tree]

ToHttpApiData (Key Tree)

Defined in Pantry.Storage

Methods

toUrlPiece :: Key Tree -> Text

toEncodedUrlPiece :: Key Tree -> Builder

toHeader :: Key Tree -> ByteString

toQueryParam :: Key Tree -> Text

FromHttpApiData (Key Tree)

Defined in Pantry.Storage

Methods

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

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

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

PathPiece (Key Tree)

Defined in Pantry.Storage

Methods

fromPathPiece :: Text -> Maybe (Key Tree)

toPathPiece :: Key Tree -> Text

PersistFieldSql (Key Tree)

Defined in Pantry.Storage

Methods

sqlType :: Proxy (Key Tree) -> SqlType

PersistField (Key Tree)

Defined in Pantry.Storage

Methods

toPersistValue :: Key Tree -> PersistValue

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

data Unique Tree

Defined in Pantry.Storage

data Unique Tree = UniqueTree BlobId

data EntityField Tree typ

Defined in Pantry.Storage

data EntityField Tree typ

• = typ ~ TreeId => TreeId
• | typ ~ BlobId => TreeKey
• | typ ~ Maybe BlobId => TreeCabal
• | typ ~ FileType => TreeCabalType
• | typ ~ PackageNameId => TreeName
• | typ ~ VersionId => TreeVersion

newtype Key Tree

Defined in Pantry.Storage

newtype Key Tree = TreeKey' {

• unTreeKey :: BackendKey SqlBackend

}

type PersistEntityBackend Tree

Defined in Pantry.Storage

type PersistEntityBackend Tree = SqlBackend

type HackageCabalId = Key HackageCabal

type VersionId = Key Version

data Version

Instances

PersistFieldSql Version

Defined in Pantry.Storage

Methods

sqlType :: Proxy Version -> SqlType

OnlyOneUniqueKey Version

Defined in Pantry.Storage

Methods

onlyUniqueP :: Version -> Unique Version

AtLeastOneUniqueKey Version

Defined in Pantry.Storage

Methods

requireUniquesP :: Version -> NonEmpty (Unique Version)

PersistEntity Version

Defined in Pantry.Storage

Associated Types

type PersistEntityBackend Version

data Key Version

data EntityField Version :: Type -> Type

data Unique Version

Methods

keyToValues :: Key Version -> [PersistValue]

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

persistIdField :: EntityField Version (Key Version)

entityDef :: proxy Version -> EntityDef

persistFieldDef :: EntityField Version typ -> FieldDef

toPersistFields :: Version -> [PersistValue]

fromPersistValues :: [PersistValue] -> Either Text Version

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

persistUniqueKeys :: Version -> [Unique Version]

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

persistUniqueToValues :: Unique Version -> [PersistValue]

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

keyFromRecordM :: Maybe (Version -> Key Version)

SafeToInsert Version

Defined in Pantry.Storage

PersistField Version

Defined in Pantry.Storage

Methods

toPersistValue :: Version -> PersistValue

fromPersistValue :: PersistValue -> Either Text Version

ToBackendKey SqlBackend Version

Defined in Pantry.Storage

Methods

toBackendKey :: Key Version -> BackendKey SqlBackend

fromBackendKey :: BackendKey SqlBackend -> Key Version

SymbolToField "version" Tree VersionId

Defined in Pantry.Storage

Methods

symbolToField :: EntityField Tree VersionId

SymbolToField "version" Version VersionP

Defined in Pantry.Storage

Methods

symbolToField :: EntityField Version VersionP

SymbolToField "id" Version (Key Version)

Defined in Pantry.Storage

Methods

symbolToField :: EntityField Version (Key Version)

Eq (Key Version)

Defined in Pantry.Storage

Methods

(==) :: Key Version -> Key Version -> Bool

(/=) :: Key Version -> Key Version -> Bool

Ord (Key Version)

Defined in Pantry.Storage

Methods

compare :: Key Version -> Key Version -> Ordering

(<) :: Key Version -> Key Version -> Bool

(<=) :: Key Version -> Key Version -> Bool

(>) :: Key Version -> Key Version -> Bool

(>=) :: Key Version -> Key Version -> Bool

max :: Key Version -> Key Version -> Key Version

min :: Key Version -> Key Version -> Key Version

Read (Key Version)

Defined in Pantry.Storage

Methods

readsPrec :: Int -> ReadS (Key Version)

readList :: ReadS [Key Version]

readPrec :: ReadPrec (Key Version)

readListPrec :: ReadPrec [Key Version]

Show (Key Version)

Defined in Pantry.Storage

Methods

showsPrec :: Int -> Key Version -> ShowS

show :: Key Version -> String

showList :: [Key Version] -> ShowS

ToJSON (Key Version)

Defined in Pantry.Storage

Methods

toJSON :: Key Version -> Value

toEncoding :: Key Version -> Encoding

toJSONList :: [Key Version] -> Value

toEncodingList :: [Key Version] -> Encoding

FromJSON (Key Version)

Defined in Pantry.Storage

Methods

parseJSON :: Value -> Parser (Key Version)

parseJSONList :: Value -> Parser [Key Version]

ToHttpApiData (Key Version)

Defined in Pantry.Storage

Methods

toUrlPiece :: Key Version -> Text

toEncodedUrlPiece :: Key Version -> Builder

toHeader :: Key Version -> ByteString

toQueryParam :: Key Version -> Text

FromHttpApiData (Key Version)

Defined in Pantry.Storage

Methods

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

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

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

PathPiece (Key Version)

Defined in Pantry.Storage

Methods

fromPathPiece :: Text -> Maybe (Key Version)

toPathPiece :: Key Version -> Text

PersistFieldSql (Key Version)

Defined in Pantry.Storage

Methods

sqlType :: Proxy (Key Version) -> SqlType

PersistField (Key Version)

Defined in Pantry.Storage

Methods

toPersistValue :: Key Version -> PersistValue

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

data Unique Version

Defined in Pantry.Storage

data Unique Version = UniqueVersion VersionP

data EntityField Version typ

Defined in Pantry.Storage

data EntityField Version typ

• = typ ~ VersionId => VersionId
• | typ ~ VersionP => VersionVersion

newtype Key Version

Defined in Pantry.Storage

newtype Key Version = VersionKey {

• unVersionKey :: BackendKey SqlBackend

}

type PersistEntityBackend Version

Defined in Pantry.Storage

type PersistEntityBackend Version = SqlBackend

type PackageNameId = Key PackageName

data PackageName

Instances

PersistFieldSql PackageName

Defined in Pantry.Storage

Methods

sqlType :: Proxy PackageName -> SqlType

OnlyOneUniqueKey PackageName

Defined in Pantry.Storage

Methods

onlyUniqueP :: PackageName -> Unique PackageName

AtLeastOneUniqueKey PackageName

Defined in Pantry.Storage

Methods

requireUniquesP :: PackageName -> NonEmpty (Unique PackageName)

PersistEntity PackageName

Defined in Pantry.Storage

Associated Types

type PersistEntityBackend PackageName

data Key PackageName

data EntityField PackageName :: Type -> Type

data Unique PackageName

Methods

keyToValues :: Key PackageName -> [PersistValue]

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

persistIdField :: EntityField PackageName (Key PackageName)

entityDef :: proxy PackageName -> EntityDef

persistFieldDef :: EntityField PackageName typ -> FieldDef

toPersistFields :: PackageName -> [PersistValue]

fromPersistValues :: [PersistValue] -> Either Text PackageName

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

persistUniqueKeys :: PackageName -> [Unique PackageName]

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

persistUniqueToValues :: Unique PackageName -> [PersistValue]

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

keyFromRecordM :: Maybe (PackageName -> Key PackageName)

SafeToInsert PackageName

Defined in Pantry.Storage

PersistField PackageName

Defined in Pantry.Storage

Methods

toPersistValue :: PackageName -> PersistValue

fromPersistValue :: PersistValue -> Either Text PackageName

ToBackendKey SqlBackend PackageName

Defined in Pantry.Storage

Methods

toBackendKey :: Key PackageName -> BackendKey SqlBackend

fromBackendKey :: BackendKey SqlBackend -> Key PackageName

SymbolToField "name" Tree PackageNameId

Defined in Pantry.Storage

Methods

symbolToField :: EntityField Tree PackageNameId

SymbolToField "name" PackageName PackageNameP

Defined in Pantry.Storage

Methods

symbolToField :: EntityField PackageName PackageNameP

SymbolToField "id" PackageName (Key PackageName)

Defined in Pantry.Storage

Methods

symbolToField :: EntityField PackageName (Key PackageName)

Eq (Key PackageName)

Defined in Pantry.Storage

Methods

(==) :: Key PackageName -> Key PackageName -> Bool

(/=) :: Key PackageName -> Key PackageName -> Bool

Ord (Key PackageName)

Defined in Pantry.Storage

Methods

compare :: Key PackageName -> Key PackageName -> Ordering

(<) :: Key PackageName -> Key PackageName -> Bool

(<=) :: Key PackageName -> Key PackageName -> Bool

(>) :: Key PackageName -> Key PackageName -> Bool

(>=) :: Key PackageName -> Key PackageName -> Bool

max :: Key PackageName -> Key PackageName -> Key PackageName

min :: Key PackageName -> Key PackageName -> Key PackageName

Read (Key PackageName)

Defined in Pantry.Storage

Methods

readsPrec :: Int -> ReadS (Key PackageName)

readList :: ReadS [Key PackageName]

readPrec :: ReadPrec (Key PackageName)

readListPrec :: ReadPrec [Key PackageName]

Show (Key PackageName)

Defined in Pantry.Storage

Methods

showsPrec :: Int -> Key PackageName -> ShowS

show :: Key PackageName -> String

showList :: [Key PackageName] -> ShowS

ToJSON (Key PackageName)

Defined in Pantry.Storage

Methods

toJSON :: Key PackageName -> Value

toEncoding :: Key PackageName -> Encoding

toJSONList :: [Key PackageName] -> Value

toEncodingList :: [Key PackageName] -> Encoding

FromJSON (Key PackageName)

Defined in Pantry.Storage

Methods

parseJSON :: Value -> Parser (Key PackageName)

parseJSONList :: Value -> Parser [Key PackageName]

ToHttpApiData (Key PackageName)

Defined in Pantry.Storage

Methods

toUrlPiece :: Key PackageName -> Text

toEncodedUrlPiece :: Key PackageName -> Builder

toHeader :: Key PackageName -> ByteString

toQueryParam :: Key PackageName -> Text

FromHttpApiData (Key PackageName)

Defined in Pantry.Storage

Methods

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

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

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

PathPiece (Key PackageName)

Defined in Pantry.Storage

Methods

fromPathPiece :: Text -> Maybe (Key PackageName)

toPathPiece :: Key PackageName -> Text

PersistFieldSql (Key PackageName)

Defined in Pantry.Storage

Methods

sqlType :: Proxy (Key PackageName) -> SqlType

PersistField (Key PackageName)

Defined in Pantry.Storage

Methods

toPersistValue :: Key PackageName -> PersistValue

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

data Unique PackageName

Defined in Pantry.Storage

data Unique PackageName = UniquePackageName PackageNameP

data EntityField PackageName typ

Defined in Pantry.Storage

data EntityField PackageName typ

• = typ ~ PackageNameId => PackageNameId
• | typ ~ PackageNameP => PackageNameName

newtype Key PackageName

Defined in Pantry.Storage

newtype Key PackageName = PackageNameKey {

• unPackageNameKey :: BackendKey SqlBackend

}

type PersistEntityBackend PackageName

Defined in Pantry.Storage

type PersistEntityBackend PackageName = SqlBackend

type BlobId = Key Blob

migrateAll :: Migration

getPackageNameById :: PackageNameId -> ReaderT SqlBackend (RIO env) (Maybe PackageName)

getPackageNameId :: PackageName -> ReaderT SqlBackend (RIO env) PackageNameId

getVersionId :: Version -> ReaderT SqlBackend (RIO env) VersionId

storeBlob :: ByteString -> ReaderT SqlBackend (RIO env) (BlobId, BlobKey)

loadBlobById :: BlobId -> ReaderT SqlBackend (RIO env) ByteString

allBlobsSource

Arguments

:: HasResourceMap env

=> Maybe BlobId

For some x, yield blob whose id>x.

-> ConduitT () (BlobId, ByteString) (ReaderT SqlBackend (RIO env)) ()

allHackageCabalRawPackageLocations

Arguments

:: HasResourceMap env

=> Maybe HackageCabalId

For some x, yield cabals whose id>x.

-> ReaderT SqlBackend (RIO env) (Map HackageCabalId RawPackageLocationImmutable)

Pull all hackage cabal entries from the database as RawPackageLocationImmutable. We do a manual join rather than dropping to raw SQL, and Esqueleto would add more deps.

allBlobsCount :: Maybe BlobId -> ReaderT SqlBackend (RIO env) Int

allHackageCabalCount :: Maybe HackageCabalId -> ReaderT SqlBackend (RIO env) Int

getBlobKey :: BlobId -> ReaderT SqlBackend (RIO env) BlobKey

getTreeForKey :: TreeKey -> ReaderT SqlBackend (RIO env) (Maybe (Entity Tree))

data HackageTarballResult

Information returned by getHackageTarball

Since: 0.1.0.0

Constructors

HackageTarballResult

Fields

• htrPackage :: !Package

  Package that was loaded from Hackage tarball

• htrFreshPackageInfo :: !(Maybe (GenericPackageDescription, TreeId))

  This information is only available whenever package was just loaded into pantry.

forceUpdateHackageIndex :: (HasPantryConfig env, HasLogFunc env) => Maybe Utf8Builder -> RIO env DidUpdateOccur

Same as updateHackageIndex, but force the database update even if hackage security tells that there is no change. This can be useful in order to make sure the database is in sync with the locally downloaded tarball

Since: 0.1.0.0

getHackageTarball :: (HasPantryConfig env, HasLogFunc env, HasProcessContext env) => PackageIdentifierRevision -> Maybe TreeKey -> RIO env HackageTarballResult