serversession-backend-persistent-2.0.3: Storage backend for serversession using persistent and an RDBMS.
Safe HaskellSafe-Inferred
LanguageHaskell2010

Web.ServerSession.Backend.Persistent.Internal.Impl

Description

Internal module exposing the guts of the package. Use at your own risk. No API stability guarantees apply.

Synopsis

Documentation

data PersistentSession sess Source #

Entity corresponding to a Session.

We're bending persistent in ways it wasn't expected to. In particular, this entity is parametrized over the session type.

Constructors

PersistentSession 

Fields

Instances

Instances details
(FromJSON (Decomposed sess), PersistFieldSql (Decomposed sess)) => FromJSON (Entity (PersistentSession sess)) Source # 
Instance details

Defined in Web.ServerSession.Backend.Persistent.Internal.Impl

Methods

parseJSON :: Value -> Parser (Entity (PersistentSession sess)) #

parseJSONList :: Value -> Parser [Entity (PersistentSession sess)] #

omittedField :: Maybe (Entity (PersistentSession sess)) #

FromJSON (Key (PersistentSession sess)) Source # 
Instance details

Defined in Web.ServerSession.Backend.Persistent.Internal.Impl

Methods

parseJSON :: Value -> Parser (Key (PersistentSession sess)) #

parseJSONList :: Value -> Parser [Key (PersistentSession sess)] #

omittedField :: Maybe (Key (PersistentSession sess)) #

FromJSON (Decomposed sess) => FromJSON (PersistentSession sess) Source # 
Instance details

Defined in Web.ServerSession.Backend.Persistent.Internal.Impl

Methods

parseJSON :: Value -> Parser (PersistentSession sess) #

parseJSONList :: Value -> Parser [PersistentSession sess] #

omittedField :: Maybe (PersistentSession sess) #

(ToJSON (Decomposed sess), PersistFieldSql (Decomposed sess)) => ToJSON (Entity (PersistentSession sess)) Source # 
Instance details

Defined in Web.ServerSession.Backend.Persistent.Internal.Impl

Methods

toJSON :: Entity (PersistentSession sess) -> Value #

toEncoding :: Entity (PersistentSession sess) -> Encoding #

toJSONList :: [Entity (PersistentSession sess)] -> Value #

toEncodingList :: [Entity (PersistentSession sess)] -> Encoding #

omitField :: Entity (PersistentSession sess) -> Bool #

ToJSON (Key (PersistentSession sess)) Source # 
Instance details

Defined in Web.ServerSession.Backend.Persistent.Internal.Impl

Methods

toJSON :: Key (PersistentSession sess) -> Value #

toEncoding :: Key (PersistentSession sess) -> Encoding #

toJSONList :: [Key (PersistentSession sess)] -> Value #

toEncodingList :: [Key (PersistentSession sess)] -> Encoding #

omitField :: Key (PersistentSession sess) -> Bool #

ToJSON (Decomposed sess) => ToJSON (PersistentSession sess) Source # 
Instance details

Defined in Web.ServerSession.Backend.Persistent.Internal.Impl

Methods

toJSON :: PersistentSession sess -> Value #

toEncoding :: PersistentSession sess -> Encoding #

toJSONList :: [PersistentSession sess] -> Value #

toEncodingList :: [PersistentSession sess] -> Encoding #

omitField :: PersistentSession sess -> Bool #

Read (Key (PersistentSession sess)) Source # 
Instance details

Defined in Web.ServerSession.Backend.Persistent.Internal.Impl

Methods

readsPrec :: Int -> ReadS (Key (PersistentSession sess)) #

readList :: ReadS [Key (PersistentSession sess)] #

readPrec :: ReadPrec (Key (PersistentSession sess)) #

readListPrec :: ReadPrec [Key (PersistentSession sess)] #

Show (Key (PersistentSession sess)) Source # 
Instance details

Defined in Web.ServerSession.Backend.Persistent.Internal.Impl

Methods

showsPrec :: Int -> Key (PersistentSession sess) -> ShowS #

show :: Key (PersistentSession sess) -> String #

showList :: [Key (PersistentSession sess)] -> ShowS #

Show (Decomposed sess) => Show (PersistentSession sess) Source # 
Instance details

Defined in Web.ServerSession.Backend.Persistent.Internal.Impl

Methods

showsPrec :: Int -> PersistentSession sess -> ShowS #

show :: PersistentSession sess -> String #

showList :: [PersistentSession sess] -> ShowS #

Eq (Key (PersistentSession sess)) Source # 
Instance details

Defined in Web.ServerSession.Backend.Persistent.Internal.Impl

