Composite.Opaleye.RecordTable

Documentation

class DefaultRecTableField write read where

Helper typeclass which picks which of requiredTableField or optionalTableField to use for a pair of write column type and read column type.

DefaultRecTableField (Maybe (Field a)) (Field a) uses optionalTableField. DefaultRecTableField (Field a) (Field a) uses requiredTableField.

Methods

defaultRecTableField :: String -> TableFields write read

Instances

DefaultRecTableField (Maybe (Field a)) (Field a)

Defined in Composite.Opaleye.RecordTable

Methods

defaultRecTableField :: String -> TableFields (Maybe (Field a)) (Field a)

DefaultRecTableField (Field a) (Field a)

Defined in Composite.Opaleye.RecordTable

Methods

defaultRecTableField :: String -> TableFields (Field a) (Field a)

class DefaultRecTable write read where

Type class for producing a default TableFields schema for some expected record types. requiredTableField and optionalTableField are chosen automatically and the column is named after the record fields.

For example, given:

 type WriteRec = Record '["id" :-> Maybe (Field PGInt8), "name" :-> Field PGText]
 type ReadRec  = Record '["id" :->        Field PGInt8 , "name" :-> Field PGText]

This:

 defaultRecTable :: TableFields WriteRec ReadRec

Is equivalent to:

pRec (optionalTableField "id" &: requiredTableField "name" &: Nil)

Alternately, use pRec and the usual Opaleye requiredTableField and optionalTableField.

Methods

defaultRecTable :: TableFields (Rec Identity write) (Rec Identity read)

Instances

DefaultRecTable ('[] :: [Type]) ('[] :: [Type])

Defined in Composite.Opaleye.RecordTable

Methods

defaultRecTable :: TableFields (Rec Identity '[]) (Rec Identity '[])

(KnownSymbol s, DefaultRecTableField w r, DefaultRecTable writes reads) => DefaultRecTable ((s :-> w) ': writes) ((s :-> r) ': reads)

Defined in Composite.Opaleye.RecordTable

Methods

defaultRecTable :: TableFields (Rec Identity ((s :-> w) ': writes)) (Rec Identity ((s :-> r) ': reads))