Copyright	(c) digitally induced GmbH 2020
Safe Haskell	None
Language	GHC2021

IHP.ModelSupport.Types

Contents

Model Context
Type Families
Id Types
Record Metadata
Field Wrappers
Exceptions
Type Classes

Description

This module contains the core types for IHP's model support. It's designed to be lightweight and avoid heavy dependencies, allowing modules that only need the types to compile faster.

For the full model API including query functions, use ModelSupport.

Synopsis

data ModelContext = ModelContext {
- hasqlPool :: Pool
- transactionRunner :: Maybe TransactionRunner
- logger :: Logger
- trackTableReadCallback :: Maybe (Text -> IO ())
- rowLevelSecurity :: Maybe RowLevelSecurityContext
}
data RowLevelSecurityContext = RowLevelSecurityContext {
- rlsAuthenticatedRole :: Text
- rlsUserId :: Text
}
newtype TransactionRunner = TransactionRunner {
- runInTransaction :: forall a. Session a -> IO a
}
type family GetModelById id where ...
type family GetTableName model :: Symbol
type family GetModelByTableName (tableName :: Symbol)
type family PrimaryKey (tableName :: Symbol)
type family GetModelName model :: Symbol
type family Include (name :: Symbol) model
type family Include' (name :: [Symbol]) model where ...
type NormalizeModel model = GetModelByTableName (GetTableName model)
newtype Id' (table :: Symbol) = Id (PrimaryKey table)
type Id model = Id' (GetTableName model)
data MetaBag = MetaBag {
- annotations :: ![(Text, Violation)]
- touchedFields :: !Integer
- originalDatabaseRecord :: Maybe Dynamic
}
data Violation
- = TextViolation {
  - message :: !Text
  }
- | HtmlViolation {
  - message :: !Text
  }
type FieldName = ByteString
data FieldWithDefault valueType
- = Default
- | NonDefault valueType
data FieldWithUpdate (name :: k) value
- = NoUpdate (Proxy name)
- | Update value
data RecordNotFoundException = RecordNotFoundException {
- queryAndParams :: Text
}
data EnhancedSqlError = EnhancedSqlError {
- sqlErrorQuery :: Query
- sqlErrorQueryParams :: Text
- sqlError :: SqlError
}
enhancedSqlErrorMessage :: EnhancedSqlError -> Text
data HasqlSessionError = HasqlSessionError SessionError
data HasqlError = HasqlError UsageError
class CanCreate a where
- create :: a -> IO a
- createMany :: [a] -> IO [a]
- createRecordDiscardResult :: a -> IO ()
class CanUpdate a where
- updateRecord :: a -> IO a
- updateRecordDiscardResult :: a -> IO ()
class ParsePrimaryKey primaryKey where
- parsePrimaryKey :: Text -> Maybe primaryKey
class FieldBit (name :: Symbol) (model :: k) where
- fieldBit :: Integer

Model Context

data ModelContext Source #

Provides the db connection and some IHP-specific db configuration

Constructors

ModelContext

Fields

hasqlPool :: Pool
Hasql pool for prepared statement-based queries
transactionRunner :: Maybe TransactionRunner
When set, queries are sent through this runner instead of use directly | Logs all queries to this logger at log level info
logger :: Logger
trackTableReadCallback :: Maybe (Text -> IO ())
A callback that is called whenever a specific table is accessed using a SELECT query
rowLevelSecurity :: Maybe RowLevelSecurityContext
Is set to a value if row level security was enabled at runtime

Instances

Instances details

HasField "modelContext" Request ModelContext Source #
Instance details Defined in IHP.RequestVault.ModelContext Methods getField :: Request -> ModelContext #

data RowLevelSecurityContext Source #

When row level security is enabled at runtime, this keeps track of the current logged in user and the postgresql role to switch to.

Constructors

RowLevelSecurityContext
Fields rlsAuthenticatedRole :: Text Default is `ihp_authenticated`. This value comes from the `IHP_RLS_AUTHENTICATED_ROLE` env var. rlsUserId :: Text The user id of the current logged in user

