| Safe Haskell | None |
|---|
Database.Persist.Query.Internal
Contents
- class PersistStore backend m => PersistQuery backend m where
- update :: PersistEntity val => Key backend val -> [Update val] -> backend m ()
- updateGet :: PersistEntity val => Key backend val -> [Update val] -> backend m val
- updateWhere :: PersistEntity val => [Filter val] -> [Update val] -> backend m ()
- deleteWhere :: PersistEntity val => [Filter val] -> backend m ()
- selectSource :: (PersistEntity val, PersistEntityBackend val ~ backend) => [Filter val] -> [SelectOpt val] -> Source (ResourceT (backend m)) (Entity val)
- selectFirst :: (PersistEntity val, PersistEntityBackend val ~ backend) => [Filter val] -> [SelectOpt val] -> backend m (Maybe (Entity val))
- selectKeys :: PersistEntity val => [Filter val] -> [SelectOpt val] -> Source (ResourceT (backend m)) (Key backend val)
- count :: PersistEntity val => [Filter val] -> backend m Int
- selectList :: (PersistEntity val, PersistQuery backend m, PersistEntityBackend val ~ backend) => [Filter val] -> [SelectOpt val] -> backend m [Entity val]
- selectKeysList :: (PersistEntity val, PersistQuery b m, PersistEntityBackend val ~ b) => [Filter val] -> [SelectOpt val] -> b m [Key b val]
- data SelectOpt v
- = 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])
- 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 typ . PersistField typ => Filter {
- data PersistUpdate
- data Update v = forall typ . PersistField typ => Update {
- updateField :: EntityField v typ
- updateValue :: typ
- updateUpdate :: PersistUpdate
- updateFieldDef :: PersistEntity v => Update v -> FieldDef
- deleteCascadeWhere :: (DeleteCascade a backend m, PersistQuery backend m) => [Filter a] -> backend m ()
- data UpdateGetException = KeyNotFound String
Documentation
class PersistStore backend m => PersistQuery backend m whereSource
Methods
update :: PersistEntity val => Key backend val -> [Update val] -> backend m ()Source
Update individual fields on a specific record.
updateGet :: PersistEntity val => Key backend val -> [Update val] -> backend 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 => [Filter val] -> [Update val] -> backend m ()Source
Update individual fields on any record matching the given criterion.
deleteWhere :: PersistEntity val => [Filter val] -> backend m ()Source
Delete all records matching the given criterion.
selectSource :: (PersistEntity val, PersistEntityBackend val ~ backend) => [Filter val] -> [SelectOpt val] -> Source (ResourceT (backend m)) (Entity val)Source
Get all records matching the given criterion in the specified order. Returns also the identifiers.
selectFirst :: (PersistEntity val, PersistEntityBackend val ~ backend) => [Filter val] -> [SelectOpt val] -> backend m (Maybe (Entity val))Source
get just the first record for the criterion
selectKeys :: PersistEntity val => [Filter val] -> [SelectOpt val] -> Source (ResourceT (backend m)) (Key backend val)Source
Get the Keys of all records matching the given criterion.
count :: PersistEntity val => [Filter val] -> backend m IntSource
The total number of records fulfilling the given criterion.
Instances
| (PersistStore SqlPersist m, MonadThrow m, MonadIO m, MonadUnsafeIO m, MonadBaseControl IO m, MonadLogger m) => PersistQuery SqlPersist m |
selectList :: (PersistEntity val, PersistQuery backend m, PersistEntityBackend val ~ backend) => [Filter val] -> [SelectOpt val] -> backend m [Entity val]Source
Call selectSource but return the result as a list.
selectKeysList :: (PersistEntity val, PersistQuery b m, PersistEntityBackend val ~ b) => [Filter val] -> [SelectOpt val] -> b m [Key b val]Source
Call selectKeys but return the result as a list.
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
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
| |
| FilterAnd [Filter v] | convenient for internal use, not needed for the API |
| FilterOr [Filter v] | |
data PersistUpdate Source
Constructors
| forall typ . PersistField typ => Update | |
Fields
| |
updateFieldDef :: PersistEntity v => Update v -> FieldDefSource
deleteCascadeWhere :: (DeleteCascade a backend m, PersistQuery backend m) => [Filter a] -> backend m ()Source
Exceptions
data UpdateGetException Source
Constructors
| KeyNotFound String |