Squeal.PostgreSQL.Expression.Type

type expressions

Type Cast

cast

Arguments

:: TypeExpression db ty1

type to cast as

-> Expression grp lat with db params from ty0

value to convert

-> Expression grp lat with db params from ty1

>>> printSQL $ true & cast int4
(TRUE :: int4)

astype

Arguments

:: TypeExpression db ty

type to specify as

-> Expression grp lat with db params from ty

value

-> Expression grp lat with db params from ty

A safe version of cast which just matches a value with its type.

>>> printSQL (1 & astype int)
((1 :: int4) :: int)

inferredtype

Arguments

:: NullTyped db ty

=> Expression lat common grp db params from ty

value

-> Expression lat common grp db params from ty

inferredtype will add a type annotation to an Expression which can be useful for fixing the storage type of a value.

>>> printSQL (inferredtype true)
(TRUE :: bool)

Type Expression

newtype TypeExpression (db :: SchemasType) (ty :: NullType)

TypeExpressions are used in casts and createTable commands.

Constructors

UnsafeTypeExpression

Fields

• renderTypeExpression :: ByteString

Instances

Eq (TypeExpression db ty)

Defined in Squeal.PostgreSQL.Expression.Type

Methods

(==) :: TypeExpression db ty -> TypeExpression db ty -> Bool

(/=) :: TypeExpression db ty -> TypeExpression db ty -> Bool

Ord (TypeExpression db ty)

Defined in Squeal.PostgreSQL.Expression.Type

Methods

compare :: TypeExpression db ty -> TypeExpression db ty -> Ordering

(<) :: TypeExpression db ty -> TypeExpression db ty -> Bool

(<=) :: TypeExpression db ty -> TypeExpression db ty -> Bool

(>) :: TypeExpression db ty -> TypeExpression db ty -> Bool

(>=) :: TypeExpression db ty -> TypeExpression db ty -> Bool

max :: TypeExpression db ty -> TypeExpression db ty -> TypeExpression db ty

min :: TypeExpression db ty -> TypeExpression db ty -> TypeExpression db ty

Show (TypeExpression db ty)

Defined in Squeal.PostgreSQL.Expression.Type

Methods

showsPrec :: Int -> TypeExpression db ty -> ShowS

show :: TypeExpression db ty -> String

showList :: [TypeExpression db ty] -> ShowS

Generic (TypeExpression db ty)

Defined in Squeal.PostgreSQL.Expression.Type

Associated Types

type Rep (TypeExpression db ty) :: Type -> Type

Methods

from :: TypeExpression db ty -> Rep (TypeExpression db ty) x

to :: Rep (TypeExpression db ty) x -> TypeExpression db ty

NFData (TypeExpression db ty)

Defined in Squeal.PostgreSQL.Expression.Type

Methods

rnf :: TypeExpression db ty -> ()

RenderSQL (TypeExpression db ty)

Defined in Squeal.PostgreSQL.Expression.Type

Methods

renderSQL :: TypeExpression db ty -> ByteString

type Rep (TypeExpression db ty)

Defined in Squeal.PostgreSQL.Expression.Type

