Safe Haskell	None
Language	GHC2021

PgSchema.Import

Contents

CSchema class
CTabDef class
CDBFieldInfo class
CTypDef class
RecField class
TRelDef type family
CTabRels class
PGEnum type
NameNS type classes

Description

Shared import surface for generated schema modules only.

Do not import this module from handwritten application or library code.

pg-schema tooling emits a schema module (per database or slice) that imports PgSchema.Import to pull in the type classes, type families, and promoted data that describe your schema at compile time. That generated module is what your application should import alongside PgSchema.DML (and optionally PgSchema.Generation for the codegen executable).

PgSchema.Import is a thin re-export hub: it exists so generated files stay short and stable across pg-schema versions, and so the generator does not need to duplicate long import lists from internal modules. It is part of the package’s exposed-modules only so those generated modules (which live in your project, not inside this package) can depend on it via ordinary package imports.

If you import PgSchema.Import directly, you bypass the intended layering, gain no extra capability, and risk silent breakage when the re-export set changes. Treat it as an implementation detail of codegen output, not as a public API to build on.

Synopsis

class (ToStar (TTabs sch), ToStar (TTabRelFroms sch), ToStar (TTabRelTos sch), ToStar (TTabFldDefs sch), ToStar (TTabFlds sch), ToStar (TTabDefs sch), ToStar (TTypes sch), ToStar (Map1 (TTypDefSym1 sch) (TTypes sch))) => CSchema (sch :: k) where
- type TTabs (sch :: k) :: [NameNSK]
- type TTypes (sch :: k) :: [NameNSK]
class (ToStar name, ToStar (TTabDef sch name)) => CTabDef (sch :: k) (name :: NameNSK) where
- type TTabDef (sch :: k) (name :: NameNSK) :: TabDefK
data TabDef' s = TabDef {
- tdFlds :: [s]
- tdKey :: [s]
- tdUniq :: [[s]]
}
class (ToStar (TDBFieldInfo sch tab name), ToStar tab, ToStar name) => CDBFieldInfo (sch :: k) (tab :: NameNSK) (name :: Symbol) where
- type TDBFieldInfo (sch :: k) (tab :: NameNSK) (name :: Symbol) :: RecFieldK NameNSK
data FldDef' s = FldDef {
- fdType :: NameNS' s
- fdNullable :: Bool
- fdHasDefault :: Bool
}
data RelDef' s = RelDef {
- rdFrom :: NameNS' s
- rdTo :: NameNS' s
- rdCols :: [(s, s)]
}
class (ToStar name, ToStar (TTypDef sch name)) => CTypDef (sch :: k) (name :: NameNSK) where
- type TTypDef (sch :: k) (name :: NameNSK) :: TypDefK
data TypDef' s = TypDef {
- typCategory :: s
- typElem :: Maybe (NameNS' s)
- typEnum :: [s]
}
data RecField' s p
- = RFEmpty s
- | RFPlain (FldDef' s)
- | RFAggr (FldDef' s) AggrFun Bool
- | RFToHere p [Ref' s]
- | RFFromHere p [Ref' s]
- | RFSelfRef p [Ref' s]
type RecFieldK = RecField' Symbol
data Ref' s = Ref {
- fromName :: s
- fromDef :: FldDef' s
- toName :: s
- toDef :: FldDef' s
}
class (ToStar (TRelDef sch ref), CTabDef sch (RdFrom (TRelDef sch ref)), CTabDef sch (RdTo (TRelDef sch ref))) => CRelDef (sch :: k) (ref :: NameNSK) where
- type TRelDef (sch :: k) (ref :: NameNSK) :: RelDefK
class CTabRels (sch :: k) (tab :: NameNSK) where
- type TFrom (sch :: k) (tab :: NameNSK) :: [NameNSK]
- type TTo (sch :: k) (tab :: NameNSK) :: [NameNSK]
data family PGEnum sch (name :: NameNSK)
type NameNSK = NameNS' Symbol
type (->>) (ns :: s) (name :: s) = 'NameNS ns name
type ToStar (a :: k) = (SingKind (KindOf a), SingI a)

CSchema class

class (ToStar (TTabs sch), ToStar (TTabRelFroms sch), ToStar (TTabRelTos sch), ToStar (TTabFldDefs sch), ToStar (TTabFlds sch), ToStar (TTabDefs sch), ToStar (TTypes sch), ToStar (Map1 (TTypDefSym1 sch) (TTypes sch))) => CSchema (sch :: k) Source #

The main class for schema. All DML operations are based on this class. It contains all the information about the schema: tables, relations, fields, types.

This class guarantees that we can demote all the necessary information about the schema from type level to value level.

Instances will be generated by code generation

Associated Types

type TTabs (sch :: k) :: [NameNSK] Source #

type TTypes (sch :: k) :: [NameNSK] Source #

Instances

Instances details

CSchema PgCatalog Source #

Instance details

Defined in PgSchema.Schema.Catalog

Associated Types

type TTabs PgCatalog
Instance details Defined in PgSchema.Schema.Catalog type TTabs PgCatalog = '[PGC "pg_attribute", PGC "pg_class", PGC "pg_constraint", PGC "pg_enum", PGC "pg_namespace", PGC "pg_type"]
type TTypes PgCatalog
Instance details Defined in PgSchema.Schema.Catalog type TTypes PgCatalog = '[PGC "oid", PGC "int2", PGC "int2[]", PGC "float4", PGC "bool", PGC "name", PGC "char"]

CTabDef class

class (ToStar name, ToStar (TTabDef sch name)) => CTabDef (sch :: k) (name :: NameNSK) Source #

instances will be generated by code generation

Associated Types

type TTabDef (sch :: k) (name :: NameNSK) :: TabDefK Source #

Instances

Instances details

CTabDef PgCatalog (PGC "pg_attribute") Source #

Instance details

Defined in PgSchema.Schema.Catalog

Associated Types

type TTabDef PgCatalog (PGC "pg_attribute")
Instance details Defined in PgSchema.Schema.Catalog type TTabDef PgCatalog (PGC "pg_attribute") = 'TabDef '["oid", "attrelid", "attname", "atttypid", "attnum", "attnotnull", "atthasdef"] '["oid"] '['["attrelid", "attname"], '["attrelid", "attnum"]]

CTabDef PgCatalog (PGC "pg_class") Source #

Instance details

Defined in PgSchema.Schema.Catalog

Associated Types

type TTabDef PgCatalog (PGC "pg_class")
Instance details Defined in PgSchema.Schema.Catalog type TTabDef PgCatalog (PGC "pg_class") = 'TabDef '["oid", "relnamespace", "relname", "relkind"] '["oid"] '['["relnamespace", "relname"]]

CTabDef PgCatalog (PGC "pg_constraint") Source #

Instance details

Defined in PgSchema.Schema.Catalog

Associated Types

type TTabDef PgCatalog (PGC "pg_constraint")
Instance details Defined in PgSchema.Schema.Catalog type TTabDef PgCatalog (PGC "pg_constraint") = 'TabDef '["oid", "connamespace", "conname", "contype", "conrelid", "confrelid", "conkey", "confkey", "confupdtypeid", "confdeltypeid"] '["oid"] '['["connamespace", "conname"]]

CTabDef PgCatalog (PGC "pg_enum") Source #

Instance details

Defined in PgSchema.Schema.Catalog

Associated Types

type TTabDef PgCatalog (PGC "pg_enum")
Instance details Defined in PgSchema.Schema.Catalog type TTabDef PgCatalog (PGC "pg_enum") = 'TabDef '["oid", "enumtypid", "enumlabel", "enumsortorder"] '["oid"] '['["enumtypid", "enumlabel"], '["enumtypid", "enumsortorder"]]

CTabDef PgCatalog (PGC "pg_namespace") Source #

Instance details

Defined in PgSchema.Schema.Catalog

Associated Types

type TTabDef PgCatalog (PGC "pg_namespace")
Instance details Defined in PgSchema.Schema.Catalog type TTabDef PgCatalog (PGC "pg_namespace") = 'TabDef '["oid", "nspname"] '["oid"] '['["nspname"]]

CTabDef PgCatalog (PGC "pg_type") Source #

Instance details

Defined in PgSchema.Schema.Catalog

Associated Types

type TTabDef PgCatalog (PGC "pg_type")
Instance details Defined in PgSchema.Schema.Catalog type TTabDef PgCatalog (PGC "pg_type") = 'TabDef '["oid", "typnamespace", "typname", "typcategory", "typelem"] '["oid"] '['["typnamespace", "typname"]]

data TabDef' s Source #

Table shape: ordered column names, primary key, unique constraints.

Constructors

TabDef
Fields tdFlds :: [s] Physical column names in order. tdKey :: [s] Primary key column names. tdUniq :: [[s]] Unique constraints as lists of column names.

Instances

Instances details

Show s => Show (TabDef' s) Source #

Instance details

FldDef
Fields fdType :: NameNS' s PostgreSQL type of the column. fdNullable :: Bool `True` if the column allows NULL. fdHasDefault :: Bool `True` if the column has a default value; affects mandatory-field logic.

RelDef
Fields rdFrom :: NameNS' s Referencing table (child). rdTo :: NameNS' s Referenced table (parent). rdCols :: [(s, s)] Pairs `(fromColumn, toColumn)`.

TypDef
Fields typCategory :: s PostgreSql internal type category typElem :: Maybe (NameNS' s) For array types: element type name; `Nothing` for non-arrays. typEnum :: [s] Enum label names for enum types; empty list for non-enums.

RFEmpty s	Placeholder / unnamed slot (depending on schema codegen).
RFPlain (FldDef' s)	Ordinary column with `FldDef'`.
RFAggr (FldDef' s) AggrFun Bool	Aggregate field: `FldDef'`, which aggregate, and whether it is allowed outside `GROUP BY` (when `True`: any select; when `False`: only with `GROUP BY`).
RFToHere p [Ref' s]	Relation: navigate `p` toward the current table (“to here”).
RFFromHere p [Ref' s]	Relation: navigate `p` away from the current table (“from here”).
RFSelfRef p [Ref' s]	Self-referential relation through path `p`.

Ref
Fields fromName :: s Source (child) column name. fromDef :: FldDef' s Type/nullability of `fromName`. toName :: s Target (parent) column name. toDef :: FldDef' s Type/nullability of `toName`.

(Read (PGEnum sch t), ToStar t) => FromJSON (PGEnum sch t) Source #
Instance details Defined in PgSchema.Types Methods parseJSON :: Value -> Parser (PGEnum sch t) # parseJSONList :: Value -> Parser [PGEnum sch t] # omittedField :: Maybe (PGEnum sch t) #
(Show (PGEnum sch t), ToStar t) => ToJSON (PGEnum sch t) Source #
Instance details Defined in PgSchema.Types Methods toJSON :: PGEnum sch t -> Value # toEncoding :: PGEnum sch t -> Encoding # toJSONList :: [PGEnum sch t] -> Value # toEncodingList :: [PGEnum sch t] -> Encoding # omitField :: PGEnum sch t -> Bool #
(Read (PGEnum sch n), ToStar n, Typeable sch, Typeable n) => FromField (PGEnum sch n) Source #
Instance details Defined in PgSchema.Types Methods fromField :: FieldParser (PGEnum sch n) #
(Show (PGEnum sch n), ToStar n) => ToField (PGEnum sch n) Source #
Instance details Defined in PgSchema.Types Methods toField :: PGEnum sch n -> Action #
type CanConvert1 sch tab fld n ('TypDef "E" ('Nothing :: Maybe (NameNS' Symbol)) es) (PGEnum sch n) Source #
Instance details Defined in PgSchema.Types type CanConvert1 sch tab fld n ('TypDef "E" ('Nothing :: Maybe (NameNS' Symbol)) es) (PGEnum sch n)

CSchema class

Instances

CTabDef class

Instances

Instances

CDBFieldInfo class

Instances

Instances

Instances

CTypDef class

Instances

Instances

RecField class

Instances

Instances

TRelDef type family

Instances

CTabRels class

Instances

PGEnum type

Instances

NameNS type classes