Copyright	(C) 2019 Earnest Research
License	MIT
Maintainer	Daniel Donohue <ddonohue@earnestresearch.com>
Stability	experimental
Portability	non-portable
Safe Haskell	None
Language	Haskell2010

Network.Livy

Contents

Running Livy actions
Environment
Request/response
Livy actions
REST objects
Exceptions
Misc.

Description

hlivy is a Haskell library that provides bindings to the Apache Livy REST API, which enables one to easily launch Spark applications -- either in an interactive or batch fashion -- via HTTP requests to the Livy server running on the master node of a Spark cluster.

Usage:

In general, to use this library, one creates a request by using a default constructor and modifying it, as needed, with the provided request lenses. Wrapping this request with send creates a Livy action that can be ran with runLivy.

For example, to run a Spark application whose main class is com.company.my_app and to request 4 cores per executor from the cluster:

import Network.Livy
import Control.Lens ((?~), (&))

main :: IO (Either LivyError CreateBatchResponse)
main = do
  env <- newEnv "localhost" 8998
  let req = createBatch "/user/hadoop/my-app.jar"
          & cbClassName ?~ "com.company.my_app"
          & cbExecutorCores ?~ 4
  runLivy env $ send req

For more example usage, see the examples.

Synopsis

type Livy = LivyT Env (ResourceT IO)
newtype LivyT r m a = LivyT {
- unLivyT :: ReaderT r m a
}
runLivy :: HasEnv r => r -> Livy a -> IO a
runLivyT :: HasEnv r => r -> LivyT r m a -> m a
send :: LivyConstraint r m a => a -> m (Either LivyError (LivyResponse a))
data Env = Env {
- _envManager :: !Manager
- _envHost :: !ByteString
- _envPort :: !Int
}
class HasEnv a where
- environment :: Lens' a Env
- envManager :: Lens' a Manager
- envHost :: Lens' a ByteString
- envPort :: Lens' a Int
newEnv :: MonadIO m => ByteString -> Int -> m Env
class LivyRequest a where
- request :: a -> Request
type family LivyResponse a :: *
module Network.Livy.Client.Batch
module Network.Livy.Client.Interactive
data Batch = Batch {
- _bId :: !BatchId
- _bAppId :: !(Maybe Text)
- _bAppInfo :: !BatchAppInfo
- _bLog :: ![Text]
- _bState :: !BatchState
}
newtype BatchId = BatchId Int
data BatchState
- = BatchNotStarted
- | BatchStarting
- | BatchRecovering
- | BatchIdle
- | BatchRunning
- | BatchBusy
- | BatchShuttingDown
- | BatchError
- | BatchDead
- | BatchKilled
- | BatchSuccess
type BatchAppInfo = HashMap Text (Maybe Text)
bId :: Lens' Batch BatchId
bAppId :: Lens' Batch (Maybe Text)
bAppInfo :: Lens' Batch BatchAppInfo
bLog :: Lens' Batch [Text]
bState :: Lens' Batch BatchState
data Session = Session {
- _sId :: !SessionId
- _sAppId :: !(Maybe Text)
- _sOwner :: !(Maybe Text)
- _sProxyUser :: !(Maybe Text)
- _sKind :: !SessionKind
- _sLog :: ![Text]
- _sState :: !SessionState
- _sAppInfo :: !SessionAppInfo
}
newtype SessionId = SessionId Int
data SessionKind
- = SparkSession
- | PySparkSession
- | SparkRSession
- | SQLSession
- | SharedSession
data SessionState
- = SessionNotStarted
- | SessionStarting
- | SessionRecovering
- | SessionIdle
- | SessionRunning
- | SessionBusy
- | SessionShuttingDown
- | SessionError
- | SessionDead
- | SessionKilled
- | SessionSuccess
type SessionAppInfo = HashMap Text (Maybe Text)
sId :: Lens' Session SessionId
sAppId :: Lens' Session (Maybe Text)
sOwner :: Lens' Session (Maybe Text)
sProxyUser :: Lens' Session (Maybe Text)
sKind :: Lens' Session SessionKind
sLog :: Lens' Session [Text]
sState :: Lens' Session SessionState
sAppInfo :: Lens' Session SessionAppInfo
data Statement = Statement {
- _stId :: !StatementId
- _stCode :: !(Maybe Text)
- _stState :: !(Maybe StatementState)
- _stOutput :: !(Maybe StatementOutput)
}
newtype StatementId = StatementId Int
data StatementState
- = StatementWaiting
- | StatementRunning
- | StatementAvailable
- | StatementError
- | StatementCancelling
- | StatementCancelled
data StatementOutput = StatementOutput {
- _stoStatus :: !(Maybe Text)
- _stoExecutionCount :: !(Maybe Integer)
- _stoData :: !(Maybe StatementData)
}
type StatementData = HashMap Text (Maybe Text)
stoStatus :: Lens' StatementOutput (Maybe Text)
stoExecutionCount :: Lens' StatementOutput (Maybe Integer)
stoData :: Lens' StatementOutput (Maybe StatementData)
stId :: Lens' Statement StatementId
stCode :: Lens' Statement (Maybe Text)
stState :: Lens' Statement (Maybe StatementState)
stOutput :: Lens' Statement (Maybe StatementOutput)
data LivyError = LivyError {
- _leType :: !LivyErrorType
- _leMessage :: !ByteString
- _leResponseBody :: !(Maybe ByteString)
- _leCode :: !(Maybe LivyHTTPErrorCode)
}
data LivyErrorType
- = InvalidRequest
- | ParseFailure
- | LibraryException HttpException
- | UnknownErrorType
data LivyHTTPErrorCode
- = BadRequest
- | Unauthorized
- | RequestFailed
- | Forbidden
- | BadMethod
- | NotFound
- | ServerError
- | UnknownHTTPErrorCode
data APIVersion = V050Incubating

