Safe Haskell	None
Language	Haskell2010

PostgREST.Types

Description

Synopsis

data ContentType
- = CTApplicationJSON
- | CTSingularJSON
- | CTTextCSV
- | CTTextPlain
- | CTOpenAPI
- | CTOctetStream
- | CTAny
- | CTOther ByteString
toHeader :: ContentType -> Header
toMime :: ContentType -> ByteString
decodeContentType :: ByteString -> ContentType
type SqlQuery = Text
type SqlFragment = Text
data PreferResolution
- = MergeDuplicates
- | IgnoreDuplicates
data PreferRepresentation
- = Full
- | HeadersOnly
- | None
data PreferParameters
- = SingleObject
- | MultipleObjects
data PreferCount
- = ExactCount
- | PlannedCount
- | EstimatedCount
data DbStructure = DbStructure {
- dbTables :: [Table]
- dbColumns :: [Column]
- dbRelations :: [Relation]
- dbPrimaryKeys :: [PrimaryKey]
- dbProcs :: ProcsMap
- pgVersion :: PgVersion
}
tableCols :: DbStructure -> Schema -> TableName -> [Column]
tablePKCols :: DbStructure -> Schema -> TableName -> [Text]
data PgArg = PgArg {
- pgaName :: Text
- pgaType :: Text
- pgaReq :: Bool
}
data PgType
- = Scalar QualifiedIdentifier
- | Composite QualifiedIdentifier
data RetType
- = Single PgType
- | SetOf PgType
data ProcVolatility
- = Volatile
- | Stable
- | Immutable
data ProcDescription = ProcDescription {
- pdSchema :: Schema
- pdName :: Text
- pdDescription :: Maybe Text
- pdArgs :: [PgArg]
- pdReturnType :: RetType
- pdVolatility :: ProcVolatility
}
type ProcsMap = HashMap QualifiedIdentifier [ProcDescription]
findProc :: QualifiedIdentifier -> Set Text -> Bool -> ProcsMap -> Maybe ProcDescription
specifiedProcArgs :: Set FieldName -> Maybe ProcDescription -> [PgArg]
procReturnsScalar :: ProcDescription -> Bool
procTableName :: ProcDescription -> Maybe TableName
type Schema = Text
type TableName = Text
data Table = Table {
- tableSchema :: Schema
- tableName :: TableName
- tableDescription :: Maybe Text
- tableInsertable :: Bool
}
tableQi :: Table -> QualifiedIdentifier
newtype ForeignKey = ForeignKey {
- fkCol :: Column
}
data Column = Column {
- colTable :: Table
- colName :: FieldName
- colDescription :: Maybe Text
- colPosition :: Int32
- colNullable :: Bool
- colType :: Text
- colUpdatable :: Bool
- colMaxLen :: Maybe Int32
- colPrecision :: Maybe Int32
- colDefault :: Maybe Text
- colEnum :: [Text]
- colFK :: Maybe ForeignKey
}
type SourceColumn = (Column, ViewColumn)
type ViewColumn = Column
data PrimaryKey = PrimaryKey {
- pkTable :: Table
- pkName :: Text
}
data OrderDirection
- = OrderAsc
- | OrderDesc
data OrderNulls
- = OrderNullsFirst
- | OrderNullsLast
data OrderTerm = OrderTerm {
- otTerm :: Field
- otDirection :: Maybe OrderDirection
- otNullOrder :: Maybe OrderNulls
}
data QualifiedIdentifier = QualifiedIdentifier {
- qiSchema :: Schema
- qiName :: TableName
}
data Cardinality
- = O2M
- | M2O
- | M2M
type ConstraintName = Text
data Relation = Relation {
- relTable :: Table
- relColumns :: [Column]
- relConstraint :: Maybe ConstraintName
- relFTable :: Table
- relFColumns :: [Column]
- relType :: Cardinality
- relJunction :: Maybe Junction
}
data Junction = Junction {
- junTable :: Table
- junConstraint1 :: Maybe ConstraintName
- junCols1 :: [Column]
- junConstraint2 :: Maybe ConstraintName
- junCols2 :: [Column]
}
isSelfReference :: Relation -> Bool
data PayloadJSON
- = ProcessedJSON {
  - pjRaw :: ByteString
  - pjKeys :: Set Text
  }
- | RawJSON {
  - pjRaw :: ByteString
  }
data PJType
- = PJArray {
  - pjaLength :: Int
  }
- | PJObject
data Proxy = Proxy {
- proxyScheme :: Text
- proxyHost :: Text
- proxyPort :: Integer
- proxyPath :: Text
}
type Operator = Text
operators :: HashMap Operator SqlFragment
ftsOperators :: HashMap Operator SqlFragment
data OpExpr = OpExpr Bool Operation
data Operation
- = Op Operator SingleVal
- | In ListVal
- | Fts Operator (Maybe Language) SingleVal
type Language = Text
type SingleVal = Text
type ListVal = [Text]
data LogicOperator
- = And
- | Or
data LogicTree
- = Expr Bool LogicOperator [LogicTree]
- | Stmnt Filter
type FieldName = Text
type JsonPath = [JsonOperation]
data JsonOperation
- = JArrow {
  - jOp :: JsonOperand
  }
