Opaleye.Column

Functions for working directly with Columns.

Please note that numeric Column types are instances of Num, so you can use *, /, +, - on them.

Column

data Column pgType

A column of a Query, of type pgType. For example Column PGInt4 is an int4 column and a Column PGText is a text column.

Do not use the Show instance of Column. It is considered deprecated and will be removed in version 0.7.

Instances

Default ViewColumnMaker String (Column a)

Defined in Opaleye.Internal.TableMaker

Methods

def :: ViewColumnMaker String (Column a)

Default RelExprMaker String (Column a)

Defined in Opaleye.Internal.Operators

Methods

def :: RelExprMaker String (Column a)

Default Constant Bool (Column SqlBool)

Defined in Opaleye.Constant

Methods

def :: Constant Bool (Column SqlBool)

Default Constant Double (Column SqlFloat8)

Defined in Opaleye.Constant

Methods

def :: Constant Double (Column SqlFloat8)

Default Constant Int (Column SqlInt4)

Defined in Opaleye.Constant

Methods

def :: Constant Int (Column SqlInt4)

Default Constant Int32 (Column SqlInt4)

Defined in Opaleye.Constant

Methods

def :: Constant Int32 (Column SqlInt4)

Default Constant Int64 (Column SqlInt8)

Defined in Opaleye.Constant

Methods

def :: Constant Int64 (Column SqlInt8)

Default Constant ByteString (Column SqlJsonb)

Defined in Opaleye.Constant

Methods

def :: Constant ByteString (Column SqlJsonb)

Default Constant ByteString (Column SqlJson)

Defined in Opaleye.Constant

Methods

def :: Constant ByteString (Column SqlJson)

Default Constant ByteString (Column SqlBytea)

Defined in Opaleye.Constant

Methods

def :: Constant ByteString (Column SqlBytea)

Default Constant ByteString (Column SqlJsonb)

Defined in Opaleye.Constant

Methods

def :: Constant ByteString (Column SqlJsonb)

Default Constant ByteString (Column SqlJson)

Defined in Opaleye.Constant

Methods

def :: Constant ByteString (Column SqlJson)

Default Constant ByteString (Column SqlBytea)

Defined in Opaleye.Constant

Methods

def :: Constant ByteString (Column SqlBytea)

Default Constant Scientific (Column SqlNumeric)

Defined in Opaleye.Constant

Methods

def :: Constant Scientific (Column SqlNumeric)

Default Constant String (Column SqlText)

Defined in Opaleye.Constant

Methods

def :: Constant String (Column SqlText)

Default Constant Text (Column SqlText)

Defined in Opaleye.Constant

Methods

def :: Constant Text (Column SqlText)

Default Constant UTCTime (Column SqlTimestamptz)

Defined in Opaleye.Constant

Methods

def :: Constant UTCTime (Column SqlTimestamptz)

Default Constant Value (Column SqlJsonb)

Defined in Opaleye.Constant

Methods

def :: Constant Value (Column SqlJsonb)

Default Constant Value (Column SqlJson)

Defined in Opaleye.Constant

Methods

def :: Constant Value (Column SqlJson)

Default Constant Text (Column SqlText)

Defined in Opaleye.Constant

Methods

def :: Constant Text (Column SqlText)

Default Constant ZonedTime (Column SqlTimestamptz)

Defined in Opaleye.Constant

Methods

def :: Constant ZonedTime (Column SqlTimestamptz)

Default Constant LocalTime (Column SqlTimestamp)

Defined in Opaleye.Constant

Methods

def :: Constant LocalTime (Column SqlTimestamp)

Default Constant TimeOfDay (Column SqlTime)

Defined in Opaleye.Constant

Methods

def :: Constant TimeOfDay (Column SqlTime)

Default Constant Day (Column SqlDate)

Defined in Opaleye.Constant

Methods

def :: Constant Day (Column SqlDate)