Running Livy actions

type Livy = LivyT Env (ResourceT IO) Source #

A specialization of LivyT.

newtype LivyT r m a Source #

LivyT transformer.

Constructors

LivyT
Fields unLivyT :: ReaderT r m a

Instances

Monad m => MonadReader r (LivyT r m) Source #
Instance details Defined in Network.Livy.Monad Methods ask :: LivyT r m r # local :: (r -> r) -> LivyT r m a -> LivyT r m a # reader :: (r -> a) -> LivyT r m a #
MonadTrans (LivyT r) Source #
Instance details Defined in Network.Livy.Monad Methods lift :: Monad m => m a -> LivyT r m a #
Monad m => Monad (LivyT r m) Source #
Instance details Defined in Network.Livy.Monad Methods (>>=) :: LivyT r m a -> (a -> LivyT r m b) -> LivyT r m b # (>>) :: LivyT r m a -> LivyT r m b -> LivyT r m b # return :: a -> LivyT r m a # fail :: String -> LivyT r m a #
Functor m => Functor (LivyT r m) Source #
Instance details Defined in Network.Livy.Monad Methods fmap :: (a -> b) -> LivyT r m a -> LivyT r m b # (<$) :: a -> LivyT r m b -> LivyT r m a #
Applicative m => Applicative (LivyT r m) Source #
Instance details Defined in Network.Livy.Monad Methods pure :: a -> LivyT r m a # (<>) :: LivyT r m (a -> b) -> LivyT r m a -> LivyT r m b # liftA2 :: (a -> b -> c) -> LivyT r m a -> LivyT r m b -> LivyT r m c # (>) :: LivyT r m a -> LivyT r m b -> LivyT r m b # (<*) :: LivyT r m a -> LivyT r m b -> LivyT r m a #
MonadIO m => MonadIO (LivyT r m) Source #
Instance details Defined in Network.Livy.Monad Methods liftIO :: IO a -> LivyT r m a #
MonadThrow m => MonadThrow (LivyT r m) Source #
Instance details Defined in Network.Livy.Monad Methods throwM :: Exception e => e -> LivyT r m a #
MonadCatch m => MonadCatch (LivyT r m) Source #
Instance details Defined in Network.Livy.Monad Methods catch :: Exception e => LivyT r m a -> (e -> LivyT r m a) -> LivyT r m a #
MonadResource m => MonadResource (LivyT r m) Source #
Instance details Defined in Network.Livy.Monad Methods liftResourceT :: ResourceT IO a -> LivyT r m a #

runLivy :: HasEnv r => r -> Livy a -> IO a Source #

Run the Livy monad.

runLivyT :: HasEnv r => r -> LivyT r m a -> m a Source #

Run a LivyT action with the given environment.

send :: LivyConstraint r m a => a -> m (Either LivyError (LivyResponse a)) Source #

Send a request, returning the associated response if successful.

