Safe Haskell	None

Database.Persist.Query.Internal

Contents

Exceptions
Filters

Synopsis

Documentation

class PersistStore m => PersistQuery m whereSource

Methods

update :: (PersistEntity val, PersistEntityBackend val ~ PersistMonadBackend m) => Key val -> [Update val] -> m ()Source

Update individual fields on a specific record.

updateGet :: (PersistEntity val, PersistMonadBackend m ~ PersistEntityBackend val) => Key val -> [Update val] -> m valSource

Update individual fields on a specific record, and retrieve the updated value from the database.

Note that this function will throw an exception if the given key is not found in the database.

updateWhere :: (PersistEntity val, PersistEntityBackend val ~ PersistMonadBackend m) => [Filter val] -> [Update val] -> m ()Source

Update individual fields on any record matching the given criterion.

deleteWhere :: (PersistEntity val, PersistEntityBackend val ~ PersistMonadBackend m) => [Filter val] -> m ()Source

Delete all records matching the given criterion.

selectSource :: (PersistEntity val, PersistEntityBackend val ~ PersistMonadBackend m) => [Filter val] -> [SelectOpt val] -> Source m (Entity val)Source

Get all records matching the given criterion in the specified order. Returns also the identifiers.

selectFirst :: (PersistEntity val, PersistEntityBackend val ~ PersistMonadBackend m) => [Filter val] -> [SelectOpt val] -> m (Maybe (Entity val))Source

get just the first record for the criterion

selectKeys :: (PersistEntity val, PersistEntityBackend val ~ PersistMonadBackend m) => [Filter val] -> [SelectOpt val] -> Source m (Key val)Source

Get the Keys of all records matching the given criterion.

count :: (PersistEntity val, PersistEntityBackend val ~ PersistMonadBackend m) => [Filter val] -> m Int Source

The total number of records fulfilling the given criterion.

Instances

(PersistStore (ResourceT m), PersistQuery m) => PersistQuery (ResourceT m)
(PersistStore (LoggingT m), PersistQuery m) => PersistQuery (LoggingT m)
(PersistStore (ListT m), PersistQuery m) => PersistQuery (ListT m)
(PersistStore (MaybeT m), PersistQuery m) => PersistQuery (MaybeT m)
(PersistStore (IdentityT m), PersistQuery m) => PersistQuery (IdentityT m)
(PersistStore (SqlPersist m), MonadResource m, MonadLogger m) => PersistQuery (SqlPersist m)
(PersistStore (ContT r m), PersistQuery m) => PersistQuery (ContT r m)
(PersistStore (ErrorT e m), Error e, PersistQuery m) => PersistQuery (ErrorT e m)
(PersistStore (ReaderT r m), PersistQuery m) => PersistQuery (ReaderT r m)
(PersistStore (StateT s m), PersistQuery m) => PersistQuery (StateT s m)
(PersistStore (StateT s m), PersistQuery m) => PersistQuery (StateT s m)
(PersistStore (WriterT w m), Monoid w, PersistQuery m) => PersistQuery (WriterT w m)
(PersistStore (WriterT w m), Monoid w, PersistQuery m) => PersistQuery (WriterT w m)
(PersistStore (RWST r w s m), Monoid w, PersistQuery m) => PersistQuery (RWST r w s m)
(PersistStore (RWST r w s m), Monoid w, PersistQuery m) => PersistQuery (RWST r w s m)
(PersistStore (Pipe l i o u m), PersistQuery m) => PersistQuery (Pipe l i o u m)

selectList :: (PersistEntity val, PersistQuery m, PersistEntityBackend val ~ PersistMonadBackend m) => [Filter val] -> [SelectOpt val] -> m [Entity val]Source

Call selectSource but return the result as a list.

selectKeysList :: (PersistEntity val, PersistQuery m, PersistEntityBackend val ~ PersistMonadBackend m) => [Filter val] -> [SelectOpt val] -> m [Key val]Source

Call selectKeys but return the result as a list.

data SelectOpt v Source

Constructors

forall typ . Asc (EntityField v typ)
forall typ . Desc (EntityField v typ)
OffsetBy Int
LimitTo Int

limitOffsetOrder :: PersistEntity val => [SelectOpt val] -> (Int, Int, [SelectOpt val])Source

data Filter v Source

Filters which are available for select, updateWhere and deleteWhere. Each filter constructor specifies the field being filtered on, the type of comparison applied (equals, not equals, etc) and the argument for the comparison.

Constructors

forall typ . PersistField typ => Filter
Fields filterField :: EntityField v typ filterValue :: Either typ [typ] filterFilter :: PersistFilter
FilterAnd [Filter v]	convenient for internal use, not needed for the API
FilterOr [Filter v]
BackendFilter (BackendSpecificFilter (PersistEntityBackend v) v)

data PersistUpdate Source

Constructors

Assign
Add
Subtract
Multiply
Divide

Instances

Bounded PersistUpdate
Enum PersistUpdate
Read PersistUpdate
Show PersistUpdate

data Update v Source

Constructors

forall typ . PersistField typ => Update
Fields updateField :: EntityField v typ updateValue :: typ updateUpdate :: PersistUpdate

updateFieldDef :: PersistEntity v => Update v -> FieldDef Source

deleteCascadeWhere :: (DeleteCascade a m, PersistQuery m) => [Filter a] -> m ()Source

Exceptions

data UpdateGetException Source

Constructors

KeyNotFound String

Instances

Show UpdateGetException
Typeable UpdateGetException
Exception UpdateGetException

Filters

type family BackendSpecificFilter b v Source