Hipsql.API.Internal

Internal module which implements the hipsql HTTP API using servant.

Disclaimer

Changes to this module will not be reflected in the library's version updates.

Internals

newtype Version

Used to show version information for a hipsql server or client.

Constructors

Version

Fields

• version :: [Int]

Instances

Eq Version

Defined in Hipsql.API.Internal

Methods

(==) :: Version -> Version -> Bool

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

Generic Version

Defined in Hipsql.API.Internal

Associated Types

type Rep Version :: Type -> Type

Methods

from :: Version -> Rep Version x

to :: Rep Version x -> Version

ToJSON Version

Defined in Hipsql.API.Internal

Methods

toJSON :: Version -> Value

toEncoding :: Version -> Encoding

toJSONList :: [Version] -> Value

toEncodingList :: [Version] -> Encoding

FromJSON Version

Defined in Hipsql.API.Internal

Methods

parseJSON :: Value -> Parser Version

parseJSONList :: Value -> Parser [Version]

type Rep Version

Defined in Hipsql.API.Internal

type Rep Version = D1 ('MetaData "Version" "Hipsql.API.Internal" "hipsql-api-0.0.0.0-inplace" 'True) (C1 ('MetaCons "Version" 'PrefixI 'True) (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Int])))

lookupHipsqlPort :: IO (Either String Int)

Lookup the HTTP port to use for a hipsql HTTP server or client by checking the HIPSQL_PORT environment variable. Defaults to defaultHipsqlPort if unset.

defaultHipsqlPort :: Int

By default, hipsql should use the port 55805.

lookupEnvInt :: String -> IO (Maybe (Either String Int))

Lookup an environment variable and parse it as an Int.

withDefault :: IO (Maybe a) -> a -> IO a

Used in conjunction with lookupEnvInt to set a default value.

mkVersion :: Version -> Version

Constructs a Version from a Paths_hipsql_*.version value.