Environment

data Env Source #

Environment required to make requests to Livy.

Constructors

Env
Fields _envManager :: !Manager HTTP manager. _envHost :: !ByteString The host name. _envPort :: !Int The port number.

Instances

HasEnv Env Source #
Instance details Defined in Network.Livy.Env Methods environment :: Lens' Env Env Source # envManager :: Lens' Env Manager Source # envHost :: Lens' Env ByteString Source # envPort :: Lens' Env Int Source #

class HasEnv a where Source #

Minimal complete definition

environment

Methods

environment :: Lens' a Env Source #

envManager :: Lens' a Manager Source #

Manager used to create and manage HTTP connections.

envHost :: Lens' a ByteString Source #

The host name.

envPort :: Lens' a Int Source #

The port number.

Instances

HasEnv Env Source #
Instance details Defined in Network.Livy.Env Methods environment :: Lens' Env Env Source # envManager :: Lens' Env Manager Source # envHost :: Lens' Env ByteString Source # envPort :: Lens' Env Int Source #

newEnv :: MonadIO m => ByteString -> Int -> m Env Source #

Creates a new environment with a new Manager with default settings.

Request/response

class LivyRequest a where Source #

Specify how a request is created.

Methods

request :: a -> Request Source #

Instances

LivyRequest RunStatementCompletion Source #
Instance details Defined in Network.Livy.Client.Interactive.RunStatementCompletion Methods request :: RunStatementCompletion -> Request Source #
LivyRequest RunStatement Source #
Instance details Defined in Network.Livy.Client.Interactive.RunStatement Methods request :: RunStatement -> Request Source #
LivyRequest KillSession Source #
Instance details Defined in Network.Livy.Client.Interactive.KillSession Methods request :: KillSession -> Request Source #
LivyRequest GetSessions Source #
Instance details Defined in Network.Livy.Client.Interactive.GetSessions Methods request :: GetSessions -> Request Source #
LivyRequest GetSessionStatements Source #
Instance details Defined in Network.Livy.Client.Interactive.GetSessionStatements Methods request :: GetSessionStatements -> Request Source #
LivyRequest GetSessionStatement Source #
Instance details Defined in Network.Livy.Client.Interactive.GetSessionStatement Methods request :: GetSessionStatement -> Request Source #
LivyRequest GetSessionState Source #
Instance details Defined in Network.Livy.Client.Interactive.GetSessionState Methods request :: GetSessionState -> Request Source #
LivyRequest GetSessionLogs Source #
Instance details Defined in Network.Livy.Client.Interactive.GetSessionLogs Methods request :: GetSessionLogs -> Request Source #
LivyRequest GetSession Source #
Instance details Defined in Network.Livy.Client.Interactive.GetSession Methods request :: GetSession -> Request Source #
LivyRequest CreateSession Source #
Instance details Defined in Network.Livy.Client.Interactive.CreateSession Methods request :: CreateSession -> Request Source #
LivyRequest CancelStatement Source #
Instance details Defined in Network.Livy.Client.Interactive.CancelStatement Methods request :: CancelStatement -> Request Source #
LivyRequest KillBatch Source #
Instance details Defined in Network.Livy.Client.Batch.KillBatch Methods request :: KillBatch -> Request Source #
LivyRequest GetBatches Source #
Instance details Defined in Network.Livy.Client.Batch.GetBatches Methods request :: GetBatches -> Request Source #
LivyRequest GetBatchState Source #
Instance details Defined in Network.Livy.Client.Batch.GetBatchState Methods request :: GetBatchState -> Request Source #
LivyRequest GetBatchLogs Source #
Instance details Defined in Network.Livy.Client.Batch.GetBatchLogs Methods request :: GetBatchLogs -> Request Source #
LivyRequest GetBatch Source #
Instance details Defined in Network.Livy.Client.Batch.GetBatch Methods request :: GetBatch -> Request Source #
LivyRequest CreateBatch Source #
Instance details Defined in Network.Livy.Client.Batch.CreateBatch Methods request :: CreateBatch -> Request Source #

type family LivyResponse a :: * Source #

The response type of a Livy request.

Instances