type Rep (TypeExpression db ty) = D1 ('MetaData "TypeExpression" "Squeal.PostgreSQL.Expression.Type" "squeal-postgresql-0.9.0.0-D17NIjlcsGRAwJTaCTXyvM" 'True) (C1 ('MetaCons "UnsafeTypeExpression" 'PrefixI 'True) (S1 ('MetaSel ('Just "renderTypeExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

typerow

Arguments

:: (relss ~ DbRelations db, Has sch relss rels, Has rel rels row)

=> QualifiedAlias sch rel

type alias

-> TypeExpression db (null ('PGcomposite row))

The composite type corresponding to a relation can be expressed by its alias. A relation is either a composite type, a table or a view. It subsumes typetable and typeview and partly overlaps typedef.

typeenum

Arguments

:: (enumss ~ DbEnums db, Has sch enumss enums, Has enum enums labels)

=> QualifiedAlias sch enum

type alias

-> TypeExpression db (null ('PGenum labels))

An enumerated type can be expressed by its alias. typeenum is subsumed by typedef.

typedef

Arguments

:: (Has sch db schema, Has td schema ('Typedef ty))

=> QualifiedAlias sch td

type alias

-> TypeExpression db (null ty)

The enum or composite type in a Typedef can be expressed by its alias.

typetable

Arguments

:: (Has sch db schema, Has tab schema ('Table table))

=> QualifiedAlias sch tab

table alias

-> TypeExpression db (null ('PGcomposite (TableToRow table)))

The composite type corresponding to a Table definition can be expressed by its alias. It is subsumed by typerow

typeview

Arguments

:: (Has sch db schema, Has vw schema ('View view))

=> QualifiedAlias sch vw

view alias

-> TypeExpression db (null ('PGcomposite view))

The composite type corresponding to a View definition can be expressed by its alias. It is subsumed by typerow.

bool :: TypeExpression db (null 'PGbool)

logical Boolean (true/false)

int2 :: TypeExpression db (null 'PGint2)

signed two-byte integer

smallint :: TypeExpression db (null 'PGint2)

signed two-byte integer

int4 :: TypeExpression db (null 'PGint4)

signed four-byte integer

int :: TypeExpression db (null 'PGint4)

signed four-byte integer

integer :: TypeExpression db (null 'PGint4)

signed four-byte integer

int8 :: TypeExpression db (null 'PGint8)

signed eight-byte integer

bigint :: TypeExpression db (null 'PGint8)

signed eight-byte integer

numeric :: TypeExpression db (null 'PGnumeric)

arbitrary precision numeric type

float4 :: TypeExpression db (null 'PGfloat4)

single precision floating-point number (4 bytes)

real :: TypeExpression db (null 'PGfloat4)

single precision floating-point number (4 bytes)

float8 :: TypeExpression db (null 'PGfloat8)

double precision floating-point number (8 bytes)

doublePrecision :: TypeExpression db (null 'PGfloat8)

double precision floating-point number (8 bytes)

money :: TypeExpression schema (null 'PGmoney)

currency amount

text :: TypeExpression db (null 'PGtext)

variable-length character string

char :: forall n db null. (KnownNat n, 1 <= n) => TypeExpression db (null ('PGchar n))

fixed-length character string

character :: forall n db null. (KnownNat n, 1 <= n) => TypeExpression db (null ('PGchar n))

fixed-length character string

varchar :: forall n db null. (KnownNat n, 1 <= n) => TypeExpression db (null ('PGvarchar n))

variable-length character string

characterVarying :: forall n db null. (KnownNat n, 1 <= n) => TypeExpression db (null ('PGvarchar n))

variable-length character string

bytea :: TypeExpression db (null 'PGbytea)

binary data ("byte array")

timestamp :: TypeExpression db (null 'PGtimestamp)

date and time (no time zone)

timestampWithTimeZone :: TypeExpression db (null 'PGtimestamptz)

date and time, including time zone

timestamptz :: TypeExpression db (null 'PGtimestamptz)

date and time, including time zone

date :: TypeExpression db (null 'PGdate)

calendar date (year, month, day)

time :: TypeExpression db (null 'PGtime)

time of day (no time zone)

timeWithTimeZone :: TypeExpression db (null 'PGtimetz)

time of day, including time zone

timetz :: TypeExpression db (null 'PGtimetz)

time of day, including time zone

interval :: TypeExpression db (null 'PGinterval)

time span

uuid :: TypeExpression db (null 'PGuuid)

universally unique identifier

inet :: TypeExpression db (null 'PGinet)

IPv4 or IPv6 host address

json :: TypeExpression db (null 'PGjson)

textual JSON data

jsonb :: TypeExpression db (null 'PGjsonb)

binary JSON data, decomposed

vararray :: TypeExpression db pg -> TypeExpression db (null ('PGvararray pg))

variable length array

fixarray :: forall dims db null pg. All KnownNat dims => TypeExpression db pg -> TypeExpression db (null ('PGfixarray dims pg))

fixed length array

>>> renderSQL (fixarray @'[2] json)
"json[2]"

tsvector :: TypeExpression db (null 'PGtsvector)

text search query

tsquery :: TypeExpression db (null 'PGtsquery)

text search document

oid :: TypeExpression db (null 'PGoid)

Object identifiers (OIDs) are used internally by PostgreSQL as primary keys for various system tables.

int4range :: TypeExpression db (null ('PGrange 'PGint4))

Range of integer

int8range :: TypeExpression db (null ('PGrange 'PGint8))

Range of bigint

numrange :: TypeExpression db (null ('PGrange 'PGnumeric))

Range of numeric

tsrange :: TypeExpression db (null ('PGrange 'PGtimestamp))

Range of timestamp without time zone

tstzrange :: TypeExpression db (null ('PGrange 'PGtimestamptz))

Range of timestamp with time zone

daterange :: TypeExpression db (null ('PGrange 'PGdate))

Range of date

record :: TypeExpression db (null ('PGcomposite record))

Anonymous composite record

Column Type

newtype ColumnTypeExpression (db :: SchemasType) (ty :: ColumnType)

ColumnTypeExpressions are used in createTable commands.

Constructors

UnsafeColumnTypeExpression

Fields

• renderColumnTypeExpression :: ByteString

Instances

Eq (ColumnTypeExpression db ty)

Defined in Squeal.PostgreSQL.Expression.Type

Methods

(==) :: ColumnTypeExpression db ty -> ColumnTypeExpression db ty -> Bool

(/=) :: ColumnTypeExpression db ty -> ColumnTypeExpression db ty -> Bool

Ord (ColumnTypeExpression db ty)

Defined in Squeal.PostgreSQL.Expression.Type

Methods

compare :: ColumnTypeExpression db ty -> ColumnTypeExpression db ty -> Ordering

(<) :: ColumnTypeExpression db ty -> ColumnTypeExpression db ty -> Bool

(<=) :: ColumnTypeExpression db ty -> ColumnTypeExpression db ty -> Bool

(>) :: ColumnTypeExpression db ty -> ColumnTypeExpression db ty -> Bool

(>=) :: ColumnTypeExpression db ty -> ColumnTypeExpression db ty -> Bool

max :: ColumnTypeExpression db ty -> ColumnTypeExpression db ty -> ColumnTypeExpression db ty

min :: ColumnTypeExpression db ty -> ColumnTypeExpression db ty -> ColumnTypeExpression db ty

Show (ColumnTypeExpression db ty)

Defined in Squeal.PostgreSQL.Expression.Type

Methods

showsPrec :: Int -> ColumnTypeExpression db ty -> ShowS

show :: ColumnTypeExpression db ty -> String

showList :: [ColumnTypeExpression db ty] -> ShowS

Generic (ColumnTypeExpression db ty)

Defined in Squeal.PostgreSQL.Expression.Type

Associated Types

type Rep (ColumnTypeExpression db ty) :: Type -> Type

Methods

from :: ColumnTypeExpression db ty -> Rep (ColumnTypeExpression db ty) x

to :: Rep (ColumnTypeExpression db ty) x -> ColumnTypeExpression db ty

NFData (ColumnTypeExpression db ty)

Defined in Squeal.PostgreSQL.Expression.Type

Methods

rnf :: ColumnTypeExpression db ty -> ()

RenderSQL (ColumnTypeExpression db ty)

Defined in Squeal.PostgreSQL.Expression.Type

Methods

renderSQL :: ColumnTypeExpression db ty -> ByteString

type Rep (ColumnTypeExpression db ty)

Defined in Squeal.PostgreSQL.Expression.Type

type Rep (ColumnTypeExpression db ty) = D1 ('MetaData "ColumnTypeExpression" "Squeal.PostgreSQL.Expression.Type" "squeal-postgresql-0.9.0.0-D17NIjlcsGRAwJTaCTXyvM" 'True) (C1 ('MetaCons "UnsafeColumnTypeExpression" 'PrefixI 'True) (S1 ('MetaSel ('Just "renderColumnTypeExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

nullable

Arguments

:: TypeExpression db (null ty)

type

-> ColumnTypeExpression db ('NoDef :=> 'Null ty)

used in createTable commands as a column constraint to note that NULL may be present in a column

notNullable

Arguments

:: TypeExpression db (null ty)

type

-> ColumnTypeExpression db ('NoDef :=> 'NotNull ty)

used in createTable commands as a column constraint to ensure NULL is not present in a column

default_

Arguments

:: Expression 'Ungrouped '[] '[] db '[] '[] ty

default value

-> ColumnTypeExpression db ('NoDef :=> ty)

column type

-> ColumnTypeExpression db ('Def :=> ty)

used in createTable commands as a column constraint to give a default

serial2 :: ColumnTypeExpression db ('Def :=> 'NotNull 'PGint2)

not a true type, but merely a notational convenience for creating unique identifier columns with type PGint2

smallserial :: ColumnTypeExpression db ('Def :=> 'NotNull 'PGint2)

not a true type, but merely a notational convenience for creating unique identifier columns with type PGint2

serial4 :: ColumnTypeExpression db ('Def :=> 'NotNull 'PGint4)

not a true type, but merely a notational convenience for creating unique identifier columns with type PGint4

serial :: ColumnTypeExpression db ('Def :=> 'NotNull 'PGint4)

not a true type, but merely a notational convenience for creating unique identifier columns with type PGint4

serial8 :: ColumnTypeExpression db ('Def :=> 'NotNull 'PGint8)

not a true type, but merely a notational convenience for creating unique identifier columns with type PGint8

bigserial :: ColumnTypeExpression db ('Def :=> 'NotNull 'PGint8)

not a true type, but merely a notational convenience for creating unique identifier columns with type PGint8

Type Inference

class PGTyped db (ty :: PGType) where

pgtype is a demoted version of a PGType

Methods

pgtype :: TypeExpression db (null ty)

Instances

PGTyped db 'PGoid

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null 'PGoid)

PGTyped db 'PGtsquery

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null 'PGtsquery)

PGTyped db 'PGtsvector

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null 'PGtsvector)

PGTyped db 'PGjsonb

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null 'PGjsonb)

PGTyped db 'PGjson

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null 'PGjson)

PGTyped db 'PGinet

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null 'PGinet)

PGTyped db 'PGuuid

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null 'PGuuid)

PGTyped db 'PGinterval

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null 'PGinterval)

PGTyped db 'PGtimetz

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null 'PGtimetz)

PGTyped db 'PGtime

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null 'PGtime)

PGTyped db 'PGdate

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null 'PGdate)

PGTyped db 'PGtimestamptz

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null 'PGtimestamptz)

PGTyped db 'PGtimestamp

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null 'PGtimestamp)

PGTyped db 'PGbytea

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null 'PGbytea)

PGTyped db 'PGtext

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null 'PGtext)

PGTyped db 'PGmoney

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null 'PGmoney)

PGTyped db 'PGfloat8

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null 'PGfloat8)

PGTyped db 'PGfloat4

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null 'PGfloat4)

PGTyped db 'PGnumeric

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null 'PGnumeric)

PGTyped db 'PGint8

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null 'PGint8)

PGTyped db 'PGint4

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null 'PGint4)

PGTyped db 'PGint2

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null 'PGint2)

PGTyped db 'PGbool

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null 'PGbool)

(enums ~ DbEnums db, FindQualified "no enum found with labels:" enums labels ~ '(sch, td), Has sch db schema, Has td schema ('Typedef ('PGenum labels))) => PGTyped db ('PGenum labels)

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null ('PGenum labels))

(relss ~ DbRelations db, Has sch relss rels, Has rel rels row, FindQualified "no relation found with row:" relss row ~ '(sch, rel)) => PGTyped db ('PGcomposite row)

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null ('PGcomposite row))

PGTyped db ('PGrange 'PGdate)

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null ('PGrange 'PGdate))

PGTyped db ('PGrange 'PGtimestamptz)

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null ('PGrange 'PGtimestamptz))

PGTyped db ('PGrange 'PGtimestamp)

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null ('PGrange 'PGtimestamp))

PGTyped db ('PGrange 'PGnumeric)

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null ('PGrange 'PGnumeric))

PGTyped db ('PGrange 'PGint8)

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null ('PGrange 'PGint8))

PGTyped db ('PGrange 'PGint4)

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null ('PGrange 'PGint4))

PGTyped db pg => PGTyped db ('PGvararray (null pg))

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null0 :: PGType -> NullType). TypeExpression db (null0 ('PGvararray (null pg)))

(KnownNat n, 1 <= n) => PGTyped db ('PGvarchar n)

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null ('PGvarchar n))

(KnownNat n, 1 <= n) => PGTyped db ('PGchar n)

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null :: PGType -> NullType). TypeExpression db (null ('PGchar n))

(All KnownNat dims, PGTyped db pg) => PGTyped db ('PGfixarray dims (null pg))

Defined in Squeal.PostgreSQL.Expression.Type

Methods

pgtype :: forall (null0 :: PGType -> NullType). TypeExpression db (null0 ('PGfixarray dims (null pg)))

pgtypeFrom :: forall hask db null. PGTyped db (PG hask) => TypeExpression db (null (PG hask))

Specify TypeExpression from a Haskell type.

>>> printSQL $ pgtypeFrom @String
text

>>> printSQL $ pgtypeFrom @Double
float8

class NullTyped db (ty :: NullType) where

Like PGTyped but also accounts for null.

Methods

nulltype :: TypeExpression db ty

Instances

PGTyped db ty => NullTyped db (null ty)

Defined in Squeal.PostgreSQL.Expression.Type

Methods

nulltype :: TypeExpression db (null ty)

nulltypeFrom :: forall hask db. NullTyped db (NullPG hask) => TypeExpression db (NullPG hask)

Specify null TypeExpression from a Haskell type.

>>> printSQL $ nulltypeFrom @(Maybe String)
text

>>> printSQL $ nulltypeFrom @Double
float8

class ColumnTyped db (column :: ColumnType) where

Like PGTyped but also accounts for null.

Methods

columntype :: ColumnTypeExpression db column

Instances

NullTyped db ('NotNull ty) => ColumnTyped db ('NoDef :=> 'NotNull ty)

Defined in Squeal.PostgreSQL.Expression.Type

Methods

columntype :: ColumnTypeExpression db ('NoDef :=> 'NotNull ty)

NullTyped db ('Null ty) => ColumnTyped db ('NoDef :=> 'Null ty)

Defined in Squeal.PostgreSQL.Expression.Type

Methods

columntype :: ColumnTypeExpression db ('NoDef :=> 'Null ty)

columntypeFrom :: forall hask db. ColumnTyped db ('NoDef :=> NullPG hask) => ColumnTypeExpression db ('NoDef :=> NullPG hask)

Specify ColumnTypeExpression from a Haskell type.

>>> printSQL $ columntypeFrom @(Maybe String)
text NULL

>>> printSQL $ columntypeFrom @Double
float8 NOT NULL

class FieldTyped db ty where

Lift PGTyped to a field

Methods

fieldtype :: Aliased (TypeExpression db) ty

Instances

(KnownSymbol alias, NullTyped db ty) => FieldTyped db (alias ::: ty)

Defined in Squeal.PostgreSQL.Expression.Type

Methods

fieldtype :: Aliased (TypeExpression db) (alias ::: ty)