Database.Persist.Base

Contents

• Definition
• Config

Description

Synopsis

• data PersistValue
  • = PersistText Text
  • | PersistByteString ByteString
  • | PersistInt64 Int64
  • | PersistDouble Double
  • | PersistBool Bool
  • | PersistDay Day
  • | PersistTimeOfDay TimeOfDay
  • | PersistUTCTime UTCTime
  • | PersistNull
  • | PersistList [PersistValue]
  • | PersistMap [(Text, PersistValue)]
  • | PersistObjectId ByteString
• data SqlType
  • = SqlString
  • | SqlInt32
  • | SqlInteger
  • | SqlReal
  • | SqlBool
  • | SqlDay
  • | SqlTime
  • | SqlDayTime
  • | SqlBlob
• 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
• data PersistFilter
  • = Eq
  • | Ne
  • | Gt
  • | Lt
  • | Ge
  • | Le
  • | In
  • | NotIn
  • | BackendSpecificFilter String
• data PersistUpdate
  • = Assign
  • | Add
  • | Subtract
  • | Multiply
  • | Divide
• data SelectOpt v
  • = forall typ . Asc (EntityField v typ)
  • | forall typ . Desc (EntityField v typ)
  • | OffsetBy Int
  • | LimitTo Int
• data SomePersistField = forall a . PersistField a => SomePersistField a
• 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))
• getByValue :: (PersistEntity v, PersistBackend b m) => v -> b m (Maybe (Key b v, 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
• checkUnique :: (PersistEntity val, PersistBackend b m) => val -> b m Bool
• class PersistEntity a => DeleteCascade a b where
  • deleteCascade :: PersistBackend b m => Key b a -> b m ()
• deleteCascadeWhere :: (DeleteCascade a b, PersistBackend b m) => [Filter a] -> b m ()
• data PersistException
  • = PersistError String
  • | PersistMarshalError String
  • | PersistInvalidField String
  • | PersistForeignConstraintUnmet String
  • | PersistMongoDBError String
  • | PersistMongoDBUnsupported String
• data Update v = forall typ . PersistField typ => Update {
  • updateField :: EntityField v typ
  • updateValue :: typ
  • updateUpdate :: PersistUpdate
  }
• updateFieldName :: PersistEntity v => Update v -> String
• data Filter v
  • = forall typ . PersistField typ => Filter {
    • filterField :: EntityField v typ
    • filterValue :: Either typ [typ]
    • filterFilter :: PersistFilter
    }
  • | FilterAnd [Filter v]
  • | FilterOr [Filter v]
• newtype Key backend entity = Key {
  • unKey :: PersistValue
  }
• data EntityDef = EntityDef {
  • entityName :: String
  • entityAttribs :: [String]
  • entityColumns :: [ColumnDef]
  • entityUniques :: [UniqueDef]
  • entityDerives :: [String]
  }
• type ColumnName = String
• type ColumnType = String
• data ColumnDef = ColumnDef {
  • columnName :: ColumnName
  • columnType :: ColumnType
  • columnAttribs :: [String]
  }
• data UniqueDef = UniqueDef {
  • uniqueName :: String
  • uniqueColumns :: [ColumnName]
  }
• fst3 :: forall t t1 t2. (t, t1, t2) -> t
• snd3 :: forall t t1 t2. (t, t1, t2) -> t1
• third3 :: forall t t1 t2. (t, t1, t2) -> t2
• limitOffsetOrder :: PersistEntity val => [SelectOpt val] -> (Int, Int, [SelectOpt val])
• class PersistConfig c where
  • type PersistConfigBackend c :: (* -> *) -> * -> *
  • type PersistConfigPool c
  • loadConfig :: TextObject -> Either String c
  • withPool :: (Applicative m, MonadControlIO m) => c -> (PersistConfigPool c -> m a) -> m a
  • runPool :: MonadControlIO m => c -> PersistConfigBackend c m a -> PersistConfigPool c -> m a

Documentation

Definition

Config