Hipsql.Client.Internal

Internal module which implements the hipsql executable. While it is exposed as a library, it is not intended to be used as such.

Disclaimer

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

Internals

type ServantClient = HipsqlRoutes (AsClientT IO)

type PsqlM = InputT (ReaderT PsqlEnv IO)

Interpreter monad for our hipsql client.

data ClientIO

Console IO actions performed by the hipsql client. Useful so we can write tests which do not need to interact with the real stdout.

Constructors

ClientIO

Fields

• inputStrLn' :: String -> PsqlM (Maybe String)
• writeLBSLn' :: ByteString -> PsqlM ()

data PsqlEnv

Runtime environment of the hipsql session.

Constructors

PsqlEnv

Fields

• serverApiVersion :: Version
• state :: IORef ClientState
• io :: ClientIO
• serverEval' :: ByteString -> IO ByteString

newtype ClientState

Runtime state of the hipsql session.

Constructors

ClientState

Fields

• queryBuffer :: ByteString

theHipsqlClientVersion :: Version

The compiled hipsql client version.

main :: IO ()

Main entry point for the hipsql client executable.

usage :: String

Usage message for hipsql.

abort :: String -> IO a

Aborts with the given message on stderr and exits with a non-zero status.

hipsqlClient :: ClientIO -> Int -> Manager -> IO ()

Run the client using the specified configuration.

psql :: PsqlM ()

The hipsql interpreter loop.

getServerEval :: ServantClient -> ByteString -> IO ByteString

Default implementation for calling eval against a hipsql-server.

gets :: (ClientState -> a) -> PsqlM a

Access the runtime state with the supplied function.

modify :: (ClientState -> ClientState) -> PsqlM ClientState

Modify the runtime state given the supplied function.

initPsqlEnv :: ServantClient -> IO PsqlEnv

The default, initial PsqlEnv used by the hipsql client.

initPsqlEnv' :: ClientIO -> ServantClient -> IO PsqlEnv

Same as initPsqlEnv but allows for specifying the ClientIO; mostly useful for tests.

defaultClientIO :: ClientIO

The default ClientIO operations

inputStrLn :: String -> PsqlM (Maybe String)

Writes the supplied String to stdout as the shell prompt and reads a line from stdin as a String.

writeLBSLn :: ByteString -> PsqlM ()

Writes the supplied ByteString to stdout.

serverEval :: ByteString -> PsqlM ByteString

mkServantClient :: Manager -> Int -> IO ServantClient