Database.PostgreSQL.Store.Table

Table

data Table

Description of a table

Constructors

Table

Fields

• tableName :: ByteString

  Table name

• tableCols :: [ByteString]

  Table columns

Instances

Eq Table

Methods

(==) :: Table -> Table -> Bool

(/=) :: Table -> Table -> Bool

Ord Table

Methods

compare :: Table -> Table -> Ordering

(<) :: Table -> Table -> Bool

(<=) :: Table -> Table -> Bool

(>) :: Table -> Table -> Bool

(>=) :: Table -> Table -> Bool

max :: Table -> Table -> Table

min :: Table -> Table -> Table

Show Table

Methods

showsPrec :: Int -> Table -> ShowS

show :: Table -> String

showList :: [Table] -> ShowS

class Entity a => TableEntity a where

Table entity with extra information about its name and column names

Methods

describeTableType :: Tagged a Table

Describe the table type.

describeTableType :: GenericTable a => Tagged a Table

Describe the table type.

genTableName :: Table -> QueryGenerator a

Embed table name.

genTableColumns :: Table -> QueryGenerator a

Embed a comma-seperated list of the table's columns.

genTableColumnsOn :: Table -> ByteString -> QueryGenerator a

Same as genTableColumns but expands the columns on an alias of the table name.

type GenericTable a = (Generic a, GTable (AnalyzeTable a))

Constraint for generic tables

describeGenericTable :: forall a. GenericTable a => Tagged a Table

Fetch the table description for a generic table type.

Helpers

data KColumns

Type-level description of a record

Constructors

TCombine KColumns KColumns

TSelector Symbol Type

data KTable

Type-level description of a table

Constructors

TTable Symbol KColumns

class GColumns rec where

Provide the means to demote KColumns to a value.

Minimal complete definition

gDescribeColumns

Methods

gDescribeColumns :: Tagged rec [ByteString]

Instantiate singleton

Instances

(GColumns lhs, GColumns rhs) => GColumns (TCombine lhs rhs)

Methods

gDescribeColumns :: Tagged KColumns (TCombine lhs rhs) [ByteString]

KnownSymbol name => GColumns (TSelector name typ)

Methods

gDescribeColumns :: Tagged KColumns (TSelector name typ) [ByteString]

class GTable tbl where

Provide the means to demote KTable to a value.

Minimal complete definition

gDescribeTable

Methods

gDescribeTable :: Tagged tbl Table

Instantiate singleton

Instances

(KnownSymbol name, GColumns cols) => GTable (TTable name cols)

Methods

gDescribeTable :: Tagged KTable (TTable name cols) Table

type family AnalyzeRecordRep org (rec :: * -> *) :: KColumns where ...

Check the Generic representation of a record in order to generate an instance of KColumns.

Equations

AnalyzeRecordRep org (S1 (MetaSel (Just name) m1 m2 m3) (Rec0 typ)) = TSelector name typ

AnalyzeRecordRep org (S1 (MetaSel Nothing m1 m2 m3) a) = TypeError ((Text "Given type " :<>: ShowType org) :<>: Text " must have a single record constructor")

AnalyzeRecordRep org (lhs :*: rhs) = TCombine (AnalyzeRecordRep org lhs) (AnalyzeRecordRep org rhs)

AnalyzeRecordRep org U1 = TypeError ((Text "Given type " :<>: ShowType org) :<>: Text " has one constructor, therefore that constructor must have at least one field")

AnalyzeRecordRep org other = TypeError (((Text "Given type " :<>: ShowType org) :<>: Text " has a constructor with an invalid selector") :$$: ShowType other)

type family AnalyzeTableRep org (dat :: * -> *) :: KTable where ...

Check the Generic representation of a data type in order to generate an instance of KTable.

Equations

AnalyzeTableRep org (D1 meta1 (C1 (MetaCons name f True) sel)) = TTable name (AnalyzeRecordRep org sel)

AnalyzeTableRep org (D1 meta other) = TypeError ((Text "Given type " :<>: ShowType org) :<>: Text " must have a single record constructor")

AnalyzeTableRep org other = TypeError (((Text "Given type " :<>: ShowType org) :<>: Text " is not a valid data type") :$$: ShowType other)

type AnalyzeTable a = AnalyzeTableRep a (Rep a)

Analyzes a type in order to retrieve its KTable representation.