PostgREST.Types

Synopsis

• data DbStructure = DbStructure {
  • dbTables :: [Table]
  • dbColumns :: [Column]
  • dbRelations :: [Relation]
  • dbPrimaryKeys :: [PrimaryKey]
  }
• type Schema = Text
• type TableName = Text
• type SqlQuery = Text
• type SqlFragment = Text
• type RequestBody = ByteString
• data Table = Table {
  • tableSchema :: Schema
  • tableName :: TableName
  • tableInsertable :: Bool
  }
• data ForeignKey = ForeignKey {
  • fkCol :: Column
  }
• data Column
  • = Column {
    • colTable :: Table
    • 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 {
    • colTable :: Table
    }
• type Synonym = (Column, Column)
• data PrimaryKey = PrimaryKey {
  • pkTable :: Table
  • pkName :: Text
  }
• data OrderDirection
  • = OrderAsc
  • | OrderDesc
• data OrderNulls
  • = OrderNullsFirst
  • | OrderNullsLast
• data OrderTerm = OrderTerm {
  • otTerm :: Text
  • otDirection :: OrderDirection
  • otNullOrder :: Maybe OrderNulls
  }
• data QualifiedIdentifier = QualifiedIdentifier {
  • qiSchema :: Schema
  • qiName :: TableName
  }
• data RelationType
  • = Child
  • | Parent
  • | Many
• data Relation = Relation {
  • relTable :: Table
  • relColumns :: [Column]
  • relFTable :: Table
  • relFColumns :: [Column]
  • relType :: RelationType
  • relLTable :: Maybe Table
  • relLCols1 :: Maybe [Column]
  • relLCols2 :: Maybe [Column]
  }
• newtype UniformObjects = UniformObjects (Vector Object)
• data Payload
  • = PayloadJSON UniformObjects
  • | PayloadParseError ByteString
• type Operator = Text
• data FValue
  • = VText Text
  • | VForeignKey QualifiedIdentifier ForeignKey
• type FieldName = Text
• type JsonPath = [Text]
• type Field = (FieldName, Maybe JsonPath)
• type Cast = Text
• type NodeName = Text
• type SelectItem = (Field, Maybe Cast)
• type Path = [Text]
• data ReadQuery = Select {
  • select :: [SelectItem]
  • from :: [Text]
  • flt_ :: [Filter]
  • order :: Maybe [OrderTerm]
  }
• data MutateQuery
  • = Insert {
    • in_ :: Text
    • qPayload :: Payload
    }
  • | Delete {
    • in_ :: Text
    • where_ :: [Filter]
    }
  • | Update {
    • in_ :: Text
    • qPayload :: Payload
    • where_ :: [Filter]
    }
• data Filter = Filter {
  • field :: Field
  • operator :: Operator
  • value :: FValue
  }
• type ReadNode = (ReadQuery, (NodeName, Maybe Relation))
• type ReadRequest = Tree ReadNode
• type MutateRequest = MutateQuery
• data DbRequest
  • = DbRead ReadRequest
  • | DbMutate MutateRequest

Documentation