- | J2Arrow {
  - jOp :: JsonOperand
  }
data JsonOperand
- = JKey {
  - jVal :: Text
  }
- | JIdx {
  - jVal :: Text
  }
type Field = (FieldName, JsonPath)
type Alias = Text
type Cast = Text
type NodeName = Text
type RpcQParam = (Text, Text)
newtype GucHeader = GucHeader (CI ByteString, ByteString)
unwrapGucHeader :: GucHeader -> Header
addHeadersIfNotIncluded :: [Header] -> [Header] -> [Header]
type SelectItem = (Field, Maybe Cast, Maybe Alias, Maybe EmbedHint)
type EmbedHint = Text
type EmbedPath = [Text]
data Filter = Filter {
- field :: Field
- opExpr :: OpExpr
}
data JoinCondition = JoinCondition (QualifiedIdentifier, FieldName) (QualifiedIdentifier, FieldName)
data ReadQuery = Select {
- select :: [SelectItem]
- from :: QualifiedIdentifier
- fromAlias :: Maybe Alias
- implicitJoins :: [QualifiedIdentifier]
- where_ :: [LogicTree]
- joinConditions :: [JoinCondition]
- order :: [OrderTerm]
- range_ :: NonnegRange
}
data MutateQuery
- = Insert {
  - in_ :: QualifiedIdentifier
  - insCols :: Set FieldName
  - onConflict :: Maybe (PreferResolution, [FieldName])
  - where_ :: [LogicTree]
  - returning :: [FieldName]
  }
- | Update {
  - in_ :: QualifiedIdentifier
  - updCols :: Set FieldName
  - where_ :: [LogicTree]
  - returning :: [FieldName]
  }
- | Delete {
  - in_ :: QualifiedIdentifier
  - where_ :: [LogicTree]
  - returning :: [FieldName]
  }
type ReadRequest = Tree ReadNode
type MutateRequest = MutateQuery
type ReadNode = (ReadQuery, (NodeName, Maybe Relation, Maybe Alias, Maybe EmbedHint, Depth))
type Depth = Integer
fstFieldNames :: ReadRequest -> [FieldName]
data PgVersion = PgVersion {
- pgvNum :: Int32
- pgvName :: Text
}
minimumPgVersion :: PgVersion
pgVersion94 :: PgVersion
pgVersion95 :: PgVersion
pgVersion96 :: PgVersion
pgVersion100 :: PgVersion
pgVersion109 :: PgVersion
pgVersion110 :: PgVersion
pgVersion112 :: PgVersion
pgVersion114 :: PgVersion
pgVersion121 :: PgVersion
sourceCTEName :: SqlFragment
type JSPath = [JSPathExp]
data JSPathExp
- = JSPKey Text
- | JSPIdx Int
data ConnectionStatus
- = NotConnected
- | Connected PgVersion
- | FatalConnectionError Text

Documentation

data ContentType Source #

Enumeration of currently supported response content types

Constructors

CTApplicationJSON
CTSingularJSON
CTTextCSV
CTTextPlain
CTOpenAPI
CTOctetStream
CTAny
CTOther ByteString

Instances

Eq ContentType Source #
Instance details Defined in PostgREST.Types Methods (==) :: ContentType -> ContentType -> Bool # (/=) :: ContentType -> ContentType -> Bool #
Show ContentType Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> ContentType -> ShowS # show :: ContentType -> String # showList :: [ContentType] -> ShowS #

toHeader :: ContentType -> Header Source #

Convert from ContentType to a full HTTP Header

toMime :: ContentType -> ByteString Source #

Convert from ContentType to a ByteString representing the mime type

decodeContentType :: ByteString -> ContentType Source #

Convert from ByteString to ContentType. Warning: discards MIME parameters

type SqlQuery = Text Source #

A SQL query that can be executed independently

type SqlFragment = Text Source #

A part of a SQL query that cannot be executed independently

data PreferResolution Source #

Constructors

MergeDuplicates
IgnoreDuplicates

Instances

Eq PreferResolution Source #
Instance details Defined in PostgREST.Types Methods (==) :: PreferResolution -> PreferResolution -> Bool # (/=) :: PreferResolution -> PreferResolution -> Bool #
Show PreferResolution Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> PreferResolution -> ShowS # show :: PreferResolution -> String # showList :: [PreferResolution] -> ShowS #

data PreferRepresentation Source #

How to return the mutated data. From https://tools.ietf.org/html/rfc7240#section-4.2

Constructors

Full	Return the body plus the Location header(in case of POST).
HeadersOnly	Return the Location header(in case of POST). This needs a SELECT privilege on the pk.
None	Return nothing from the mutated data.