newtype TransactionRunner Source #

Runner that executes a hasql Session on the current transaction's connection

Constructors

TransactionRunner
Fields runInTransaction :: forall a. Session a -> IO a

Type Families

type family GetModelById id where ... Source #

Equations

GetModelById (Maybe (Id' tableName)) = Maybe (GetModelByTableName tableName)
GetModelById (Id' tableName) = GetModelByTableName tableName

type family GetTableName model :: Symbol Source #

type family GetModelByTableName (tableName :: Symbol) Source #

type family PrimaryKey (tableName :: Symbol) Source #

Provides the primary key type for a given table. The instances are usually declared by the generated haskell code in Generated.Types

Example: Defining the primary key for a users table

type instance PrimaryKey "users" = UUID

Example: Defining the primary key for a table with a SERIAL pk

type instance PrimaryKey "projects" = Int

type family GetModelName model :: Symbol Source #

type family Include (name :: Symbol) model Source #

type family Include' (name :: [Symbol]) model where ... Source #

Equations

Include' ('[] :: [Symbol]) model = model
Include' (x ': xs) model = Include' xs (Include x model)

type NormalizeModel model = GetModelByTableName (GetTableName model) Source #

Helper type to deal with models where relations are included or that are only partially fetched Examples:

>>> NormalizeModel (Include "author_id" Post)
Post

>>> NormalizeModel Post
Post

Id Types

newtype Id' (table :: Symbol) Source #

Constructors

Id (PrimaryKey table)

Instances

Instances details

FromJSON (PrimaryKey a) => FromJSON (Id' a) Source #

Instance details

Defined in IHP.ModelSupport

Methods

parseJSON :: Value -> Parser (Id' a) Source #

parseJSONList :: Value -> Parser [Id' a] Source #

omittedField :: Maybe (Id' a) Source #

ToJSON (PrimaryKey a) => ToJSON (Id' a) Source #

Instance details

Defined in IHP.ModelSupport

Methods

toJSON :: Id' a -> Value Source #

toEncoding :: Id' a -> Encoding Source #

toJSONList :: [Id' a] -> Value Source #

toEncodingList :: [Id' a] -> Encoding Source #

omitField :: Id' a -> Bool Source #

PrimaryKey table ~ UUID => Serialize (Id' table) Source #

Instance details

Defined in IHP.Controller.Session

Methods

put :: Putter (Id' table) Source #

get :: Get (Id' table) Source #

(KnownSymbol table, NFData (PrimaryKey table)) => NFData (Id' table) Source #

Instance details

Defined in IHP.ModelSupport.Types

Methods

rnf :: Id' table -> () #

(KnownSymbol table, Data (PrimaryKey table)) => Data (Id' table) Source #

Instance details

Defined in IHP.ModelSupport.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Id' table -> c (Id' table) #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Id' table) #

toConstr :: Id' table -> Constr #

dataTypeOf :: Id' table -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (Id' table)) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Id' table)) #

gmapT :: (forall b. Data b => b -> b) -> Id' table -> Id' table #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Id' table -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Id' table -> r #

gmapQ :: (forall d. Data d => d -> u) -> Id' table -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Id' table -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Id' table -> m (Id' table) #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Id' table -> m (Id' table) #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Id' table -> m (Id' table) #

(Read (PrimaryKey model), ParsePrimaryKey (PrimaryKey model)) => IsString (Id' model) Source #

Sometimes you have a hardcoded UUID value which represents some record id. This instance allows you to write the Id like a string:

let projectId = "ca63aace-af4b-4e6c-bcfa-76ca061dbdc6" :: Id Project

Instance details

Defined in IHP.ModelSupport

Methods

fromString :: String -> Id' model #

Show (PrimaryKey model) => Show (Id' model) Source #

Instance details

Defined in IHP.ModelSupport

Methods

showsPrec :: Int -> Id' model -> ShowS #

show :: Id' model -> String #

showList :: [Id' model] -> ShowS #

Eq (PrimaryKey table) => Eq (Id' table) Source #

Instance details

Defined in IHP.ModelSupport.Types

Methods

(==) :: Id' table -> Id' table -> Bool #

(/=) :: Id' table -> Id' table -> Bool #

Ord (PrimaryKey table) => Ord (Id' table) Source #

Instance details

Defined in IHP.ModelSupport.Types

Methods

compare :: Id' table -> Id' table -> Ordering #

(<) :: Id' table -> Id' table -> Bool #

(<=) :: Id' table -> Id' table -> Bool #

(>) :: Id' table -> Id' table -> Bool #

(>=) :: Id' table -> Id' table -> Bool #

max :: Id' table -> Id' table -> Id' table #

min :: Id' table -> Id' table -> Id' table #

Hashable (PrimaryKey table) => Hashable (Id' table) Source #

Instance details

Defined in IHP.ModelSupport.Types

Methods

hashWithSalt :: Int -> Id' table -> Int Source #

hash :: Id' table -> Int Source #

IsScalar (PrimaryKey table) => DefaultParamEncoder (Id' table) Source #

Encode Id table' for tables with any primary key type that has an IsScalar instance. This covers UUID, Text, Int, and other primary key types.

Instance details

Defined in IHP.Hasql.Encoders

Methods

defaultParam :: NullableOrNot Value (Id' table) Source #

IsScalar (PrimaryKey table) => DefaultParamEncoder (Maybe (Id' table)) Source #

Encode 'Maybe (Id' table)' for nullable foreign keys with any encodable primary key type.

Instance details

Defined in IHP.Hasql.Encoders

Methods

defaultParam :: NullableOrNot Value (Maybe (Id' table)) Source #

IsScalar (PrimaryKey table) => DefaultParamEncoder [Id' table] Source #

Encode list of Id table' for tables with any encodable primary key type. Used by filterWhereIdIn for simple primary keys.

Instance details

Defined in IHP.Hasql.Encoders

Methods

defaultParam :: NullableOrNot Value [Id' table] Source #

IsScalar (PrimaryKey table) => DefaultParamEncoder [Maybe (Id' table)] Source #

Encode '[Maybe (Id' table)]' for filterWhereIn with nullable foreign keys.

Instance details

Defined in IHP.Hasql.Encoders

Methods

defaultParam :: NullableOrNot Value [Maybe (Id' table)] Source #

(IsScalar (PrimaryKey a), IsScalar (PrimaryKey b)) => DefaultParamEncoder [(Id' a, Id' b)] Source #

Encode '[(Id' a, Id' b)]' as PostgreSQL array of composite types Used by filterWhereIdIn for tables with two-column composite primary keys

Instance details

Defined in IHP.Hasql.Encoders

Methods

defaultParam :: NullableOrNot Value [(Id' a, Id' b)] Source #

(IsScalar (PrimaryKey a), IsScalar (PrimaryKey b), IsScalar (PrimaryKey c)) => DefaultParamEncoder [(Id' a, Id' b, Id' c)] Source #

Encode '[(Id' a, Id' b, Id' c)]' as PostgreSQL array of composite types Used by filterWhereIdIn for tables with three-column composite primary keys

Instance details

Defined in IHP.Hasql.Encoders

Methods

defaultParam :: NullableOrNot Value [(Id' a, Id' b, Id' c)] Source #

(IsScalar (PrimaryKey a), IsScalar (PrimaryKey b), IsScalar (PrimaryKey c), IsScalar (PrimaryKey d)) => DefaultParamEncoder [(Id' a, Id' b, Id' c, Id' d)] Source #

Encode '[(Id' a, Id' b, Id' c, Id' d)]' as PostgreSQL array of composite types Used by filterWhereIdIn for tables with four-column composite primary keys

Instance details

Defined in IHP.Hasql.Encoders

Methods

defaultParam :: NullableOrNot Value [(Id' a, Id' b, Id' c, Id' d)] Source #

IsScalar (PrimaryKey table) => IsScalar (Id' table) Source #

IsScalar instance for Id' so that Id columns can use encoder and decoder directly in generated code, without manual wrapping/unwrapping.

Instance details

Defined in IHP.Hasql.FromRow

Methods

encoder :: Value (Id' table) Source #

decoder :: Value (Id' table) Source #

IsEmpty (PrimaryKey table) => IsEmpty (Id' table) Source #

Instance details

Defined in IHP.ModelSupport

Methods

isEmpty :: Id' table -> Bool Source #

IsScalar (PrimaryKey table) => HasqlDecodeColumn (Id' table) Source #

Decode Id table' by decoding the primary key type and wrapping with Id

Instance details

Defined in IHP.Hasql.FromRow

Methods

hasqlColumnDecoder :: Row (Id' table) Source #

IsScalar (PrimaryKey table) => HasqlDecodeColumn (Maybe (Id' table)) Source #

Decode 'Maybe (Id' table)' for nullable foreign keys

Instance details

Defined in IHP.Hasql.FromRow

Methods

hasqlColumnDecoder :: Row (Maybe (Id' table)) Source #

InputValue (PrimaryKey model') => InputValue (Id' model') Source #

Instance details

Defined in IHP.ModelSupport

Methods

inputValue :: Id' model' -> Text Source #

InputValue (PrimaryKey table) => ApplyAttribute (Id' table)

Instance details

Defined in IHP.ViewSupport

Methods

applyAttribute :: Text -> Text -> Id' table -> Markup

FromField (PrimaryKey model) => FromField (Id' model) Source #

Instance details

Defined in IHP.PGSimpleCompat

Methods

fromField :: FieldParser (Id' model) Source #

ToField (PrimaryKey model) => ToField (Id' model) Source #

Instance details

Defined in IHP.PGSimpleCompat

Methods

toField :: Id' model -> Action Source #

ParamReader (PrimaryKey model') => ParamReader (Id' model') Source #

Instance details

Defined in IHP.Controller.Param

Methods

readParameter :: ByteString -> Either ByteString (Id' model') Source #

readParameterJSON :: Value -> Either ByteString (Id' model') Source #

(model ~ GetModelById (Id' table), GetTableName model ~ table, FilterPrimaryKey table) => Fetchable (Id' table) model Source #

Instance details

Defined in IHP.Fetch

Associated Types

type FetchResult (Id' table) model
Instance details Defined in IHP.Fetch type FetchResult (Id' table) model = model

Methods

fetch :: Id' table -> IO (FetchResult (Id' table) model) Source #

fetchOneOrNothing :: Id' table -> IO (Maybe model) Source #

fetchOne :: Id' table -> IO model Source #

(model ~ GetModelById (Id' table), GetTableName model ~ table, FilterPrimaryKey table) => Fetchable (Maybe (Id' table)) model Source #

Instance details

Defined in IHP.Fetch

Associated Types

type FetchResult (Maybe (Id' table)) model
Instance details Defined in IHP.Fetch type FetchResult (Maybe (Id' table)) model = [model]

Methods

fetch :: Maybe (Id' table) -> IO (FetchResult (Maybe (Id' table)) model) Source #

fetchOneOrNothing :: Maybe (Id' table) -> IO (Maybe model) Source #

fetchOne :: Maybe (Id' table) -> IO model Source #

(model ~ GetModelById (Id' table), GetModelByTableName table ~ model, GetTableName model ~ table, DefaultParamEncoder [PrimaryKey table]) => Fetchable [Id' table] model Source #

Instance details

Defined in IHP.Fetch

Associated Types

type FetchResult [Id' table] model
Instance details Defined in IHP.Fetch type FetchResult [Id' table] model = [model]

Methods

fetch :: [Id' table] -> IO (FetchResult [Id' table] model) Source #

fetchOneOrNothing :: [Id' table] -> IO (Maybe model) Source #

fetchOne :: [Id' table] -> IO model Source #

(TypeError (('Text "Looks like you forgot to pass a " ':<>: 'ShowType (GetModelByTableName record)) ':<>: 'Text " id to this data constructor.") :: Constraint) => Eq (Id' record -> controller) Source #

Instance details

Defined in IHP.ViewSupport

Methods

(==) :: (Id' record -> controller) -> (Id' record -> controller) -> Bool #

(/=) :: (Id' record -> controller) -> (Id' record -> controller) -> Bool #

(IsScalar (PrimaryKey a), IsScalar (PrimaryKey b)) => DefaultParamEncoder (Id' a, Id' b) Source #

Encode '(Id' a, Id' b)' as PostgreSQL composite/record type Used for composite primary keys with two Id columns of any scalar PK type

Instance details

Defined in IHP.Hasql.Encoders

Methods

defaultParam :: NullableOrNot Value (Id' a, Id' b) Source #

(ToField (Id' a), ToField (Id' b)) => ToField (Id' a, Id' b) Source #

Instance details

Defined in IHP.PGSimpleCompat

Methods

toField :: (Id' a, Id' b) -> Action Source #

(IsScalar (PrimaryKey a), IsScalar (PrimaryKey b), IsScalar (PrimaryKey c)) => DefaultParamEncoder (Id' a, Id' b, Id' c) Source #

Encode '(Id' a, Id' b, Id' c)' as PostgreSQL composite/record type Used for composite primary keys with three Id columns of any scalar PK type

Instance details

Defined in IHP.Hasql.Encoders

Methods

defaultParam :: NullableOrNot Value (Id' a, Id' b, Id' c) Source #

(IsScalar (PrimaryKey a), IsScalar (PrimaryKey b), IsScalar (PrimaryKey c), IsScalar (PrimaryKey d)) => DefaultParamEncoder (Id' a, Id' b, Id' c, Id' d) Source #

Encode '(Id' a, Id' b, Id' c, Id' d)' as PostgreSQL composite/record type Used for composite primary keys with four Id columns of any scalar PK type

Instance details

Defined in IHP.Hasql.Encoders

Methods

defaultParam :: NullableOrNot Value (Id' a, Id' b, Id' c, Id' d) Source #

type FetchResult (Id' table) model Source #

Instance details

Defined in IHP.Fetch

type FetchResult (Id' table) model = model

type FetchResult (Maybe (Id' table)) model Source #

Instance details

Defined in IHP.Fetch

type FetchResult (Maybe (Id' table)) model = [model]

type FetchResult [Id' table] model Source #

Instance details

Defined in IHP.Fetch

type FetchResult [Id' table] model = [model]

type Id model = Id' (GetTableName model) Source #

We need to map the model to its table name to prevent infinite recursion in the model data definition E.g. `type Project = Project' { id :: Id Project }` will not work But `type Project = Project' { id :: Id "projects" }` will

Record Metadata

data MetaBag Source #

Every IHP database record has a magic meta field which keeps a MetaBag inside. This data structure is used e.g. to keep track of the validation errors that happend.

Constructors

MetaBag

Fields

annotations :: ![(Text, Violation)]
Stores validation failures, as a list of (field name, error) pairs. E.g. annotations = [ ("name", TextViolation "cannot be empty") ]
touchedFields :: !Integer
Bitmask of touched fields. Whenever a set is called on a field, its bit is set via .|.. Only touched fields are saved to the database when you call updateRecord. For ≤64 columns, fits in a single machine word.
originalDatabaseRecord :: Maybe Dynamic
When the record has been fetched from the database, we save the initial database record here. This is used by didChange to check if a field value is different from the initial database value.

Instances

Instances details

Default MetaBag Source #
Instance details Defined in IHP.ModelSupport Methods def :: MetaBag Source #
Show MetaBag Source #
Instance details Defined in IHP.ModelSupport.Types Methods showsPrec :: Int -> MetaBag -> ShowS # show :: MetaBag -> String # showList :: [MetaBag] -> ShowS #
Eq MetaBag Source #
Instance details Defined in IHP.ModelSupport.Types Methods (==) :: MetaBag -> MetaBag -> Bool # (/=) :: MetaBag -> MetaBag -> Bool #
SetField "touchedFields" MetaBag Integer Source #
Instance details Defined in IHP.ModelSupport Methods setField :: Integer -> MetaBag -> MetaBag Source #
SetField "annotations" MetaBag [(Text, Violation)] Source #
Instance details Defined in IHP.ModelSupport Methods setField :: [(Text, Violation)] -> MetaBag -> MetaBag Source #

data Violation Source #

The error message of a validator can be either a plain text value or a HTML formatted value

Constructors

TextViolation	Plain text validation error, like "cannot be empty"
Fields message :: !Text
HtmlViolation	HTML formatted, already pre-escaped validation error, like "Invalid, please href="http://example.com"check the documentation/a"
Fields message :: !Text

Instances

Instances details

Show Violation Source #
Instance details Defined in IHP.ModelSupport.Types Methods showsPrec :: Int -> Violation -> ShowS # show :: Violation -> String # showList :: [Violation] -> ShowS #
Eq Violation Source #
Instance details Defined in IHP.ModelSupport.Types Methods (==) :: Violation -> Violation -> Bool # (/=) :: Violation -> Violation -> Bool #
SetField "annotations" MetaBag [(Text, Violation)] Source #
Instance details Defined in IHP.ModelSupport Methods setField :: [(Text, Violation)] -> MetaBag -> MetaBag Source #

type FieldName = ByteString Source #

Field Wrappers

data FieldWithDefault valueType Source #

Represents fields that have a default value in an SQL schema

The Default constructor represents the default value from the schema, while the NonDefault constructor holds some other value for the field

Constructors

Default
NonDefault valueType

Instances

Instances details

Show valueType => Show (FieldWithDefault valueType) Source #
Instance details Defined in IHP.ModelSupport.Types Methods showsPrec :: Int -> FieldWithDefault valueType -> ShowS # show :: FieldWithDefault valueType -> String # showList :: [FieldWithDefault valueType] -> ShowS #
Eq valueType => Eq (FieldWithDefault valueType) Source #
Instance details Defined in IHP.ModelSupport.Types Methods (==) :: FieldWithDefault valueType -> FieldWithDefault valueType -> Bool # (/=) :: FieldWithDefault valueType -> FieldWithDefault valueType -> Bool #
ToField valueType => ToField (FieldWithDefault valueType) Source #
Instance details Defined in IHP.PGSimpleCompat Methods toField :: FieldWithDefault valueType -> Action Source #

data FieldWithUpdate (name :: k) value Source #

Represents fields that may have been updated

The NoUpdate constructor represents the existing value in the database, while the Update constructor holds some new value for the field

Constructors

NoUpdate (Proxy name)
Update value

Instances

Instances details

Show value => Show (FieldWithUpdate name value) Source #
Instance details Defined in IHP.ModelSupport.Types Methods showsPrec :: Int -> FieldWithUpdate name value -> ShowS # show :: FieldWithUpdate name value -> String # showList :: [FieldWithUpdate name value] -> ShowS #
Eq value => Eq (FieldWithUpdate name value) Source #
Instance details Defined in IHP.ModelSupport.Types Methods (==) :: FieldWithUpdate name value -> FieldWithUpdate name value -> Bool # (/=) :: FieldWithUpdate name value -> FieldWithUpdate name value -> Bool #
(KnownSymbol name, ToField value) => ToField (FieldWithUpdate name value) Source #
Instance details Defined in IHP.PGSimpleCompat Methods toField :: FieldWithUpdate name value -> Action Source #

Exceptions

data RecordNotFoundException Source #

Thrown by fetchOne when the query result is empty

Constructors

RecordNotFoundException
Fields queryAndParams :: Text

Instances

Instances details

Exception RecordNotFoundException Source #
Instance details Defined in IHP.ModelSupport.Types Methods toException :: RecordNotFoundException -> SomeException # fromException :: SomeException -> Maybe RecordNotFoundException # displayException :: RecordNotFoundException -> String # backtraceDesired :: RecordNotFoundException -> Bool #
Show RecordNotFoundException Source #
Instance details Defined in IHP.ModelSupport.Types Methods showsPrec :: Int -> RecordNotFoundException -> ShowS # show :: RecordNotFoundException -> String # showList :: [RecordNotFoundException] -> ShowS #

data EnhancedSqlError Source #

Whenever calls to query or execute raise an SqlError exception, we wrap that exception in this data structure. This allows us to show the actual database query that has triggered the error.

Constructors

EnhancedSqlError
Fields sqlErrorQuery :: Query sqlErrorQueryParams :: Text sqlError :: SqlError

Instances

Instances details

Exception EnhancedSqlError Source #
Instance details Defined in IHP.ModelSupport.Types Methods toException :: EnhancedSqlError -> SomeException # fromException :: SomeException -> Maybe EnhancedSqlError # displayException :: EnhancedSqlError -> String # backtraceDesired :: EnhancedSqlError -> Bool #
Show EnhancedSqlError Source #
Instance details Defined in IHP.ModelSupport.Types Methods showsPrec :: Int -> EnhancedSqlError -> ShowS # show :: EnhancedSqlError -> String # showList :: [EnhancedSqlError] -> ShowS #

enhancedSqlErrorMessage :: EnhancedSqlError -> Text Source #

Extract the SQL error message as Text from an EnhancedSqlError.

This avoids downstream packages needing to import postgresql-simple to access the sqlErrorMsg field on SqlError.

data HasqlSessionError Source #

Wrapper to make SessionError an Exception, since it doesn't have one by default

Constructors

HasqlSessionError SessionError

Instances

Instances details

Exception HasqlSessionError Source #
Instance details Defined in IHP.ModelSupport.Types Methods toException :: HasqlSessionError -> SomeException # fromException :: SomeException -> Maybe HasqlSessionError # displayException :: HasqlSessionError -> String # backtraceDesired :: HasqlSessionError -> Bool #
Show HasqlSessionError Source #
Instance details Defined in IHP.ModelSupport.Types Methods showsPrec :: Int -> HasqlSessionError -> ShowS # show :: HasqlSessionError -> String # showList :: [HasqlSessionError] -> ShowS #

data HasqlError Source #

Exception type for hasql pool usage errors

Constructors

HasqlError UsageError

Instances

Instances details

Exception HasqlError Source #
Instance details Defined in IHP.ModelSupport.Types Methods toException :: HasqlError -> SomeException # fromException :: SomeException -> Maybe HasqlError # displayException :: HasqlError -> String # backtraceDesired :: HasqlError -> Bool #
Show HasqlError Source #
Instance details Defined in IHP.ModelSupport.Types Methods showsPrec :: Int -> HasqlError -> ShowS # show :: HasqlError -> String # showList :: [HasqlError] -> ShowS #

Type Classes

class CanCreate a where Source #

Minimal complete definition

create, createMany

Methods

create :: a -> IO a Source #

createMany :: [a] -> IO [a] Source #

createRecordDiscardResult :: a -> IO () Source #

Like createRecord but doesn't return the created record

class CanUpdate a where Source #

Minimal complete definition

updateRecord

Methods

updateRecord :: a -> IO a Source #

updateRecordDiscardResult :: a -> IO () Source #

Like updateRecord but doesn't return the updated record

class ParsePrimaryKey primaryKey where Source #

Methods

parsePrimaryKey :: Text -> Maybe primaryKey Source #

Instances

Instances details

ParsePrimaryKey Text Source #
Instance details Defined in IHP.ModelSupport Methods parsePrimaryKey :: Text -> Maybe Text Source #
ParsePrimaryKey UUID Source #
Instance details Defined in IHP.ModelSupport Methods parsePrimaryKey :: Text -> Maybe UUID Source #

class FieldBit (name :: Symbol) (model :: k) where Source #

Maps a field name to its bit position in the touchedFields bitmask. Instances are generated by the schema compiler for each table's fields.

Methods

fieldBit :: Integer Source #