Methods

(==) :: Key (PersistentSession sess) -> Key (PersistentSession sess) -> Bool #

(/=) :: Key (PersistentSession sess) -> Key (PersistentSession sess) -> Bool #

Eq (Decomposed sess) => Eq (PersistentSession sess) Source # 
Instance details

Defined in Web.ServerSession.Backend.Persistent.Internal.Impl

Methods

(==) :: PersistentSession sess -> PersistentSession sess -> Bool #

(/=) :: PersistentSession sess -> PersistentSession sess -> Bool #

Ord (Key (PersistentSession sess)) Source # 
Instance details

Defined in Web.ServerSession.Backend.Persistent.Internal.Impl

Methods

compare :: Key (PersistentSession sess) -> Key (PersistentSession sess) -> Ordering #

(<) :: Key (PersistentSession sess) -> Key (PersistentSession sess) -> Bool #

(<=) :: Key (PersistentSession sess) -> Key (PersistentSession sess) -> Bool #

(>) :: Key (PersistentSession sess) -> Key (PersistentSession sess) -> Bool #

(>=) :: Key (PersistentSession sess) -> Key (PersistentSession sess) -> Bool #

max :: Key (PersistentSession sess) -> Key (PersistentSession sess) -> Key (PersistentSession sess) #

min :: Key (PersistentSession sess) -> Key (PersistentSession sess) -> Key (PersistentSession sess) #

Ord (Decomposed sess) => Ord (PersistentSession sess) Source # 
Instance details

Defined in Web.ServerSession.Backend.Persistent.Internal.Impl

Methods

compare :: PersistentSession sess -> PersistentSession sess -> Ordering #

(<) :: PersistentSession sess -> PersistentSession sess -> Bool #

(<=) :: PersistentSession sess -> PersistentSession sess -> Bool #

(>) :: PersistentSession sess -> PersistentSession sess -> Bool #

(>=) :: PersistentSession sess -> PersistentSession sess -> Bool #

max :: PersistentSession sess -> PersistentSession sess -> PersistentSession sess #

min :: PersistentSession sess -> PersistentSession sess -> PersistentSession sess #

PathPiece (Key (PersistentSession sess)) Source # 
Instance details

Defined in Web.ServerSession.Backend.Persistent.Internal.Impl

Methods

fromPathPiece :: Text -> Maybe (Key (PersistentSession sess)) #

toPathPiece :: Key (PersistentSession sess) -> Text #

PersistFieldSql (Decomposed sess) => PersistEntity (PersistentSession sess) Source # 
Instance details

Defined in Web.ServerSession.Backend.Persistent.Internal.Impl

Associated Types

type PersistEntityBackend (PersistentSession sess) #

data Key (PersistentSession sess) #

data EntityField (PersistentSession sess) :: Type -> Type #

data Unique (PersistentSession sess) #

Methods

keyToValues :: Key (PersistentSession sess) -> [PersistValue] #

keyFromValues :: [PersistValue] -> Either Text (Key (PersistentSession sess)) #

persistIdField :: EntityField (PersistentSession sess) (Key (PersistentSession sess)) #

entityDef :: proxy (PersistentSession sess) -> EntityDef #

persistFieldDef :: EntityField (PersistentSession sess) typ -> FieldDef #

toPersistFields :: PersistentSession sess -> [PersistValue] #

fromPersistValues :: [PersistValue] -> Either Text (PersistentSession sess) #

tabulateEntityA :: Applicative f => (forall a. EntityField (PersistentSession sess) a -> f a) -> f (Entity (PersistentSession sess)) #

persistUniqueKeys :: PersistentSession sess -> [Unique (PersistentSession sess)] #

persistUniqueToFieldNames :: Unique (PersistentSession sess) -> NonEmpty (FieldNameHS, FieldNameDB) #

persistUniqueToValues :: Unique (PersistentSession sess) -> [PersistValue] #

fieldLens :: EntityField (PersistentSession sess) field -> forall (f :: Type -> Type). Functor f => (field -> f field) -> Entity (PersistentSession sess) -> f (Entity (PersistentSession sess)) #

keyFromRecordM :: Maybe (PersistentSession sess -> Key (PersistentSession sess)) #

SafeToInsert (PersistentSession sess) Source # 
Instance details

Defined in Web.ServerSession.Backend.Persistent.Internal.Impl

PersistField (Key (PersistentSession sess)) Source # 
Instance details

Defined in Web.ServerSession.Backend.Persistent.Internal.Impl

Methods

toPersistValue :: Key (PersistentSession sess) -> PersistValue #