Instances

Eq PreferRepresentation Source #
Instance details Defined in PostgREST.Types Methods (==) :: PreferRepresentation -> PreferRepresentation -> Bool # (/=) :: PreferRepresentation -> PreferRepresentation -> Bool #
Show PreferRepresentation Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> PreferRepresentation -> ShowS # show :: PreferRepresentation -> String # showList :: [PreferRepresentation] -> ShowS #

data PreferParameters Source #

Constructors

SingleObject	Pass all parameters as a single json object to a stored procedure
MultipleObjects	Pass an array of json objects as params to a stored procedure

Instances

Eq PreferParameters Source #
Instance details Defined in PostgREST.Types Methods (==) :: PreferParameters -> PreferParameters -> Bool # (/=) :: PreferParameters -> PreferParameters -> Bool #
Show PreferParameters Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> PreferParameters -> ShowS # show :: PreferParameters -> String # showList :: [PreferParameters] -> ShowS #

data PreferCount Source #

Constructors

ExactCount	exact count(slower)
PlannedCount	PostgreSQL query planner rows count guess. Done by using EXPLAIN {query}.
EstimatedCount	use the query planner rows if the count is superior to max-rows, otherwise get the exact count.

Instances

Eq PreferCount Source #
Instance details Defined in PostgREST.Types Methods (==) :: PreferCount -> PreferCount -> Bool # (/=) :: PreferCount -> PreferCount -> Bool #
Show PreferCount Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> PreferCount -> ShowS # show :: PreferCount -> String # showList :: [PreferCount] -> ShowS #

data DbStructure Source #

Constructors

DbStructure
Fields dbTables :: [Table] dbColumns :: [Column] dbRelations :: [Relation] dbPrimaryKeys :: [PrimaryKey] dbProcs :: ProcsMap pgVersion :: PgVersion

Instances

Eq DbStructure Source #
Instance details Defined in PostgREST.Types Methods (==) :: DbStructure -> DbStructure -> Bool # (/=) :: DbStructure -> DbStructure -> Bool #
Show DbStructure Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> DbStructure -> ShowS # show :: DbStructure -> String # showList :: [DbStructure] -> ShowS #

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

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

data PgArg Source #

Constructors

PgArg
Fields pgaName :: Text pgaType :: Text pgaReq :: Bool

Instances

Eq PgArg Source #
Instance details Defined in PostgREST.Types Methods (==) :: PgArg -> PgArg -> Bool # (/=) :: PgArg -> PgArg -> Bool #
Ord PgArg Source #
Instance details Defined in PostgREST.Types Methods compare :: PgArg -> PgArg -> Ordering # (<) :: PgArg -> PgArg -> Bool # (<=) :: PgArg -> PgArg -> Bool # (>) :: PgArg -> PgArg -> Bool # (>=) :: PgArg -> PgArg -> Bool # max :: PgArg -> PgArg -> PgArg # min :: PgArg -> PgArg -> PgArg #
Show PgArg Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> PgArg -> ShowS # show :: PgArg -> String # showList :: [PgArg] -> ShowS #

data PgType Source #

Constructors

Scalar QualifiedIdentifier
Composite QualifiedIdentifier

Instances

Eq PgType Source #
Instance details Defined in PostgREST.Types Methods (==) :: PgType -> PgType -> Bool # (/=) :: PgType -> PgType -> Bool #
Ord PgType Source #
Instance details Defined in PostgREST.Types Methods compare :: PgType -> PgType -> Ordering # (<) :: PgType -> PgType -> Bool # (<=) :: PgType -> PgType -> Bool # (>) :: PgType -> PgType -> Bool # (>=) :: PgType -> PgType -> Bool # max :: PgType -> PgType -> PgType # min :: PgType -> PgType -> PgType #
Show PgType Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> PgType -> ShowS # show :: PgType -> String # showList :: [PgType] -> ShowS #

data RetType Source #

Constructors

Single PgType
SetOf PgType

Instances

Eq RetType Source #
Instance details Defined in PostgREST.Types Methods (==) :: RetType -> RetType -> Bool # (/=) :: RetType -> RetType -> Bool #
Ord RetType Source #
Instance details Defined in PostgREST.Types Methods compare :: RetType -> RetType -> Ordering # (<) :: RetType -> RetType -> Bool # (<=) :: RetType -> RetType -> Bool # (>) :: RetType -> RetType -> Bool # (>=) :: RetType -> RetType -> Bool # max :: RetType -> RetType -> RetType # min :: RetType -> RetType -> RetType #
Show RetType Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> RetType -> ShowS # show :: RetType -> String # showList :: [RetType] -> ShowS #

data ProcVolatility Source #

Constructors

Volatile
Stable
Immutable

Instances

