Database.Persist

Synopsis

• class PersistField a where
  • toPersistValue :: a -> PersistValue
  • fromPersistValue :: PersistValue -> Either String a
  • sqlType :: a -> SqlType
  • isNullable :: a -> Bool
• class PersistEntity val where
  • data EntityField val :: * -> *
  • data Unique val :: ((* -> *) -> * -> *) -> *
  • persistColumnDef :: EntityField val typ -> ColumnDef
  • entityDef :: val -> EntityDef
  • toPersistFields :: val -> [SomePersistField]
  • fromPersistValues :: [PersistValue] -> Either String val
  • halfDefined :: val
  • persistUniqueToFieldNames :: Unique val backend -> [String]
  • persistUniqueToValues :: Unique val backend -> [PersistValue]
  • persistUniqueKeys :: val -> [Unique val backend]
• class (MonadIO (b m), MonadIO m, Monad (b m), Monad m) => PersistBackend b m where
  • insert :: PersistEntity val => val -> b m (Key b val)
  • replace :: PersistEntity val => Key b val -> val -> b m ()
  • update :: PersistEntity val => Key b val -> [Update val] -> b m ()
  • updateWhere :: PersistEntity val => [Filter val] -> [Update val] -> b m ()
  • delete :: PersistEntity val => Key b val -> b m ()
  • deleteBy :: PersistEntity val => Unique val b -> b m ()
  • deleteWhere :: PersistEntity val => [Filter val] -> b m ()
  • get :: PersistEntity val => Key b val -> b m (Maybe val)
  • getBy :: PersistEntity val => Unique val b -> b m (Maybe (Key b val, val))
  • selectEnum :: PersistEntity val => [Filter val] -> [SelectOpt val] -> Enumerator (Key b val, val) (b m) a
  • selectFirst :: PersistEntity val => [Filter val] -> [SelectOpt val] -> b m (Maybe (Key b val, val))
  • selectKeys :: PersistEntity val => [Filter val] -> Enumerator (Key b val) (b m) a
  • count :: PersistEntity val => [Filter val] -> b m Int
• newtype Key backend entity = Key {
  • unKey :: PersistValue
  }
• selectList :: (PersistEntity val, PersistBackend b m) => [Filter val] -> [SelectOpt val] -> b m [(Key b val, val)]
• insertBy :: (PersistEntity v, PersistBackend b m) => v -> b m (Either (Key b v, v) (Key b v))
• getJust :: (PersistBackend b m, PersistEntity val, Show (Key b val)) => Key b val -> b m val
• belongsTo :: (PersistBackend b m, PersistEntity ent1, PersistEntity ent2) => (ent1 -> Maybe (Key b ent2)) -> ent1 -> b m (Maybe ent2)
• belongsToJust :: (PersistBackend b m, PersistEntity ent1, PersistEntity ent2) => (ent1 -> Key b ent2) -> ent1 -> b m ent2
• getByValue :: (PersistEntity v, PersistBackend b m) => v -> b m (Maybe (Key b v, v))
• checkUnique :: (PersistEntity val, PersistBackend b m) => val -> b m Bool
• data Update v = forall typ . PersistField typ => Update {
  • updateField :: EntityField v typ
  • updateValue :: typ
  • updateUpdate :: PersistUpdate
  }
• data SelectOpt v
  • = forall typ . Asc (EntityField v typ)
  • | forall typ . Desc (EntityField v typ)
  • | OffsetBy Int
  • | LimitTo Int
• data Filter v
  • = forall typ . PersistField typ => Filter {
    • filterField :: EntityField v typ
    • filterValue :: Either typ [typ]
    • filterFilter :: PersistFilter
    }
  • | FilterAnd [Filter v]
  • | FilterOr [Filter v]
• (=.), (/=.), (*=.), (-=.), (+=.) :: forall v typ. PersistField typ => EntityField v typ -> typ -> Update v
• (==.), (>=.), (>.), (<=.), (<.), (!=.) :: forall v typ. PersistField typ => EntityField v typ -> typ -> Filter v
• (<-.), (/<-.) :: forall v typ. PersistField typ => EntityField v typ -> [typ] -> Filter v
• (||.) :: forall v. [Filter v] -> [Filter v] -> [Filter v]

Documentation