Default Constant UUID (Column SqlUuid)

Defined in Opaleye.Constant

Methods

def :: Constant UUID (Column SqlUuid)

QueryRunnerColumnDefault a b => Default QueryRunner (Column a) b

Defined in Opaleye.Internal.RunQuery

Methods

def :: QueryRunner (Column a) b

Default Unpackspec (Column a) (Column a)

Defined in Opaleye.Internal.Unpackspec

Methods

def :: Unpackspec (Column a) (Column a)

Default Valuesspec (Column a) (Column a)

Defined in Opaleye.Internal.Values

Methods

def :: Valuesspec (Column a) (Column a)

Default Binaryspec (Column a) (Column a)

Defined in Opaleye.Internal.Binary

Methods

def :: Binaryspec (Column a) (Column a)

Default IfPP (Column a) (Column a)

Defined in Opaleye.Internal.Operators

Methods

def :: IfPP (Column a) (Column a)

Default EqPP (Column a) (Column a)

Defined in Opaleye.Internal.Operators

Methods

def :: EqPP (Column a) (Column a)

Default NullMaker (Column a) (Column (Nullable a))

Defined in Opaleye.Internal.Join

Methods

def :: NullMaker (Column a) (Column (Nullable a))

Default NullMaker (Column (Nullable a)) (Column (Nullable a))

Defined in Opaleye.Internal.Join

Methods

def :: NullMaker (Column (Nullable a)) (Column (Nullable a))

(Default Constant a (Column b), IsSqlType b) => Default Constant [a] (Column (SqlArray b))

Defined in Opaleye.Constant

Methods

def :: Constant [a] (Column (SqlArray b))

Default Constant haskell (Column sql) => Default Constant (Maybe haskell) (Maybe (Column sql))

Defined in Opaleye.Constant

Methods

def :: Constant (Maybe haskell) (Maybe (Column sql))

Default Constant haskell (Column sql) => Default Constant (Maybe haskell) (Column (Nullable sql))

Defined in Opaleye.Constant

Methods

def :: Constant (Maybe haskell) (Column (Nullable sql))

Default Constant (CI Text) (Column SqlCitext)

Defined in Opaleye.Constant

Methods

def :: Constant (CI Text) (Column SqlCitext)

Default Constant (CI Text) (Column SqlCitext)

Defined in Opaleye.Constant

Methods

def :: Constant (CI Text) (Column SqlCitext)

Default Constant (PGRange Int) (Column (SqlRange SqlInt4))

Defined in Opaleye.Constant

Methods

def :: Constant (PGRange Int) (Column (SqlRange SqlInt4))

Default Constant (PGRange Int64) (Column (SqlRange SqlInt8))

Defined in Opaleye.Constant

Methods

def :: Constant (PGRange Int64) (Column (SqlRange SqlInt8))

Default Constant (PGRange Scientific) (Column (SqlRange SqlNumeric))

Defined in Opaleye.Constant

Methods

def :: Constant (PGRange Scientific) (Column (SqlRange SqlNumeric))

Default Constant (PGRange UTCTime) (Column (SqlRange SqlTimestamptz))

Defined in Opaleye.Constant

Methods

def :: Constant (PGRange UTCTime) (Column (SqlRange SqlTimestamptz))

Default Constant (PGRange LocalTime) (Column (SqlRange SqlTimestamp))

Defined in Opaleye.Constant

Methods

def :: Constant (PGRange LocalTime) (Column (SqlRange SqlTimestamp))

Default Constant (PGRange Day) (Column (SqlRange SqlDate))

Defined in Opaleye.Constant

Methods

def :: Constant (PGRange Day) (Column (SqlRange SqlDate))

Default Distinctspec (Column a) (Column a)

Defined in Opaleye.Internal.Distinct

Methods

def :: Distinctspec (Column a) (Column a)

Default Updater (Column a) (Maybe (Column a))

