Database.Neo4j.Cypher

IMPORTANT! MODULE DEPRECATED, better use the code in this same library that uses the Neo4j transactional endpoint in Database.Neo4j.Transactional.Cypher Module to provide Cypher support. Currently we allow sending queries with parameters, the result is a collection of column headers and JSON data values, the Graph object has the function addCypher that tries to find nodes and relationships in a cypher query result and insert them in a Database.Neo4j.Graph object

import qualified Database.Neo4j.Cypher as C

withConnection host port $ do
   ...
   -- Run a cypher query with parameters
   res <- C.cypher "CREATE (n:Person { name : {name} }) RETURN n" M.fromList [("name", C.newparam ("Pep" :: T.Text))]

   -- Get all nodes and relationships that this query returned and insert them in a Graph object
   let graph = G.addCypher (C.fromSuccess res) G.empty

   -- Get the column headers
   let columnHeaders = C.cols $ C.fromSuccess res

   -- Get the rows of JSON values received
   let values = C.vals $ C.fromSuccess res

Types

data Response

Type for a Cypher response with tuples containing column name and their values

Constructors

Response

Fields

• cols :: [Text]
• vals :: [[Value]]

Instances

Eq Response

Methods

(==) :: Response -> Response -> Bool

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

Show Response

Methods

showsPrec :: Int -> Response -> ShowS

show :: Response -> String

showList :: [Response] -> ShowS

FromJSON Response

How to create a response object from a cypher JSON response

Methods

parseJSON :: Value -> Parser Response

parseJSONList :: Value -> Parser [Response]

data ParamValue

Value for a cypher parmeter value, might be a literal, a property map or a list of property maps

Constructors

ParamLiteral PropertyValue

ParamProperties Properties

ParamPropertiesArray [Properties]

Instances

Eq ParamValue

Methods

(==) :: ParamValue -> ParamValue -> Bool

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

Show ParamValue

Methods

showsPrec :: Int -> ParamValue -> ShowS

show :: ParamValue -> String

showList :: [ParamValue] -> ShowS

ToJSON ParamValue

Instance toJSON for param values so we can serialize them in queries

Methods

toJSON :: ParamValue -> Value

toEncoding :: ParamValue -> Encoding

toJSONList :: [ParamValue] -> Value

toEncodingList :: [ParamValue] -> Encoding

type Params = HashMap Text ParamValue

We use hashmaps to represent Cypher parameters

newparam :: PropertyValueConstructor a => a -> ParamValue

Sending queries

cypher :: Text -> Params -> Neo4j (Either Text Response)

Deprecated: Use Database.Neo4j.Transactional.Cypher instead

Run a cypher query

fromResult :: Response -> Either Text Response -> Response

Deprecated: Use Database.Neo4j.Transactional.Cypher instead

Get the result of the response or a default value

fromSuccess :: Either Text Response -> Response

Deprecated: Use Database.Neo4j.Transactional.Cypher instead

Get the result of the response or a default value

isSuccess :: Either Text Response -> Bool

Deprecated: Use Database.Neo4j.Transactional.Cypher instead

True if the operation succeeded