Opaleye.Internal.Table

Documentation

data Table writeFields viewFields

Define a table as follows, where "id", "color", "location", "quantity" and "radius" are the table's fields in Postgres and the types are given in the type signature. The id field is an autoincrementing field (i.e. optional for writes).

data Widget a b c d e = Widget { wid      :: a
                               , color    :: b
                               , location :: c
                               , quantity :: d
                               , radius   :: e }

$(makeAdaptorAndInstance "pWidget" ''Widget)

widgetTable :: Table (Widget (Maybe (Field SqlInt4)) (Field SqlText) (Field SqlText)
                             (Field SqlInt4) (Field SqlFloat8))
                     (Widget (Field SqlText) (Field SqlText) (Field SqlText)
                             (Field SqlInt4) (Field SqlFloat8))
widgetTable = table "widgetTable"
                     (pWidget Widget { wid      = tableField "id"
                                     , color    = tableField "color"
                                     , location = tableField "location"
                                     , quantity = tableField "quantity"
                                     , radius   = tableField "radius" })

The constructors of Table are internal only and will be deprecated in version 0.7.

Constructors

Table String (TableFields writeFields viewFields)

For unqualified table names. Do not use the constructor. It is internal and will be deprecated in version 0.7.

TableWithSchema String String (TableFields writeFields viewFields)

Schema name, table name, table properties. Do not use the constructor. It is internal and will be deprecated in version 0.7.

Instances

Profunctor Table

Defined in Opaleye.Internal.Table

Methods

dimap :: (a -> b) -> (c -> d) -> Table b c -> Table a d

lmap :: (a -> b) -> Table b c -> Table a c

rmap :: (b -> c) -> Table a b -> Table a c

