Opaleye.RunQuery

This module will be deprecated in 0.7. Use Opaleye.RunSelect instead.

Documentation

runQuery :: Default FromFields fields haskells => Connection -> Select fields -> IO [haskells]

Use runSelect instead. runQuery will be deprecated in 0.7.

runQueryFold :: Default FromFields fields haskells => Connection -> Select fields -> b -> (b -> haskells -> IO b) -> IO b

Use runSelectFold instead. runQueryFold will be deprecated in 0.7.

queryRunnerColumn :: (Column a' -> Column a) -> (b -> b') -> FromField a b -> FromField a' b'

Use unsafeFromField instead. queryRunnerColumn will be deprecated in 0.7.

runQueryExplicit :: FromFields fields haskells -> Connection -> Select fields -> IO [haskells]

Use runSelectExplict instead. Will be deprecated in 0.7.

runQueryFoldExplicit :: FromFields fields haskells -> Connection -> Select fields -> b -> (b -> haskells -> IO b) -> IO b

Use runSelectFoldExplict instead. Will be deprecated in 0.7.

declareCursor :: Default FromFields fields haskells => Connection -> Select fields -> IO (Cursor haskells)

Use declareCursor instead. Will be deprecated in 0.7.

declareCursorExplicit :: FromFields fields haskells -> Connection -> Select fields -> IO (Cursor haskells)

Use declareCursorExplicit instead. Will be deprecated in 0.7.

closeCursor :: Cursor fields -> IO ()

Use closeCursor instead. Will be deprecated in 0.7.

foldForward :: Cursor haskells -> Int -> (a -> haskells -> IO a) -> a -> IO (Either a a)

Use foldForward instead. Will be deprecated in 0.7.

prepareQuery :: FromFields fields haskells -> Select fields -> (Maybe Query, RowParser haskells)

Deprecated: Will be removed in version 0.7

Datatypes

data Cursor haskells

Cursor within a transaction.

type FromFields = QueryRunner

type FromField = QueryRunnerColumn

data QueryRunner columns haskells

A FromFields (or the old name QueryRunner) specifies how to convert Postgres values (fields) into Haskell values (haskells). Most likely you will never need to create on of these or handle one directly. It will be provided for you by the Default FromFields instance.

"FromFields fields haskells" corresponds to postgresql-simple's "RowParser haskells". "Default FromFields columns haskells" corresponds to postgresql-simple's "FromRow haskells".

Instances

Profunctor FromFields

Defined in Opaleye.Internal.RunQuery

Methods

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

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

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

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

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

ProductProfunctor FromFields

Defined in Opaleye.Internal.RunQuery

Methods

purePP :: b -> FromFields a b

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

empty :: FromFields () ()

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

SumProfunctor FromFields

Defined in Opaleye.Internal.RunQuery

Methods

(+++!) :: FromFields a b -> FromFields a' b' -> FromFields (Either a a') (Either b b')

DefaultFromField a b => Default FromFields (Column a) b

Defined in Opaleye.Internal.RunQuery

Methods

def :: FromFields (Column a) b

Functor (FromFields c)

Defined in Opaleye.Internal.RunQuery

Methods

fmap :: (a -> b) -> FromFields c a -> FromFields c b

(<$) :: a -> FromFields c b -> FromFields c a

Applicative (FromFields c)

Defined in Opaleye.Internal.RunQuery

Methods

pure :: a -> FromFields c a

(<*>) :: FromFields c (a -> b) -> FromFields c a -> FromFields c b

liftA2 :: (a -> b -> c0) -> FromFields c a -> FromFields c b -> FromFields c c0

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

(<*) :: FromFields c a -> FromFields c b -> FromFields c a

data QueryRunnerColumn pgType haskellType

A FromField sqlType haskellType (or the old name, QueryRunnerColumn sqlType haskellType) encodes how to turn a value of Postgres type sqlType into a value of Haskell type haskellType. For example a value of type FromField SqlText String encodes how to turn a SqlText result from the database into a Haskell String.

"FromField sqlType haskellType" corresponds to postgresql-simple's "FieldParser haskellType".

Instances

DefaultFromField sqlType haskellType => Default FromField sqlType haskellType

Defined in Opaleye.Internal.RunQuery

Methods

def :: FromField sqlType haskellType

Functor (FromField u)

Defined in Opaleye.Internal.RunQuery

Methods

fmap :: (a -> b) -> FromField u a -> FromField u b

(<$) :: a -> FromField u b -> FromField u a

class QueryRunnerColumnDefault sqlType haskellType where

(Note that a better name for this class would be DefaultFromField and it probably will have this name in version 0.7. When you see QueryRunnerColumnDefault please read DefaultFromField instead. That will probably make things easier to understand.)

A QueryRunnerColumnDefault sqlType haskellType represents the default way to turn a sqlType result from the database into a Haskell value of type haskellType.

"QueryRunnerColumnDefault sqlType haskellType" corresponds to postgresql-simple's "FromField haskellType".

