Squeal.PostgreSQL.Type.Schema

Provides a type-level DSL for kinds of Postgres types, tables, schema, constraints, and more. It also defines useful type families to operate on these.

Postgres Type

data PGType

PGType is the promoted datakind of PostgreSQL types.

>>> :kind 'PGbool
'PGbool :: PGType

Constructors

PGbool

logical Boolean (true/false)

PGint2

signed two-byte integer

PGint4

signed four-byte integer

PGint8

signed eight-byte integer

PGnumeric

arbitrary precision numeric type

PGfloat4

single precision floating-point number (4 bytes)

PGfloat8

double precision floating-point number (8 bytes)

PGmoney

currency amount

PGchar Nat

fixed-length character string

PGvarchar Nat

variable-length character string

PGtext

variable-length character string

PGbytea

binary data ("byte array")

PGtimestamp

date and time (no time zone)

PGtimestamptz

date and time, including time zone

PGdate

calendar date (year, month, day)

PGtime

time of day (no time zone)

PGtimetz

time of day, including time zone

PGinterval

time span

PGuuid

universally unique identifier

PGinet

IPv4 or IPv6 host address

PGjson

textual JSON data

PGjsonb

binary JSON data, decomposed

PGvararray NullType

variable length array

PGfixarray [Nat] NullType

fixed length array

PGenum [Symbol]

enumerated (enum) types are data types that comprise a static, ordered set of values.

PGcomposite RowType

a composite type represents the structure of a row or record; it is essentially just a list of field names and their data types.

PGtsvector

A tsvector value is a sorted list of distinct lexemes, which are words that have been normalized to merge different variants of the same word.

PGtsquery

A tsquery value stores lexemes that are to be searched for.

PGoid

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

PGrange PGType

Range types are data types representing a range of values of some element type (called the range's subtype).

UnsafePGType Symbol

an escape hatch for unsupported PostgreSQL types

Instances

PGSubset PGjsonb

Defined in Squeal.PostgreSQL.Expression

Methods

(@>) :: Operator (null0 PGjsonb) (null1 PGjsonb) (Null PGbool)

(<@) :: Operator (null0 PGjsonb) (null1 PGjsonb) (Null PGbool)

PGSubset PGtsquery

Defined in Squeal.PostgreSQL.Expression

Methods

(@>) :: Operator (null0 PGtsquery) (null1 PGtsquery) (Null PGbool)

(<@) :: Operator (null0 PGtsquery) (null1 PGtsquery) (Null PGbool)

TimeOp PGtimestamp PGinterval

Defined in Squeal.PostgreSQL.Expression.Time

Methods

(!+) :: Operator (null PGtimestamp) (null PGinterval) (null PGtimestamp)

(+!) :: Operator (null PGinterval) (null PGtimestamp) (null PGtimestamp)

(!-) :: Operator (null PGtimestamp) (null PGinterval) (null PGtimestamp)

(!-!) :: Operator (null PGtimestamp) (null PGtimestamp) (null PGinterval)

TimeOp PGtimestamptz PGinterval

Defined in Squeal.PostgreSQL.Expression.Time

Methods

(!+) :: Operator (null PGtimestamptz) (null PGinterval) (null PGtimestamptz)

(+!) :: Operator (null PGinterval) (null PGtimestamptz) (null PGtimestamptz)

(!-) :: Operator (null PGtimestamptz) (null PGinterval) (null PGtimestamptz)

(!-!) :: Operator (null PGtimestamptz) (null PGtimestamptz) (null PGinterval)

TimeOp PGdate PGint4

Defined in Squeal.PostgreSQL.Expression.Time

Methods

(!+) :: Operator (null PGdate) (null PGint4) (null PGdate)

(+!) :: Operator (null PGint4) (null PGdate) (null PGdate)

(!-) :: Operator (null PGdate) (null PGint4) (null PGdate)

(!-!) :: Operator (null PGdate) (null PGdate) (null PGint4)

TimeOp PGtime PGinterval

Defined in Squeal.PostgreSQL.Expression.Time

Methods

(!+) :: Operator (null PGtime) (null PGinterval) (null PGtime)

(+!) :: Operator (null PGinterval) (null PGtime) (null PGtime)

(!-) :: Operator (null PGtime) (null PGinterval) (null PGtime)

(!-!) :: Operator (null PGtime) (null PGtime) (null PGinterval)

TimeOp PGtimetz PGinterval

Defined in Squeal.PostgreSQL.Expression.Time

Methods

(!+) :: Operator (null PGtimetz) (null PGinterval) (null PGtimetz)

(+!) :: Operator (null PGinterval) (null PGtimetz) (null PGtimetz)

(!-) :: Operator (null PGtimetz) (null PGinterval) (null PGtimetz)

(!-!) :: Operator (null PGtimetz) (null PGtimetz) (null PGinterval)

TimeOp PGinterval PGinterval

Defined in Squeal.PostgreSQL.Expression.Time

Methods

(!+) :: Operator (null PGinterval) (null PGinterval) (null PGinterval)

(+!) :: Operator (null PGinterval) (null PGinterval) (null PGinterval)

(!-) :: Operator (null PGinterval) (null PGinterval) (null PGinterval)

(!-!) :: Operator (null PGinterval) (null PGinterval) (null PGinterval)

PGIntersect (PGvararray ty :: PGType)

Defined in Squeal.PostgreSQL.Expression

Methods

(@&&) :: Operator (null0 (PGvararray ty)) (null1 (PGvararray ty)) (Null PGbool)

PGIntersect (PGrange ty :: PGType)

Defined in Squeal.PostgreSQL.Expression

Methods

(@&&) :: Operator (null0 (PGrange ty)) (null1 (PGrange ty)) (Null PGbool)

PGSubset (PGvararray ty :: PGType)

Defined in Squeal.PostgreSQL.Expression

Methods

(@>) :: Operator (null0 (PGvararray ty)) (null1 (PGvararray ty)) (Null PGbool)

(<@) :: Operator (null0 (PGvararray ty)) (null1 (PGvararray ty)) (Null PGbool)

PGSubset (PGrange ty :: PGType)

Defined in Squeal.PostgreSQL.Expression

Methods

(@>) :: Operator (null0 (PGrange ty)) (null1 (PGrange ty)) (Null PGbool)

(<@) :: Operator (null0 (PGrange ty)) (null1 (PGrange ty)) (Null PGbool)

data NullType

NullType encodes the potential presence or definite absence of a NULL allowing operations which are sensitive to such to be well typed.

>>> :kind 'Null 'PGint4
'Null 'PGint4 :: NullType
>>> :kind 'NotNull ('PGvarchar 50)
'NotNull ('PGvarchar 50) :: NullType

Constructors

Null PGType

NULL may be present

NotNull PGType

NULL is absent

Instances

Aggregate AggregateArg (Expression (Grouped bys) :: FromType -> FromType -> SchemasType -> [NullType] -> FromType -> NullType -> Type)

