PostgREST.ApiRequest

Documentation

type RequestBody = ByteString

data Action

Types of things a user wants to do to tablesviewsprocs

Constructors

ActionCreate

ActionRead

ActionUpdate

ActionDelete

ActionInfo

ActionInvoke

ActionInappropriate

Instances

Eq Action

Methods

(==) :: Action -> Action -> Bool

(/=) :: Action -> Action -> Bool

data Target

The target db object of a user action

Constructors

TargetIdent QualifiedIdentifier

TargetProc QualifiedIdentifier

TargetRoot

TargetUnknown [Text]

data PreferRepresentation

How to return the inserted data

Constructors

Full

HeadersOnly

None

Instances

Eq PreferRepresentation

Methods

(==) :: PreferRepresentation -> PreferRepresentation -> Bool

(/=) :: PreferRepresentation -> PreferRepresentation -> Bool

data ContentType

Enumeration of currently supported content types for route responses and upload payloads

Constructors

ApplicationJSON

TextCSV

Instances

Eq ContentType

Methods

(==) :: ContentType -> ContentType -> Bool

(/=) :: ContentType -> ContentType -> Bool

Show ContentType

Methods

showsPrec :: Int -> ContentType -> ShowS

show :: ContentType -> String

showList :: [ContentType] -> ShowS

data ApiRequest

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 String NonnegRange

  Requested range of rows within response

• iTarget :: Target

  The target, be it calling a proc or accessing a table

• iAccepts :: Either ByteString ContentType

  The content type the client most desires (or JSON if undecided)

• iPayload :: Maybe Payload

  Data sent by client and used for mutation actions

• iPreferRepresentation :: PreferRepresentation

  If client wants created items echoed back

• iPreferSingular :: Bool

  If client wants first row as raw object

• iPreferCount :: Bool

  Whether the client wants a result count (slower)

• iFilters :: [(String, String)]

  Filters on the result ("id", "eq.10")

• iSelect :: String

  &select parameter used to shape the response

• iOrder :: [(String, String)]

  &order parameters for each level

• iCanonicalQS :: String

  Alphabetized (canonical) request query string for response URLs

• iJWT :: Text

  JSON Web Token

userApiRequest :: Schema -> Request -> RequestBody -> ApiRequest

Examines HTTP request and translates it into user intent.

pickContentType :: Maybe ByteString -> Either ByteString ContentType

Picks a preferred content type from an Accept header (or from Content-Type as a degenerate case).

For example text/csv -> TextCSV */* -> ApplicationJSON textcsv, applicationjson -> TextCSV applicationjson, textcsv -> ApplicationJSON

type CsvData = Vector (HashMap Text ByteString)

csvToJson :: (Header, CsvData) -> Array

Converts CSV like a,b 1,hi 2,bye

into a JSON array like [ {"a": "1", "b": "hi"}, {"a": 2, "b": "bye"} ]

The reason for its odd signature is so that it can compose directly with CSV.decodeByName

pluralize :: Value -> Array

Convert {foo} to [{foo}], leave arrays unchanged and truncate everything else to an empty array.

ensureUniform :: Array -> Maybe UniformObjects

Test that Array contains only Objects having the same keys and if so mark it as UniformObjects