Opaleye.Field

Functions for working directly with Field_s.

Please note that numeric Field_ types are instances of Num, so you can use *, /, +, - on them. To create Field_s, see Opaleye.ToFields and Opaleye.SqlTypes.

Field_ used to be called Column and for technical reasons there are still a few uses of the old name around. If you see Column SqlType then you can understand it as Field SqlType, and if you see Column (Nullable SqlType) then you can understand it as FieldNullable SqlType.

Column will be fully deprecated in version 0.10.

Documentation

data Field_ (n :: Nullability) sqlType

A field of a Select, of type sqlType. For example a Field SqlInt4 is an int4 column and a Field SqlText is a text column.

Instances

Default ToFields Bool (Field SqlBool)

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields Bool (Field SqlBool)

Default ToFields Double (Field SqlFloat8)

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields Double (Field SqlFloat8)

Default ToFields Int (Field SqlInt4)

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields Int (Field SqlInt4)

Default ToFields Int32 (Field SqlInt4)

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields Int32 (Field SqlInt4)

Default ToFields Int64 (Field SqlInt8)

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields Int64 (Field SqlInt8)

Default ToFields String (Field SqlVarcharN)

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields String (Field SqlVarcharN)

Default ToFields String (Field SqlText)

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields String (Field SqlText)

Default ToFields ByteString (Field SqlJsonb)

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields ByteString (Field SqlJsonb)

Default ToFields ByteString (Field SqlJson)

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields ByteString (Field SqlJson)

Default ToFields ByteString (Field SqlBytea)

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields ByteString (Field SqlBytea)

Default ToFields ByteString (Field SqlJsonb)

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields ByteString (Field SqlJsonb)

Default ToFields ByteString (Field SqlJson)

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields ByteString (Field SqlJson)

Default ToFields ByteString (Field SqlBytea)

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields ByteString (Field SqlBytea)

Default ToFields Scientific (Field SqlNumeric)

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields Scientific (Field SqlNumeric)

Default ToFields UTCTime (Field SqlTimestamptz)

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields UTCTime (Field SqlTimestamptz)

Default ToFields Text (Field SqlVarcharN)

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields Text (Field SqlVarcharN)

Default ToFields Text (Field SqlText)

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields Text (Field SqlText)

Default ToFields Value (Field SqlJsonb)

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields Value (Field SqlJsonb)

Default ToFields Value (Field SqlJson)

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields Value (Field SqlJson)

Default ToFields Text (Field SqlVarcharN)

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields Text (Field SqlVarcharN)

Default ToFields Text (Field SqlText)

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields Text (Field SqlText)

Default ToFields ZonedTime (Field SqlTimestamptz)

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields ZonedTime (Field SqlTimestamptz)

Default ToFields LocalTime (Field SqlTimestamp)

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields LocalTime (Field SqlTimestamp)

Default ToFields TimeOfDay (Field SqlTime)

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields TimeOfDay (Field SqlTime)

Default ToFields CalendarDiffTime (Field SqlInterval)

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields CalendarDiffTime (Field SqlInterval)

Default ToFields Day (Field SqlDate)

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields Day (Field SqlDate)

Default ToFields UUID (Field SqlUuid)

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields UUID (Field SqlUuid)

Default ViewColumnMaker String (Field_ n a)

Defined in Opaleye.Internal.TableMaker

Methods

def :: ViewColumnMaker String (Field_ n a)

Default RelExprMaker String (Field_ n a)

Defined in Opaleye.Internal.Operators

Methods

def :: RelExprMaker String (Field_ n a)

IsSqlType b => Default Nullspec a (Field_ n b)

Defined in Opaleye.Internal.Values

Methods

def :: Nullspec a (Field_ n b)

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

Defined in Opaleye.Internal.RunQuery

Methods

def :: FromFields (Field a) b

Default EqPP (Field a) (Field a)

Defined in Opaleye.Internal.Operators

Methods

def :: EqPP (Field a) (Field a)

DefaultFromField a b => Default FromFields (FieldNullable a) (Maybe b)

Defined in Opaleye.Internal.RunQuery

Methods

def :: FromFields (FieldNullable a) (Maybe b)

(Default ToFields a (Field_ n b), IsSqlType b) => Default ToFields [a] (Field (SqlArray_ n b))

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields [a] (Field (SqlArray_ n b))

Default ToFields haskell (Field_ n sql) => Default ToFields (Maybe haskell) (Maybe (Field_ n sql))

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields (Maybe haskell) (Maybe (Field_ n sql))

Default ToFields haskell (Field sql) => Default ToFields (Maybe haskell) (FieldNullable sql)

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields (Maybe haskell) (FieldNullable sql)

