postgrest-0.2.12.1: REST API for any Postgres database

Safe Haskell	None
Language	Haskell2010

PostgREST.Types

Documentation

data DbStructure Source

Constructors

DbStructure
Fields tables :: [Table] columns :: [Column] relations :: [Relation] primaryKeys :: [PrimaryKey]

data Table Source

Constructors

Table
Fields tableSchema :: Text tableName :: Text tableInsertable :: Bool tableAcl :: [Text]

Instances

Show Table Source
ToJSON Table Source

data ForeignKey Source

Constructors

ForeignKey
Fields fkTable :: Text fkCol :: Text

Instances

Eq ForeignKey Source
Show ForeignKey Source
ToJSON ForeignKey Source

data Column Source

Constructors

Column
Fields colSchema :: Text colTable :: Text colName :: Text colPosition :: Int colNullable :: Bool colType :: Text colUpdatable :: Bool colMaxLen :: Maybe Int colPrecision :: Maybe Int colDefault :: Maybe Text colEnum :: [Text] colFK :: Maybe ForeignKey
Star
Fields colSchema :: Text colTable :: Text

Instances

Show Column Source
ToJSON Column Source

data PrimaryKey Source

Constructors

PrimaryKey
Fields pkSchema :: Text pkTable :: Text pkName :: Text

data OrderTerm Source

Constructors

OrderTerm
Fields otTerm :: Text otDirection :: ByteString otNullOrder :: Maybe ByteString

Instances

Eq OrderTerm Source
Show OrderTerm Source

data QualifiedIdentifier Source

Constructors

QualifiedIdentifier
Fields qiSchema :: Text qiName :: Text

Instances

Eq QualifiedIdentifier Source
Show QualifiedIdentifier Source

data RelationType Source

Constructors

Child
Parent
Many

Instances

Eq RelationType Source
Show RelationType Source

data Relation Source

Constructors

Relation
Fields relSchema :: Text relTable :: Text relColumns :: [Text] relFTable :: Text relFColumns :: [Text] relType :: RelationType relLTable :: Maybe Text relLCols1 :: Maybe [Text] relLCols2 :: Maybe [Text]

Instances

Eq Relation Source
Show Relation Source

type Operator = Text Source

data FValue Source

Constructors

VText Text
VForeignKey QualifiedIdentifier ForeignKey

Instances

Eq FValue Source
Show FValue Source

type FieldName = Text Source

type JsonPath = [Text] Source

type Field = (FieldName, Maybe JsonPath) Source

type Cast = Text Source

type SelectItem = (Field, Maybe Cast) Source

type Path = [Text] Source

data Query Source

Constructors

Select
Fields mainTable :: Text fields :: [SelectItem] joinTables :: [Text] filters :: [Filter] order :: Maybe [OrderTerm] relation :: Maybe Relation

Instances

Eq Query Source
Show Query Source

data Filter Source

Constructors

Filter
Fields field :: Field operator :: Operator value :: FValue

Instances

Eq Filter Source
Show Filter Source

type ApiRequest = Tree Query Source