Opaleye.Internal.RunQuery

Documentation

data FromField pgType haskellType

A FromField 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".

Constructors

QueryRunnerColumn (Unpackspec (Column pgType) ()) (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

bytestring ~ ByteString => Default (Inferrable FromField) SqlBytea bytestring

Defined in Opaleye.Internal.Inferrable

Methods

def :: Inferrable FromField SqlBytea bytestring

cttext ~ CI Text => Default (Inferrable FromField) SqlCitext cttext

Defined in Opaleye.Internal.Inferrable

Methods

def :: Inferrable FromField SqlCitext cttext

uuid ~ UUID => Default (Inferrable FromField) SqlUuid uuid

Defined in Opaleye.Internal.Inferrable

Methods

def :: Inferrable FromField SqlUuid uuid

localtime ~ LocalTime => Default (Inferrable FromField) SqlTimestamp localtime

Defined in Opaleye.Internal.Inferrable

Methods

def :: Inferrable FromField SqlTimestamp localtime

timeofday ~ TimeOfDay => Default (Inferrable FromField) SqlTime timeofday

Defined in Opaleye.Internal.Inferrable

Methods

def :: Inferrable FromField SqlTime timeofday

text ~ Text => Default (Inferrable FromField) SqlText text

Defined in Opaleye.Internal.Inferrable

Methods

def :: Inferrable FromField SqlText text

scientific ~ Scientific => Default (Inferrable FromField) SqlNumeric scientific

Defined in Opaleye.Internal.Inferrable

Methods

def :: Inferrable FromField SqlNumeric scientific

int ~ Int => Default (Inferrable FromField) SqlInt4 int

Defined in Opaleye.Internal.Inferrable

Methods

def :: Inferrable FromField SqlInt4 int

int64 ~ Int64 => Default (Inferrable FromField) SqlInt8 int64

Defined in Opaleye.Internal.Inferrable

Methods

def :: Inferrable FromField SqlInt8 int64

double ~ Double => Default (Inferrable FromField) SqlFloat8 double

Defined in Opaleye.Internal.Inferrable

Methods

def :: Inferrable FromField SqlFloat8 double

day ~ Day => Default (Inferrable FromField) SqlDate day

Defined in Opaleye.Internal.Inferrable

Methods

def :: Inferrable FromField SqlDate day

bool ~ Bool => Default (Inferrable FromField) SqlBool bool

Defined in Opaleye.Internal.Inferrable

Methods

def :: Inferrable FromField SqlBool bool

(Typeable h, Default (Inferrable FromField) f h, hs ~ [h]) => Default (Inferrable FromField) (SqlArray f) hs

Defined in Opaleye.Internal.Inferrable

Methods

def :: Inferrable FromField (SqlArray f) hs

type QueryRunnerColumn = FromField

data FromFields columns haskells

A FromFields 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".

Constructors

QueryRunner (Unpackspec columns ()) (columns -> RowParser haskells) (columns -> Int)

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

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

(.#) :: forall a b c q. 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

Default FromFields fields haskells => Default FromFields (MaybeFields fields) (Maybe haskells)

Defined in Opaleye.Internal.MaybeFields

Methods

def :: FromFields (MaybeFields fields) (Maybe haskells)

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

Default (Inferrable FromField) a b => Default (Inferrable FromFields) (Column a) b

Defined in Opaleye.Internal.Inferrable

Methods

def :: Inferrable FromFields (Column a) b

(Default (Inferrable FromField) a b, Maybe b ~ maybe_b) => Default (Inferrable FromFields) (Column (Nullable a)) maybe_b

Defined in Opaleye.Internal.Inferrable

Methods

def :: Inferrable FromFields (Column (Nullable a)) maybe_b

(Default (Inferrable FromFields) fields haskells, Maybe haskells ~ maybe_haskells) => Default (Inferrable FromFields) (MaybeFields fields) maybe_haskells

Defined in Opaleye.Internal.MaybeFields

Methods

def :: Inferrable FromFields (MaybeFields fields) maybe_haskells

type QueryRunner = FromFields

fieldQueryRunnerColumn :: FromField haskell => FromField pgType haskell

fromPGSFromField :: FromField haskell => FromField pgType haskell

fieldParserQueryRunnerColumn :: FieldParser haskell -> FromField pgType haskell

fromPGSFieldParser :: FieldParser haskell -> FromField pgType haskell

queryRunner :: FromField a b -> FromFields (Column a) b

queryRunnerColumnNullable :: FromField a b -> FromField (Nullable a) (Maybe b)

unsafeFromFieldRaw :: FromField a (Field, Maybe ByteString)

class DefaultFromField sqlType haskellType where

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

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

Creating an instance of DefaultFromField 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 DefaultFromField 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

Deprecated: Use defaultFromField instead. It will be removed in 0.8

defaultFromField :: FromField sqlType haskellType

Instances

DefaultFromField SqlJsonb String

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField SqlJsonb String

defaultFromField :: FromField SqlJsonb String

DefaultFromField SqlJsonb Value

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField SqlJsonb Value

defaultFromField :: FromField SqlJsonb Value

DefaultFromField SqlJson String

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField SqlJson String

defaultFromField :: FromField SqlJson String

DefaultFromField SqlJson Value

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField SqlJson Value

defaultFromField :: FromField SqlJson Value

DefaultFromField SqlBytea ByteString

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField SqlBytea ByteString

defaultFromField :: FromField SqlBytea ByteString

DefaultFromField SqlBytea ByteString

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField SqlBytea ByteString

defaultFromField :: FromField SqlBytea ByteString

DefaultFromField SqlUuid UUID

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField SqlUuid UUID

defaultFromField :: FromField SqlUuid UUID

DefaultFromField SqlTimestamptz UTCTime

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField SqlTimestamptz UTCTime

defaultFromField :: FromField SqlTimestamptz UTCTime

DefaultFromField SqlTimestamptz ZonedTime

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField SqlTimestamptz ZonedTime

defaultFromField :: FromField SqlTimestamptz ZonedTime

DefaultFromField SqlTimestamp LocalTime

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField SqlTimestamp LocalTime

defaultFromField :: FromField SqlTimestamp LocalTime

DefaultFromField SqlTime TimeOfDay

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField SqlTime TimeOfDay

defaultFromField :: FromField SqlTime TimeOfDay

DefaultFromField SqlText String

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField SqlText String

defaultFromField :: FromField SqlText String

DefaultFromField SqlText Text

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField SqlText Text

defaultFromField :: FromField SqlText Text

DefaultFromField SqlText Text

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField SqlText Text

defaultFromField :: FromField SqlText Text

DefaultFromField SqlNumeric Scientific

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField SqlNumeric Scientific

defaultFromField :: FromField SqlNumeric Scientific

DefaultFromField SqlInt4 Int

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField SqlInt4 Int

defaultFromField :: FromField SqlInt4 Int

DefaultFromField SqlInt4 Int32

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField SqlInt4 Int32

defaultFromField :: FromField SqlInt4 Int32

DefaultFromField SqlInt8 Int64

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField SqlInt8 Int64

defaultFromField :: FromField SqlInt8 Int64

DefaultFromField SqlFloat8 Double

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField SqlFloat8 Double

defaultFromField :: FromField SqlFloat8 Double

DefaultFromField SqlDate Day

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField SqlDate Day

defaultFromField :: FromField SqlDate Day

DefaultFromField SqlBool Bool

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField SqlBool Bool

defaultFromField :: FromField SqlBool Bool

DefaultFromField SqlCitext (CI Text)

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField SqlCitext (CI Text)

defaultFromField :: FromField SqlCitext (CI Text)

DefaultFromField SqlCitext (CI Text)

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField SqlCitext (CI Text)

defaultFromField :: FromField SqlCitext (CI Text)

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

Defined in Opaleye.Internal.RunQuery

Methods

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

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

(Typeable b, DefaultFromField a b) => DefaultFromField (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) => DefaultFromField (SqlArray a) [b]

Defined in Opaleye.Internal.RunQuery

Methods

queryRunnerColumnDefault :: FromField (SqlArray a) [b]

defaultFromField :: FromField (SqlArray a) [b]

type QueryRunnerColumnDefault = DefaultFromField

arrayColumn :: Column (SqlArray a) -> Column a

fromFieldArray :: Typeable h => FromField f h -> FromField (SqlArray f) [h]

fromFieldRange :: Typeable b => FromField a b -> FromField (PGRange a) (PGRange b)

jsonFieldParser :: FieldParser String

jsonbFieldParser :: FieldParser String

jsonFieldTypeParser :: ByteString -> FieldParser String

prepareRowParser :: FromFields columns haskells -> columns -> RowParser haskells

data Cursor haskells

Cursor within a transaction.

Constructors

EmptyCursor

Cursor (RowParser haskells) Cursor

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