Database.Seakale.Store.Internal

Documentation

data Entity a

A value together with its identifier.

Constructors

Entity

Fields

• entityID :: EntityID a
• entityVal :: a

Instances

(ToRow backend k (EntityID a), ToRow backend l a, (~) Nat ((:+) k l) i) => ToRow backend i (Entity a)

Methods

toRow :: backend -> Entity a -> QueryData i

(FromRow backend k (EntityID a), FromRow backend l a, (~) Nat ((:+) k l) i) => FromRow backend i (Entity a)

Methods

fromRow :: RowParser backend i (Entity a)

(Eq (EntityID a), Eq a) => Eq (Entity a)

Methods

(==) :: Entity a -> Entity a -> Bool

(/=) :: Entity a -> Entity a -> Bool

(Show (EntityID a), Show a) => Show (Entity a)

Methods

showsPrec :: Int -> Entity a -> ShowS

show :: Entity a -> String

showList :: [Entity a] -> ShowS

data Relation backend k l a

Constructors

Relation

Fields

• relationName :: RelationName
• relationIDColumns :: Vector k Column
• relationColumns :: Vector l Column

eqRelation :: Relation backend k l a -> Relation backend k l a -> Bool

newtype RelationName

Constructors

RelationName

Fields

• unRelationName :: ByteString -> ByteString

Instances

Eq RelationName

Methods

(==) :: RelationName -> RelationName -> Bool

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

IsString RelationName

Methods

fromString :: String -> RelationName

newtype Column

Constructors

Column

Fields

• unColumn :: ByteString -> ByteString

Instances

Eq Column

Methods

(==) :: Column -> Column -> Bool

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

Show Column

Methods

showsPrec :: Int -> Column -> ShowS

show :: Column -> String

showList :: [Column] -> ShowS

IsString Column

Methods

fromString :: String -> Column

class (Typeable backend, Typeable k, Typeable l, Typeable a) => Storable backend k l a | a -> k, a -> l where

Minimal complete definition

relation

Associated Types

data EntityID a :: *

Methods

relation :: backend -> Relation backend k l a

Instances

(Storable backend k l a, Storable backend i j b, (~) Nat ((:+) k i) g, (~) Nat ((:+) l j) h, Typeable Nat g, Typeable Nat h) => Storable backend g h (FullJoin a b)

Associated Types

data EntityID (FullJoin a b) :: *

Methods

relation :: backend -> Relation backend g h (FullJoin a b)

(Storable backend k l a, Storable backend i j b, (~) Nat ((:+) k i) g, (~) Nat ((:+) l j) h, Typeable Nat g, Typeable Nat h) => Storable backend g h (InnerJoin a b)

Associated Types

data EntityID (InnerJoin a b) :: *

Methods

relation :: backend -> Relation backend g h (InnerJoin a b)

(Storable backend k l a, Storable backend i j b, (~) Nat ((:+) k i) g, (~) Nat ((:+) l j) h, Typeable Nat g, Typeable Nat h) => Storable backend g h (RightJoin a b)

Associated Types

data EntityID (RightJoin a b) :: *

Methods

relation :: backend -> Relation backend g h (RightJoin a b)

(Storable backend k l a, Storable backend i j b, (~) Nat ((:+) k i) g, (~) Nat ((:+) l j) h, Typeable Nat g, Typeable Nat h) => Storable backend g h (LeftJoin a b)

Associated Types

data EntityID (LeftJoin a b) :: *

Methods

relation :: backend -> Relation backend g h (LeftJoin a b)

data Condition backend a

Constructors

Condition (ByteString -> backend -> (Query n, QueryData n))

Instances

Monoid (Condition backend a)

Methods

mempty :: Condition backend a

mappend :: Condition backend a -> Condition backend a -> Condition backend a

mconcat :: [Condition backend a] -> Condition backend a

eqCondition :: backend -> Condition backend a -> Condition backend a -> Bool

combineConditions :: ByteString -> Condition backend a -> Condition backend a -> Condition backend a

buildCondition :: ByteString -> ByteString -> (backend -> Vector n Column) -> (backend -> QueryData n) -> Condition backend a

buildCondition' :: ByteString -> (backend -> Vector n Column) -> (backend -> Vector n Column) -> Condition backend a

data Order

Constructors

Asc

Desc

Instances

Eq Order

Methods

(==) :: Order -> Order -> Bool

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

Show Order