Eq ProcVolatility Source #
Instance details Defined in PostgREST.Types Methods (==) :: ProcVolatility -> ProcVolatility -> Bool # (/=) :: ProcVolatility -> ProcVolatility -> Bool #
Ord ProcVolatility Source #
Instance details Defined in PostgREST.Types Methods compare :: ProcVolatility -> ProcVolatility -> Ordering # (<) :: ProcVolatility -> ProcVolatility -> Bool # (<=) :: ProcVolatility -> ProcVolatility -> Bool # (>) :: ProcVolatility -> ProcVolatility -> Bool # (>=) :: ProcVolatility -> ProcVolatility -> Bool # max :: ProcVolatility -> ProcVolatility -> ProcVolatility # min :: ProcVolatility -> ProcVolatility -> ProcVolatility #
Show ProcVolatility Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> ProcVolatility -> ShowS # show :: ProcVolatility -> String # showList :: [ProcVolatility] -> ShowS #

data ProcDescription Source #

Constructors

ProcDescription
Fields pdSchema :: Schema pdName :: Text pdDescription :: Maybe Text pdArgs :: [PgArg] pdReturnType :: RetType pdVolatility :: ProcVolatility

Instances

Eq ProcDescription Source #
Instance details Defined in PostgREST.Types Methods (==) :: ProcDescription -> ProcDescription -> Bool # (/=) :: ProcDescription -> ProcDescription -> Bool #
Ord ProcDescription Source #
Instance details Defined in PostgREST.Types Methods compare :: ProcDescription -> ProcDescription -> Ordering # (<) :: ProcDescription -> ProcDescription -> Bool # (<=) :: ProcDescription -> ProcDescription -> Bool # (>) :: ProcDescription -> ProcDescription -> Bool # (>=) :: ProcDescription -> ProcDescription -> Bool # max :: ProcDescription -> ProcDescription -> ProcDescription # min :: ProcDescription -> ProcDescription -> ProcDescription #
Show ProcDescription Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> ProcDescription -> ShowS # show :: ProcDescription -> String # showList :: [ProcDescription] -> ShowS #

type ProcsMap = HashMap QualifiedIdentifier [ProcDescription] Source #

A map of all procs, all of which can be overloaded(one entry will have more than one ProcDescription). | It uses a HashMap for a faster lookup.

findProc :: QualifiedIdentifier -> Set Text -> Bool -> ProcsMap -> Maybe ProcDescription Source #

Search a pg procedure by its parameters. Since a function can be overloaded, the name is not enough to find it. An overloaded function can have a different volatility or even a different return type. Ideally, handling overloaded functions should be left to pg itself. But we need to know certain proc attributes in advance.

specifiedProcArgs :: Set FieldName -> Maybe ProcDescription -> [PgArg] Source #

Search the procedure parameters by matching them with the specified keys. If the key doesn't match a parameter, a parameter with a default type "text" is assumed.

procReturnsScalar :: ProcDescription -> Bool Source #

procTableName :: ProcDescription -> Maybe TableName Source #

type Schema = Text Source #

type TableName = Text Source #

data Table Source #

Constructors

Table
Fields tableSchema :: Schema tableName :: TableName tableDescription :: Maybe Text tableInsertable :: Bool

Instances

Eq Table Source #
Instance details Defined in PostgREST.Types Methods (==) :: Table -> Table -> Bool # (/=) :: Table -> Table -> Bool #
Ord Table Source #
Instance details Defined in PostgREST.Types 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 Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> Table -> ShowS # show :: Table -> String # showList :: [Table] -> ShowS #

tableQi :: Table -> QualifiedIdentifier Source #

newtype ForeignKey Source #

Constructors

ForeignKey
Fields fkCol :: Column

Instances

Eq ForeignKey Source #
Instance details Defined in PostgREST.Types Methods (==) :: ForeignKey -> ForeignKey -> Bool # (/=) :: ForeignKey -> ForeignKey -> Bool #
Ord ForeignKey Source #
Instance details Defined in PostgREST.Types Methods compare :: ForeignKey -> ForeignKey -> Ordering # (<) :: ForeignKey -> ForeignKey -> Bool # (<=) :: ForeignKey -> ForeignKey -> Bool # (>) :: ForeignKey -> ForeignKey -> Bool # (>=) :: ForeignKey -> ForeignKey -> Bool # max :: ForeignKey -> ForeignKey -> ForeignKey # min :: ForeignKey -> ForeignKey -> ForeignKey #
Show ForeignKey Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> ForeignKey -> ShowS # show :: ForeignKey -> String # showList :: [ForeignKey] -> ShowS #

data Column Source #

Constructors

Column
Fields colTable :: Table colName :: FieldName colDescription :: Maybe Text colPosition :: Int32 colNullable :: Bool colType :: Text colUpdatable :: Bool colMaxLen :: Maybe Int32 colPrecision :: Maybe Int32 colDefault :: Maybe Text colEnum :: [Text] colFK :: Maybe ForeignKey

Instances