type LivyResponse RunStatementCompletion Source #
Instance details Defined in Network.Livy.Client.Interactive.RunStatementCompletion type LivyResponse RunStatementCompletion = RunStatementCompletionResponse
type LivyResponse RunStatement Source #
Instance details Defined in Network.Livy.Client.Interactive.RunStatement type LivyResponse RunStatement = RunStatementResponse
type LivyResponse KillSession Source #
Instance details Defined in Network.Livy.Client.Interactive.KillSession type LivyResponse KillSession = KillSessionResponse
type LivyResponse GetSessions Source #
Instance details Defined in Network.Livy.Client.Interactive.GetSessions type LivyResponse GetSessions = GetSessionsResponse
type LivyResponse GetSessionStatements Source #
Instance details Defined in Network.Livy.Client.Interactive.GetSessionStatements type LivyResponse GetSessionStatements = GetSessionStatementsResponse
type LivyResponse GetSessionStatement Source #
Instance details Defined in Network.Livy.Client.Interactive.GetSessionStatement type LivyResponse GetSessionStatement = GetSessionStatementResponse
type LivyResponse GetSessionState Source #
Instance details Defined in Network.Livy.Client.Interactive.GetSessionState type LivyResponse GetSessionState = GetSessionStateResponse
type LivyResponse GetSessionLogs Source #
Instance details Defined in Network.Livy.Client.Interactive.GetSessionLogs type LivyResponse GetSessionLogs = GetSessionLogsResponse
type LivyResponse GetSession Source #
Instance details Defined in Network.Livy.Client.Interactive.GetSession type LivyResponse GetSession = GetSessionResponse
type LivyResponse CreateSession Source #
Instance details Defined in Network.Livy.Client.Interactive.CreateSession type LivyResponse CreateSession = CreateSessionResponse
type LivyResponse CancelStatement Source #
Instance details Defined in Network.Livy.Client.Interactive.CancelStatement type LivyResponse CancelStatement = CancelStatementResponse
type LivyResponse KillBatch Source #
Instance details Defined in Network.Livy.Client.Batch.KillBatch type LivyResponse KillBatch = KillBatchResponse
type LivyResponse GetBatches Source #
Instance details Defined in Network.Livy.Client.Batch.GetBatches type LivyResponse GetBatches = GetBatchesResponse
type LivyResponse GetBatchState Source #
Instance details Defined in Network.Livy.Client.Batch.GetBatchState type LivyResponse GetBatchState = GetBatchStateResponse
type LivyResponse GetBatchLogs Source #
Instance details Defined in Network.Livy.Client.Batch.GetBatchLogs type LivyResponse GetBatchLogs = GetBatchLogsResponse
type LivyResponse GetBatch Source #
Instance details Defined in Network.Livy.Client.Batch.GetBatch type LivyResponse GetBatch = GetBatchResponse
type LivyResponse CreateBatch Source #
Instance details Defined in Network.Livy.Client.Batch.CreateBatch type LivyResponse CreateBatch = CreateBatchResponse

Livy actions

module Network.Livy.Client.Batch

module Network.Livy.Client.Interactive

REST objects

Batch session

data Batch Source #

A batch session with Livy.

Constructors

Batch
Fields _bId :: !BatchId The session id. _bAppId :: !(Maybe Text) The application id of this session. _bAppInfo :: !BatchAppInfo The detailed application info. _bLog :: ![Text] The log lines. _bState :: !BatchState The batch state.

Instances

Eq Batch Source #
Instance details Defined in Network.Livy.Client.Types.Batch Methods (==) :: Batch -> Batch -> Bool # (/=) :: Batch -> Batch -> Bool #
Show Batch Source #
Instance details Defined in Network.Livy.Client.Types.Batch Methods showsPrec :: Int -> Batch -> ShowS # show :: Batch -> String # showList :: [Batch] -> ShowS #
ToJSON Batch Source #
Instance details Defined in Network.Livy.Client.Types.Batch Methods toJSON :: Batch -> Value # toEncoding :: Batch -> Encoding # toJSONList :: [Batch] -> Value # toEncodingList :: [Batch] -> Encoding #
FromJSON Batch Source #
Instance details Defined in Network.Livy.Client.Types.Batch Methods parseJSON :: Value -> Parser Batch # parseJSONList :: Value -> Parser [Batch] #

newtype BatchId Source #

The id of this batch session.

Constructors

BatchId Int

Instances

