Safe Haskell	None
Language	Haskell2010

PostgREST.Request.Types

Synopsis

type Alias = Text
type Depth = Integer
type EmbedHint = Text
type EmbedPath = [Text]
type Field = (FieldName, JsonPath)
data Filter = Filter {
- field :: Field
- opExpr :: OpExpr
}
data JoinCondition = JoinCondition (QualifiedIdentifier, FieldName) (QualifiedIdentifier, FieldName)
data JsonOperand
- = JKey {
  - jVal :: Text
  }
- | JIdx {
  - jVal :: Text
  }
data JsonOperation
- = JArrow {
  - jOp :: JsonOperand
  }
- | J2Arrow {
  - jOp :: JsonOperand
  }
type JsonPath = [JsonOperation]
type ListVal = [Text]
data LogicOperator
- = And
- | Or
data LogicTree
- = Expr Bool LogicOperator [LogicTree]
- | Stmnt Filter
data MutateQuery
- = Insert {
  - in_ :: QualifiedIdentifier
  - insCols :: Set FieldName
  - insBody :: Maybe ByteString
  - onConflict :: Maybe (PreferResolution, [FieldName])
  - where_ :: [LogicTree]
  - returning :: [FieldName]
  }
- | Update {
  - in_ :: QualifiedIdentifier
  - updCols :: Set FieldName
  - updBody :: Maybe ByteString
  - where_ :: [LogicTree]
  - returning :: [FieldName]
  }
- | Delete {
  - in_ :: QualifiedIdentifier
  - where_ :: [LogicTree]
  - returning :: [FieldName]
  }
type MutateRequest = MutateQuery
type NodeName = Text
data OpExpr = OpExpr Bool Operation
data Operation
- = Op Operator SingleVal
- | In ListVal
- | Fts Operator (Maybe Language) SingleVal
data OrderDirection
- = OrderAsc
- | OrderDesc
data OrderNulls
- = OrderNullsFirst
- | OrderNullsLast
data OrderTerm = OrderTerm {
- otTerm :: Field
- otDirection :: Maybe OrderDirection
- otNullOrder :: Maybe OrderNulls
}
type ReadNode = (ReadQuery, (NodeName, Maybe Relationship, Maybe Alias, Maybe EmbedHint, Depth))
data ReadQuery = Select {
- select :: [SelectItem]
- from :: QualifiedIdentifier
- fromAlias :: Maybe Alias
- implicitJoins :: [QualifiedIdentifier]
- where_ :: [LogicTree]
- joinConditions :: [JoinCondition]
- order :: [OrderTerm]
- range_ :: NonnegRange
}
type ReadRequest = Tree ReadNode
type SelectItem = (Field, Maybe Cast, Maybe Alias, Maybe EmbedHint)
type SingleVal = Text
fstFieldNames :: ReadRequest -> [FieldName]

Documentation

type Alias = Text Source #

type Depth = Integer Source #

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"]

type Field = (FieldName, JsonPath) Source #

data Filter Source #

Constructors

Filter
Fields field :: Field opExpr :: OpExpr

Instances

Instances details

Eq Filter Source #
Instance details Defined in PostgREST.Request.Types Methods (==) :: Filter -> Filter -> Bool # (/=) :: Filter -> Filter -> Bool #

data JoinCondition Source #

Constructors

JoinCondition (QualifiedIdentifier, FieldName) (QualifiedIdentifier, FieldName)

Instances

Instances details

Eq JoinCondition Source #
Instance details Defined in PostgREST.Request.Types Methods (==) :: JoinCondition -> JoinCondition -> Bool # (/=) :: JoinCondition -> JoinCondition -> Bool #

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

Instances details

Eq JsonOperand Source #
Instance details Defined in PostgREST.Request.Types Methods (==) :: JsonOperand -> JsonOperand -> Bool # (/=) :: JsonOperand -> JsonOperand -> Bool #

data JsonOperation Source #

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

Constructors

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

Instances

Instances details

Eq JsonOperation Source #
Instance details Defined in PostgREST.Request.Types Methods (==) :: JsonOperation -> JsonOperation -> Bool # (/=) :: JsonOperation -> JsonOperation -> Bool #

type JsonPath = [JsonOperation] Source #

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

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

Instances details

Eq LogicOperator Source #
Instance details Defined in PostgREST.Request.Types Methods (==) :: LogicOperator -> LogicOperator -> Bool # (/=) :: LogicOperator -> LogicOperator -> Bool #
Show LogicOperator Source #
Instance details Defined in PostgREST.Request.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

Instances details

Eq LogicTree Source #
Instance details Defined in PostgREST.Request.Types Methods (==) :: LogicTree -> LogicTree -> Bool # (/=) :: LogicTree -> LogicTree -> Bool #

data MutateQuery Source #

Constructors

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

type MutateRequest = MutateQuery Source #

type NodeName = Text Source #

data OpExpr Source #

Constructors

OpExpr Bool Operation

Instances

Instances details

Eq OpExpr Source #
Instance details Defined in PostgREST.Request.Types Methods (==) :: OpExpr -> OpExpr -> Bool # (/=) :: OpExpr -> OpExpr -> Bool #

data Operation Source #

Constructors

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

Instances

Instances details

Eq Operation Source #
Instance details Defined in PostgREST.Request.Types Methods (==) :: Operation -> Operation -> Bool # (/=) :: Operation -> Operation -> Bool #

data OrderDirection Source #

Constructors

OrderAsc
OrderDesc

Instances

Instances details

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

data OrderNulls Source #

Constructors

OrderNullsFirst
OrderNullsLast

Instances

Instances details

Eq OrderNulls Source #
Instance details Defined in PostgREST.Request.Types Methods (==) :: OrderNulls -> OrderNulls -> Bool # (/=) :: OrderNulls -> OrderNulls -> Bool #
Show OrderNulls Source #
Instance details Defined in PostgREST.Request.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

Instances details

Eq OrderTerm Source #
Instance details Defined in PostgREST.Request.Types Methods (==) :: OrderTerm -> OrderTerm -> Bool # (/=) :: OrderTerm -> OrderTerm -> Bool #

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

data ReadQuery Source #

Constructors

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

Instances

Instances details

Eq ReadQuery Source #
Instance details Defined in PostgREST.Request.Types Methods (==) :: ReadQuery -> ReadQuery -> Bool # (/=) :: ReadQuery -> ReadQuery -> Bool #

type ReadRequest = Tree ReadNode Source #

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

The select value in `/tbl?select=alias:field::cast`

type SingleVal = Text Source #

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

fstFieldNames :: ReadRequest -> [FieldName] Source #