Eq Column Source #
Instance details Defined in PostgREST.Types Methods (==) :: Column -> Column -> Bool # (/=) :: Column -> Column -> Bool #
Ord Column Source #
Instance details Defined in PostgREST.Types Methods compare :: Column -> Column -> Ordering # (<) :: Column -> Column -> Bool # (<=) :: Column -> Column -> Bool # (>) :: Column -> Column -> Bool # (>=) :: Column -> Column -> Bool # max :: Column -> Column -> Column # min :: Column -> Column -> Column #
Show Column Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> Column -> ShowS # show :: Column -> String # showList :: [Column] -> ShowS #

type SourceColumn = (Column, ViewColumn) Source #

The source table column a view column refers to

type ViewColumn = Column Source #

data PrimaryKey Source #

Constructors

PrimaryKey
Fields pkTable :: Table pkName :: Text

Instances

Eq PrimaryKey Source #
Instance details Defined in PostgREST.Types Methods (==) :: PrimaryKey -> PrimaryKey -> Bool # (/=) :: PrimaryKey -> PrimaryKey -> Bool #
Show PrimaryKey Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> PrimaryKey -> ShowS # show :: PrimaryKey -> String # showList :: [PrimaryKey] -> ShowS #

data OrderDirection Source #

Constructors

OrderAsc
OrderDesc

Instances

Eq OrderDirection Source #
Instance details Defined in PostgREST.Types Methods (==) :: OrderDirection -> OrderDirection -> Bool # (/=) :: OrderDirection -> OrderDirection -> Bool #
Show OrderDirection Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> OrderDirection -> ShowS # show :: OrderDirection -> String # showList :: [OrderDirection] -> ShowS #

data OrderNulls Source #

Constructors

OrderNullsFirst
OrderNullsLast

Instances

Eq OrderNulls Source #
Instance details Defined in PostgREST.Types Methods (==) :: OrderNulls -> OrderNulls -> Bool # (/=) :: OrderNulls -> OrderNulls -> Bool #
Show OrderNulls Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> OrderNulls -> ShowS # show :: OrderNulls -> String # showList :: [OrderNulls] -> ShowS #

data OrderTerm Source #

Constructors

OrderTerm
Fields otTerm :: Field otDirection :: Maybe OrderDirection otNullOrder :: Maybe OrderNulls

Instances

Eq OrderTerm Source #
Instance details Defined in PostgREST.Types Methods (==) :: OrderTerm -> OrderTerm -> Bool # (/=) :: OrderTerm -> OrderTerm -> Bool #
Show OrderTerm Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> OrderTerm -> ShowS # show :: OrderTerm -> String # showList :: [OrderTerm] -> ShowS #

data QualifiedIdentifier Source #

Represents a pg identifier with a prepended schema name "schema.table" When qiSchema is "", the schema is defined by the pg search_path

Constructors

QualifiedIdentifier
Fields qiSchema :: Schema qiName :: TableName

Instances