Default ToFields (CI Text) (Field SqlCitext)

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields (CI Text) (Field SqlCitext)

Default ToFields (CI Text) (Field SqlCitext)

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields (CI Text) (Field SqlCitext)

Default ToFields (PGRange Int) (Field (SqlRange SqlInt4))

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields (PGRange Int) (Field (SqlRange SqlInt4))

Default ToFields (PGRange Int64) (Field (SqlRange SqlInt8))

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields (PGRange Int64) (Field (SqlRange SqlInt8))

Default ToFields (PGRange Scientific) (Field (SqlRange SqlNumeric))

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields (PGRange Scientific) (Field (SqlRange SqlNumeric))

Default ToFields (PGRange UTCTime) (Field (SqlRange SqlTimestamptz))

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields (PGRange UTCTime) (Field (SqlRange SqlTimestamptz))

Default ToFields (PGRange LocalTime) (Field (SqlRange SqlTimestamp))

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields (PGRange LocalTime) (Field (SqlRange SqlTimestamp))

Default ToFields (PGRange Day) (Field (SqlRange SqlDate))

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields (PGRange Day) (Field (SqlRange SqlDate))

Default ToFields (Field a) (Field a)

Defined in Opaleye.Internal.Constant

Methods

def :: ToFields (Field a) (Field a)

Default NullMaker (FieldNullable a) (FieldNullable a)

Defined in Opaleye.Internal.Join

Methods

def :: NullMaker (FieldNullable a) (FieldNullable a)

Default NullMaker (Field a) (FieldNullable a)

Defined in Opaleye.Internal.Join

Methods

def :: NullMaker (Field a) (FieldNullable a)

Default Updater (Field_ n a) (Maybe (Field_ n a))

Defined in Opaleye.Internal.Manipulation

Methods

def :: Updater (Field_ n a) (Maybe (Field_ n a))

Default Unpackspec (Field_ n a) (Field_ n a)

Defined in Opaleye.Internal.Unpackspec

Methods

def :: Unpackspec (Field_ n a) (Field_ n a)

Default Binaryspec (Field_ n a) (Field_ n a)

Defined in Opaleye.Internal.Binary

Methods

def :: Binaryspec (Field_ n a) (Field_ n a)

Default IfPP (Field_ n a) (Field_ n a)

Defined in Opaleye.Internal.Operators

Methods

def :: IfPP (Field_ n a) (Field_ n a)

IsSqlType a => Default Valuesspec (Field_ n a) (Field_ n a)

Defined in Opaleye.Internal.Values

Methods

def :: Valuesspec (Field_ n a) (Field_ n a)

Default ValuesspecUnsafe (Field_ n a) (Field_ n a)

Defined in Opaleye.Internal.Values

Methods

def :: ValuesspecUnsafe (Field_ n a) (Field_ n a)

Default Distinctspec (Field_ n a) (Field_ n a)

Defined in Opaleye.Internal.Distinct

Methods

def :: Distinctspec (Field_ n a) (Field_ n a)

Default Updater (Field_ n a) (Field_ n a)

Defined in Opaleye.Internal.Manipulation

Methods

def :: Updater (Field_ n a) (Field_ n a)

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

Defined in Opaleye.Internal.Column

Methods

(/) :: Field a -> Field a -> Field a

recip :: Field a -> Field a

fromRational :: Rational -> Field a

SqlNum a => Num (Field a)

Defined in Opaleye.Internal.Column

Methods

(+) :: Field a -> Field a -> Field a

(-) :: Field a -> Field a -> Field a

(*) :: Field a -> Field a -> Field a

negate :: Field a -> Field a

abs :: Field a -> Field a

signum :: Field a -> Field a

fromInteger :: Integer -> Field a

SqlString a => IsString (Field a)

Defined in Opaleye.Internal.Column

Methods

fromString :: String -> Field a

InferrableTableField (Maybe (Field_ n r)) n r

Equivalaent to defining the column with optionalTableField. If the write type is Maybe (Field_ n r) (i.e. DEFAULT can be written to it) then the write type is Field_ n r.

Defined in Opaleye.Internal.Table

Methods

tableField :: String -> TableFields (Maybe (Field_ n r)) (Field_ n r)

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

Defined in Opaleye.Internal.Inferrable

Methods

def :: Inferrable FromFields (FieldNullable a) maybe_b

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

Defined in Opaleye.Internal.Inferrable

Methods

def :: Inferrable FromFields (Field a) b

Field a ~ fieldA => Default (Inferrable ToFields) (Field a) fieldA

Defined in Opaleye.Internal.Inferrable

Methods