fromPersistValue :: PersistValue -> Either Text (Key (PersistentSession sess)) #

PersistFieldSql (Key (PersistentSession sess)) Source # 
Instance details

Defined in Web.ServerSession.Backend.Persistent.Internal.Impl

Methods

sqlType :: Proxy (Key (PersistentSession sess)) -> SqlType #

data EntityField (PersistentSession sess) typ Source # 
Instance details

Defined in Web.ServerSession.Backend.Persistent.Internal.Impl

data EntityField (PersistentSession sess) typ
newtype Key (PersistentSession sess) Source # 
Instance details

Defined in Web.ServerSession.Backend.Persistent.Internal.Impl

newtype Key (PersistentSession sess) = PersistentSessionKey' {}
type PersistEntityBackend (PersistentSession sess) Source # 
Instance details

Defined in Web.ServerSession.Backend.Persistent.Internal.Impl

type PersistEntityBackend (PersistentSession sess) = SqlBackend
data Unique (PersistentSession sess) Source # 
Instance details

Defined in Web.ServerSession.Backend.Persistent.Internal.Impl

data Unique (PersistentSession sess)

type PersistentSessionId sess = Key (PersistentSession sess) Source #

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

Instances details
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

Instance details

Defined in Database.Persist.Class.PersistEntity

Methods

fromLabel :: EntityField rec typ #

data EntityField (PersistentSession sess) typ Source # 
Instance details

Defined in Web.ServerSession.Backend.Persistent.Internal.Impl

data EntityField (PersistentSession sess) typ

serverSessionDefsBySessionMap :: [UnboundEntityDef] Source #

Simple version. Entity definitions needed to generate the SQL schema for SqlStorage. Example:

mkMigrate "migrateAll" serverSessionDefsBySessionMap

Note: Also import PersistentSessionBySessionMap in the same module.

type PersistentSessionBySessionMap = PersistentSession SessionMap Source #

mkServerSessionDefs :: forall sess. PersistEntity sess => Proxy sess -> Text -> [UnboundEntityDef] Source #

Entity definitions needed to generate the SQL schema for SqlStorage. Generate schema by specifying Haskell name in Text.

Example using SessionMap:

type PersistentSessionBySessionMap = PersistentSession SessionMap
mkMigrate "migrateAll" (mkServerSessionDefs (Proxy :: Proxy PersistentSessionBySessionMap) "PersistentSessionBySessionMap")

psKey :: SessionId sess -> Key (PersistentSession sess) Source #

Generate a key to the entity from the session ID.

toPersistentSession :: Session sess -> PersistentSession sess Source #

Convert from Session to PersistentSession.

fromPersistentSession :: PersistentSession sess -> Session sess Source #

Convert from PersistentSession to Session.

newtype SqlStorage sess Source #

SQL session storage backend using persistent.

Constructors

SqlStorage 

Fields

Instances

Instances details
(IsSessionData sess, PersistFieldSql (Decomposed sess)) => Storage (SqlStorage sess) Source # 
Instance details

Defined in Web.ServerSession.Backend.Persistent.Internal.Impl

Associated Types

type SessionData (SqlStorage sess) #

type TransactionM (SqlStorage sess) :: Type -> Type #

Methods

runTransactionM :: SqlStorage sess -> TransactionM (SqlStorage sess) a -> IO a #

getSession :: SqlStorage sess -> SessionId (SessionData (SqlStorage sess)) -> TransactionM (SqlStorage sess) (Maybe (Session (SessionData (SqlStorage sess)))) #

deleteSession :: SqlStorage sess -> SessionId (SessionData (SqlStorage sess)) -> TransactionM (SqlStorage sess) () #

deleteAllSessionsOfAuthId :: SqlStorage sess -> AuthId -> TransactionM (SqlStorage sess) () #

insertSession :: SqlStorage sess -> Session (SessionData (SqlStorage sess)) -> TransactionM (SqlStorage sess) () #

replaceSession :: SqlStorage sess -> Session (SessionData (SqlStorage sess)) -> TransactionM (SqlStorage sess) () #

type SessionData (SqlStorage sess) Source # 
Instance details

Defined in Web.ServerSession.Backend.Persistent.Internal.Impl

type SessionData (SqlStorage sess) = sess
type TransactionM (SqlStorage sess) Source # 
Instance details

Defined in Web.ServerSession.Backend.Persistent.Internal.Impl

type TransactionM (SqlStorage sess) = SqlPersistT IO

throwSS :: Storage (SqlStorage sess) => StorageException (SqlStorage sess) -> TransactionM (SqlStorage sess) a Source #

Specialization of throwIO for SqlStorage.