Eq BatchId Source #
Instance details Defined in Network.Livy.Client.Types.Batch Methods (==) :: BatchId -> BatchId -> Bool # (/=) :: BatchId -> BatchId -> Bool #
Show BatchId Source #
Instance details Defined in Network.Livy.Client.Types.Batch Methods showsPrec :: Int -> BatchId -> ShowS # show :: BatchId -> String # showList :: [BatchId] -> ShowS #
ToJSON BatchId Source #
Instance details Defined in Network.Livy.Client.Types.Batch Methods toJSON :: BatchId -> Value # toEncoding :: BatchId -> Encoding # toJSONList :: [BatchId] -> Value # toEncodingList :: [BatchId] -> Encoding #
FromJSON BatchId Source #
Instance details Defined in Network.Livy.Client.Types.Batch Methods parseJSON :: Value -> Parser BatchId # parseJSONList :: Value -> Parser [BatchId] #
ToText BatchId Source #
Instance details Defined in Network.Livy.Client.Types.Batch Methods toText :: BatchId -> Text Source #

data BatchState Source #

The present state of a batch session.

Constructors

BatchNotStarted	Batch session has not been started.
BatchStarting	Batch session is starting.
BatchRecovering	Batch session is recovering.
BatchIdle	Batch session is waiting for input.
BatchRunning	Batch session is running.
BatchBusy	Batch session is executing a statement.
BatchShuttingDown	Batch session is shutting down.
BatchError	Batch session errored out.
BatchDead	Batch session has exited.
BatchKilled	Batch session is killed.
BatchSuccess	Batch session is successfully stopped.

Instances

Bounded BatchState Source #
Instance details Defined in Network.Livy.Client.Types.Batch Methods minBound :: BatchState # maxBound :: BatchState #
Enum BatchState Source #
Instance details Defined in Network.Livy.Client.Types.Batch Methods succ :: BatchState -> BatchState # pred :: BatchState -> BatchState # toEnum :: Int -> BatchState # fromEnum :: BatchState -> Int # enumFrom :: BatchState -> [BatchState] # enumFromThen :: BatchState -> BatchState -> [BatchState] # enumFromTo :: BatchState -> BatchState -> [BatchState] # enumFromThenTo :: BatchState -> BatchState -> BatchState -> [BatchState] #
Eq BatchState Source #
Instance details Defined in Network.Livy.Client.Types.Batch Methods (==) :: BatchState -> BatchState -> Bool # (/=) :: BatchState -> BatchState -> Bool #
Show BatchState Source #
Instance details Defined in Network.Livy.Client.Types.Batch Methods showsPrec :: Int -> BatchState -> ShowS # show :: BatchState -> String # showList :: [BatchState] -> ShowS #
ToJSON BatchState Source #
Instance details Defined in Network.Livy.Client.Types.Batch Methods toJSON :: BatchState -> Value # toEncoding :: BatchState -> Encoding # toJSONList :: [BatchState] -> Value # toEncodingList :: [BatchState] -> Encoding #
FromJSON BatchState Source #
Instance details Defined in Network.Livy.Client.Types.Batch Methods parseJSON :: Value -> Parser BatchState # parseJSONList :: Value -> Parser [BatchState] #
ToText BatchState Source #
Instance details Defined in Network.Livy.Client.Types.Batch Methods toText :: BatchState -> Text Source #

type BatchAppInfo = HashMap Text (Maybe Text) Source #

Detailed application information.

Lenses

bId :: Lens' Batch BatchId Source #

bAppId :: Lens' Batch (Maybe Text) Source #

bAppInfo :: Lens' Batch BatchAppInfo Source #

bLog :: Lens' Batch [Text] Source #

bState :: Lens' Batch BatchState Source #

Interactive session

data Session Source #

An interactive session with Livy.

Constructors

Session

Fields

_sId :: !SessionId
The session id.
_sAppId :: !(Maybe Text)
The application id of this session.
_sOwner :: !(Maybe Text)
Remote user who submitted this session.
_sProxyUser :: !(Maybe Text)
User to impersonate when running.
_sKind :: !SessionKind
Session kind (spark, pyspark, sparkr, sql, shared).
_sLog :: ![Text]
The log lines.
_sState :: !SessionState
The session state.
_sAppInfo :: !SessionAppInfo
The detailed application info.

Instances

Eq Session Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods (==) :: Session -> Session -> Bool # (/=) :: Session -> Session -> Bool #
Show Session Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods showsPrec :: Int -> Session -> ShowS # show :: Session -> String # showList :: [Session] -> ShowS #
ToJSON Session Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods toJSON :: Session -> Value # toEncoding :: Session -> Encoding # toJSONList :: [Session] -> Value # toEncodingList :: [Session] -> Encoding #
FromJSON Session Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods parseJSON :: Value -> Parser Session # parseJSONList :: Value -> Parser [Session] #