Defined in Squeal.PostgreSQL.Expression.Aggregate

Methods

countStar :: Expression (Grouped bys) lat with db params from (NotNull PGint8)

count :: AggregateArg (ty ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (NotNull PGint8)

sum_ :: AggregateArg (null ty ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null (PGSum ty))

arrayAgg :: AggregateArg (ty ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null (PGvararray ty))

jsonAgg :: AggregateArg (ty ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGjson)

jsonbAgg :: AggregateArg (ty ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGjsonb)

bitAnd :: In int PGIntegral => AggregateArg (null int ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null int)

bitOr :: In int PGIntegral => AggregateArg (null int ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null int)

boolAnd :: AggregateArg (null PGbool ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGbool)

boolOr :: AggregateArg (null PGbool ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGbool)

every :: AggregateArg (null PGbool ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGbool)

max_ :: AggregateArg (null ty ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null ty)

min_ :: AggregateArg (null ty ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null ty)

avg :: AggregateArg (null ty ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null (PGAvg ty))

corr :: AggregateArg (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGfloat8)

covarPop :: AggregateArg (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGfloat8)

covarSamp :: AggregateArg (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGfloat8)

regrAvgX :: AggregateArg (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGfloat8)

regrAvgY :: AggregateArg (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGfloat8)

regrCount :: AggregateArg (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGint8)

regrIntercept :: AggregateArg (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGfloat8)

regrR2 :: AggregateArg (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGfloat8)

regrSlope :: AggregateArg (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGfloat8)

regrSxx :: AggregateArg (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGfloat8)

regrSxy :: AggregateArg (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGfloat8)

regrSyy :: AggregateArg (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGfloat8)

stddev :: AggregateArg (null ty ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null (PGAvg ty))

stddevPop :: AggregateArg (null ty ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null (PGAvg ty))

stddevSamp :: AggregateArg (null ty ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null (PGAvg ty))

variance :: AggregateArg (null ty ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null (PGAvg ty))

varPop :: AggregateArg (null ty ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null (PGAvg ty))

varSamp :: AggregateArg (null ty ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null (PGAvg ty))

Aggregate (WindowArg grp :: [NullType] -> FromType -> FromType -> SchemasType -> [NullType] -> FromType -> Type) (WindowFunction grp :: FromType -> FromType -> SchemasType -> [NullType] -> FromType -> NullType -> Type)

Defined in Squeal.PostgreSQL.Expression.Window

Methods

countStar :: WindowFunction grp lat with db params from (NotNull PGint8)

count :: WindowArg grp (ty ': []) lat with db params from -> WindowFunction grp lat with db params from (NotNull PGint8)

sum_ :: WindowArg grp (null ty ': []) lat with db params from -> WindowFunction grp lat with db params from (Null (PGSum ty))

arrayAgg :: WindowArg grp (ty ': []) lat with db params from -> WindowFunction grp lat with db params from (Null (PGvararray ty))

jsonAgg :: WindowArg grp (ty ': []) lat with db params from -> WindowFunction grp lat with db params from (Null PGjson)

jsonbAgg :: WindowArg grp (ty ': []) lat with db params from -> WindowFunction grp lat with db params from (Null PGjsonb)

bitAnd :: In int PGIntegral => WindowArg grp (null int ': []) lat with db params from -> WindowFunction grp lat with db params from (Null int)

bitOr :: In int PGIntegral => WindowArg grp (null int ': []) lat with db params from -> WindowFunction grp lat with db params from (Null int)

boolAnd :: WindowArg grp (null PGbool ': []) lat with db params from -> WindowFunction grp lat with db params from (Null PGbool)

boolOr :: WindowArg grp (null PGbool ': []) lat with db params from -> WindowFunction grp lat with db params from (Null PGbool)

every :: WindowArg grp (null PGbool ': []) lat with db params from -> WindowFunction grp lat with db params from (Null PGbool)

max_ :: WindowArg grp (null ty ': []) lat with db params from -> WindowFunction grp lat with db params from (Null ty)

min_ :: WindowArg grp (null ty ': []) lat with db params from -> WindowFunction grp lat with db params from (Null ty)

avg :: WindowArg grp (null ty ': []) lat with db params from -> WindowFunction grp lat with db params from (Null (PGAvg ty))

corr :: WindowArg grp (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> WindowFunction grp lat with db params from (Null PGfloat8)

covarPop :: WindowArg grp (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> WindowFunction grp lat with db params from (Null PGfloat8)

covarSamp :: WindowArg grp (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> WindowFunction grp lat with db params from (Null PGfloat8)

regrAvgX :: WindowArg grp (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> WindowFunction grp lat with db params from (Null PGfloat8)

regrAvgY :: WindowArg grp (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> WindowFunction grp lat with db params from (Null PGfloat8)

regrCount :: WindowArg grp (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> WindowFunction grp lat with db params from (Null PGint8)

regrIntercept :: WindowArg grp (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> WindowFunction grp lat with db params from (Null PGfloat8)

regrR2 :: WindowArg grp (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> WindowFunction grp lat with db params from (Null PGfloat8)

regrSlope :: WindowArg grp (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> WindowFunction grp lat with db params from (Null PGfloat8)

regrSxx :: WindowArg grp (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> WindowFunction grp lat with db params from (Null PGfloat8)

regrSxy :: WindowArg grp (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> WindowFunction grp lat with db params from (Null PGfloat8)

regrSyy :: WindowArg grp (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> WindowFunction grp lat with db params from (Null PGfloat8)

stddev :: WindowArg grp (null ty ': []) lat with db params from -> WindowFunction grp lat with db params from (Null (PGAvg ty))

stddevPop :: WindowArg grp (null ty ': []) lat with db params from -> WindowFunction grp lat with db params from (Null (PGAvg ty))

stddevSamp :: WindowArg grp (null ty ': []) lat with db params from -> WindowFunction grp lat with db params from (Null (PGAvg ty))

variance :: WindowArg grp (null ty ': []) lat with db params from -> WindowFunction grp lat with db params from (Null (PGAvg ty))

varPop :: WindowArg grp (null ty ': []) lat with db params from -> WindowFunction grp lat with db params from (Null (PGAvg ty))

varSamp :: WindowArg grp (null ty ': []) lat with db params from -> WindowFunction grp lat with db params from (Null (PGAvg ty))

(Has tab (Join from lat) row, Has col row ty, GroupedBy tab col bys, columns ~ ((col ::: ty) ': ([] :: [(Symbol, NullType)]))) => IsQualified tab col (NP (Aliased (Expression (Grouped bys) lat with db params from)) columns)

Defined in Squeal.PostgreSQL.Expression

Methods

(!) :: Alias tab -> Alias col -> NP (Aliased (Expression (Grouped bys) lat with db params from)) columns

(Has tab (Join from lat) row, Has col row ty, GroupedBy tab col bys, column ~ (col ::: ty)) => IsQualified tab col (Aliased (Expression (Grouped bys) lat with db params from) column)

Defined in Squeal.PostgreSQL.Expression

Methods

(!) :: Alias tab -> Alias col -> Aliased (Expression (Grouped bys) lat with db params from) column

(Has tab (Join from lat) row, Has col row ty, GroupedBy tab col bys, tys ~ (ty ': ([] :: [NullType]))) => IsQualified tab col (NP (Expression (Grouped bys) lat with db params from) tys)

Defined in Squeal.PostgreSQL.Expression

Methods

(!) :: Alias tab -> Alias col -> NP (Expression (Grouped bys) lat with db params from) tys

(Has tab (Join from lat) row, Has col row ty, columns ~ ((col ::: ty) ': ([] :: [(Symbol, NullType)]))) => IsQualified tab col (NP (Aliased (Expression Ungrouped lat with db params from)) columns)

Defined in Squeal.PostgreSQL.Expression

Methods

(!) :: Alias tab -> Alias col -> NP (Aliased (Expression Ungrouped lat with db params from)) columns

(Has tab (Join from lat) row, Has col row ty, column ~ (col ::: ty)) => IsQualified tab col (Aliased (Expression Ungrouped lat with db params from) column)

Defined in Squeal.PostgreSQL.Expression

Methods

(!) :: Alias tab -> Alias col -> Aliased (Expression Ungrouped lat with db params from) column

(Has tab (Join from lat) row, Has col row ty, tys ~ (ty ': ([] :: [NullType]))) => IsQualified tab col (NP (Expression Ungrouped lat with db params from) tys)

Defined in Squeal.PostgreSQL.Expression

Methods

(!) :: Alias tab -> Alias col -> NP (Expression Ungrouped lat with db params from) tys

IsLabel fld (MaybeT (DecodeRow row) y) => IsLabel fld (MaybeT (DecodeRow (field ': row)) y)

Defined in Squeal.PostgreSQL.Session.Decode

Methods

fromLabel :: MaybeT (DecodeRow (field ': row)) y

FromValue ty (Maybe y) => IsLabel fld (MaybeT (DecodeRow ((fld ::: ty) ': row)) y)

Defined in Squeal.PostgreSQL.Session.Decode

Methods

fromLabel :: MaybeT (DecodeRow ((fld ::: ty) ': row)) y

IsLabel fld (DecodeRow row y) => IsLabel fld (DecodeRow (field ': row) y)

Defined in Squeal.PostgreSQL.Session.Decode

Methods

fromLabel :: DecodeRow (field ': row) y

FromValue ty y => IsLabel fld (DecodeRow ((fld ::: ty) ': row) y)

Defined in Squeal.PostgreSQL.Session.Decode

Methods

fromLabel :: DecodeRow ((fld ::: ty) ': row) y

(HasUnique tab (Join from lat) row, Has col row ty, GroupedBy tab col bys, columns ~ ((col ::: ty) ': ([] :: [(Symbol, NullType)]))) => IsLabel col (NP (Aliased (Expression (Grouped bys) lat with db params from)) columns)

Defined in Squeal.PostgreSQL.Expression

Methods

fromLabel :: NP (Aliased (Expression (Grouped bys) lat with db params from)) columns

(HasUnique tab (Join from lat) row, Has col row ty, GroupedBy tab col bys, column ~ (col ::: ty)) => IsLabel col (Aliased (Expression (Grouped bys) lat with db params from) column)

Defined in Squeal.PostgreSQL.Expression

Methods

fromLabel :: Aliased (Expression (Grouped bys) lat with db params from) column

(HasUnique tab (Join from lat) row, Has col row ty, GroupedBy tab col bys, tys ~ (ty ': ([] :: [NullType]))) => IsLabel col (NP (Expression (Grouped bys) lat with db params from) tys)

Defined in Squeal.PostgreSQL.Expression

Methods

fromLabel :: NP (Expression (Grouped bys) lat with db params from) tys

(HasUnique tab (Join from lat) row, Has col row ty, columns ~ ((col ::: ty) ': ([] :: [(Symbol, NullType)]))) => IsLabel col (NP (Aliased (Expression Ungrouped lat with db params from)) columns)

Defined in Squeal.PostgreSQL.Expression

Methods

fromLabel :: NP (Aliased (Expression Ungrouped lat with db params from)) columns

(HasUnique tab (Join from lat) row, Has col row ty, column ~ (col ::: ty)) => IsLabel col (Aliased (Expression Ungrouped lat with db params from) column)

Defined in Squeal.PostgreSQL.Expression

Methods

fromLabel :: Aliased (Expression Ungrouped lat with db params from) column

(HasUnique tab (Join from lat) row, Has col row ty, tys ~ (ty ': ([] :: [NullType]))) => IsLabel col (NP (Expression Ungrouped lat with db params from) tys)

Defined in Squeal.PostgreSQL.Expression

Methods

fromLabel :: NP (Expression Ungrouped lat with db params from) tys

OidOfNull db ty => OidOfField db (fld ::: ty)

Defined in Squeal.PostgreSQL.Session.Oid

Methods

oidOfField :: ReaderT (K Connection db) IO Oid

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

Defined in Squeal.PostgreSQL.Expression.Type

Methods

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

(fld0 ~ fld1, ToParam db ty x) => ToField db (fld0 ::: ty) (fld1 ::: x)

Defined in Squeal.PostgreSQL.Session.Encode

Methods

toField :: P (fld1 ::: x) -> ReaderT (K Connection db) IO (K (Maybe Encoding) (fld0 ::: ty))

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)

(KnownSymbol cte, with1 ~ ((cte ::: common) ': with)) => Aliasable cte (statement with db params common) (Path (CommonTableExpression statement db params) with with1)

Defined in Squeal.PostgreSQL.Query.With

Methods

as :: statement with db params common -> Alias cte -> Path (CommonTableExpression statement db params) with with1

JsonBuildObject ([] :: [NullType])

Defined in Squeal.PostgreSQL.Expression.Json

Methods

jsonBuildObject :: [] ---> null PGjson

jsonbBuildObject :: [] ---> null PGjsonb

FilterWhere AggregateArg Ungrouped

Defined in Squeal.PostgreSQL.Expression.Aggregate

Methods

filterWhere :: Condition Ungrouped lat with db params from -> AggregateArg xs lat with db params from -> AggregateArg xs lat with db params from

FilterWhere (WindowArg grp :: [NullType] -> FromType -> FromType -> SchemasType -> [NullType] -> FromType -> Type) grp

Defined in Squeal.PostgreSQL.Expression.Window

Methods

filterWhere :: Condition grp lat with db params from -> WindowArg grp xs lat with db params from -> WindowArg grp xs lat with db params from

Additional (FromClause lat with db params :: FromType -> Type)

Defined in Squeal.PostgreSQL.Query.From

Methods

also :: FromClause lat with db params ys -> FromClause lat with db params xs -> FromClause lat with db params (Join xs ys)

Additional (Selection grp lat with db params from :: RowType -> Type)

Defined in Squeal.PostgreSQL.Query.Select

Methods

also :: Selection grp lat with db params from ys -> Selection grp lat with db params from xs -> Selection grp lat with db params from (Join xs ys)

(JsonBuildObject tys, In key PGJsonKey) => JsonBuildObject (NotNull key ': (value ': tys))

Defined in Squeal.PostgreSQL.Expression.Json

Methods

jsonBuildObject :: (NotNull key ': (value ': tys)) ---> null PGjson

jsonbBuildObject :: (NotNull key ': (value ': tys)) ---> null PGjsonb

ty0 ~ ty1 => SamePGType (alias0 ::: (def0 :=> null0 ty0)) (alias1 ::: (def1 :=> null1 ty1))

Defined in Squeal.PostgreSQL.Type.Schema

(FromValue ty y, fld0 ~ fld1) => FromField (fld0 ::: ty) (fld1 ::: y)

Defined in Squeal.PostgreSQL.Session.Decode

Methods

fromField :: Maybe ByteString -> Either Text (P (fld1 ::: y))

(KnownSymbol col, InlineParam x ty) => InlineColumn (col ::: Optional I (Def :=> x)) (col ::: (Def :=> ty))

Defined in Squeal.PostgreSQL.Expression.Inline

Methods

inlineColumn :: P (col ::: Optional I (Def :=> x)) -> Aliased (Optional (Expression grp lat with db params from)) (col ::: (Def :=> ty))

(KnownSymbol col, InlineParam x ty) => InlineColumn (col ::: x) (col ::: (NoDef :=> ty))

Defined in Squeal.PostgreSQL.Expression.Inline

Methods

inlineColumn :: P (col ::: x) -> Aliased (Optional (Expression grp lat with db params from)) (col ::: (NoDef :=> ty))

(KnownSymbol alias, InlineParam x ty) => InlineField (alias ::: x) (alias ::: ty)

Defined in Squeal.PostgreSQL.Expression.Inline

Methods

inlineField :: P (alias ::: x) -> Aliased (Expression grp lat with db params from) (alias ::: ty)

AddColumn (Def :=> ty)

Defined in Squeal.PostgreSQL.Definition.Table

Methods

addColumn :: (KnownSymbol column, Has sch db schema, Has tab schema (Table (constraints :=> columns))) => Alias column -> ColumnTypeExpression db (Def :=> ty) -> AlterTable sch tab db (constraints :=> Create column (Def :=> ty) columns)

AddColumn (NoDef :=> Null ty)

Defined in Squeal.PostgreSQL.Definition.Table

Methods

addColumn :: (KnownSymbol column, Has sch db schema, Has tab schema (Table (constraints :=> columns))) => Alias column -> ColumnTypeExpression db (NoDef :=> Null ty) -> AlterTable sch tab db (constraints :=> Create column (NoDef :=> Null ty) columns)

IsString (Selection grp lat with db params from (("fromOnly" ::: NotNull PGtext) ': ([] :: [(Symbol, NullType)])))

Defined in Squeal.PostgreSQL.Query.Select

Methods

fromString :: String -> Selection grp lat with db params from (("fromOnly" ::: NotNull PGtext) ': [])

type RowType = [(Symbol, NullType)]

A RowType is a row of NullTypes. They correspond to Haskell record types by means of RowPG and are used in many places.

>>> :{
type family PersonRow :: RowType where
  PersonRow =
    '[ "name"        ::: 'NotNull 'PGtext
     , "age"         ::: 'NotNull 'PGint4
     , "dateOfBirth" :::    'Null 'PGdate
     ]
:}

type FromType = [(Symbol, RowType)]

FromType is a row of RowTypes. It can be thought of as a product, or horizontal gluing and is used in FromClauses and TableExpressions.

Schema Type

type ColumnType = (Optionality, NullType)

ColumnType encodes the allowance of DEFAULT and NULL and the base PGType for a column.

>>> :set -XTypeFamilies -XTypeInType
>>> import GHC.TypeLits
>>> type family IdColumn :: ColumnType where IdColumn = 'Def :=> 'NotNull 'PGint4
>>> type family EmailColumn :: ColumnType where EmailColumn = 'NoDef :=> 'Null 'PGtext

type ColumnsType = [(Symbol, ColumnType)]

ColumnsType is a row of ColumnTypes.

>>> :{
type family UsersColumns :: ColumnsType where
  UsersColumns =
    '[ "name" ::: 'NoDef :=> 'NotNull 'PGtext
     , "id"   :::   'Def :=> 'NotNull 'PGint4
     ]
:}

type TableType = (TableConstraints, ColumnsType)

TableType encodes a row of constraints on a table as well as the types of its columns.

>>> :{
type family UsersTable :: TableType where
  UsersTable =
    '[ "pk_users" ::: 'PrimaryKey '["id"] ] :=>
    '[ "id"       :::   'Def :=> 'NotNull 'PGint4
     , "name"     ::: 'NoDef :=> 'NotNull 'PGtext
     ]
:}

data SchemumType

A SchemumType is a user-created type, like a Table, View or Typedef.

Constructors

Table TableType

View RowType

Typedef PGType

Index IndexType

Function FunctionType

Procedure [NullType]

UnsafeSchemum Symbol

Instances

Category Definition

Defined in Squeal.PostgreSQL.Definition

Methods

id :: Definition a a

(.) :: Definition b c -> Definition a b -> Definition a c

IndexedMonadTrans PQ

Defined in Squeal.PostgreSQL.Session

Methods

pqAp :: Monad m => PQ i j m (x -> y) -> PQ j k m x -> PQ i k m y

pqJoin :: Monad m => PQ i j m (PQ j k m y) -> PQ i k m y

pqBind :: Monad m => (x -> PQ j k m y) -> PQ i j m x -> PQ i k m y

pqThen :: Monad m => PQ j k m y -> PQ i j m x -> PQ i k m y

pqAndThen :: Monad m => (y -> PQ j k m z) -> (x -> PQ i j m y) -> x -> PQ i k m z

Aggregate AggregateArg (Expression (Grouped bys) :: FromType -> FromType -> SchemasType -> [NullType] -> FromType -> NullType -> Type)

Defined in Squeal.PostgreSQL.Expression.Aggregate

Methods

countStar :: Expression (Grouped bys) lat with db params from (NotNull PGint8)

count :: AggregateArg (ty ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (NotNull PGint8)

sum_ :: AggregateArg (null ty ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null (PGSum ty))

arrayAgg :: AggregateArg (ty ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null (PGvararray ty))

jsonAgg :: AggregateArg (ty ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGjson)

jsonbAgg :: AggregateArg (ty ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGjsonb)

bitAnd :: In int PGIntegral => AggregateArg (null int ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null int)

bitOr :: In int PGIntegral => AggregateArg (null int ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null int)

boolAnd :: AggregateArg (null PGbool ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGbool)

boolOr :: AggregateArg (null PGbool ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGbool)

every :: AggregateArg (null PGbool ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGbool)

max_ :: AggregateArg (null ty ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null ty)

min_ :: AggregateArg (null ty ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null ty)

avg :: AggregateArg (null ty ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null (PGAvg ty))

corr :: AggregateArg (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGfloat8)

covarPop :: AggregateArg (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGfloat8)

covarSamp :: AggregateArg (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGfloat8)

regrAvgX :: AggregateArg (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGfloat8)

regrAvgY :: AggregateArg (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGfloat8)

regrCount :: AggregateArg (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGint8)

regrIntercept :: AggregateArg (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGfloat8)

regrR2 :: AggregateArg (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGfloat8)

regrSlope :: AggregateArg (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGfloat8)

regrSxx :: AggregateArg (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGfloat8)

regrSxy :: AggregateArg (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGfloat8)

regrSyy :: AggregateArg (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> Expression (Grouped bys) lat with db params from (Null PGfloat8)

stddev :: AggregateArg (null ty ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null (PGAvg ty))

stddevPop :: AggregateArg (null ty ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null (PGAvg ty))

stddevSamp :: AggregateArg (null ty ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null (PGAvg ty))

variance :: AggregateArg (null ty ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null (PGAvg ty))

varPop :: AggregateArg (null ty ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null (PGAvg ty))

varSamp :: AggregateArg (null ty ': []) lat with db params from -> Expression (Grouped bys) lat with db params from (Null (PGAvg ty))

Aggregate (WindowArg grp :: [NullType] -> FromType -> FromType -> SchemasType -> [NullType] -> FromType -> Type) (WindowFunction grp :: FromType -> FromType -> SchemasType -> [NullType] -> FromType -> NullType -> Type)

Defined in Squeal.PostgreSQL.Expression.Window

Methods

countStar :: WindowFunction grp lat with db params from (NotNull PGint8)

count :: WindowArg grp (ty ': []) lat with db params from -> WindowFunction grp lat with db params from (NotNull PGint8)

sum_ :: WindowArg grp (null ty ': []) lat with db params from -> WindowFunction grp lat with db params from (Null (PGSum ty))

arrayAgg :: WindowArg grp (ty ': []) lat with db params from -> WindowFunction grp lat with db params from (Null (PGvararray ty))

jsonAgg :: WindowArg grp (ty ': []) lat with db params from -> WindowFunction grp lat with db params from (Null PGjson)

jsonbAgg :: WindowArg grp (ty ': []) lat with db params from -> WindowFunction grp lat with db params from (Null PGjsonb)

bitAnd :: In int PGIntegral => WindowArg grp (null int ': []) lat with db params from -> WindowFunction grp lat with db params from (Null int)

bitOr :: In int PGIntegral => WindowArg grp (null int ': []) lat with db params from -> WindowFunction grp lat with db params from (Null int)

boolAnd :: WindowArg grp (null PGbool ': []) lat with db params from -> WindowFunction grp lat with db params from (Null PGbool)

boolOr :: WindowArg grp (null PGbool ': []) lat with db params from -> WindowFunction grp lat with db params from (Null PGbool)

every :: WindowArg grp (null PGbool ': []) lat with db params from -> WindowFunction grp lat with db params from (Null PGbool)

max_ :: WindowArg grp (null ty ': []) lat with db params from -> WindowFunction grp lat with db params from (Null ty)

min_ :: WindowArg grp (null ty ': []) lat with db params from -> WindowFunction grp lat with db params from (Null ty)

avg :: WindowArg grp (null ty ': []) lat with db params from -> WindowFunction grp lat with db params from (Null (PGAvg ty))

corr :: WindowArg grp (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> WindowFunction grp lat with db params from (Null PGfloat8)

covarPop :: WindowArg grp (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> WindowFunction grp lat with db params from (Null PGfloat8)

covarSamp :: WindowArg grp (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> WindowFunction grp lat with db params from (Null PGfloat8)

regrAvgX :: WindowArg grp (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> WindowFunction grp lat with db params from (Null PGfloat8)

regrAvgY :: WindowArg grp (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> WindowFunction grp lat with db params from (Null PGfloat8)

regrCount :: WindowArg grp (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> WindowFunction grp lat with db params from (Null PGint8)

regrIntercept :: WindowArg grp (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> WindowFunction grp lat with db params from (Null PGfloat8)

regrR2 :: WindowArg grp (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> WindowFunction grp lat with db params from (Null PGfloat8)

regrSlope :: WindowArg grp (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> WindowFunction grp lat with db params from (Null PGfloat8)

regrSxx :: WindowArg grp (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> WindowFunction grp lat with db params from (Null PGfloat8)

regrSxy :: WindowArg grp (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> WindowFunction grp lat with db params from (Null PGfloat8)

regrSyy :: WindowArg grp (null PGfloat8 ': (null PGfloat8 ': [])) lat with db params from -> WindowFunction grp lat with db params from (Null PGfloat8)

stddev :: WindowArg grp (null ty ': []) lat with db params from -> WindowFunction grp lat with db params from (Null (PGAvg ty))

stddevPop :: WindowArg grp (null ty ': []) lat with db params from -> WindowFunction grp lat with db params from (Null (PGAvg ty))

stddevSamp :: WindowArg grp (null ty ': []) lat with db params from -> WindowFunction grp lat with db params from (Null (PGAvg ty))

variance :: WindowArg grp (null ty ': []) lat with db params from -> WindowFunction grp lat with db params from (Null (PGAvg ty))

varPop :: WindowArg grp (null ty ': []) lat with db params from -> WindowFunction grp lat with db params from (Null (PGAvg ty))

varSamp :: WindowArg grp (null ty ': []) lat with db params from -> WindowFunction grp lat with db params from (Null (PGAvg ty))

Migratory Definition (Indexed PQ IO ())

pure migrations

Defined in Squeal.PostgreSQL.Session.Migration

Methods

runMigrations :: Path (Migration Definition) db0 db1 -> Indexed PQ IO () db0 db1

Migratory (IsoQ Definition) (IsoQ (Indexed PQ IO ()))

pure rewindable migrations

Defined in Squeal.PostgreSQL.Session.Migration

Methods

runMigrations :: Path (Migration (IsoQ Definition)) db0 db1 -> IsoQ (Indexed PQ IO ()) db0 db1

Migratory (IsoQ (Indexed PQ IO ())) (IsoQ (Indexed PQ IO ()))

impure rewindable migrations

Defined in Squeal.PostgreSQL.Session.Migration

Methods

runMigrations :: Path (Migration (IsoQ (Indexed PQ IO ()))) db0 db1 -> IsoQ (Indexed PQ IO ()) db0 db1

Migratory (OpQ Definition) (OpQ (Indexed PQ IO ()))

pure rewinds

Defined in Squeal.PostgreSQL.Session.Migration

Methods

runMigrations :: Path (Migration (OpQ Definition)) db0 db1 -> OpQ (Indexed PQ IO ()) db0 db1

Migratory (OpQ (Indexed PQ IO ())) (OpQ (Indexed PQ IO ()))

impure rewinds

Defined in Squeal.PostgreSQL.Session.Migration

Methods

runMigrations :: Path (Migration (OpQ (Indexed PQ IO ()))) db0 db1 -> OpQ (Indexed PQ IO ()) db0 db1

Migratory (Indexed PQ IO ()) (Indexed PQ IO ())

impure migrations

Defined in Squeal.PostgreSQL.Session.Migration

Methods

runMigrations :: Path (Migration (Indexed PQ IO ())) db0 db1 -> Indexed PQ IO () db0 db1

data IndexType

PostgreSQL provides several index types: B-tree, Hash, GiST, SP-GiST, GIN and BRIN. Each index type uses a different algorithm that is best suited to different types of queries.

Constructors

Btree

B-trees can handle equality and range queries on data that can be sorted into some ordering.

Hash

Hash indexes can only handle simple equality comparisons.

Gist

GiST indexes are not a single kind of index, but rather an infrastructure within which many different indexing strategies can be implemented.

Spgist

SP-GiST indexes, like GiST indexes, offer an infrastructure that supports various kinds of searches.

Gin

GIN indexes are “inverted indexes” which are appropriate for data values that contain multiple component values, such as arrays.

Brin

BRIN indexes (a shorthand for Block Range INdexes) store summaries about the values stored in consecutive physical block ranges of a table.

type FunctionType = ([NullType], ReturnsType)

Use :=> to pair the parameter types with the return type of a function.

>>> :{
type family Fn :: FunctionType where
  Fn = '[ 'NotNull 'PGint4] :=> 'Returns ('NotNull 'PGint4)
:}

data ReturnsType

Return type of a function

Constructors

Returns NullType

function

ReturnsTable RowType

set returning function

type SchemaType = [(Symbol, SchemumType)]

A schema of a database consists of a list of aliased, user-defined SchemumTypes.

>>> :{
type family Schema :: SchemaType where
  Schema =
    '[ "users" ::: 'Table (
        '[ "pk_users" ::: 'PrimaryKey '["id"] ] :=>
        '[ "id"   :::   'Def :=> 'NotNull 'PGint4
        , "name" ::: 'NoDef :=> 'NotNull 'PGtext
        ])
    , "emails" ::: 'Table (
        '[ "pk_emails"  ::: 'PrimaryKey '["id"]
        , "fk_user_id" ::: 'ForeignKey '["user_id"] "public" "users" '["id"]
        ] :=>
        '[ "id"      :::   'Def :=> 'NotNull 'PGint4
        , "user_id" ::: 'NoDef :=> 'NotNull 'PGint4
        , "email"   ::: 'NoDef :=>    'Null 'PGtext
        ])
    ]
:}

type SchemasType = [(Symbol, SchemaType)]

A database contains one or more named schemas, which in turn contain tables. The same object name can be used in different schemas without conflict; for example, both schema1 and myschema can contain tables named mytable. Unlike databases, schemas are not rigidly separated: a user can access objects in any of the schemas in the database they are connected to, if they have privileges to do so.

There are several reasons why one might want to use schemas:

• To allow many users to use one database without interfering with each other.
• To organize database objects into logical groups to make them more manageable.
• Third-party applications can be put into separate schemas so they do not collide with the names of other objects.

type family Public (schema :: SchemaType) :: SchemasType where ...

A type family to use for a single schema database.

Equations

Public schema = '["public" ::: schema]

Constraint

type (:=>) constraint ty = '(constraint, ty) infixr 7

The constraint operator, :=> is a type level pair between a "constraint" and some type, for use in pairing an Optionality with a NullType to produce a ColumnType or a TableConstraints and a ColumnsType to produce a TableType.

data Optionality

Optionality encodes the availability of DEFAULT for inserts and updates. A column can be assigned a default value. A data Manipulation command can also request explicitly that a column be set to its default value, without having to know what that value is.

Constructors

Def

DEFAULT is available for inserts and updates

NoDef

DEFAULT is unavailable for inserts and updates

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)

ty0 ~ ty1 => SamePGType (alias0 ::: (def0 :=> null0 ty0)) (alias1 ::: (def1 :=> null1 ty1))

Defined in Squeal.PostgreSQL.Type.Schema

(KnownSymbol col, InlineParam x ty) => InlineColumn (col ::: Optional I (Def :=> x)) (col ::: (Def :=> ty))

Defined in Squeal.PostgreSQL.Expression.Inline

Methods

inlineColumn :: P (col ::: Optional I (Def :=> x)) -> Aliased (Optional (Expression grp lat with db params from)) (col ::: (Def :=> ty))

(KnownSymbol col, InlineParam x ty) => InlineColumn (col ::: x) (col ::: (NoDef :=> ty))

Defined in Squeal.PostgreSQL.Expression.Inline

Methods

inlineColumn :: P (col ::: x) -> Aliased (Optional (Expression grp lat with db params from)) (col ::: (NoDef :=> ty))

AddColumn (Def :=> ty)

Defined in Squeal.PostgreSQL.Definition.Table

Methods

addColumn :: (KnownSymbol column, Has sch db schema, Has tab schema (Table (constraints :=> columns))) => Alias column -> ColumnTypeExpression db (Def :=> ty) -> AlterTable sch tab db (constraints :=> Create column (Def :=> ty) columns)

AddColumn (NoDef :=> Null ty)

Defined in Squeal.PostgreSQL.Definition.Table

Methods

addColumn :: (KnownSymbol column, Has sch db schema, Has tab schema (Table (constraints :=> columns))) => Alias column -> ColumnTypeExpression db (NoDef :=> Null ty) -> AlterTable sch tab db (constraints :=> Create column (NoDef :=> Null ty) columns)

data TableConstraint

TableConstraint encodes various forms of data constraints of columns in a table. TableConstraints give you as much control over the data in your tables as you wish. If a user attempts to store data in a column that would violate a constraint, an error is raised. This applies even if the value came from the default value definition.

Constructors

Check [Symbol]

Unique [Symbol]

PrimaryKey [Symbol]

ForeignKey [Symbol] Symbol Symbol [Symbol]

type TableConstraints = [(Symbol, TableConstraint)]

A TableConstraints is a row of TableConstraints.

>>> :{
type family UsersConstraints :: TableConstraints where
  UsersConstraints = '[ "pk_users" ::: 'PrimaryKey '["id"] ]
:}

type family Uniquely (key :: [Symbol]) (constraints :: TableConstraints) :: Constraint where ...

A ForeignKey must reference columns that either are a PrimaryKey or form a Unique constraint.

Equations

Uniquely key ((uq ::: Unique key) ': constraints) = ()

Uniquely key ((pk ::: PrimaryKey key) ': constraints) = ()

Uniquely key (_ ': constraints) = Uniquely key constraints

Enumerated Label

class IsPGlabel (label :: Symbol) expr where

IsPGlabel looks very much like the IsLabel class. Whereas the overloaded label, fromLabel is used for column references, labels are used for enum terms. A label is called with type application like label @"beef".

Methods

label :: expr

Instances

label ~ label1 => IsPGlabel label (PGlabel label1)

Defined in Squeal.PostgreSQL.Type.Schema

Methods

label :: PGlabel label1

IsPGlabel label (y -> NP (K y :: Symbol -> Type) (label ': ([] :: [Symbol])))

Defined in Squeal.PostgreSQL.Type.Schema

Methods

label :: y -> NP (K y) (label ': [])

IsPGlabel label (y -> K y label)

Defined in Squeal.PostgreSQL.Type.Schema

Methods

label :: y -> K y label

labels ~ (label ': ([] :: [Symbol])) => IsPGlabel label (NP PGlabel labels)

Defined in Squeal.PostgreSQL.Type.Schema

Methods

label :: NP PGlabel labels

(KnownSymbol label, In label labels) => IsPGlabel label (Expression grp lat with db params from (null (PGenum labels)))

Defined in Squeal.PostgreSQL.Expression

Methods

label :: Expression grp lat with db params from (null (PGenum labels))

data PGlabel (label :: Symbol)

A PGlabel unit type with an IsPGlabel instance

Constructors

PGlabel

Instances

label ~ label1 => IsPGlabel label (PGlabel label1)

Defined in Squeal.PostgreSQL.Type.Schema

Methods

label :: PGlabel label1

labels ~ (label ': ([] :: [Symbol])) => IsPGlabel label (NP PGlabel labels)

Defined in Squeal.PostgreSQL.Type.Schema

Methods

label :: NP PGlabel labels

KnownSymbol label => RenderSQL (PGlabel label)

Defined in Squeal.PostgreSQL.Type.Schema

Methods

renderSQL :: PGlabel label -> ByteString

All KnownSymbol labels => RenderSQL (NP PGlabel labels)

Defined in Squeal.PostgreSQL.Type.Schema

Methods

renderSQL :: NP PGlabel labels -> ByteString

Data Definition

type family Create alias x xs where ...

Create alias x xs adds alias ::: x to the end of xs and is used in createTable statements and in ALTER TABLE addColumn.

Equations

Create alias x '[] = '[alias ::: x]

Create alias x ((alias ::: y) ': xs) = TypeError ((Text "Create: alias " :<>: ShowType alias) :<>: Text "already exists")

Create alias y (x ': xs) = x ': Create alias y xs

type family CreateIfNotExists alias x xs where ...

Similar to Create but no error on pre-existence

Equations

CreateIfNotExists alias x '[] = '[alias ::: x]

CreateIfNotExists alias x ((alias ::: y) ': xs) = (alias ::: y) ': xs

CreateIfNotExists alias y (x ': xs) = x ': CreateIfNotExists alias y xs

type family CreateOrReplace alias x xs where ...

Similar to Create but used to replace values with the same type.

Equations

CreateOrReplace alias x '[] = '[alias ::: x]

CreateOrReplace alias x ((alias ::: x) ': xs) = (alias ::: x) ': xs

CreateOrReplace alias x ((alias ::: y) ': xs) = TypeError (((((Text "CreateOrReplace: expected type " :<>: ShowType x) :<>: Text " but alias ") :<>: ShowType alias) :<>: Text " has type ") :<>: ShowType y)

CreateOrReplace alias y (x ': xs) = x ': CreateOrReplace alias y xs

type family Drop alias xs where ...

Drop alias xs removes the type associated with alias in xs and is used in dropTable statements and in ALTER TABLE dropColumn statements.

Equations

Drop alias '[] = TypeError ((Text "Drop: alias " :<>: ShowType alias) :<>: Text " does not exist")

Drop alias ((alias ::: x) ': xs) = xs

Drop alias (x ': xs) = x ': Drop alias xs

type family DropSchemum alias sch xs where ...

Drop a particular flavor of schemum type

Equations

DropSchemum alias sch '[] = TypeError ((Text "DropSchemum: alias " :<>: ShowType alias) :<>: Text " does not exist")

DropSchemum alias sch ((alias ::: sch x) ': xs) = xs

DropSchemum alias sch0 ((alias ::: sch1 x) ': xs) = TypeError (((((Text "DropSchemum: expected schemum " :<>: ShowType sch0) :<>: Text " but alias ") :<>: ShowType alias) :<>: Text " has schemum ") :<>: ShowType sch1)

DropSchemum alias sch (x ': xs) = x ': DropSchemum alias sch xs

type family DropIfExists alias xs where ...

Similar to Drop but no error on non-existence

Equations

DropIfExists alias '[] = '[]

DropIfExists alias ((alias ::: x) ': xs) = xs

DropIfExists alias (x ': xs) = x ': DropIfExists alias xs

type family DropSchemumIfExists alias sch xs where ...

Similar to DropSchemum but no error on non-existence

Equations

DropSchemumIfExists alias sch '[] = '[]

DropSchemumIfExists alias sch ((alias ::: sch x) ': xs) = xs

DropSchemumIfExists alias sch0 ((alias ::: sch1 x) ': xs) = TypeError (((((Text "DropSchemumIfExists: expected schemum " :<>: ShowType sch1) :<>: Text " but alias ") :<>: ShowType alias) :<>: Text " has schemum ") :<>: ShowType sch0)

DropSchemumIfExists alias sch (x ': xs) = x ': DropSchemumIfExists alias sch xs

type family Alter alias x xs where ...

Alter alias x xs replaces the type associated with an alias in xs with the type x and is used in alterTable and alterColumn.

Equations

Alter alias x '[] = TypeError ((Text "Alter: alias " :<>: ShowType alias) :<>: Text " does not exist")

Alter alias x1 ((alias ::: x0) ': xs) = (alias ::: x1) ': xs

Alter alias x1 (x0 ': xs) = x0 ': Alter alias x1 xs

type family AlterIfExists alias x xs where ...

Similar to Alter but no error on non-existence

Equations

AlterIfExists alias x '[] = '[]

AlterIfExists alias x1 ((alias ::: x0) ': xs) = (alias ::: x1) ': xs

AlterIfExists alias x1 (x0 ': xs) = x0 ': AlterIfExists alias x1 xs

type family Rename alias0 alias1 xs where ...

Rename alias0 alias1 xs replaces the alias alias0 by alias1 in xs and is used in alterTableRename and renameColumn.

Equations

Rename alias0 alias1 '[] = TypeError ((Text "Rename: alias " :<>: ShowType alias0) :<>: Text " does not exist")

Rename alias0 alias1 ((alias0 ::: x0) ': xs) = (alias1 ::: x0) ': xs

Rename alias0 alias1 (x ': xs) = x ': Rename alias0 alias1 xs

type family RenameIfExists alias0 alias1 xs where ...

Similar to Rename but no error on non-existence

Equations

RenameIfExists alias x '[] = '[]

RenameIfExists alias0 alias1 ((alias0 ::: x0) ': xs) = (alias1 ::: x0) ': xs

RenameIfExists alias0 alias1 (x ': xs) = x ': RenameIfExists alias0 alias1 xs

type family SetSchema sch0 sch1 schema0 schema1 obj srt ty db where ...

Move an object from one schema to another

Equations

SetSchema sch0 sch1 schema0 schema1 obj srt ty db = Alter sch1 (Create obj (srt ty) schema1) (Alter sch0 (DropSchemum obj srt schema0) db)

type family ConstraintInvolves column constraint where ...

Check if a TableConstraint involves a column

Equations

ConstraintInvolves column (Check columns) = column `Elem` columns

ConstraintInvolves column (Unique columns) = column `Elem` columns

ConstraintInvolves column (PrimaryKey columns) = column `Elem` columns

ConstraintInvolves column (ForeignKey columns sch tab refcolumns) = column `Elem` columns

type family DropIfConstraintsInvolve column constraints where ...

Drop all TableConstraints that involve a column

Equations

DropIfConstraintsInvolve column '[] = '[]

DropIfConstraintsInvolve column ((alias ::: constraint) ': constraints) = If (ConstraintInvolves column constraint) (DropIfConstraintsInvolve column constraints) ((alias ::: constraint) ': DropIfConstraintsInvolve column constraints)

Type Classification

type PGNum = '[PGint2, PGint4, PGint8, PGnumeric, PGfloat4, PGfloat8]

Numeric Postgres types.

type PGIntegral = '[PGint2, PGint4, PGint8]

Integral Postgres types.

type PGFloating = '[PGfloat4, PGfloat8, PGnumeric]

Floating Postgres types.

type PGJsonType = '[PGjson, PGjsonb]

Is a type a valid JSON type?

type PGJsonKey = '[PGint2, PGint4, PGtext]

Is a type a valid JSON key?

class SamePGType (ty0 :: (Symbol, ColumnType)) (ty1 :: (Symbol, ColumnType))

Equality constraint on the underlying PGType of two columns.

Instances

ty0 ~ ty1 => SamePGType (alias0 ::: (def0 :=> null0 ty0)) (alias1 ::: (def1 :=> null1 ty1))

Defined in Squeal.PostgreSQL.Type.Schema

type family AllNotNull (columns :: ColumnsType) :: Constraint where ...

AllNotNull is a constraint that proves a ColumnsType has no NULLs.

Equations

AllNotNull ((_ ::: (_ :=> NotNull _)) ': columns) = AllNotNull columns

AllNotNull '[] = ()

type family NotAllNull (columns :: ColumnsType) :: Constraint where ...

NotAllNull is a constraint that proves a ColumnsType has some NOT NULL.

Equations

NotAllNull ((_ ::: (_ :=> NotNull _)) ': _) = ()

NotAllNull ((_ ::: (_ :=> Null _)) ': columns) = NotAllNull columns

Nullification

type family NullifyType (ty :: NullType) :: NullType where ...

NullifyType is an idempotent that nullifies a NullType.

Equations

NullifyType (null ty) = Null ty

type family NullifyRow (columns :: RowType) :: RowType where ...

NullifyRow is an idempotent that nullifies a RowType.

Equations

NullifyRow ((column ::: ty) ': columns) = (column ::: NullifyType ty) ': NullifyRow columns

NullifyRow '[] = '[]

type family NullifyFrom (tables :: FromType) :: FromType where ...

NullifyFrom is an idempotent that nullifies a FromType used to nullify the left or right hand side of an outer join in a FromClause.

Equations

NullifyFrom ((table ::: columns) ': tables) = (table ::: NullifyRow columns) ': NullifyFrom tables

NullifyFrom '[] = '[]

Table Conversion

type family TableToColumns (table :: TableType) :: ColumnsType where ...

TableToColumns removes table constraints.

Equations

TableToColumns (constraints :=> columns) = columns

type family ColumnsToRow (columns :: ColumnsType) :: RowType where ...

ColumnsToRow removes column constraints.

Equations

ColumnsToRow ((column ::: (_ :=> ty)) ': columns) = (column ::: ty) ': ColumnsToRow columns

ColumnsToRow '[] = '[]

type family TableToRow (table :: TableType) :: RowType where ...

Convert a table to a row type.

Equations

TableToRow tab = ColumnsToRow (TableToColumns tab)

Updatable

type Updatable table columns = (All (HasIn (TableToColumns table)) columns, AllUnique columns, SListI (TableToColumns table))

Updatable lists of columns

class AllUnique (xs :: [(Symbol, a)])

No elem of xs appears more than once, in the context of assignment.

Instances

AllUnique ([] :: [(Symbol, a)])

Defined in Squeal.PostgreSQL.Type.Schema

(IsNotElem x (Elem x xs), AllUnique xs) => AllUnique (x ': xs :: [(Symbol, a)])

Defined in Squeal.PostgreSQL.Type.Schema

class IsNotElem x isElem

Utility class for AllUnique to provide nicer error messages.

Instances

IsNotElem (x :: k) False

Defined in Squeal.PostgreSQL.Type.Schema

(TypeError ((Text "Cannot assign to " :<>: ShowType alias) :<>: Text " more than once") :: Constraint) => IsNotElem ((,) alias a :: (k2, k1)) True

Defined in Squeal.PostgreSQL.Type.Schema

User Types

type family UserType (db :: SchemasType) (ty :: PGType) where ...

Calculate the schema and name of a user defined type.

Equations

UserType '[] ty = TypeError (Text "No such user type: " :<>: ShowType ty)

UserType ((sch ::: schema) ': schemas) ty = UserTypeNamespace sch (UserTypeName schema ty) schemas ty

type family UserTypeName (schema :: SchemaType) (ty :: PGType) where ...

Calculate the name of a user defined type.

Equations

UserTypeName '[] ty = Nothing

UserTypeName ((td ::: Typedef ty) ': _) ty = Just td

UserTypeName (_ ': schema) ty = UserTypeName schema ty

type family UserTypeNamespace (sch :: Symbol) (td :: Maybe Symbol) (schemas :: SchemasType) (ty :: PGType) where ...

Helper to calculate the schema of a user defined type.

Equations

UserTypeNamespace sch Nothing schemas ty = UserType schemas ty

UserTypeNamespace sch (Just td) schemas ty = '(sch, td)