Safe Haskell	None
Language	Haskell2010

PostgREST.Request.ApiRequest

Description

Synopsis

data ApiRequest = ApiRequest {
- iAction :: Action
- iRange :: HashMap Text NonnegRange
- iTopLevelRange :: NonnegRange
- iTarget :: Target
- iPayload :: Maybe Payload
- iPreferRepresentation :: PreferRepresentation
- iPreferParameters :: Maybe PreferParameters
- iPreferCount :: Maybe PreferCount
- iPreferResolution :: Maybe PreferResolution
- iPreferTransaction :: Maybe PreferTransaction
- iFilters :: [(Text, Text)]
- iLogic :: [(Text, Text)]
- iSelect :: Maybe Text
- iOnConflict :: Maybe Text
- iColumns :: Set FieldName
- iOrder :: [(Text, Text)]
- iCanonicalQS :: ByteString
- iJWT :: Text
- iHeaders :: [(ByteString, ByteString)]
- iCookies :: [(ByteString, ByteString)]
- iPath :: ByteString
- iMethod :: ByteString
- iProfile :: Maybe Schema
- iSchema :: Schema
- iAcceptContentType :: ContentType
}
data InvokeMethod
- = InvHead
- | InvGet
- | InvPost
data ContentType
- = CTApplicationJSON
- | CTSingularJSON
- | CTTextCSV
- | CTTextPlain
- | CTOpenAPI
- | CTUrlEncoded
- | CTOctetStream
- | CTAny
- | CTOther ByteString
data Action
- = ActionCreate
- | ActionRead {
  - isHead :: Bool
  }
- | ActionUpdate
- | ActionDelete
- | ActionSingleUpsert
- | ActionInvoke InvokeMethod
- | ActionInfo
- | ActionInspect {
  - isHead :: Bool
  }
data Target
- = TargetIdent QualifiedIdentifier
- | TargetProc {
  - tProc :: ProcDescription
  - tpIsRootSpec :: Bool
  }
- | TargetDefaultSpec {
  - tdsSchema :: Schema
  }
- | TargetUnknown
data Payload
- = ProcessedJSON {
  - payRaw :: ByteString
  - payKeys :: Set Text
  }
- | RawJSON {
  - payRaw :: ByteString
  }
- | RawPay {
  - payRaw :: ByteString
  }
userApiRequest :: AppConfig -> DbStructure -> Request -> RequestBody -> Either ApiRequestError ApiRequest

Documentation

data ApiRequest Source #

Describes what the user wants to do. This data type is a translation of the raw elements of an HTTP request into domain specific language. There is no guarantee that the intent is sensible, it is up to a later stage of processing to determine if it is an action we are able to perform.

Constructors

ApiRequest

Fields

iAction :: Action
Similar but not identical to HTTP verb, e.g. Create/Invoke both POST
iRange :: HashMap Text NonnegRange
Requested range of rows within response
iTopLevelRange :: NonnegRange
Requested range of rows from the top level
iTarget :: Target
The target, be it calling a proc or accessing a table
iPayload :: Maybe Payload
Data sent by client and used for mutation actions
iPreferRepresentation :: PreferRepresentation
If client wants created items echoed back
iPreferParameters :: Maybe PreferParameters
How to pass parameters to a stored procedure
iPreferCount :: Maybe PreferCount
Whether the client wants a result count
iPreferResolution :: Maybe PreferResolution
Whether the client wants to UPSERT or ignore records on PK conflict
iPreferTransaction :: Maybe PreferTransaction
Whether the clients wants to commit or rollback the transaction
iFilters :: [(Text, Text)]
Filters on the result ("id", "eq.10")
iLogic :: [(Text, Text)]
&and and &or parameters used for complex boolean logic
iSelect :: Maybe Text
&select parameter used to shape the response
iOnConflict :: Maybe Text
&on_conflict parameter used to upsert on specific unique keys
iColumns :: Set FieldName
parsed colums from &columns parameter and payload
iOrder :: [(Text, Text)]
&order parameters for each level
iCanonicalQS :: ByteString
Alphabetized (canonical) request query string for response URLs
iJWT :: Text
JSON Web Token
iHeaders :: [(ByteString, ByteString)]
HTTP request headers
iCookies :: [(ByteString, ByteString)]
Request Cookies
iPath :: ByteString
Raw request path
iMethod :: ByteString
Raw request method
iProfile :: Maybe Schema
The request profile for enabling use of multiple schemas. Follows the spec in hhttps:/www.w3.orgTRdx-prof-connegttps:/www.w3.orgTRdx-prof-conneg.
iSchema :: Schema
The request schema. Can vary depending on iProfile.
iAcceptContentType :: ContentType

data InvokeMethod Source #

Constructors

InvHead
InvGet
InvPost

Instances

Instances details

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

data ContentType Source #

Enumeration of currently supported response content types

Constructors

CTApplicationJSON
CTSingularJSON
CTTextCSV
CTTextPlain
CTOpenAPI
CTUrlEncoded
CTOctetStream
CTAny
CTOther ByteString

Instances

Instances details

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

data Action Source #

Types of things a user wants to do to tablesviewsprocs

Constructors

ActionCreate
ActionRead
Fields isHead :: Bool
ActionUpdate
ActionDelete
ActionSingleUpsert
ActionInvoke InvokeMethod
ActionInfo
ActionInspect
Fields isHead :: Bool

Instances

Instances details

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

data Target Source #

The target db object of a user action

Constructors

TargetIdent QualifiedIdentifier
TargetProc
Fields tProc :: ProcDescription tpIsRootSpec :: Bool
TargetDefaultSpec
Fields tdsSchema :: Schema
TargetUnknown

data Payload Source #

Constructors

ProcessedJSON	Cached attributes of a JSON payload
Fields payRaw :: 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 payKeys :: 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 payRaw :: 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
RawPay
Fields payRaw :: 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

userApiRequest :: AppConfig -> DbStructure -> Request -> RequestBody -> Either ApiRequestError ApiRequest Source #

Examines HTTP request and translates it into user intent.