(#.) :: Coercible c b => q b c -> Table a b -> Table a c

(.#) :: Coercible b a => Table b c -> q a b -> Table a c

Functor (Table a)

Defined in Opaleye.Internal.Table

Methods

fmap :: (a0 -> b) -> Table a a0 -> Table a b

(<$) :: a0 -> Table a b -> Table a a0

tableIdentifier :: Table writeColumns viewColumns -> TableIdentifier

tableColumns :: Table writeColumns viewColumns -> TableFields writeColumns viewColumns

tableProperties :: Table writeColumns viewColumns -> TableFields writeColumns viewColumns

Use tableColumns instead. Will be deprecated soon.

data TableProperties writeColumns viewColumns

Use TableFields instead. TableProperties will be deprecated in version 0.7.

Constructors

TableProperties

Fields

• tablePropertiesWriter :: Writer writeColumns viewColumns
• tablePropertiesView :: View viewColumns

Instances

Profunctor TableProperties

Defined in Opaleye.Internal.Table

Methods

dimap :: (a -> b) -> (c -> d) -> TableProperties b c -> TableProperties a d

lmap :: (a -> b) -> TableProperties b c -> TableProperties a c

rmap :: (b -> c) -> TableProperties a b -> TableProperties a c

(#.) :: Coercible c b => q b c -> TableProperties a b -> TableProperties a c

(.#) :: Coercible b a => TableProperties b c -> q a b -> TableProperties a c

ProductProfunctor TableProperties

Defined in Opaleye.Internal.Table

Methods

purePP :: b -> TableProperties a b

(****) :: TableProperties a (b -> c) -> TableProperties a b -> TableProperties a c

empty :: TableProperties () ()

(***!) :: TableProperties a b -> TableProperties a' b' -> TableProperties (a, a') (b, b')

Functor (TableProperties a)

Defined in Opaleye.Internal.Table

Methods

fmap :: (a0 -> b) -> TableProperties a a0 -> TableProperties a b

(<$) :: a0 -> TableProperties a b -> TableProperties a a0

Applicative (TableProperties a)

Defined in Opaleye.Internal.Table

Methods

pure :: a0 -> TableProperties a a0

(<*>) :: TableProperties a (a0 -> b) -> TableProperties a a0 -> TableProperties a b

liftA2 :: (a0 -> b -> c) -> TableProperties a a0 -> TableProperties a b -> TableProperties a c

(*>) :: TableProperties a a0 -> TableProperties a b -> TableProperties a b

(<*) :: TableProperties a a0 -> TableProperties a b -> TableProperties a a0

type TableColumns = TableProperties

Use TableFields instead. TableColumns will be deprecated in version 0.7.

type TableFields = TableProperties

The new name for TableColumns and TableProperties which will replace them in version 0.7.

tableColumnsWriter :: TableFields writeColumns viewColumns -> Writer writeColumns viewColumns

tableColumnsView :: TableFields writeColumns viewColumns -> View viewColumns

newtype View columns

Internal only. Do not use. View will be deprecated in version 0.7.

Constructors

View columns

newtype Writer columns dummy

Internal only. Do not use. Writer will be deprecated in version 0.7.

Constructors

Writer (forall f. Functor f => PackMap (f PrimExpr, String) () (f columns) ())

Instances

Profunctor Writer

Defined in Opaleye.Internal.Table

Methods

dimap :: (a -> b) -> (c -> d) -> Writer b c -> Writer a d

lmap :: (a -> b) -> Writer b c -> Writer a c

rmap :: (b -> c) -> Writer a b -> Writer a c

(#.) :: Coercible c b => q b c -> Writer a b -> Writer a c

(.#) :: Coercible b a => Writer b c -> q a b -> Writer a c

ProductProfunctor Writer

Defined in Opaleye.Internal.Table

Methods

purePP :: b -> Writer a b

(****) :: Writer a (b -> c) -> Writer a b -> Writer a c

empty :: Writer () ()

(***!) :: Writer a b -> Writer a' b' -> Writer (a, a') (b, b')

Functor (Writer a)

Defined in Opaleye.Internal.Table

Methods

fmap :: (a0 -> b) -> Writer a a0 -> Writer a b

(<$) :: a0 -> Writer a b -> Writer a a0

Applicative (Writer a)

Defined in Opaleye.Internal.Table

Methods

pure :: a0 -> Writer a a0

(<*>) :: Writer a (a0 -> b) -> Writer a a0 -> Writer a b

liftA2 :: (a0 -> b -> c) -> Writer a a0 -> Writer a b -> Writer a c

(*>) :: Writer a a0 -> Writer a b -> Writer a b

(<*) :: Writer a a0 -> Writer a b -> Writer a a0

requiredTableField :: String -> TableFields (Column a) (Column a)

requiredTableField is for fields which are not optional. You must provide them on writes.

optionalTableField :: String -> TableFields (Maybe (Column a)) (Column a)

optionalTableField is for fields that you can omit on writes, such as fields which have defaults or which are SERIAL.

readOnlyTableField :: String -> TableFields () (Column a)

readOnlyTableField is for fields that you must omit on writes, such as SERIAL fields intended to auto-increment only.

required :: String -> TableFields (Column a) (Column a)

Use requiredTableField instead. required will be deprecated in 0.7.

optional :: String -> TableFields (Maybe (Column a)) (Column a)

Use optionalTableField instead. optional will be deprecated in 0.7.

readOnly :: String -> TableFields () (Column a)

Use readOnlyTableField instead. readOnly will be deprecated in 0.7.

class TableColumn writeType sqlType | writeType -> sqlType where

Minimal complete definition

tableField

Methods

tableColumn :: String -> TableFields writeType (Column sqlType)

Do not use. Use tableField instead. Will be deprecated in 0.7.

tableField :: String -> TableFields writeType (Column sqlType)

Infer either a required (requiredTableField) or optional (optionalTableField) field depending on the write type. It's generally more convenient to use this than required or optional but you do have to provide a type signature instead.

Instances

TableColumn (Maybe (Column a)) a

Defined in Opaleye.Internal.Table

Methods

tableColumn :: String -> TableFields (Maybe (Column a)) (Column a)

tableField :: String -> TableFields (Maybe (Column a)) (Column a)

TableColumn (Column a) a

Defined in Opaleye.Internal.Table

Methods

tableColumn :: String -> TableFields (Column a) (Column a)

tableField :: String -> TableFields (Column a) (Column a)

queryTable :: Unpackspec viewColumns columns -> Table writeColumns viewColumns -> Tag -> (columns, PrimQuery)

runColumnMaker :: Unpackspec tablecolumns columns -> Tag -> tablecolumns -> (columns, [(Symbol, PrimExpr)])

runWriter :: Writer columns columns' -> columns -> [(PrimExpr, String)]

runWriter' :: Writer columns columns' -> NonEmpty columns -> (NonEmpty [PrimExpr], [String])

newtype Zip a

Constructors

Zip

Fields

• unZip :: NonEmpty [a]

Instances

Semigroup (Zip a)

Defined in Opaleye.Internal.Table

Methods

(<>) :: Zip a -> Zip a -> Zip a

sconcat :: NonEmpty (Zip a) -> Zip a

stimes :: Integral b => b -> Zip a -> Zip a

Monoid (Zip a)

Defined in Opaleye.Internal.Table

Methods

mempty :: Zip a

mappend :: Zip a -> Zip a -> Zip a

mconcat :: [Zip a] -> Zip a

requiredW :: String -> Writer (Column a) (Column a)

optionalW :: String -> Writer (Maybe (Column a)) (Column a)