def :: Inferrable ToFields (Field a) fieldA

(Profunctor p, IsSqlType a, Default p (Field_ n a) (Field_ n a)) => Default (WithNulls p) (Field_ n a) (Field_ n a)

Defined in Opaleye.Internal.MaybeFields

Methods

def :: WithNulls p (Field_ n a) (Field_ n a)

InferrableTableField (Field_ n r) n r

Equivalent to defining the column with requiredTableField. If the write type is Field_ n r then the read type is also Field_ n r.

Defined in Opaleye.Internal.Table

Methods

tableField :: String -> TableFields (Field_ n r) (Field_ n r)

type Field = Field_ NonNullable

type FieldNullable = Field_ 'Nullable

data Nullability

Constructors

NonNullable

Nullable

Instances

type A ('H NullsT :: Arr Type (TC a) k2) ('TC '(t, b) :: TC a)

Defined in Opaleye.Internal.TypeFamilies

type A ('H NullsT :: Arr Type (TC a) k2) ('TC '(t, b) :: TC a) = A ('H NullsT :: Arr Type (C a) k2) ('C t)

type A ('H WT :: Arr Type (TC a) k2) ('TC '(t, Req) :: TC a)

Defined in Opaleye.Internal.TypeFamilies

type A ('H WT :: Arr Type (TC a) k2) ('TC '(t, Req) :: TC a) = A ('H OT :: Arr Type (C a) k2) ('C t)

type A ('H OT :: Arr Type (TC a) k2) ('TC '(t, b) :: TC a)

Defined in Opaleye.Internal.TypeFamilies

type A ('H OT :: Arr Type (TC a) k2) ('TC '(t, b) :: TC a) = A ('H OT :: Arr Type (C a) k2) ('C t)

type A ('H HT :: Arr Type (TC a) k2) ('TC '(t, b) :: TC a)

Defined in Opaleye.Internal.TypeFamilies

type A ('H HT :: Arr Type (TC a) k2) ('TC '(t, b) :: TC a) = A ('H HT :: Arr Type (C a) k2) ('C t)

type A ('H HT :: Arr Type (C k2) k2) ('C '(h, o, NN) :: C k2)

Defined in Opaleye.Internal.TypeFamilies

type A ('H HT :: Arr Type (C k2) k2) ('C '(h, o, NN) :: C k2) = h

type A ('H WT :: Arr Type (TC a) Type) ('TC '(t, Opt) :: TC a)

Defined in Opaleye.Internal.TypeFamilies

type A ('H WT :: Arr Type (TC a) Type) ('TC '(t, Opt) :: TC a) = Maybe (A ('H OT :: Arr Type (C a) Type) ('C t))

type A ('H NullsT :: Arr Type (C Type) Type) ('C '(h, o, n) :: C Type)

Defined in Opaleye.Internal.TypeFamilies

type A ('H NullsT :: Arr Type (C Type) Type) ('C '(h, o, n) :: C Type) = Column (Nullable o)

type A ('H OT :: Arr Type (C Type) Type) ('C '(h, o, N) :: C Type)

Defined in Opaleye.Internal.TypeFamilies

type A ('H OT :: Arr Type (C Type) Type) ('C '(h, o, N) :: C Type) = Column (Nullable o)

type A ('H OT :: Arr Type (C Type) Type) ('C '(h, o, NN) :: C Type)

Defined in Opaleye.Internal.TypeFamilies

type A ('H OT :: Arr Type (C Type) Type) ('C '(h, o, NN) :: C Type) = Column o

type A ('H HT :: Arr Type (C Type) Type) ('C '(h, o, N) :: C Type)

Defined in Opaleye.Internal.TypeFamilies

type A ('H HT :: Arr Type (C Type) Type) ('C '(h, o, N) :: C Type) = Maybe h

Coercing fields

unsafeCoerceField :: Field_ n a -> Field_ n' b

Working with NULL

Instead of working with NULL you are recommended to use Opaleye.MaybeFields instead.

null :: FieldNullable a

A NULL of any type

isNull :: FieldNullable a -> Field PGBool

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

matchNullable

Arguments

:: Field b

-> (Field a -> Field b)

-> FieldNullable a

-> Field b

If the Field 'Nullable a is NULL then return the Field 'NonNullable b otherwise map the underlying Field 'Nullable a using the provided function.

The Opaleye equivalent of maybe.

fromNullable

Arguments

:: Field a

-> FieldNullable a

-> Field a

If the FieldNullable a is NULL then return the provided Field a otherwise return the underlying Field a.

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

toNullable :: Field a -> FieldNullable a

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

The Opaleye equivalent of Just.

maybeToNullable :: Maybe (Field a) -> FieldNullable a

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