PostgREST.DbStructure

This module contains queries that target PostgreSQL system catalogs, these are used to build the schema cache(DbStructure).

The schema cache is necessary for resource embedding, foreign keys are used for inferring the relationships between tables.

These queries are executed once at startup or when PostgREST is reloaded.

Documentation

data DbStructure

Constructors

DbStructure

Fields

• dbTables :: [Table]
• dbColumns :: [Column]
• dbRelationships :: [Relationship]
• dbPrimaryKeys :: [PrimaryKey]
• dbProcs :: ProcsMap

Instances

Generic DbStructure

Defined in PostgREST.DbStructure

Associated Types

type Rep DbStructure :: Type -> Type

Methods

from :: DbStructure -> Rep DbStructure x

to :: Rep DbStructure x -> DbStructure

ToJSON DbStructure

Defined in PostgREST.DbStructure

Methods

toJSON :: DbStructure -> Value

toEncoding :: DbStructure -> Encoding

toJSONList :: [DbStructure] -> Value

toEncodingList :: [DbStructure] -> Encoding

type Rep DbStructure

Defined in PostgREST.DbStructure

type Rep DbStructure = D1 ('MetaData "DbStructure" "PostgREST.DbStructure" "postgrest-8.0.0-4wwkfqOKlk5GjHJ3yFP36o" 'False) (C1 ('MetaCons "DbStructure" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbTables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Table]) :*: S1 ('MetaSel ('Just "dbColumns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Column])) :*: (S1 ('MetaSel ('Just "dbRelationships") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Relationship]) :*: (S1 ('MetaSel ('Just "dbPrimaryKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [PrimaryKey]) :*: S1 ('MetaSel ('Just "dbProcs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ProcsMap)))))

queryDbStructure :: [Schema] -> [Schema] -> Bool -> Transaction DbStructure

accessibleTables :: Bool -> Statement Schema [Table]

accessibleProcs :: Bool -> Statement Schema ProcsMap

schemaDescription :: Bool -> Statement Schema (Maybe Text)

tableCols :: DbStructure -> Schema -> TableName -> [Column]

tablePKCols :: DbStructure -> Schema -> TableName -> [Text]