Database.Cayley.Client

Documentation

data Quad

Constructors

Quad

Fields

• subject :: !Text

  Subject node

• predicate :: !Text

  Predicate node

• object :: !Text

  Object node

• label :: !(Maybe Text)

  Label node

Instances

FromJSON Quad

Defined in Database.Cayley.Types

Methods

parseJSON :: Value -> Parser Quad

parseJSONList :: Value -> Parser [Quad]

omittedField :: Maybe Quad

ToJSON Quad

Defined in Database.Cayley.Types

Methods

toJSON :: Quad -> Value

toEncoding :: Quad -> Encoding

toJSONList :: [Quad] -> Value

toEncodingList :: [Quad] -> Encoding

omitField :: Quad -> Bool

Generic Quad

Defined in Database.Cayley.Types

Associated Types

type Rep Quad :: Type -> Type

Methods

from :: Quad -> Rep Quad x

to :: Rep Quad x -> Quad

Show Quad

Defined in Database.Cayley.Types

Methods

showsPrec :: Int -> Quad -> ShowS

show :: Quad -> String

showList :: [Quad] -> ShowS

Binary Quad

Defined in Database.Cayley.Types

Methods

put :: Quad -> Put

get :: Get Quad

putList :: [Quad] -> Put

Eq Quad

Two quads are equals when subject, predicate, object and label are equals.

Defined in Database.Cayley.Types

Methods

(==) :: Quad -> Quad -> Bool

(/=) :: Quad -> Quad -> Bool

type Rep Quad

Defined in Database.Cayley.Types

type Rep Quad = D1 ('MetaData "Quad" "Database.Cayley.Types" "cayley-client-0.4.19.3-DEELHK4hWB6K79WI6a0ukH" 'False) (C1 ('MetaCons "Quad" 'PrefixI 'True) ((S1 ('MetaSel ('Just "subject") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "predicate") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "object") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "label") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text)))))

Connection

defaultCayleyConfig :: CayleyConfig

CayleyConfig { serverPort = 64210 , serverName = "localhost" , apiVersion = V1 , queryLang = Gremlin }

connectCayley :: CayleyConfig -> IO CayleyConnection

Get a connection to Cayley with the given configuration.

λ> conn <- connectCayley defaultCayleyConfig

Operations

query :: CayleyConnection -> Query -> IO (Either String Value)

Perform a query, in Gremlin graph query language per default (or in MQL).

λ> query conn "graph.Vertex('Humphrey Bogart').In('name').All()"
Right (Array (fromList [Object (fromList [("id",String "/en/humphrey_bogart")])]))

data Shape

Instances

FromJSON Shape

Defined in Database.Cayley.Types

Methods

parseJSON :: Value -> Parser Shape

parseJSONList :: Value -> Parser [Shape]

omittedField :: Maybe Shape

Show Shape

Defined in Database.Cayley.Types

Methods

showsPrec :: Int -> Shape -> ShowS

show :: Shape -> String

showList :: [Shape] -> ShowS

Eq Shape

Defined in Database.Cayley.Types

Methods

(==) :: Shape -> Shape -> Bool

(/=) :: Shape -> Shape -> Bool

queryShape :: CayleyConnection -> Query -> IO (Either String Shape)

Return the description of the given executed query.

write :: CayleyConnection -> Quad -> IO (Maybe Value)

Write the given Quad.

writeQuad :: CayleyConnection -> Subject -> Predicate -> Object -> Maybe Label -> IO (Maybe Value)

Write a Quad with the given subject, predicate, object and optional label. Throw result or extract amount of query results from it.

λ> writeQuad conn "Humphrey" "loves" "Lauren" (Just "In love")
Just (Object (fromList [("result",String "Successfully wrote 1 quads.")]))

writeQuads :: CayleyConnection -> [Quad] -> IO (Maybe Value)

Write the given list of Quad(s).

writeNQuadFile :: (MonadThrow m, MonadIO m) => CayleyConnection -> FilePath -> m (Maybe Value)

Write a N-Quad file.

λ> writeNQuadFile conn "testdata.nq"
Just (Object (fromList [("result",String "Successfully wrote 11 quads.")]))

delete :: CayleyConnection -> Quad -> IO (Maybe Value)

Delete the given Quad.

deleteQuad :: CayleyConnection -> Subject -> Predicate -> Object -> Maybe Label -> IO (Maybe Value)

Delete the Quad defined by the given subject, predicate, object and optional label.

deleteQuads :: CayleyConnection -> [Quad] -> IO (Maybe Value)

Delete the given list of Quad(s).

Utils

createQuad :: Subject -> Predicate -> Object -> Maybe Label -> Maybe Quad

Given a subject, a predicate, an object and an optional label, create a valid Quad.

isValid :: Quad -> Bool

A valid Quad has its subject, predicate and object not empty.

results :: Maybe Value -> IO (Either String Int)

Get amount of results from a write/delete Quad(s) operation, or an explicite error message.

λ> writeNQuadFile conn "testdata.nq" >>= results
Right 11