CypherQueryBuilder 1.8.1

MatchQuery.Return(string[]) Method

Returns the specified returns.

public virtual CypherQueryBuilder.MatchQuery Return(params string[] returns);

Parameters

returns System.String []

The returns.

Returns

MatchQuery.Return<T>(Node<T>, Expression<Func<T,object>>, bool) Method

Returns the specified node.

public virtual CypherQueryBuilder.MatchQuery Return<T>(CypherQueryBuilder.Node<T> node, System.Linq.Expressions.Expression<System.Func<T,object>> f, bool aliasToBeRemoved=true);

Type parameters

T

Parameters

f System.Linq.Expressions.Expression<System.Func<T ,System.Object >>

The node.

The f.

aliasToBeRemoved System.Boolean

if set to true [alias to be removed].

Returns

f System.Linq.Expressions.Expression<System.Func<T ,System.Object >>

MatchQuery.Return<T>(string, Expression<Func<T,object>>, bool) Method

Returns the specified alias.

public virtual CypherQueryBuilder.MatchQuery Return<T>(string? alias, System.Linq.Expressions.Expression<System.Func<T,object>> f, bool aliasToBeRemoved=true);

Type parameters

T

Parameters

alias System.String

The alias.

The f.

aliasToBeRemoved System.Boolean

Returns

f System.Linq.Expressions.Expression<System.Func<T ,System.Object >>

MatchQuery.Return<T>(Expression<Func<T,object>>, bool) Method

Returns the specified f.

public CypherQueryBuilder.MatchQuery Return<T>(System.Linq.Expressions.Expression<System.Func<T,object>>? f=null, bool aliasToBeRemoved=true);

Type parameters

T

Parameters

The f.

aliasToBeRemoved System.Boolean

if set to true [alias to be removed].

Returns

MatchQuery.Skip(int) Method

Skips the specified skip.

public CypherQueryBuilder.MatchQuery Skip(int skip);

Parameters

skip System.Int32

The skip.

Returns

MatchQuery.Union(MatchQuery) Method

Unions the specified other.

public CypherQueryBuilder.UnionQuery Union(CypherQueryBuilder.MatchQuery other);

Parameters

other MatchQuery

The other.

Returns

UnionQuery

MatchQuery.Update<T,K>(Expression<Func<T,K>>, Expression<Func<T,K>>, string) Method

Create Update Query.

public virtual CypherQueryBuilder.UpdateQuery Update<T,K>(System.Linq.Expressions.Expression<System.Func<T,K>> propertySelector, System.Linq.Expressions.Expression<System.Func<T,K>> valueSelector, string? alias=null);

Type parameters

T

K

Parameters

propertySelector System.Linq.Expressions.Expression<System.Func<T ,K >>

valueSelector System.Linq.Expressions.Expression<System.Func<T ,K >>

alias System.String

Returns

UpdateQuery
UpdateQuery

Example

var r = 2010;  
            var mNode = Node<Movie>.Instance().Where(p => p.ReleaseYear > 500);  
            var q = Query  
                .Match(mNode)  
                .Update<Movie, int>(p => p.ReleaseYear, p => r)  
                .Return<Movie>()  
                .OrderBy<Movie, int>(m => m.ReleaseYear)  
                .Return<Movie>(p => new { p.Title, p.ReleaseYear });  
            var str = q.Compile();

MatchQuery.Where(string) Method

Wheres the specified clause.

public CypherQueryBuilder.MatchQuery Where(string clause);

Parameters

clause System.String

The clause.

Returns

MatchQuery

Example

var movie = new Movie() { ReleaseYear = 2010, Title = "Gambler" };  
            var m = movie.AsNode().Where(p => p.ReleaseYear == 2001 || p.ReleaseYear < 1997 || p.Title == "D");  
            var n = new Node("n")  
                .WithLabels("Actor")  
                .WithProperty("name", "Clint Eastwood")  
                .WithRelation(m, "r", new { Role = "Hero" }, true, "ACTED_IN");  
            var q = Query  
                .Match(n).Where(m.BasicFilter)  
                .Return<Movie>(p => new { p.Title, p.ReleaseYear });  
            var str = q.Compile();

MatchQuery.Where<T>(Expression<Func<T,bool>>, string) Method

Wheres the specified expr.

public CypherQueryBuilder.MatchQuery Where<T>(System.Linq.Expressions.Expression<System.Func<T,bool>> expr, string? alias=null);

Type parameters

T

Parameters

