neo4j-orm

a query builder for neo4j

Installation

Grab it using npm.

npm install -g neo4j-orm

Usage

You can start working just requring it.

var neo4j = require('neo4j-orm');

Create Connection

You can Connect neo4j without object parameters if you have username neo4j and password neo4j like this just calling.

var db =  new neo4j();

OR

var db =  new neo4j({

 connection.host = 'localhost',
 connection.username = 'neo4j',
 connection.password = '123456',
 connection.port     = '7474',
 
},function(err){
 // callback is optional
});

Note: it'll create a node_id just like mongo's object_id to create uniquness among created nodes, it'll throw an error if you want to add node_id in the object

Create single node

You have to call exec() to execute the query

db.createNode(['n'],{

	{
		name:'Aniruddha',
		skills: 'php,nodejs'
	}

}).exec();

Create multiple node

You can add as many node you want with a single query

db.createNode(['n','m','o'],{

	{
		name:'Aniruddha',
		skills: 'php,nodejs'
	} , 
	{
	  name: 'Omran jamal',
	  skills: 'php,nodejs,markup'
	},
	{
	 name: 'nahiyan alamgir',
	 skills: 'JS,compiler development'
	}

}).exec();

Return node

You have to call return() to execute the query

db.createNode(['n'],{

	{
		name:'Aniruddha',
		skills: 'php,nodejs'
	}

}).return().exec();

or you can specify with node data you want in return by passing array like return([])

db.createNode(['n'],{

	{
		name:'Aniruddha',
		skills: 'php,nodejs'
	}

}).return(['n']).exec();

Add label

You have to call addlabel() to execute the query

db.createNode(['n'],{

	{
		name:'Aniruddha',
		skills: 'php,nodejs'
	}

}).addlabel('person').exec();

Add multiple label

You have to call addlabels() to execute the query

db.createNode(['n'],{

	{
		name:'Aniruddha',
		skills: 'php,nodejs'
	}

}).addlabels(['person','software developer']).exec();

You can add where clause

You have to call where(column,sign,value) to execute the query

db.match(['n']).where('n.name','=','Aniruddha').return().exec(function(err,res){

		console.log(err,res);

});

You can add whereIn clause

You have to call whereIn(node_and_column,[]) to execute the query

db.match(['n']).whereIn('n.name',['Aniruddha','Omran jamal']).return().exec(function(err,res){

		console.log(err,res);

});

Search by label

You have to call matchLabel(node,label) to execute the query

 db.matchLabel('n','person').return(['n']).exec(function(err,res){

		console.log(err,res);

});