Database.TinkerPop.Types

Documentation

type Gremlin = Text

Represent Gremlin code

type Binding = Object

A Map of key/value pairs

data RequestArgs

parameters to pass to Gremlin Server. (TODO: The requirements for the contents of this Map are dependent on the op selected.)

Constructors

RequestArgs

Fields

_requestArgsGremlin :: Text

The Gremlin script to evaluate

_requestArgsBindings :: Maybe Binding

A map of key/value pairs to apply as variables in the context of the Gremlin script

_requestArgsLanguage :: Text

The flavor used (e.g. gremlin-groovy)

_requestArgsBatchSize :: Maybe Int

When the result is an iterator this value defines the number of iterations each ResponseMessage should contain

Instances

ToJSON RequestArgs

FromJSON RequestArgs

HasLanguage RequestArgs Text

HasGremlin RequestArgs Text

HasArgs RequestMessage RequestArgs

HasBindings RequestArgs (Maybe Binding)

HasBatchSize RequestArgs (Maybe Int)

class HasBatchSize s a | s -> a where

Methods

batchSize :: Lens' s a

Instances

HasBatchSize RequestArgs (Maybe Int)

class HasBindings s a | s -> a where

Methods

bindings :: Lens' s a

Instances

HasBindings RequestArgs (Maybe Binding)

class HasGremlin s a | s -> a where

Methods

gremlin :: Lens' s a

Instances

HasGremlin RequestArgs Text

class HasLanguage s a | s -> a where

Methods

language :: Lens' s a

Instances

HasLanguage RequestArgs Text

data RequestMessage

Format of requests to the Gremlin Server

Constructors

RequestMessage

Fields

_requestMessageRequestId :: Text

A UUID representing the unique identification for the request.

_requestMessageOp :: Text

The name of the "operation" to execute based on the available OpProcessor configured in the Gremlin Server. To evaluate a script, use eval.

_requestMessageProcessor :: Text

The name of the OpProcessor to utilize. The default OpProcessor for evaluating scripts is unamed and therefore script evaluation purposes, this value can be an empty string.

_requestMessageArgs :: RequestArgs

Parameters to pass to Gremlin Server

Instances

ToJSON RequestMessage

FromJSON RequestMessage

HasRequestId RequestMessage Text

HasProcessor RequestMessage Text

HasOp RequestMessage Text

HasArgs RequestMessage RequestArgs

class HasArgs s a | s -> a where

Methods

args :: Lens' s a

Instances

HasArgs RequestMessage RequestArgs

class HasOp s a | s -> a where

Methods

op :: Lens' s a

Instances

HasOp RequestMessage Text

class HasProcessor s a | s -> a where

Methods

processor :: Lens' s a

Instances

HasProcessor RequestMessage Text

class HasRequestId s a | s -> a where

Methods

requestId :: Lens' s a

Instances

HasRequestId RequestMessage Text

HasRequestId ResponseMessage Text

data ResponseStatus

The staus of Gremlin Server Response

Constructors

ResponseStatus

Fields

_responseStatusMessage :: Text

Human-readable String usually associated with errors.

_responseStatusCode :: Int

HTTP status code

_responseStatusAttributes :: Object

Protocol-level information

Instances

Show ResponseStatus

ToJSON ResponseStatus

FromJSON ResponseStatus

HasMessage ResponseStatus Text

HasCode ResponseStatus Int

HasAttributes ResponseStatus Object

HasStatus ResponseMessage ResponseStatus

class HasAttributes s a | s -> a where

Methods

attributes :: Lens' s a

Instances

HasAttributes ResponseStatus Object

class HasCode s a | s -> a where

Methods

code :: Lens' s a

Instances

HasCode ResponseStatus Int

class HasMessage s a | s -> a where

Methods

message :: Lens' s a

Instances

HasMessage ResponseStatus Text

data ResponseResult

The Result of Gremlin Server response

Constructors

ResponseResult

Fields

_responseResultData' :: Maybe [Value]

the actual data returned from the server (the type of data is determined by the operation requested)

_responseResultMeta :: Object

Map of meta-data related to the response.

Instances

Show ResponseResult

ToJSON ResponseResult

FromJSON ResponseResult

HasMeta ResponseResult Object

HasResult ResponseMessage ResponseResult

HasData' ResponseResult (Maybe [Value])

class HasData' s a | s -> a where

Methods

data' :: Lens' s a

Instances

HasData' ResponseResult (Maybe [Value])

class HasMeta s a | s -> a where

Methods

meta :: Lens' s a

Instances

HasMeta ResponseResult Object

data ResponseMessage

Response of Gremlin Server

Constructors

ResponseMessage

Fields

_responseMessageRequestId :: Text

The identifier of the RequestMessage that generated this ResponseMessage.

_responseMessageStatus :: ResponseStatus

status

_responseMessageResult :: ResponseResult

result

Instances

Show ResponseMessage

ToJSON ResponseMessage

FromJSON ResponseMessage

HasRequestId ResponseMessage Text

HasStatus ResponseMessage ResponseStatus

HasResult ResponseMessage ResponseResult

HasChans Connection (TVar (Map Text (TChan (Either String ResponseMessage))))

class HasResult s a | s -> a where

Methods

result :: Lens' s a

Instances

HasResult ResponseMessage ResponseResult

class HasStatus s a | s -> a where

Methods

status :: Lens' s a

Instances

HasStatus ResponseMessage ResponseStatus

data Connection

Connection handle

Constructors

Connection

Fields

_connectionSocket :: Connection

_connectionChans :: TVar (Map Text (TChan (Either String ResponseMessage)))

Instances

HasSocket Connection Connection

HasChans Connection (TVar (Map Text (TChan (Either String ResponseMessage))))

class HasChans s a | s -> a where

Methods

chans :: Lens' s a

Instances

HasChans Connection (TVar (Map Text (TChan (Either String ResponseMessage))))

class HasSocket s a | s -> a where

Methods

socket :: Lens' s a

Instances

HasSocket Connection Connection