expr System.Linq.Expressions.Expression<System.Func<T ,System.Boolean >>

The expr.

alias System.String

Returns

MatchQuery

Example

var r = 2010;  
            var actor = new Person { FullName = "Debjit", Age = 80 };  
            var mNode = Node<Movie>.Instance().Where(p => p.ReleaseYear > 500);  
            mNode.WithRelation(actor.AsNode(), new ActedIn() { ReleaseYear = 2009 });  
            var q = Query  
                .Match(mNode)  
                .Where<ActedIn>(p => p.ReleaseYear > 2000)  
                .Delete(mNode.Relation);  
            var str = q.Compile();

Node Class

public class Node : CypherQueryBuilder.Entity

Inheritance System.Object 🡒 Entity 🡒 Node

Derived
↳ Node<T>

Methods

Node.Compile(HashSet<string>) Method

Compiles this instance Cipher queryable string format.

public override (string match,string where) Compile(System.Collections.Generic.HashSet<string> matchedAliases);

Parameters

matchedAliases System.Collections.Generic.HashSet<System.String >

Implements Compile(HashSet<string>)

Returns

<System.String ,System.String >
ValueTuple of (string match, string where).

Node.Instance<T>(int) Method

Create a new Instance of node type T with alias suffixed with sequence

public static CypherQueryBuilder.Node<T> Instance<T>(int sequence=0);

Type parameters

T

Parameters

sequence System.Int32

Returns

CypherQueryBuilder.Node<T >
New node of type T

Remarks

sequence will be default to zero if not provided

Node.Instance<T>(T, int) Method

Create a new Instance of node type T with alias suffixed with sequence

public static CypherQueryBuilder.Node<T> Instance<T>(T obj, int sequence=0);

Type parameters

T

Parameters

obj T

The object.

sequence System.Int32

Returns

CypherQueryBuilder.Node<T >
New node of type T

Remarks

sequence will be default to zero if not provided

Node.WithLabels(string[]) Method

Applies the labels fo the node.

public virtual CypherQueryBuilder.Node WithLabels(params string[] labels);

Parameters

labels System.String []

The labels.

Implements WithLabels(string[])

Returns

Node

Node.WithProperty(object) Method

Configure the property.

public virtual CypherQueryBuilder.Node WithProperty(object obj);

Parameters

obj System.Object

The object.

Implements WithProperty(object)

Returns

Node
The same node

Node.WithProperty(string, object) Method

Configure the property.

public virtual CypherQueryBuilder.Node WithProperty(string key, object? value);

Parameters

key System.String

The key.

value System.Object

The value.

Implements WithProperty(string, object)

Returns

Node
The same node

Node.WithRelation(Node, string, object, bool, string[]) Method

Configure the relation with another node.

public CypherQueryBuilder.Node WithRelation(CypherQueryBuilder.Node to, string relationAlias, object? relationProperties=null, bool isForward=true, params string[] labels);

Parameters

to Node

To.

relationAlias System.String

The relation alias.

relationProperties System.Object

The relation properties.

isForward System.Boolean

if set to true [is forward].

labels System.String []

The labels.

Returns

Node
The same node

Node.WithRelation<R>(Node, R, int, bool, string[]) Method

Withes the relation.

public CypherQueryBuilder.Node WithRelation<R>(CypherQueryBuilder.Node to, R instance, int aliasSequence=0, bool isForward=true, params string[] labels);

Type parameters

R

Parameters

to Node

To.

instance R

The instance for the relation.

aliasSequence System.Int32

The alias sequence for the relation.

isForward System.Boolean

if set to true [is forward].

labels System.String []

The labels.

Returns

Node

Example

var r = 2010;  
            var actor = new Person { FullName = "Debjit", Age = 80 };  
            var mNode = Node<Movie>.Instance().Where(p => p.ReleaseYear > 500);  
            mNode.WithRelation(actor.AsNode(), new ActedIn() { ReleaseYear = 2009 });

Node<T> Class

public class Node<T> : CypherQueryBuilder.Node

Type parameters

T

Inheritance System.Object 🡒 Entity 🡒 Node 🡒 Node<T>

Methods

Node<T>.Instance(Node<T>, int) Method

Create a new Instance of node type T with alias suffixed with sequence

public static CypherQueryBuilder.Node<T> Instance(out CypherQueryBuilder.Node<T> node, int sequence=0);

Parameters

CypherQueryBuilder.Node<T >

out parameter

sequence System.Int32

Returns

CypherQueryBuilder.Node<T >
New node of type T

Example

