0.9.7 • Published 7 years ago

neocy v0.9.7

Weekly downloads
2
License
MIT
Repository
github
Last release
7 years ago

neocy

Neo4j Cypher library using promises and transactions.

Usage

For simple transactions:

const Neo4j = require('neocy');
let neo4j = new Neo4j();
neo4j.init('127.0.0.1', 7474, 'neo4j', 'password');

let result;
try {
  result = await neo4j.simpleTransaction([
    'MATCH (u:User {uid: {params}.uid})',
    'RETURN u'
  ], {
    params: {
      uid: '134'
    }
  });
} catch (error) {
  result = {
    error
  };
}
return result || {};

For more complicated transactions involving mulitple queries:

const Neo4j = require('neocy');
let neo4j = new Neo4j();
neo4j.init('127.0.0.1', 7474, 'neo4j', 'password');

let users = [
  {
    uid: "111",
    name: "John Smith"
  },
  {
    uid: "134",
    name: "Carlos Justiniano"
  },
];
let transaction = neo4j.createTransaction();

users.forEach((user) => {
  let q = neo4j.createQueryBuilder();
  q.add([
    'CREATE (u:User {uid: {params}.uid, name: {params}.name})'
  ]);
  transaction.addQuery(q, {
    params: user
  });
});

let result;
try {
  result = await neo4j.getSimpleListData(await transaction.execute());
} catch (error) {
  result = {
    error
  };
}
return result || {};

API

MethodDescriptionNotes
initInitialize Neo4j Graph DatabaseRequired
createTransactionCreates a transaction objectSee Transaction API section
createQueryBuilderCreates a new query builder objectSee Query Build API section
getSimpleDataHelper to extract simple data responsesSimple data is defined as a single return value. A single object qualifies
getSimpleListDataHelper to extract simple arrat of data responsesSimilar to getSimpleData but returns and array of objects
toPropsConvert an object of properties to a property query string
toNamedPropsConverts a named object to a cypher compatible key / value pair
toSetsConverts an object to a cypher compatible list of set statements
simpleTransactionPerforms a simple transaction consisting of only a single transactions.

Transaction API

MethodDescriptionNotes
addQueryAppends a query to the transaction's list of query statementsRequires a Query Builder object and params
executeExecutes a transaction

Query Builder API

MethodDescriptionNotes
addAdds a partial query statement
toStringReturns the full query as a string

Tests

The specs folder contains tests.

To run the tests you first need to install mocha:

$ npm install mocha -g

Then run:

$ npm run test
0.9.7

7 years ago

0.9.6

7 years ago

0.9.5

7 years ago

0.9.4

7 years ago

0.9.3

7 years ago

0.9.2

7 years ago

0.9.1

7 years ago

0.9.0

7 years ago