gremlin-haskell-0.1.0.1: Graph database client for TinkerPop3 Gremlin Server

Copyright(c) 2015 The gremlin-haskell Authors
LicenseBSD3
Maintainernakaji.dayo@gmail.com
Stabilityexperimental
Portabilitynon-portable
Safe HaskellNone
LanguageHaskell2010

Database.TinkerPop.Types

Description

 

Synopsis

Documentation

type Gremlin = Text Source

Represent Gremlin code

type Binding = Object Source

A Map of key/value pairs

data RequestArgs Source

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

class HasBatchSize s a | s -> a where Source

Methods

batchSize :: Lens' s a Source

class HasBindings s a | s -> a where Source

Methods

bindings :: Lens' s a Source

class HasGremlin s a | s -> a where Source

Methods

gremlin :: Lens' s a Source

class HasLanguage s a | s -> a where Source

Methods

language :: Lens' s a Source

data RequestMessage Source

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

class HasArgs s a | s -> a where Source

Methods

args :: Lens' s a Source

class HasOp s a | s -> a where Source

Methods

op :: Lens' s a Source

class HasProcessor s a | s -> a where Source

Methods

processor :: Lens' s a Source

class HasAttributes s a | s -> a where Source

Methods

attributes :: Lens' s a Source

class HasCode s a | s -> a where Source

Methods

code :: Lens' s a Source

class HasMessage s a | s -> a where Source

Methods

message :: Lens' s a Source

data ResponseResult Source

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.

class HasData' s a | s -> a where Source

Methods

data' :: Lens' s a Source

class HasMeta s a | s -> a where Source

Methods

meta :: Lens' s a Source

class HasResult s a | s -> a where Source

Methods

result :: Lens' s a Source

class HasStatus s a | s -> a where Source

Methods

status :: Lens' s a Source

class HasChans s a | s -> a where Source

Methods

chans :: Lens' s a Source

class HasSocket s a | s -> a where Source

Methods

socket :: Lens' s a Source