Node<Domain>.Instance(out var domainNode).Where(p => p.Uid == "TestDomain");  
            Node<Group>.Instance(out var groupNode).WithProperty(new { Uid = "gId_1", Name = "GName", Domain = "TestDomain" });  
            var q = Query.Match(domainNode)  
                .CreateRelation("hg", "HAS_DOMAIN", groupNode, domainNode, false, new { DomainId = "TestDomain", GroupId = "gId_1" });  
            var (cq, parameters) = q.CompileWithParemeters();  
            Console.WriteLine(cq);

Remarks

sequence will be default to zero if not provided

Node<T>.Instance(int) Method

Create a new Instance of node type T with alias suffixed with sequence

public static CypherQueryBuilder.Node<T> Instance(int sequence=0);

Parameters

sequence System.Int32

Returns

CypherQueryBuilder.Node<T >
New node of type T

Remarks

sequence will be default to zero if not provided

Node<T>.Instance(T, int) Method

Create a new Instance of node type T with alias suffixed with sequence

public static CypherQueryBuilder.Node<T> Instance(T obj, int sequence=0);

Parameters

obj T

The object.

sequence System.Int32

The sequence.

Returns

CypherQueryBuilder.Node<T >
New node of type T

Remarks

sequence will be default to zero if not provided

Node<T>.Where(Expression<Func<T,bool>>) Method

Applies filter or Where clause.

public CypherQueryBuilder.Node<T> Where(System.Linq.Expressions.Expression<System.Func<T,bool>> expr);

Parameters

expr System.Linq.Expressions.Expression<System.Func<T ,System.Boolean >>

The expr.

Returns

CypherQueryBuilder.Node<T >
The same node of type T

Node<T>.WithProperty(object) Method

Configure the property.

public virtual CypherQueryBuilder.Node<T> WithProperty(object obj);

Parameters

obj System.Object

The object.

Implements WithProperty(object)

Returns

CypherQueryBuilder.Node<T >
The same node of type T

Node<T>.WithProperty(string, object) Method

Configure the property.

public virtual CypherQueryBuilder.Node<T> WithProperty(string key, object? value);

Parameters

key System.String

The key.

value System.Object

The value.

Implements WithProperty(string, object)

Returns

CypherQueryBuilder.Node<T >
The same node of type T

Node<T>.WithProperty(T) Method

Configure the property.

public CypherQueryBuilder.Node<T> WithProperty(T obj);

Parameters

obj T

The object.

Returns

NodeCreationQuery Class

public class NodeCreationQuery : CypherQueryBuilder.QueryBase

Inheritance System.Object 🡒 Utility.Disposable 🡒 QueryBase 🡒 NodeCreationQuery

Methods

NodeCreationQuery.Compile() Method

Compiles this instance to Cypher Query string.

public override string Compile();

Returns

System.String
Cypher Query string

NodeCreationQuery.Merge(Node, Node[]) Method

Merges the specified node.

public CypherQueryBuilder.NodeCreationQuery Merge(CypherQueryBuilder.Node node, params CypherQueryBuilder.Node[] otherNodes);

Parameters

node Node

The node.

otherNodes Node []

The other nodes.

Returns

NodeCreationQuery.ReleaseResources() Method

Releases the resources.

public override void ReleaseResources();

NodeCreationQuery.Return(string[]) Method

Returns the specified returns.

public virtual CypherQueryBuilder.NodeCreationQuery Return(params string[] returns);

Parameters

returns System.String []

The returns.

Returns

NodeCreationQuery.Return<T>(Node<T>, Expression<Func<T,object>>, bool) Method

Returns the specified node.

public virtual CypherQueryBuilder.NodeCreationQuery Return<T>(CypherQueryBuilder.Node<T> node, System.Linq.Expressions.Expression<System.Func<T,object>> f, bool aliasToBeRemoved=true);

Type parameters

T

Parameters

f System.Linq.Expressions.Expression<System.Func<T ,System.Object >>

The node.

The f.

aliasToBeRemoved System.Boolean

if set to true [alias to be removed].

Returns

f System.Linq.Expressions.Expression<System.Func<T ,System.Object >>

NodeCreationQuery.Return<T>(Expression<Func<T,object>>, bool) Method

Returns the specified f.

public CypherQueryBuilder.NodeCreationQuery Return<T>(System.Linq.Expressions.Expression<System.Func<T,object>> f, bool aliasToBeRemoved=true);

Type parameters

T

Parameters

The f.

aliasToBeRemoved System.Boolean

