Hipsql.API

Public API for hipsql server and client implementations using servant.

Documentation

type HipsqlAPI = ToServantApi HipsqlRoutes

The servant API type for hipsql.

data HipsqlRoutes route

The API routes for hipsql.

Constructors

HipsqlRoutes

Fields

• getVersion :: route :- (Summary "Gets the current server version" :> ("version" :> Get '[JSON] Version))
• eval :: route :- (Summary "Evaluate a psql expression" :> ("eval" :> (ReqBody '[OctetStream] ByteString :> Post '[OctetStream] ByteString)))

Instances

Generic (HipsqlRoutes route)

Defined in Hipsql.API

Associated Types

type Rep (HipsqlRoutes route) :: Type -> Type

Methods

from :: HipsqlRoutes route -> Rep (HipsqlRoutes route) x

to :: Rep (HipsqlRoutes route) x -> HipsqlRoutes route

type Rep (HipsqlRoutes route)

Defined in Hipsql.API

type Rep (HipsqlRoutes route) = D1 ('MetaData "HipsqlRoutes" "Hipsql.API" "hipsql-api-0.0.0.0-inplace" 'False) (C1 ('MetaCons "HipsqlRoutes" 'PrefixI 'True) (S1 ('MetaSel ('Just "getVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (route :- (Summary "Gets the current server version" :> ("version" :> Get '[JSON] Version)))) :*: S1 ('MetaSel ('Just "eval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (route :- (Summary "Evaluate a psql expression" :> ("eval" :> (ReqBody '[OctetStream] ByteString :> Post '[OctetStream] ByteString)))))))

theHipsqlAPI :: Proxy HipsqlAPI

A hipsql API proxy value.

theHipsqlApiVersion :: Version

The current hipsql-api version; servers and clients should use this to report which version of the API they are compiled against.

renderVersion :: Version -> String

Render a Version to a human-readable String.

isCompatibleWith :: Version -> Version -> Bool

Check if two Versions are compatible wth one another.