Hipsql.Server.Internal

Internal module which implements starting a hipsql-server from Haskell code.

Disclaimer

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

Internals

newtype Deps

Dependencies required for starting a hipsql server.

Constructors

Deps

Fields

• logger :: String -> IO ()

newtype Config

Configuration required for starting a hipsql server.

Constructors

Config

Fields

• port :: Int

data QueryResponse

A successful response from issuing a query.

Constructors

QueryResponse

Fields

• columnNames :: [Maybe ByteString]
• resultRows :: [[Maybe ByteString]]

newtype QueryError

An error response from issuing a query.

Constructors

QueryError ByteString

Instances

Show QueryError

Defined in Hipsql.Server.Internal

Methods

showsPrec :: Int -> QueryError -> ShowS

show :: QueryError -> String

showList :: [QueryError] -> ShowS

Exception QueryError

Defined in Hipsql.Server.Internal

Methods

toException :: QueryError -> SomeException

fromException :: SomeException -> Maybe QueryError

displayException :: QueryError -> String

newtype ServerState

Runtime state of the hipsql server.

Constructors

ServerState

Fields

• extendedDisplay :: Bool

data ServerEnv

Runtime environment of the hipsql server.

Constructors

ServerEnv

Fields

• conn :: Connection
• killswitch :: MVar ()
• state :: IORef ServerState

newServerEnv :: Connection -> IO ServerEnv

Create an initial ServerEnv.

toHandler :: IO a -> Handler a

Lifts the IO action to a servant Handler, ensuring exceptions are handled accordingly.

server :: ServerEnv -> Server HipsqlAPI

Create a servant Server of the HipsqlAPI.

renderQueryResult :: ServerEnv -> QueryResponse -> IO ByteString

Render a QueryResponse received from issuing a query as human readable. Respects the current extendedDisplay state.

renderXTable :: [ByteString] -> [[ByteString]] -> ByteString

Special case of renderTable which renders the supplied header and values via extendedDisplay.

renderTable :: Maybe [ByteString] -> [[ByteString]] -> ByteString

Render the supplied optional header and values as a table for printing in the console. Attempts to match closely to real psql output.

safeInit :: [a] -> [a]

Same as init except returns an empty list if the supplied list is empty.

rawQuery :: ServerEnv -> ByteString -> IO QueryResponse

Execute the supplied query and return its response.

mkQueryResponse :: Result -> IO QueryResponse

Construct a QueryResponse from a Result. NOTE: This is dangerous as it does not validate that an error did not occur. Prefer rawQuery instead.

helpMessage :: ByteString

Help message displayed when the user gives the ? command.

application :: ServerEnv -> Application

A servant Application of the HipsqlAPI.

startHipsql :: Maybe SrcLoc -> Connection -> IO ()

Start a hipsql session with the given Connection.

startHipsql' :: Maybe SrcLoc -> Config -> Deps -> Connection -> IO ()

Same as startHipsql but allows you to specify the Config and Deps directly.

startHipsqlWith :: Maybe SrcLoc -> ((Connection -> IO ()) -> IO ()) -> IO ()

Same as startHipsql except uses a Connection acquiring function. Useful when integrating with libraries like postgresql-simple which give you exclusive access to the Connection via such a function.

startHipsqlWith' :: Maybe SrcLoc -> Config -> Deps -> ((Connection -> IO ()) -> IO ()) -> IO ()

Same as startHipsqlWith but allows you to specify the Config and Deps directly.

getDefaultConfig :: IO Config

Gets the default Config used by the hipsql server.

getDefaultDeps :: IO Deps

Gets the default Deps used by the hipsql server.