if set to true [alias to be removed].

Returns

Query Class

Query - The main entry point to build cypher query for create, merge or match

public static class Query

Inheritance System.Object 🡒 Query

Methods

Query.Create(bool, Node, Node[]) Method

Creates the specified to merge.

private static CypherQueryBuilder.NodeCreationQuery Create(bool toMerge, CypherQueryBuilder.Node node, params CypherQueryBuilder.Node[] otherNodes);

Parameters

toMerge System.Boolean

if set to true [to merge].

node Node

The node.

otherNodes Node []

The other nodes.

Returns

System.Text.RegularExpressions.Regex

Query.Create(Node, Node[]) Method

Creates the specified node.

public static CypherQueryBuilder.NodeCreationQuery Create(CypherQueryBuilder.Node node, params CypherQueryBuilder.Node[] otherNodes);

Parameters

node Node

Node to Instance

otherNodes Node []

Other nodes to match in case multiple nodes to be created.

Returns

NodeCreationQuery
NodeCreationQuery

Example

Example to build create query.

var movie = new Movie() { ReleaseYear = 2010, Title = "Gambler" };  
            var q = Query.Instance(  
                Node<Movie>.Instance(movie)  
                    .WithRelation(Node<Person>.Instance(new Person {Age = 30, FullName = "Ray" }), "DIRECTED_BY"))  
                .Return<Movie>(p => new { p.Title, p.ReleaseYear }).Return<Person>(p => new { p.FullName});  
            var str = q.Compile();

Query.Match(Node, Node[]) Method

Matches the specified node.

public static CypherQueryBuilder.MatchQuery Match(CypherQueryBuilder.Node node, params CypherQueryBuilder.Node[] otherNodes);

Parameters

node Node

Node to Match

otherNodes Node []

Other nodes to match in case multiple nodes to be matched

Returns

MatchQuery
MatchQuery

Example

var q = Query.Match(n).Return("n", "r", "m");

Query.Merge(Node, Node[]) Method

Merges the specified node.

public static CypherQueryBuilder.NodeCreationQuery Merge(CypherQueryBuilder.Node node, params CypherQueryBuilder.Node[] otherNodes);

Parameters

node Node

The node.

otherNodes Node []

The other nodes in case multiple nodes to be merged.

Returns

NodeCreationQuery
NodeCreationQuery

Example

Example to build merge query.

var movie = new Movie() { ReleaseYear = 2010, Title = "Gambler" };  
            var q = Query.Merge(  
                Node<Movie>.Instance(movie)  
                    .WithRelation(Node<Person>.Instance(new Person {Age = 30, FullName = "Ray" }), "DIRECTED_BY"))  
                .Return<Movie>(p => new { p.Title, p.ReleaseYear }).Return<Person>(p => new { p.FullName});  
            var str = q.Compile();

QueryBase Class

public abstract class QueryBase : Utility.Disposable

Inheritance System.Object 🡒 Utility.Disposable 🡒 QueryBase

Derived
↳ MatchQuery
↳ NodeCreationQuery

Methods

QueryBase.AssignmentExp() Method

private static System.Text.RegularExpressions.Regex AssignmentExp();

Returns

Remarks

Pattern:

(?<K>\\w+)\\s*\\=\\s*(?<V>\\w+(\\.\\w+)?)  
```<br/>  
Options:<br/>  
  
```csharp  
RegexOptions.IgnoreCase  
```<br/>  
Explanation:<br/>  
  
```csharp  
○ "K" capture group.<br/>  
    ○ Match a word character atomically at least once.<br/>  
○ Match a whitespace character atomically any number of times.<br/>  
○ Match '='.<br/>  
○ Match a whitespace character atomically any number of times.<br/>  
○ "V" capture group.<br/>  
    ○ Match a word character greedily at least once.<br/>  
    ○ Optional (greedy).<br/>  
        ○ 1st capture group.<br/>  
            ○ Match '.'.<br/>  
            ○ Match a word character atomically at least once.<br/>

QueryBase.Compile() Method

Compiles this instance to Cypher Query string.

public abstract string Compile();

Returns

System.String
Cypher Query string

QueryBase.Return<T>(Node<T>, Expression<Func<T,object>>, bool) Method

Collect data to build return parts whilde compiling.

public virtual CypherQueryBuilder.QueryBase Return<T>(CypherQueryBuilder.Node<T> node, System.Linq.Expressions.Expression<System.Func<T,object>> f, bool aliasToBeRemoved=true);

Type parameters

T

Parameters