newtype SessionId Source #

The id of this interactive session.

Constructors

SessionId Int

Instances

Eq SessionId Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods (==) :: SessionId -> SessionId -> Bool # (/=) :: SessionId -> SessionId -> Bool #
Show SessionId Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods showsPrec :: Int -> SessionId -> ShowS # show :: SessionId -> String # showList :: [SessionId] -> ShowS #
ToJSON SessionId Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods toJSON :: SessionId -> Value # toEncoding :: SessionId -> Encoding # toJSONList :: [SessionId] -> Value # toEncodingList :: [SessionId] -> Encoding #
FromJSON SessionId Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods parseJSON :: Value -> Parser SessionId # parseJSONList :: Value -> Parser [SessionId] #
ToText SessionId Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods toText :: SessionId -> Text Source #

data SessionKind Source #

The kind of Livy session.

Constructors

SparkSession	A Scala Spark session.
PySparkSession	A PySpark session.
SparkRSession	A SparkR session.
SQLSession	A Spark SQL session.
SharedSession	A session that supports all types.

Instances

Bounded SessionKind Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods minBound :: SessionKind # maxBound :: SessionKind #
Enum SessionKind Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods succ :: SessionKind -> SessionKind # pred :: SessionKind -> SessionKind # toEnum :: Int -> SessionKind # fromEnum :: SessionKind -> Int # enumFrom :: SessionKind -> [SessionKind] # enumFromThen :: SessionKind -> SessionKind -> [SessionKind] # enumFromTo :: SessionKind -> SessionKind -> [SessionKind] # enumFromThenTo :: SessionKind -> SessionKind -> SessionKind -> [SessionKind] #
Eq SessionKind Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods (==) :: SessionKind -> SessionKind -> Bool # (/=) :: SessionKind -> SessionKind -> Bool #
Show SessionKind Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods showsPrec :: Int -> SessionKind -> ShowS # show :: SessionKind -> String # showList :: [SessionKind] -> ShowS #
ToJSON SessionKind Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods toJSON :: SessionKind -> Value # toEncoding :: SessionKind -> Encoding # toJSONList :: [SessionKind] -> Value # toEncodingList :: [SessionKind] -> Encoding #
FromJSON SessionKind Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods parseJSON :: Value -> Parser SessionKind # parseJSONList :: Value -> Parser [SessionKind] #
ToText SessionKind Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods toText :: SessionKind -> Text Source #

data SessionState Source #

The present state of a session.

Constructors

SessionNotStarted	Session has not been started.
SessionStarting	Session is starting.
SessionRecovering	Session is recovering.
SessionIdle	Session is waiting for input.
SessionRunning	Session is running.
SessionBusy	Session is executing a statement.
SessionShuttingDown	Session is shutting down.
SessionError	Session errored out.
SessionDead	Session has exited.
SessionKilled	Session is killed.
SessionSuccess	Session is successfully stopped.

Instances

Bounded SessionState Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods minBound :: SessionState # maxBound :: SessionState #
Enum SessionState Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods succ :: SessionState -> SessionState # pred :: SessionState -> SessionState # toEnum :: Int -> SessionState # fromEnum :: SessionState -> Int # enumFrom :: SessionState -> [SessionState] # enumFromThen :: SessionState -> SessionState -> [SessionState] # enumFromTo :: SessionState -> SessionState -> [SessionState] # enumFromThenTo :: SessionState -> SessionState -> SessionState -> [SessionState] #
Eq SessionState Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods (==) :: SessionState -> SessionState -> Bool # (/=) :: SessionState -> SessionState -> Bool #
Show SessionState Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods showsPrec :: Int -> SessionState -> ShowS # show :: SessionState -> String # showList :: [SessionState] -> ShowS #
ToJSON SessionState Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods toJSON :: SessionState -> Value # toEncoding :: SessionState -> Encoding # toJSONList :: [SessionState] -> Value # toEncodingList :: [SessionState] -> Encoding #
FromJSON SessionState Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods parseJSON :: Value -> Parser SessionState # parseJSONList :: Value -> Parser [SessionState] #
ToText SessionState Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods toText :: SessionState -> Text Source #