Eq QualifiedIdentifier Source #
Instance details Defined in PostgREST.Types Methods (==) :: QualifiedIdentifier -> QualifiedIdentifier -> Bool # (/=) :: QualifiedIdentifier -> QualifiedIdentifier -> Bool #
Ord QualifiedIdentifier Source #
Instance details Defined in PostgREST.Types Methods compare :: QualifiedIdentifier -> QualifiedIdentifier -> Ordering # (<) :: QualifiedIdentifier -> QualifiedIdentifier -> Bool # (<=) :: QualifiedIdentifier -> QualifiedIdentifier -> Bool # (>) :: QualifiedIdentifier -> QualifiedIdentifier -> Bool # (>=) :: QualifiedIdentifier -> QualifiedIdentifier -> Bool # max :: QualifiedIdentifier -> QualifiedIdentifier -> QualifiedIdentifier # min :: QualifiedIdentifier -> QualifiedIdentifier -> QualifiedIdentifier #
Show QualifiedIdentifier Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> QualifiedIdentifier -> ShowS # show :: QualifiedIdentifier -> String # showList :: [QualifiedIdentifier] -> ShowS #
Generic QualifiedIdentifier Source #
Instance details Defined in PostgREST.Types Associated Types type Rep QualifiedIdentifier :: Type -> Type # Methods from :: QualifiedIdentifier -> Rep QualifiedIdentifier x # to :: Rep QualifiedIdentifier x -> QualifiedIdentifier #
Hashable QualifiedIdentifier Source #
Instance details Defined in PostgREST.Types Methods hashWithSalt :: Int -> QualifiedIdentifier -> Int # hash :: QualifiedIdentifier -> Int #
type Rep QualifiedIdentifier Source #
Instance details Defined in PostgREST.Types type Rep QualifiedIdentifier = D1 (MetaData "QualifiedIdentifier" "PostgREST.Types" "postgrest-7.0.1-I2LxYwBzonR6GboyH3n0YA" False) (C1 (MetaCons "QualifiedIdentifier" PrefixI True) (S1 (MetaSel (Just "qiSchema") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Schema) :*: S1 (MetaSel (Just "qiName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TableName)))

data Cardinality Source #

The relationship cardinality). | TODO: missing one-to-one

Constructors

O2M	one-to-many, previously known as Parent
M2O	many-to-one, previously known as Child
M2M	many-to-many, previously known as Many

Instances

Eq Cardinality Source #
Instance details Defined in PostgREST.Types Methods (==) :: Cardinality -> Cardinality -> Bool # (/=) :: Cardinality -> Cardinality -> Bool #
Show Cardinality Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> Cardinality -> ShowS # show :: Cardinality -> String # showList :: [Cardinality] -> ShowS #

type ConstraintName = Text Source #

data Relation Source #

Relationship between two tables. The order of the relColumns and relFColumns should be maintained to get the join conditions right. TODO merge relColumns and relFColumns to a tuple or Data.Bimap

Constructors

Relation
Fields relTable :: Table relColumns :: [Column] relConstraint :: Maybe ConstraintName Just on O2M/M2O, Nothing on M2M relFTable :: Table relFColumns :: [Column] relType :: Cardinality relJunction :: Maybe Junction Junction for M2M Cardinality

Instances

Eq Relation Source #
Instance details Defined in PostgREST.Types Methods (==) :: Relation -> Relation -> Bool # (/=) :: Relation -> Relation -> Bool #
Show Relation Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> Relation -> ShowS # show :: Relation -> String # showList :: [Relation] -> ShowS #

data Junction Source #

Junction table on an M2M relationship

Constructors

Junction
Fields junTable :: Table junConstraint1 :: Maybe ConstraintName junCols1 :: [Column] junConstraint2 :: Maybe ConstraintName junCols2 :: [Column]

Instances

Eq Junction Source #
Instance details Defined in PostgREST.Types Methods (==) :: Junction -> Junction -> Bool # (/=) :: Junction -> Junction -> Bool #
Show Junction Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> Junction -> ShowS # show :: Junction -> String # showList :: [Junction] -> ShowS #

isSelfReference :: Relation -> Bool Source #

data PayloadJSON Source #

Constructors

ProcessedJSON	Cached attributes of a JSON payload
Fields pjRaw :: ByteString This is the raw ByteString that comes from the request body. We cache this instead of an Aeson Value because it was detected that for large payloads the encoding had high memory usage, see https://github.com/PostgREST/postgrest/pull/1005 for more details pjKeys :: Set Text Keys of the object or if it's an array these keys are guaranteed to be the same across all its objects
RawJSON
Fields pjRaw :: ByteString This is the raw ByteString that comes from the request body. We cache this instead of an Aeson Value because it was detected that for large payloads the encoding had high memory usage, see https://github.com/PostgREST/postgrest/pull/1005 for more details

Instances

Eq PayloadJSON Source #
Instance details Defined in PostgREST.Types Methods (==) :: PayloadJSON -> PayloadJSON -> Bool # (/=) :: PayloadJSON -> PayloadJSON -> Bool #
Show PayloadJSON Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> PayloadJSON -> ShowS # show :: PayloadJSON -> String # showList :: [PayloadJSON] -> ShowS #

data PJType Source #

Constructors

PJArray
Fields pjaLength :: Int
PJObject

Instances

Eq PJType Source #
Instance details Defined in PostgREST.Types Methods (==) :: PJType -> PJType -> Bool # (/=) :: PJType -> PJType -> Bool #
Show PJType Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> PJType -> ShowS # show :: PJType -> String # showList :: [PJType] -> ShowS #

data Proxy Source #

Constructors

Proxy
Fields proxyScheme :: Text proxyHost :: Text proxyPort :: Integer proxyPath :: Text

Instances

Eq Proxy Source #
Instance details Defined in PostgREST.Types Methods (==) :: Proxy -> Proxy -> Bool # (/=) :: Proxy -> Proxy -> Bool #
Show Proxy Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> Proxy -> ShowS # show :: Proxy -> String # showList :: [Proxy] -> ShowS #

type Operator = Text Source #

operators :: HashMap Operator SqlFragment Source #

ftsOperators :: HashMap Operator SqlFragment Source #

data OpExpr Source #

Constructors

OpExpr Bool Operation

Instances

Eq OpExpr Source #
Instance details Defined in PostgREST.Types Methods (==) :: OpExpr -> OpExpr -> Bool # (/=) :: OpExpr -> OpExpr -> Bool #
Show OpExpr Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> OpExpr -> ShowS # show :: OpExpr -> String # showList :: [OpExpr] -> ShowS #

data Operation Source #

Constructors

Op Operator SingleVal
In ListVal
Fts Operator (Maybe Language) SingleVal

Instances

Eq Operation Source #
Instance details Defined in PostgREST.Types Methods (==) :: Operation -> Operation -> Bool # (/=) :: Operation -> Operation -> Bool #
Show Operation Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> Operation -> ShowS # show :: Operation -> String # showList :: [Operation] -> ShowS #

type Language = Text Source #

type SingleVal = Text Source #

Represents a single value in a filter, e.g. id=eq.singleval

type ListVal = [Text] Source #

Represents a list value in a filter, e.g. id=in.(val1,val2,val3)

data LogicOperator Source #

Constructors

And
Or

Instances

Eq LogicOperator Source #
Instance details Defined in PostgREST.Types Methods (==) :: LogicOperator -> LogicOperator -> Bool # (/=) :: LogicOperator -> LogicOperator -> Bool #
Show LogicOperator Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> LogicOperator -> ShowS # show :: LogicOperator -> String # showList :: [LogicOperator] -> ShowS #

data LogicTree Source #

Boolean logic expression tree e.g. "and(name.eq.N,or(id.eq.1,id.eq.2))" is:

And / name.eq.N Or / id.eq.1 id.eq.2

Constructors

Expr Bool LogicOperator [LogicTree]
Stmnt Filter

Instances

Eq LogicTree Source #
Instance details Defined in PostgREST.Types Methods (==) :: LogicTree -> LogicTree -> Bool # (/=) :: LogicTree -> LogicTree -> Bool #
Show LogicTree Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> LogicTree -> ShowS # show :: LogicTree -> String # showList :: [LogicTree] -> ShowS #

type FieldName = Text Source #

type JsonPath = [JsonOperation] Source #

Json path operations as specified in https://www.postgresql.org/docs/9.4/static/functions-json.html

data JsonOperation Source #

Represents the single arrow `->` or double arrow ->> operators

Constructors

JArrow
Fields jOp :: JsonOperand
J2Arrow
Fields jOp :: JsonOperand

Instances

Eq JsonOperation Source #
Instance details Defined in PostgREST.Types Methods (==) :: JsonOperation -> JsonOperation -> Bool # (/=) :: JsonOperation -> JsonOperation -> Bool #
Show JsonOperation Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> JsonOperation -> ShowS # show :: JsonOperation -> String # showList :: [JsonOperation] -> ShowS #

data JsonOperand Source #

Represents the key(`->'key'`) or index(`->'1`::int`), the index is Text because we reuse our escaping functons and let pg do the casting with '1'::int

Constructors

JKey
Fields jVal :: Text
JIdx
Fields jVal :: Text

Instances

Eq JsonOperand Source #
Instance details Defined in PostgREST.Types Methods (==) :: JsonOperand -> JsonOperand -> Bool # (/=) :: JsonOperand -> JsonOperand -> Bool #
Show JsonOperand Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> JsonOperand -> ShowS # show :: JsonOperand -> String # showList :: [JsonOperand] -> ShowS #

type Field = (FieldName, JsonPath) Source #

type Alias = Text Source #

type Cast = Text Source #

type NodeName = Text Source #

type RpcQParam = (Text, Text) Source #

newtype GucHeader Source #

Custom guc header, it's obtained by parsing the json in a: `SET LOCAL "response.headers" = '[{"Set-Cookie": ".."}]'

Constructors

GucHeader (CI ByteString, ByteString)

Instances

Eq GucHeader Source #
Instance details Defined in PostgREST.Types Methods (==) :: GucHeader -> GucHeader -> Bool # (/=) :: GucHeader -> GucHeader -> Bool #
Show GucHeader Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> GucHeader -> ShowS # show :: GucHeader -> String # showList :: [GucHeader] -> ShowS #
FromJSON GucHeader Source #
Instance details Defined in PostgREST.Types Methods parseJSON :: Value -> Parser GucHeader # parseJSONList :: Value -> Parser [GucHeader] #

unwrapGucHeader :: GucHeader -> Header Source #

addHeadersIfNotIncluded :: [Header] -> [Header] -> [Header] Source #

Add headers not already included to allow the user to override them instead of duplicating them

type SelectItem = (Field, Maybe Cast, Maybe Alias, Maybe EmbedHint) Source #

This type will hold information about which particular Relation between two tables to choose when there are multiple ones. Specifically, it will contain the name of the foreign key or the join table in many to many relations.

type EmbedHint = Text Source #

Disambiguates an embedding operation when there's multiple relationships between two tables. | Can be the name of a foreign key constraint, column name or the junction in an m2m relationship.

type EmbedPath = [Text] Source #

Path of the embedded levels, e.g "clients.projects.name=eq.." gives Path ["clients", "projects"]

data Filter Source #

Constructors

Filter
Fields field :: Field opExpr :: OpExpr

Instances

Eq Filter Source #
Instance details Defined in PostgREST.Types Methods (==) :: Filter -> Filter -> Bool # (/=) :: Filter -> Filter -> Bool #
Show Filter Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> Filter -> ShowS # show :: Filter -> String # showList :: [Filter] -> ShowS #

data JoinCondition Source #

Constructors

JoinCondition (QualifiedIdentifier, FieldName) (QualifiedIdentifier, FieldName)

Instances

Eq JoinCondition Source #
Instance details Defined in PostgREST.Types Methods (==) :: JoinCondition -> JoinCondition -> Bool # (/=) :: JoinCondition -> JoinCondition -> Bool #
Show JoinCondition Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> JoinCondition -> ShowS # show :: JoinCondition -> String # showList :: [JoinCondition] -> ShowS #

data ReadQuery Source #

Constructors

Select
Fields select :: [SelectItem] from :: QualifiedIdentifier fromAlias :: Maybe Alias A table alias is used in case of self joins implicitJoins :: [QualifiedIdentifier] Only used for Many to Many joins. Parent and Child joins use explicit joins. where_ :: [LogicTree] joinConditions :: [JoinCondition] order :: [OrderTerm] range_ :: NonnegRange

Instances

Eq ReadQuery Source #
Instance details Defined in PostgREST.Types Methods (==) :: ReadQuery -> ReadQuery -> Bool # (/=) :: ReadQuery -> ReadQuery -> Bool #
Show ReadQuery Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> ReadQuery -> ShowS # show :: ReadQuery -> String # showList :: [ReadQuery] -> ShowS #

data MutateQuery Source #

Constructors

Insert
Fields in_ :: QualifiedIdentifier insCols :: Set FieldName onConflict :: Maybe (PreferResolution, [FieldName]) where_ :: [LogicTree] returning :: [FieldName]
Update
Fields in_ :: QualifiedIdentifier updCols :: Set FieldName where_ :: [LogicTree] returning :: [FieldName]
Delete
Fields in_ :: QualifiedIdentifier where_ :: [LogicTree] returning :: [FieldName]

Instances

Eq MutateQuery Source #
Instance details Defined in PostgREST.Types Methods (==) :: MutateQuery -> MutateQuery -> Bool # (/=) :: MutateQuery -> MutateQuery -> Bool #
Show MutateQuery Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> MutateQuery -> ShowS # show :: MutateQuery -> String # showList :: [MutateQuery] -> ShowS #

type ReadRequest = Tree ReadNode Source #

type MutateRequest = MutateQuery Source #

type ReadNode = (ReadQuery, (NodeName, Maybe Relation, Maybe Alias, Maybe EmbedHint, Depth)) Source #

type Depth = Integer Source #

fstFieldNames :: ReadRequest -> [FieldName] Source #

data PgVersion Source #

Constructors

PgVersion
Fields pgvNum :: Int32 pgvName :: Text

Instances

Eq PgVersion Source #
Instance details Defined in PostgREST.Types Methods (==) :: PgVersion -> PgVersion -> Bool # (/=) :: PgVersion -> PgVersion -> Bool #
Ord PgVersion Source #
Instance details Defined in PostgREST.Types Methods compare :: PgVersion -> PgVersion -> Ordering # (<) :: PgVersion -> PgVersion -> Bool # (<=) :: PgVersion -> PgVersion -> Bool # (>) :: PgVersion -> PgVersion -> Bool # (>=) :: PgVersion -> PgVersion -> Bool # max :: PgVersion -> PgVersion -> PgVersion # min :: PgVersion -> PgVersion -> PgVersion #
Show PgVersion Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> PgVersion -> ShowS # show :: PgVersion -> String # showList :: [PgVersion] -> ShowS #

minimumPgVersion :: PgVersion Source #

Tells the minimum PostgreSQL version required by this version of PostgREST

pgVersion94 :: PgVersion Source #

pgVersion95 :: PgVersion Source #

pgVersion96 :: PgVersion Source #

pgVersion100 :: PgVersion Source #

pgVersion109 :: PgVersion Source #

pgVersion110 :: PgVersion Source #

pgVersion112 :: PgVersion Source #

pgVersion114 :: PgVersion Source #

pgVersion121 :: PgVersion Source #

sourceCTEName :: SqlFragment Source #

type JSPath = [JSPathExp] Source #

full jspath, e.g. .property[0].attr.detail

data JSPathExp Source #

jspath expression, e.g. .property, .property[0] or ."property-dash"

Constructors

JSPKey Text
JSPIdx Int

Instances

Eq JSPathExp Source #
Instance details Defined in PostgREST.Types Methods (==) :: JSPathExp -> JSPathExp -> Bool # (/=) :: JSPathExp -> JSPathExp -> Bool #
Show JSPathExp Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> JSPathExp -> ShowS # show :: JSPathExp -> String # showList :: [JSPathExp] -> ShowS #

data ConnectionStatus Source #

Current database connection status data ConnectionStatus

Constructors

NotConnected
Connected PgVersion
FatalConnectionError Text

Instances

Eq ConnectionStatus Source #
Instance details Defined in PostgREST.Types Methods (==) :: ConnectionStatus -> ConnectionStatus -> Bool # (/=) :: ConnectionStatus -> ConnectionStatus -> Bool #
Show ConnectionStatus Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> ConnectionStatus -> ShowS # show :: ConnectionStatus -> String # showList :: [ConnectionStatus] -> ShowS #