Safe Haskell	None
Language	Haskell2010

Opaleye.Table

Contents

Creating tables
Querying tables
Other
Deprecated
Module reexport

Description

Columns can be required or optional and, independently, nullable or non-nullable.

A required non-nullable SqlInt4 (for example) is created with required and gives rise to a

TableFields (Column SqlInt4) (Column SqlInt4)

The leftmost argument is the type of writes. When you insert or update into this column you must give it a Column SqlInt4 (which you can create with sqlInt4 :: Int -> Column SqlInt4).

A required nullable SqlInt4 is created with required and gives rise to a

TableFields (Column (Nullable SqlInt4)) (Column (Nullable SqlInt4))

When you insert or update into this column you must give it a Column (Nullable SqlInt4), which you can create either with sqlInt4 and toNullable :: Column a -> Column (Nullable a), or with null :: Column (Nullable a).

An optional non-nullable SqlInt4 is created with optional and gives rise to a

TableFields (Maybe (Column SqlInt4)) (Column SqlInt4)

Optional columns are those that can be omitted on writes, such as those that have DEFAULTs or those that are SERIAL. When you insert or update into this column you must give it a Maybe (Column SqlInt4). If you provide Nothing then the column will be omitted from the query and the default value will be used. Otherwise you have to provide a Just containing a Column SqlInt4.

An optional nullable SqlInt4 is created with optional and gives rise to a

TableFields (Maybe (Column (Nullable SqlInt4))) (Column (Nullable SqlInt4))

Optional columns are those that can be omitted on writes, such as those that have DEFAULTs or those that are SERIAL. When you insert or update into this column you must give it a Maybe (Column (Nullable SqlInt4)). If you provide Nothing then the default value will be used. Otherwise you have to provide a Just containing a Column (Nullable SqlInt4) (which can be null).

Synopsis

table :: String -> TableFields writeFields viewFields -> Table writeFields viewFields
tableWithSchema :: String -> String -> TableFields writeFields viewFields -> Table writeFields viewFields
data Table writerColumns viewColumns
tableColumn :: TableColumn writeType sqlType => String -> TableFields writeType (Column sqlType)
tableField :: TableColumn writeType sqlType => String -> TableFields writeType (Column sqlType)
optional :: String -> TableFields (Maybe (Column a)) (Column a)
required :: String -> TableFields (Column a) (Column a)
selectTable :: Default Unpackspec fields fields => Table a fields -> Select fields
type TableColumns = TableProperties
type TableFields = TableProperties
data View columns
data Writer columns dummy
data Table writerColumns viewColumns
- = Table String (TableFields writerColumns viewColumns)
- | TableWithSchema String String (TableFields writerColumns viewColumns)
selectTable :: Default Unpackspec fields fields => Table a fields -> Select fields
table :: String -> TableFields writeFields viewFields -> Table writeFields viewFields
tableWithSchema :: String -> String -> TableFields writeFields viewFields -> Table writeFields viewFields
selectTableExplicit :: Unpackspec tablefields fields -> Table a tablefields -> Select fields
queryTable :: Default Unpackspec fields fields => Table a fields -> Select fields
queryTableExplicit :: Unpackspec tablefields fields -> Table a tablefields -> Select fields

Creating tables

table #

Arguments

:: String	Table name
-> TableFields writeFields viewFields
-> Table writeFields viewFields

Create a table with unqualified names.

tableWithSchema #

Arguments

:: String	Schema name
-> String	Table name
-> TableFields writeFields viewFields
-> Table writeFields viewFields

Create a table.

data Table writerColumns viewColumns #

Instances

Profunctor Table #
Instance details 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) #
Instance details Defined in Opaleye.Internal.Table Methods fmap :: (a0 -> b) -> Table a a0 -> Table a b # (<$) :: a0 -> Table a b -> Table a a0 #

tableColumn :: TableColumn writeType sqlType => String -> TableFields writeType (Column sqlType) #

Infer either a required or optional column 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.

tableField :: TableColumn writeType sqlType => String -> TableFields writeType (Column sqlType) #

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

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

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

required is for columns which are not optional. You must provide them on writes.

Querying tables

selectTable #

Arguments

:: Default Unpackspec fields fields
=> Table a fields
-> Select fields

Example type specialization:

selectTable :: Table w (Column a, Column b)
            -> Select (Column a, Column b)

Assuming the makeAdaptorAndInstance splice has been run for the product type Foo:

selectTable :: Table w (Foo (Column a) (Column b) (Column c))
            -> Select (Foo (Column a) (Column b) (Column c))

Other

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.

Deprecated

data View columns #

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

data Writer columns dummy #

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

Instances

Profunctor Writer #
Instance details 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 #
Instance details 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) #
Instance details 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) #
Instance details 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 #

data Table writerColumns viewColumns #

Constructors

Table String (TableFields writerColumns viewColumns)	For unqualified table names. Do not use the constructor. It is internal and will be deprecated in version 0.7.
TableWithSchema String String (TableFields writerColumns viewColumns)	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 #
Instance details 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) #
Instance details Defined in Opaleye.Internal.Table Methods fmap :: (a0 -> b) -> Table a a0 -> Table a b # (<$) :: a0 -> Table a b -> Table a a0 #

Module reexport

selectTable #

Arguments

:: Default Unpackspec fields fields
=> Table a fields
-> Select fields

Example type specialization:

selectTable :: Table w (Column a, Column b)
            -> Select (Column a, Column b)

Assuming the makeAdaptorAndInstance splice has been run for the product type Foo:

selectTable :: Table w (Foo (Column a) (Column b) (Column c))
            -> Select (Foo (Column a) (Column b) (Column c))

table #

Arguments

:: String	Table name
-> TableFields writeFields viewFields
-> Table writeFields viewFields

Create a table with unqualified names.

tableWithSchema #

Arguments

:: String	Schema name
-> String	Table name
-> TableFields writeFields viewFields
-> Table writeFields viewFields

Create a table.

selectTableExplicit #

Arguments

:: Unpackspec tablefields fields
-> Table a tablefields
-> Select fields

queryTable :: Default Unpackspec fields fields => Table a fields -> Select fields #

Use selectTable instead. Will be deprecated in version 0.7.

queryTableExplicit :: Unpackspec tablefields fields -> Table a tablefields -> Select fields #

Use selectTableExplicit instead. Will be deprecated in version 0.7.