This library is deprecated and will no longer be updated.
Abstract some trivial operations on the Neo4j driver for Nodejs and make the use simpler. That's why we created OGMNeo.
You can find ogmneo in npm here and install using the follow command
npm install ogmneoconst ogmneo = require('ogmneo');
ogmneo.Connection.connect('neo4j', 'databasepass', 'localhost');
// Or if you want to add some neo4j driver configuration options
ogmneo.Connection.connect('neo4j', 'databasepass', 'localhost', { maxTransactionRetryTime: 30000, encrypted: false });
// See more about the config options you can add on: http://neo4j.com/docs/api/javascript-driver/current/function/index.html#static-function-driverOGMNeo connects using the neo4j bolt protocol.
You can see the generated Cypher on your console by setting Connection.logCypherEnabled property true.
const ogmneo = require('ogmneo');
ogmneo.Connection.logCypherEnabled = true; const ogmneo = require('ogmneo');
ogmneo.Node.create({ name: 'name', tes: 3 }, 'test')
.then((node) => {
//Created returned object => {id: 1, name: 'name', tes: 3}
}).catch((error) => {
//Handle error
}); const ogmneo = require('ogmneo');
let query = ogmneo.Query.create('test')
.where(new ogmneo.Where('name', { $eq: 'name1' }));
ogmneo.Node.find(query)
.then((nodes) => {
//Found nodes.
}).catch((error) => {
//Handle error.
});You can create relations between nodes.
const ogmneo = require('ogmneo');
ogmneo.Relation.relate(node1.id, 'relatedto', node2.id, {property: 'a'})
.then((rels) => {
// Created relation node {id: 2, type: 'relatedto', property: 'a'}
}).catch((error) => {
//Handle error
});You can find the relation nodes.
const ogmneo = require('ogmneo');
let query = ogmneo.RelationQuery.create('relatedto')
.startNode(node1.id)
.endNode(node2.id)
.relationWhere(ogmneo.Where.create('property', { $eq: 'c' }))
.ascOrderBy('property')
.limit(3);
ogmneo.Relation.find(query)
.then((nodes) => {
//Found relation nodes.
}).catch((error) => {
//Handle error.
});
//OR
ogmneo.Relation.findPopulated(query)
.then((nodes) => {
//Found relation nodes with start and end nodes populated.
}).catch((error) => {
//Handle error.
});
You can execute Cypher using the direct Neo4j Driver session object. Or you can use OGMNeoCypher.
const ogmneo = require('ogmneo');
ogmneo.Cypher.transactionalRead(cypherStatement)
.then((result) => {
console.log(result);
}).catch((error) => {
reject(error);
});
//OR
ogmneo.Cypher.transactionalWrite(cypherStatement)
.then((result) => {
console.log(result);
}).catch((error) => {
reject(error);
});
You can create and drop indexes in properties.
const ogmneo = require('ogmneo');
//Creating
ogmneo.Index.create('label', ['property'])
.then((result) => {
//Handle creation
});
//Dropping
ogmneo.Index.drop('label', ['property'])
.then((result) => {
//Handle drop
});Almost every method of ogmneo.Node and ogmneo.Relation have now the Operation API, that instead of executing the function on database returning a promise, it creates an ogmneo.Operation object that can be executed after by the ogmneo.OperationExecuter. Exemple:
const ogmneo = require('ogmneo');
let operation = ogmneo.Node.createOperation({ name: 'name', tes: 3 }, 'test');
ogmneo.OperationExecuter.execute(operation)
.then((node) => {
//Created returned object => {id: 1, name: 'name', tes: 3}
}).catch((error) => {
//Handle error
});With the Operation API we can now execute as many READ or WRITE operations on the same transaction. For example, you want to create nodes and then relate those two. But if the relationship operation fails you want to rollback all the operations.
const ogmneo = require('ogmneo');
let createDriver = ogmneo.Node.createOperation({name: 'Ayrton Senna', carNumber: 12 }, 'Driver');
ogmneo.OperationExecuter.write((transaction) => {
return ogmneo.OperationExecuter.execute(createDriver, transaction)
.then((driver) => {
let createCar = ogmneo.Node.createOperation({name: 'MP4/4'}, 'Car');
return ogmneo.OperationExecuter.execute(createCar, transaction).then((car) => {
let relate = ogmneo.Relation.relateOperation(driver.id, 'DRIVES', car.id, {year: 1988});
return ogmneo.OperationExecuter.execute(relate, transaction);
});
});
}).then((result) => {
//Result here
});All of those operations will be executed on the same transaction and you can rollback anytime you want. The transaction is the neo4j driver transaction object and you can see more about it on their docs here.
You can also batch many operation READ or WRITE operations in a single transaction.
const ogmneo = require('ogmneo');
let createUser1 = OGMNeoNode.createOperation({name: 'Ayrton Senna'}, 'Person');
let createUser2 = OGMNeoNode.createOperation({name: 'Alain Prost'}, 'Person');
ogmneo.OperationExecuter.batchWriteOperations([createUser1, createUser2]).then((result) => {
let created1 = result[0];
let created2 = result[1];
console.log(created1.name); // 'Ayrton Senna'
console.log(created2.name); // 'Alain Prost'
});If one of those fails, all other operations on the transaction will be rolledback automatically.
See the full API documentation at docs. All docs was generated by JSDoc.
See a demo sample on the ogmneo-demo repository.
Most of this library functions are covered by unit tests. See the code coverage on codecov.io.
OGMNeo is released under the MIT License.