type SessionAppInfo = HashMap Text (Maybe Text) Source #

Detailed application information.

Lenses

sId :: Lens' Session SessionId Source #

sAppId :: Lens' Session (Maybe Text) Source #

sOwner :: Lens' Session (Maybe Text) Source #

sProxyUser :: Lens' Session (Maybe Text) Source #

sKind :: Lens' Session SessionKind Source #

sLog :: Lens' Session [Text] Source #

sState :: Lens' Session SessionState Source #

sAppInfo :: Lens' Session SessionAppInfo Source #

Statements for interactive sessions

data Statement Source #

A Statement represents the result of an execution statement.

Constructors

Statement
Fields _stId :: !StatementId The statement id. _stCode :: !(Maybe Text) The execution code. _stState :: !(Maybe StatementState) The execution state. _stOutput :: !(Maybe StatementOutput) The execution output.

Instances

Eq Statement Source #
Instance details Defined in Network.Livy.Client.Types.Statement Methods (==) :: Statement -> Statement -> Bool # (/=) :: Statement -> Statement -> Bool #
Show Statement Source #
Instance details Defined in Network.Livy.Client.Types.Statement Methods showsPrec :: Int -> Statement -> ShowS # show :: Statement -> String # showList :: [Statement] -> ShowS #
ToJSON Statement Source #
Instance details Defined in Network.Livy.Client.Types.Statement Methods toJSON :: Statement -> Value # toEncoding :: Statement -> Encoding # toJSONList :: [Statement] -> Value # toEncodingList :: [Statement] -> Encoding #
FromJSON Statement Source #
Instance details Defined in Network.Livy.Client.Types.Statement Methods parseJSON :: Value -> Parser Statement # parseJSONList :: Value -> Parser [Statement] #

newtype StatementId Source #

The id of this statement.

Constructors

StatementId Int

Instances

Eq StatementId Source #
Instance details Defined in Network.Livy.Client.Types.Statement Methods (==) :: StatementId -> StatementId -> Bool # (/=) :: StatementId -> StatementId -> Bool #
Show StatementId Source #
Instance details Defined in Network.Livy.Client.Types.Statement Methods showsPrec :: Int -> StatementId -> ShowS # show :: StatementId -> String # showList :: [StatementId] -> ShowS #
ToJSON StatementId Source #
Instance details Defined in Network.Livy.Client.Types.Statement Methods toJSON :: StatementId -> Value # toEncoding :: StatementId -> Encoding # toJSONList :: [StatementId] -> Value # toEncodingList :: [StatementId] -> Encoding #
FromJSON StatementId Source #
Instance details Defined in Network.Livy.Client.Types.Statement Methods parseJSON :: Value -> Parser StatementId # parseJSONList :: Value -> Parser [StatementId] #
ToText StatementId Source #
Instance details Defined in Network.Livy.Client.Types.Statement Methods toText :: StatementId -> Text Source #

data StatementState Source #

The present state of a submitted Statement.

Constructors

StatementWaiting	Statement is enqueued but execution hasn't started.
StatementRunning	Statement is currently running.
StatementAvailable	Statement has a response ready.
StatementError	Statement failed.
StatementCancelling	Statement is being cancelled.
StatementCancelled	Statement is cancelled.

Instances

Bounded StatementState Source #
Instance details Defined in Network.Livy.Client.Types.Statement Methods minBound :: StatementState # maxBound :: StatementState #
Enum StatementState Source #
Instance details Defined in Network.Livy.Client.Types.Statement Methods succ :: StatementState -> StatementState # pred :: StatementState -> StatementState # toEnum :: Int -> StatementState # fromEnum :: StatementState -> Int # enumFrom :: StatementState -> [StatementState] # enumFromThen :: StatementState -> StatementState -> [StatementState] # enumFromTo :: StatementState -> StatementState -> [StatementState] # enumFromThenTo :: StatementState -> StatementState -> StatementState -> [StatementState] #
Eq StatementState Source #
Instance details Defined in Network.Livy.Client.Types.Statement Methods (==) :: StatementState -> StatementState -> Bool # (/=) :: StatementState -> StatementState -> Bool #
Show StatementState Source #
Instance details Defined in Network.Livy.Client.Types.Statement Methods showsPrec :: Int -> StatementState -> ShowS # show :: StatementState -> String # showList :: [StatementState] -> ShowS #
ToJSON StatementState Source #
Instance details Defined in Network.Livy.Client.Types.Statement Methods toJSON :: StatementState -> Value # toEncoding :: StatementState -> Encoding # toJSONList :: [StatementState] -> Value # toEncodingList :: [StatementState] -> Encoding #
FromJSON StatementState Source #
Instance details Defined in Network.Livy.Client.Types.Statement Methods parseJSON :: Value -> Parser StatementState # parseJSONList :: Value -> Parser [StatementState] #
ToText StatementState Source #
Instance details Defined in Network.Livy.Client.Types.Statement Methods toText :: StatementState -> Text Source #