Methods

showsPrec :: Int -> Order -> ShowS

show :: Order -> String

showList :: [Order] -> ShowS

data SelectClauses backend a

Constructors

SelectClauses

Fields

• selectGroupBy :: backend -> [Column]
• selectOrderBy :: backend -> [(Column, Order)]
• selectLimit :: Maybe Int
• selectOffset :: Maybe Int

Instances

Monoid (SelectClauses backend a)

Methods

mempty :: SelectClauses backend a

mappend :: SelectClauses backend a -> SelectClauses backend a -> SelectClauses backend a

mconcat :: [SelectClauses backend a] -> SelectClauses backend a

eqSelectClauses :: backend -> SelectClauses backend a -> SelectClauses backend a -> Bool

buildWhereClause :: Condition backend a -> ByteString -> backend -> ByteString

buildOnClause :: Condition backend a -> ByteString -> backend -> ByteString

buildColumnList :: [Column] -> ByteString

buildRelationName :: RelationName -> ByteString

buildSelectClauses :: SelectClauses backend a -> backend -> ByteString

buildSelectRequest :: backend -> Relation backend k l a -> Condition backend a -> SelectClauses backend a -> ByteString

buildCountRequest :: backend -> Relation backend k l a -> Condition backend a -> ByteString

data SelectF backend a

Constructors

(Storable backend k l b, FromRow backend (k :+ l) (Entity b)) => Select (Relation backend k l b) (Condition backend b) (SelectClauses backend b) ([Entity b] -> a)

Storable backend k l b => Count (Relation backend k l b) (Condition backend b) (Integer -> a)

SelectGetBackend (backend -> a)

SelectThrowError SeakaleError

SelectCatchError a (SeakaleError -> a)

Instances

Monad m => MonadSeakaleBase backend (FreeT (SelectF backend) m)

Methods

getBackend :: FreeT (SelectF backend) m backend

throwSeakaleError :: SeakaleError -> FreeT (SelectF backend) m a

catchSeakaleError :: FreeT (SelectF backend) m a -> (SeakaleError -> FreeT (SelectF backend) m a) -> FreeT (SelectF backend) m a

Monad m => MonadSelect backend (FreeT (SelectF backend) m)

Methods

select :: (Storable backend k l a, FromRow backend (k :+ l) (Entity a)) => Relation backend k l a -> Condition backend a -> SelectClauses backend a -> FreeT (SelectF backend) m [Entity a]

count :: Storable backend k l a => Relation backend k l a -> Condition backend a -> FreeT (SelectF backend) m Integer

Functor (SelectF backend)

Methods

fmap :: (a -> b) -> SelectF backend a -> SelectF backend b

(<$) :: a -> SelectF backend b -> SelectF backend a

type SelectT backend = FreeT (SelectF backend)

type Select backend = SelectT backend Identity

class MonadSeakaleBase backend m => MonadSelect backend m where

Minimal complete definition

select, count

Methods

select :: (Storable backend k l a, FromRow backend (k :+ l) (Entity a)) => Relation backend k l a -> Condition backend a -> SelectClauses backend a -> m [Entity a]

count :: Storable backend k l a => Relation backend k l a -> Condition backend a -> m Integer

Instances

(MonadSelect backend m, MonadTrans t, MonadSeakaleBase backend (t m)) => MonadSelect backend (t m)

Methods

select :: (Storable backend k l a, FromRow backend (k :+ l) (Entity a)) => Relation backend k l a -> Condition backend a -> SelectClauses backend a -> t m [Entity a]

count :: Storable backend k l a => Relation backend k l a -> Condition backend a -> t m Integer

Monad m => MonadSelect backend (RequestT backend m)

Methods

select :: (Storable backend k l a, FromRow backend (k :+ l) (Entity a)) => Relation backend k l a -> Condition backend a -> SelectClauses backend a -> RequestT backend m [Entity a]

count :: Storable backend k l a => Relation backend k l a -> Condition backend a -> RequestT backend m Integer

Monad m => MonadSelect backend (FreeT (SelectF backend) m)

Methods

select :: (Storable backend k l a, FromRow backend (k :+ l) (Entity a)) => Relation backend k l a -> Condition backend a -> SelectClauses backend a -> FreeT (SelectF backend) m [Entity a]

count :: Storable backend k l a => Relation backend k l a -> Condition backend a -> FreeT (SelectF backend) m Integer