Defined in Opaleye.Internal.Manipulation

Methods

def :: Updater (Column a) (Maybe (Column a))

Default Updater (Column a) (Column a)

Defined in Opaleye.Internal.Manipulation

Methods

def :: Updater (Column a) (Column a)

(SqlNum a, SqlFractional a) => Fractional (Column a)

Defined in Opaleye.Internal.Column

Methods

(/) :: Column a -> Column a -> Column a

recip :: Column a -> Column a

fromRational :: Rational -> Column a

SqlNum a => Num (Column a)

Defined in Opaleye.Internal.Column

Methods

(+) :: Column a -> Column a -> Column a

(-) :: Column a -> Column a -> Column a

(*) :: Column a -> Column a -> Column a

negate :: Column a -> Column a

abs :: Column a -> Column a

signum :: Column a -> Column a

fromInteger :: Integer -> Column a

Show (Column pgType)

Defined in Opaleye.Internal.Column

Methods

showsPrec :: Int -> Column pgType -> ShowS

show :: Column pgType -> String

showList :: [Column pgType] -> ShowS

SqlString a => IsString (Column a)

Defined in Opaleye.Internal.Column

Methods

fromString :: String -> Column a

TableColumn (Maybe (Column a)) a

Defined in Opaleye.Internal.Table

Methods

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

TableColumn (Column a) a

Defined in Opaleye.Internal.Table

Methods

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

type Map Nulled (Column (Nullable a))

Defined in Opaleye.Internal.Join

type Map Nulled (Column (Nullable a)) = Column (Nullable a)

type Map Nulled (Column PGJsonb)

Defined in Opaleye.Internal.Join

type Map Nulled (Column PGJsonb) = Column (Nullable PGJsonb)

type Map Nulled (Column PGJson)

Defined in Opaleye.Internal.Join

type Map Nulled (Column PGJson) = Column (Nullable PGJson)

type Map Nulled (Column PGBytea)

Defined in Opaleye.Internal.Join

type Map Nulled (Column PGBytea) = Column (Nullable PGBytea)

type Map Nulled (Column PGCitext)

Defined in Opaleye.Internal.Join

type Map Nulled (Column PGCitext) = Column (Nullable PGCitext)

type Map Nulled (Column PGUuid)

Defined in Opaleye.Internal.Join

type Map Nulled (Column PGUuid) = Column (Nullable PGUuid)

type Map Nulled (Column PGTimestamptz)

Defined in Opaleye.Internal.Join

type Map Nulled (Column PGTimestamptz) = Column (Nullable PGTimestamptz)

type Map Nulled (Column PGTimestamp)

Defined in Opaleye.Internal.Join

type Map Nulled (Column PGTimestamp) = Column (Nullable PGTimestamp)

type Map Nulled (Column PGTime)

Defined in Opaleye.Internal.Join

type Map Nulled (Column PGTime) = Column (Nullable PGTime)

type Map Nulled (Column PGText)

Defined in Opaleye.Internal.Join

type Map Nulled (Column PGText) = Column (Nullable PGText)

type Map Nulled (Column PGText)

Defined in Opaleye.Internal.Join

type Map Nulled (Column PGText) = Column (Nullable PGText)

type Map Nulled (Column PGInt4)

Defined in Opaleye.Internal.Join

type Map Nulled (Column PGInt4) = Column (Nullable PGInt4)

type Map Nulled (Column PGInt8)

Defined in Opaleye.Internal.Join

type Map Nulled (Column PGInt8) = Column (Nullable PGInt8)

type Map Nulled (Column PGFloat8)

Defined in Opaleye.Internal.Join

type Map Nulled (Column PGFloat8) = Column (Nullable PGFloat8)

type Map Nulled (Column PGDate)

Defined in Opaleye.Internal.Join

type Map Nulled (Column PGDate) = Column (Nullable PGDate)

type Map Nulled (Column PGBool)