data StatementOutput Source #

The output of a completed statement.

Constructors

StatementOutput
Fields _stoStatus :: !(Maybe Text) Execution status. _stoExecutionCount :: !(Maybe Integer) A monotonically increasing number. _stoData :: !(Maybe StatementData) Statement output.

Instances

Eq StatementOutput Source #
Instance details Defined in Network.Livy.Client.Types.Statement Methods (==) :: StatementOutput -> StatementOutput -> Bool # (/=) :: StatementOutput -> StatementOutput -> Bool #
Show StatementOutput Source #
Instance details Defined in Network.Livy.Client.Types.Statement Methods showsPrec :: Int -> StatementOutput -> ShowS # show :: StatementOutput -> String # showList :: [StatementOutput] -> ShowS #
ToJSON StatementOutput Source #
Instance details Defined in Network.Livy.Client.Types.Statement Methods toJSON :: StatementOutput -> Value # toEncoding :: StatementOutput -> Encoding # toJSONList :: [StatementOutput] -> Value # toEncodingList :: [StatementOutput] -> Encoding #
FromJSON StatementOutput Source #
Instance details Defined in Network.Livy.Client.Types.Statement Methods parseJSON :: Value -> Parser StatementOutput # parseJSONList :: Value -> Parser [StatementOutput] #

type StatementData = HashMap Text (Maybe Text) Source #

Statement output.

Lenses

stoStatus :: Lens' StatementOutput (Maybe Text) Source #

stoExecutionCount :: Lens' StatementOutput (Maybe Integer) Source #

stoData :: Lens' StatementOutput (Maybe StatementData) Source #

stId :: Lens' Statement StatementId Source #

stCode :: Lens' Statement (Maybe Text) Source #

stState :: Lens' Statement (Maybe StatementState) Source #

stOutput :: Lens' Statement (Maybe StatementOutput) Source #

Exceptions

data LivyError Source #

An error with Livy.

Constructors

LivyError
Fields _leType :: !LivyErrorType _leMessage :: !ByteString _leResponseBody :: !(Maybe ByteString) _leCode :: !(Maybe LivyHTTPErrorCode)

Instances

Show LivyError Source #
Instance details Defined in Network.Livy.Types Methods showsPrec :: Int -> LivyError -> ShowS # show :: LivyError -> String # showList :: [LivyError] -> ShowS #
Exception LivyError Source #
Instance details Defined in Network.Livy.Types Methods toException :: LivyError -> SomeException # fromException :: SomeException -> Maybe LivyError # displayException :: LivyError -> String #

data LivyErrorType Source #

Livy error types.

Constructors

InvalidRequest
ParseFailure
LibraryException HttpException
UnknownErrorType

Instances

Show LivyErrorType Source #
Instance details Defined in Network.Livy.Types Methods showsPrec :: Int -> LivyErrorType -> ShowS # show :: LivyErrorType -> String # showList :: [LivyErrorType] -> ShowS #

data LivyHTTPErrorCode Source #

HTTP response error codes.

Constructors

BadRequest
Unauthorized
RequestFailed
Forbidden
BadMethod
NotFound
ServerError
UnknownHTTPErrorCode

Instances

Show LivyHTTPErrorCode Source #
Instance details Defined in Network.Livy.Types Methods showsPrec :: Int -> LivyHTTPErrorCode -> ShowS # show :: LivyHTTPErrorCode -> String # showList :: [LivyHTTPErrorCode] -> ShowS #

Misc.

data APIVersion Source #

Constructors

V050Incubating

The version of Livy for this package release.

Instances

Show APIVersion Source #
Instance details Defined in Network.Livy Methods showsPrec :: Int -> APIVersion -> ShowS # show :: APIVersion -> String # showList :: [APIVersion] -> ShowS #