runSelectT :: Monad m => SelectT backend m a -> RequestT backend m a

runSelect :: Select backend a -> Request backend a

data UpdateSetter backend a

Constructors

UpdateSetter (backend -> Vector n (Column, ByteString))

Instances

Monoid (UpdateSetter backend a)

Methods

mempty :: UpdateSetter backend a

mappend :: UpdateSetter backend a -> UpdateSetter backend a -> UpdateSetter backend a

mconcat :: [UpdateSetter backend a] -> UpdateSetter backend a

eqUpdateSetter :: backend -> UpdateSetter backend a -> UpdateSetter backend a -> Bool

data StoreF backend a

Constructors

(Storable backend k l b, ToRow backend l b, FromRow backend k (EntityID b)) => Insert [b] ([EntityID b] -> a)

Storable backend k l b => Update (UpdateSetter backend b) (Condition backend b) (Integer -> a)

Storable backend k l b => Delete (Condition backend b) (Integer -> a)

Instances

MonadSeakaleBase backend m => MonadSeakaleBase backend (FreeT (StoreF backend) m)

Methods

getBackend :: FreeT (StoreF backend) m backend

throwSeakaleError :: SeakaleError -> FreeT (StoreF backend) m a

catchSeakaleError :: FreeT (StoreF backend) m a -> (SeakaleError -> FreeT (StoreF backend) m a) -> FreeT (StoreF backend) m a

MonadSelect backend m => MonadStore backend (FreeT (StoreF backend) m)

Methods

insert :: (Storable backend k l b, ToRow backend l b, FromRow backend k (EntityID b)) => [b] -> FreeT (StoreF backend) m [EntityID b]

update :: Storable backend k l a => UpdateSetter backend a -> Condition backend a -> FreeT (StoreF backend) m Integer

delete :: Storable backend k l a => Condition backend a -> FreeT (StoreF backend) m Integer

Functor (StoreF backend)

Methods

fmap :: (a -> b) -> StoreF backend a -> StoreF backend b

(<$) :: a -> StoreF backend b -> StoreF backend a

type StoreT backend m = FreeT (StoreF backend) (SelectT backend m)

type Store backend = StoreT backend Identity

class MonadSelect backend m => MonadStore backend m where

Minimal complete definition

insert, update, delete

Methods

insert :: (Storable backend k l b, ToRow backend l b, FromRow backend k (EntityID b)) => [b] -> m [EntityID b]

update :: Storable backend k l a => UpdateSetter backend a -> Condition backend a -> m Integer

delete :: Storable backend k l a => Condition backend a -> m Integer

Instances

(MonadStore backend m, MonadTrans t, MonadSeakaleBase backend (t m)) => MonadStore backend (t m)

Methods

insert :: (Storable backend k l b, ToRow backend l b, FromRow backend k (EntityID b)) => [b] -> t m [EntityID b]

update :: Storable backend k l a => UpdateSetter backend a -> Condition backend a -> t m Integer

delete :: Storable backend k l a => Condition backend a -> t m Integer

Monad m => MonadStore backend (RequestT backend m)

Methods

insert :: (Storable backend k l b, ToRow backend l b, FromRow backend k (EntityID b)) => [b] -> RequestT backend m [EntityID b]

update :: Storable backend k l a => UpdateSetter backend a -> Condition backend a -> RequestT backend m Integer

delete :: Storable backend k l a => Condition backend a -> RequestT backend m Integer

MonadSelect backend m => MonadStore backend (FreeT (StoreF backend) m)

Methods

insert :: (Storable backend k l b, ToRow backend l b, FromRow backend k (EntityID b)) => [b] -> FreeT (StoreF backend) m [EntityID b]

update :: Storable backend k l a => UpdateSetter backend a -> Condition backend a -> FreeT (StoreF backend) m Integer

delete :: Storable backend k l a => Condition backend a -> FreeT (StoreF backend) m Integer

buildInsertRequest :: Relation backend k l a -> [QueryData l] -> ByteString

buildSetter :: backend -> UpdateSetter backend a -> ByteString

buildUpdateRequest :: backend -> Relation backend k l a -> UpdateSetter backend a -> Condition backend a -> ByteString

buildDeleteRequest :: backend -> Relation backend k l a -> Condition backend a -> ByteString

runStoreT :: forall backend m a. Monad m => StoreT backend m a -> RequestT backend m a

runStore :: Store backend a -> Request backend a