Creating an instance of QueryRunnerColumnDefault for your own types is necessary for retrieving those types from the database.

You should use one of the three methods below for writing a QueryRunnerColumnDefault instance.

1. If you already have a postgresql-simple FromField instance for your haskellType, use fromPGSFromField. (This is how most of the built-in instances are defined.)
2. If you don't have a postgresql-simple FromField instance, but you do have an Opaleye FromField value for the type it wraps use unsafeFromField if possible. See the documentation for unsafeFromField for an example.
3. If you have a more complicated case, but not a FromField instance, write a FieldParser for your type and use fromPGSFieldParser. You can also add a FromField instance using this.

Minimal complete definition

queryRunnerColumnDefault | defaultFromField

Methods

queryRunnerColumnDefault :: FromField sqlType haskellType

Do not use queryRunnerColumnDefault. It will be deprecated in version 0.7.

defaultFromField :: FromField sqlType haskellType

Instances

QueryRunnerColumnDefault PGJsonb Value

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField PGJsonb Value

defaultFromField :: FromField PGJsonb Value

QueryRunnerColumnDefault PGJsonb String

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField PGJsonb String

defaultFromField :: FromField PGJsonb String

QueryRunnerColumnDefault PGJson Value

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField PGJson Value

defaultFromField :: FromField PGJson Value

QueryRunnerColumnDefault PGJson String

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField PGJson String

defaultFromField :: FromField PGJson String

QueryRunnerColumnDefault PGBytea ByteString

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField PGBytea ByteString

defaultFromField :: FromField PGBytea ByteString

QueryRunnerColumnDefault PGBytea ByteString

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField PGBytea ByteString

defaultFromField :: FromField PGBytea ByteString

QueryRunnerColumnDefault PGUuid UUID

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField PGUuid UUID

defaultFromField :: FromField PGUuid UUID

QueryRunnerColumnDefault PGTimestamptz UTCTime

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField PGTimestamptz UTCTime

defaultFromField :: FromField PGTimestamptz UTCTime

QueryRunnerColumnDefault PGTimestamptz ZonedTime

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField PGTimestamptz ZonedTime

defaultFromField :: FromField PGTimestamptz ZonedTime

QueryRunnerColumnDefault PGTimestamp LocalTime

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField PGTimestamp LocalTime

defaultFromField :: FromField PGTimestamp LocalTime

QueryRunnerColumnDefault PGTime TimeOfDay

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField PGTime TimeOfDay

defaultFromField :: FromField PGTime TimeOfDay

QueryRunnerColumnDefault PGText Text

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField PGText Text

defaultFromField :: FromField PGText Text

QueryRunnerColumnDefault PGText Text

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField PGText Text

defaultFromField :: FromField PGText Text

QueryRunnerColumnDefault PGText String

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField PGText String

defaultFromField :: FromField PGText String

QueryRunnerColumnDefault PGNumeric Scientific

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField PGNumeric Scientific

defaultFromField :: FromField PGNumeric Scientific

QueryRunnerColumnDefault PGInt4 Int

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField PGInt4 Int

defaultFromField :: FromField PGInt4 Int

QueryRunnerColumnDefault PGInt4 Int32

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField PGInt4 Int32

defaultFromField :: FromField PGInt4 Int32

QueryRunnerColumnDefault PGInt8 Int64

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField PGInt8 Int64

defaultFromField :: FromField PGInt8 Int64

QueryRunnerColumnDefault PGFloat8 Double

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField PGFloat8 Double

defaultFromField :: FromField PGFloat8 Double

QueryRunnerColumnDefault PGDate Day

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField PGDate Day

defaultFromField :: FromField PGDate Day

QueryRunnerColumnDefault PGBool Bool

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField PGBool Bool

defaultFromField :: FromField PGBool Bool

QueryRunnerColumnDefault PGCitext (CI Text)

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField PGCitext (CI Text)

defaultFromField :: FromField PGCitext (CI Text)

QueryRunnerColumnDefault PGCitext (CI Text)

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField PGCitext (CI Text)

defaultFromField :: FromField PGCitext (CI Text)

DefaultFromField a b => QueryRunnerColumnDefault (Nullable a) (Maybe b)

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField (Nullable a) (Maybe b)

defaultFromField :: FromField (Nullable a) (Maybe b)

(Typeable b, FromField b, DefaultFromField a b) => QueryRunnerColumnDefault (PGRange a) (PGRange b)

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField (PGRange a) (PGRange0 b)

defaultFromField :: FromField (PGRange a) (PGRange0 b)

(Typeable b, DefaultFromField a b) => QueryRunnerColumnDefault (PGArray a) [b]

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField (PGArray a) [b]

defaultFromField :: FromField (PGArray a) [b]

Creating new QueryRunnerColumns

fieldQueryRunnerColumn :: FromField haskell => FromField pgType haskell

fieldParserQueryRunnerColumn :: FieldParser haskell -> FromField pgType haskell