Defined in Opaleye.Internal.Join

type Map Nulled (Column PGBool) = Column (Nullable PGBool)

Working with NULL

data Nullable a

Only used within a Column, to indicate that it can be NULL. For example, a Column (Nullable PGText) can be NULL but a Column PGText cannot.

Instances

Default NullMaker (Column a) (Column (Nullable a))

Defined in Opaleye.Internal.Join

Methods

def :: NullMaker (Column a) (Column (Nullable a))

Default NullMaker (Column (Nullable a)) (Column (Nullable a))

Defined in Opaleye.Internal.Join

Methods

def :: NullMaker (Column (Nullable a)) (Column (Nullable a))

Default Constant haskell (Column sql) => Default Constant (Maybe haskell) (Column (Nullable sql))

Defined in Opaleye.Constant

Methods

def :: Constant (Maybe haskell) (Column (Nullable sql))

IsSqlType a => IsSqlType (Nullable a)

Defined in Opaleye.PGTypes

Methods

showPGType :: proxy (Nullable a) -> String

showSqlType :: proxy (Nullable a) -> String

PGOrd a => PGOrd (Nullable a)

Defined in Opaleye.Order

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

Defined in Opaleye.Internal.RunQuery

Methods

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

type Map Nulled (Column (Nullable a))

Defined in Opaleye.Internal.Join

type Map Nulled (Column (Nullable a)) = Column (Nullable a)

null :: Column (Nullable a)

A NULL of any type

isNull :: Column (Nullable a) -> Column PGBool

TRUE if the value of the column is NULL, FALSE otherwise.

matchNullable :: Column b -> (Column a -> Column b) -> Column (Nullable a) -> Column b

If the Column (Nullable a) is NULL then return the Column b otherwise map the underlying Column a using the provided function.

The Opaleye equivalent of maybe.

fromNullable :: Column a -> Column (Nullable a) -> Column a

If the Column (Nullable a) is NULL then return the provided Column a otherwise return the underlying Column a.

The Opaleye equivalent of fromMaybe and very similar to PostgreSQL's COALESCE.

toNullable :: Column a -> Column (Nullable a)

Treat a column as though it were nullable. This is always safe.

The Opaleye equivalent of Just.

maybeToNullable :: Maybe (Column a) -> Column (Nullable a)

If the argument is Nothing return NULL otherwise return the provided value coerced to a nullable type.

Unsafe operations

unsafeCast :: String -> Column a -> Column b

Cast a column to any other type. Implements Postgres's :: or CAST( ... AS ... ) operations. This is safe for some conversions, such as uuid to text.

unsafeCoerceColumn :: Column a -> Column b

Treat a Column as though it were of a different type. If such a treatment is not valid then Postgres may fail with an error at SQL run time.

unsafeCompositeField :: Column a -> String -> Column b

Entire module

null :: Column (Nullable a)

A NULL of any type

isNull :: Column (Nullable a) -> Column PGBool

TRUE if the value of the column is NULL, FALSE otherwise.

matchNullable :: Column b -> (Column a -> Column b) -> Column (Nullable a) -> Column b

If the Column (Nullable a) is NULL then return the Column b otherwise map the underlying Column a using the provided function.

The Opaleye equivalent of maybe.

fromNullable :: Column a -> Column (Nullable a) -> Column a

If the Column (Nullable a) is NULL then return the provided Column a otherwise return the underlying Column a.

The Opaleye equivalent of fromMaybe and very similar to PostgreSQL's COALESCE.

toNullable :: Column a -> Column (Nullable a)

Treat a column as though it were nullable. This is always safe.

The Opaleye equivalent of Just.

maybeToNullable :: Maybe (Column a) -> Column (Nullable a)

If the argument is Nothing return NULL otherwise return the provided value coerced to a nullable type.

joinNullable :: Column (Nullable (Nullable a)) -> Column (Nullable a)