CypherQueryBuilder 1.5.1

There is a newer version of this package available.
See the version list below for details.

dotnet add package CypherQueryBuilder --version 1.5.1

NuGet\Install-Package CypherQueryBuilder -Version 1.5.1

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="CypherQueryBuilder" Version="1.5.1" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add CypherQueryBuilder --version 1.5.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: CypherQueryBuilder, 1.5.1"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

// Install CypherQueryBuilder as a Cake Addin
#addin nuget:?package=CypherQueryBuilder&version=1.5.1

// Install CypherQueryBuilder as a Cake Tool
#tool nuget:?package=CypherQueryBuilder&version=1.5.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

CypherQueryBuilder

CypherQueryBuilder Assembly

Namespaces

CypherQueryBuilder Namespace

Classes

CreateQuery Class

public class CreateQuery : CypherQueryBuilder.MatchQuery

Inheritance System.Object 🡒 Utility.Disposable 🡒 QueryBase 🡒 MatchQuery 🡒 CreateQuery

Methods

CreateQuery.Compile() Method

Compiles this instance to Cypher Query string.

public override string Compile();

Returns

System.String
Cypher Query string

CreateQuery.CompileWithParemeters() Method

Compiles the instance to Cypher Query string with paremeters.

public override (string query,System.Collections.Generic.Dictionary<string,object?> parameters) CompileWithParemeters();

Returns

<System.String ,System.Collections.Generic.Dictionary<System.String ,System.Object >>
ValueTuple<string, Dictionary<string, Nullable<Object>>>

Example

Usage:

var metaDataCount = 2;  
            var metaDataNodes = new Node<MetaData>[metaDataCount];  
            for (int i = 0; i < metaDataCount; i++)  
            {  
                var id = $"mId_{i}";  
                metaDataNodes[i] = Node<MetaData>.Instance(i).Where(p => p.Uid == id);  
            }  
            var domainNode = Node<Domain>.Instance().Where(p => p.Uid == "TestDomain");  
            var (mq, parameters) = Query.Match(domainNode, metaDataNodes).CompileAsParemeterized();

DeleteQuery Class

public class DeleteQuery : CypherQueryBuilder.MatchQuery

Inheritance System.Object 🡒 Utility.Disposable 🡒 QueryBase 🡒 MatchQuery 🡒 DeleteQuery

Methods

DeleteQuery.Compile() Method

Compiles this instance to Cypher Query string.

public override string Compile();

Returns

System.String
Cypher Query string

DeleteQuery.Delete<T>(T[]) Method

Deletes the specified entities.

public override CypherQueryBuilder.DeleteQuery Delete<T>(params T[] entities)
    where T : CypherQueryBuilder.Entity;

Type parameters

T

Parameters

entities T []

The entities to delete.

Returns

DeleteQuery
DeleteQuery

DeleteQuery.Detach<T>(T[]) Method

Detaches, i.e. delete with all the associated relations (if it is a node), the specified entities.

public override CypherQueryBuilder.DeleteQuery Detach<T>(params T[] entities)
    where T : CypherQueryBuilder.Entity;

Type parameters

T

Parameters

entities T []

The entities to detache and delete.

Returns

DeleteQuery
DeleteQuery

DeleteQuery.ReleaseResources() Method

Releases the resources, used while disposing.

public override void ReleaseResources();

MatchQuery Class

public class MatchQuery : CypherQueryBuilder.QueryBase

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

Derived
↳ CreateQuery
↳ DeleteQuery
↳ UpdateQuery

Methods

MatchQuery.Compile() Method

Compiles this instance to Cypher Query string.

public override string Compile();

Returns

System.String
Cypher Query string

MatchQuery.CompileWithParemeters() Method

Compiles the instance to Cypher Query string with paremeters.

public virtual (string query,System.Collections.Generic.Dictionary<string,object?> parameters) CompileWithParemeters();

Returns

<System.String ,System.Collections.Generic.Dictionary<System.String ,System.Object >>
ValueTuple<string, Dictionary<string, Nullable<Object>>>

Example

Usage:

var metaDataCount = 2;  
            var metaDataNodes = new Node<MetaData>[metaDataCount];  
            for (int i = 0; i < metaDataCount; i++)  
            {  
                var id = $"mId_{i}";  
                metaDataNodes[i] = Node<MetaData>.Instance(i).Where(p => p.Uid == id);  
            }  
            var domainNode = Node<Domain>.Instance().Where(p => p.Uid == "TestDomain");  
            var (mq, parameters) = Query.Match(domainNode, metaDataNodes).CompileAsParemeterized();

MatchQuery.CreateRelation(string, string, Node, Node, bool, object) Method

Creates the relation.

public virtual CypherQueryBuilder.CreateQuery CreateRelation(string alias, string label, CypherQueryBuilder.Node from, CypherQueryBuilder.Node to, bool toMerge=false, object? properties=null);

Parameters

alias System.String

The alias.

label System.String

The label.

from CypherQueryBuilder.Node

From.

to CypherQueryBuilder.Node

To.

toMerge System.Boolean

if set to true [to merge].

properties System.Object

The properties.

Returns

CreateQuery

MatchQuery.Limit(int) Method

Limits the specified limit.

public CypherQueryBuilder.MatchQuery Limit(int limit);

Parameters

limit System.Int32

The limit.

Returns

MatchQuery
MatchQuery

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

Orders the by.

public virtual CypherQueryBuilder.MatchQuery OrderBy<T,K>(System.Linq.Expressions.Expression<System.Func<T,K>> keySelector, string? alias=null);

Type parameters

T

Entity (Node or Relation)

K

The property of the T type Node or Relation on which order by will be applied.

Parameters

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

The key selector.

alias System.String

The alias.

Returns

MatchQuery
MatchQuery

Example

var movie = new Movie() { ReleaseYear = 2010, Title = "Gambler" };  
            var mNode = Node<Movie>.Instance(movie);  
            var q = Query  
                .Match(mNode, pNode)  
                .Return<Movie>()  
                .OrderBy<Movie, int>(m => m.ReleaseYear);

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

Orders the by descending.

public virtual CypherQueryBuilder.MatchQuery OrderByDescending<T,K>(System.Linq.Expressions.Expression<System.Func<T,K>> keySelector, string? alias=null);

Type parameters

T

Entity (Node or Relation)

K

The property of the T type Node or Relation on which descending order by will be applied.

Parameters

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

The key selector.

alias System.String

The alias.

Returns

MatchQuery
MatchQuery

Example

var movie = new Movie() { ReleaseYear = 2010, Title = "Gambler" };  
            var mNode = Node<Movie>.Instance(movie);  
            var q = Query  
                .Match(mNode, pNode)  
                .Return<Movie>()  
                .OrderByDescending<Movie, int>(m => m.ReleaseYear);

MatchQuery.OrWhere(string) Method

Ors the where.

public CypherQueryBuilder.MatchQuery OrWhere(string clause);

Parameters

clause System.String

The clause.

Returns

MatchQuery

MatchQuery.Return(string[]) Method

Returns the specified returns.

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

Parameters

returns System.String []

The returns.

Returns

MatchQuery

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

Returns the specified node.

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

Type parameters

T

Parameters

node CypherQueryBuilder.Node<T >

The node.

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

The f.

Returns

MatchQuery

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

Returns the specified alias.

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

Type parameters

T

Parameters

alias System.String

The alias.

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

The f.

Returns

MatchQuery

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

Returns the specified f.

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

Type parameters

T

Parameters

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

The f.

Returns

MatchQuery

MatchQuery.Skip(int) Method

Skips the specified skip.

public CypherQueryBuilder.MatchQuery Skip(int skip);

Parameters

skip System.Int32

The skip.

Returns

MatchQuery

MatchQuery.Union(MatchQuery) Method

Unions the specified other.

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

Parameters

other MatchQuery

The other.

Returns

CypherQueryBuilder.UnionQuery

MatchQuery.Where(string) Method

Wheres the specified clause.

public CypherQueryBuilder.MatchQuery Where(string clause);

Parameters

clause System.String

The clause.

Returns

MatchQuery

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 CypherQueryBuilder.Node

The node.

otherNodes CypherQueryBuilder.Node []

The other nodes.

Returns

CypherQueryBuilder.NodeCreationQuery

Query.Create(Node, Node[]) Method

Creates the specified node.

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

Parameters

node CypherQueryBuilder.Node

Node to Instance

otherNodes CypherQueryBuilder.Node []

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

Returns

CypherQueryBuilder.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 CypherQueryBuilder.Node

Node to Match

otherNodes CypherQueryBuilder.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 CypherQueryBuilder.Node

The node.

otherNodes CypherQueryBuilder.Node []

The other nodes in case multiple nodes to be merged.

Returns

CypherQueryBuilder.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

Methods

QueryBase.Compile() Method

Compiles this instance to Cypher Query string.

public abstract string Compile();

Returns

System.String
Cypher Query string

UpdateQuery Class

public class UpdateQuery : CypherQueryBuilder.MatchQuery

Inheritance System.Object 🡒 Utility.Disposable 🡒 QueryBase 🡒 MatchQuery 🡒 UpdateQuery

Methods

UpdateQuery.Compile() Method

Compiles this instance to Cypher Query string.

public override string Compile();

Returns

System.String
Cypher Query string

UpdateQuery.CompileWithParemeters() Method

Compiles the instance to Cypher Query string with paremeters.

public override (string query,System.Collections.Generic.Dictionary<string,object?> parameters) CompileWithParemeters();

Returns

<System.String ,System.Collections.Generic.Dictionary<System.String ,System.Object >>
ValueTuple<string, Dictionary<string, Nullable<Object>>>

Example

Usage:

var metaDataCount = 2;  
            var metaDataNodes = new Node<MetaData>[metaDataCount];  
            for (int i = 0; i < metaDataCount; i++)  
            {  
                var id = $"mId_{i}";  
                metaDataNodes[i] = Node<MetaData>.Instance(i).Where(p => p.Uid == id);  
            }  
            var domainNode = Node<Domain>.Instance().Where(p => p.Uid == "TestDomain");  
            var (mq, parameters) = Query.Match(domainNode, metaDataNodes).CompileAsParemeterized();

Product	Compatible and additional computed target framework versions.
.NET	net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last updated
1.7.4	91	11/11/2024
1.7.3	81	11/5/2024
1.7.2	71	10/29/2024
1.7.1	109	9/25/2024
1.7.0	93	9/24/2024
1.6.2	107	9/11/2024
1.6.1	82	8/2/2024
1.6.0	60	7/31/2024
1.5.2	72	7/26/2024
1.5.1	101	7/24/2024
1.5.0	98	7/15/2024
1.4.2	88	7/12/2024
1.4.1	92	7/12/2024
1.4.0	80	7/12/2024
1.3.2	111	7/9/2024
1.3.1	97	7/5/2024
1.3.0	98	7/5/2024
1.2.0	108	7/2/2024
1.1.1	106	7/1/2024
1.1.0	107	6/29/2024
1.0.0	128	6/25/2024

CypherQueryBuilder 1.5.1

CypherQueryBuilder

CypherQueryBuilder Assembly

Namespaces

CypherQueryBuilder Namespace

Classes

CreateQuery Class

Methods

CreateQuery.Compile() Method

Returns

See Also

CreateQuery.CompileWithParemeters() Method

Returns

Example

See Also

DeleteQuery Class

Methods

DeleteQuery.Compile() Method

Returns

DeleteQuery.Delete<T>(T[]) Method

Type parameters

Parameters

Returns

DeleteQuery.Detach<T>(T[]) Method

Type parameters

Parameters

Returns

DeleteQuery.ReleaseResources() Method

MatchQuery Class

Methods

MatchQuery.Compile() Method

Returns

See Also

MatchQuery.CompileWithParemeters() Method

Returns

Example

See Also

MatchQuery.CreateRelation(string, string, Node, Node, bool, object) Method

Parameters

Returns

MatchQuery.Limit(int) Method

Parameters

Returns

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

Type parameters

Parameters

Returns

Example

See Also

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

Type parameters

Parameters

Returns

Example

See Also

MatchQuery.OrWhere(string) Method

Parameters

Returns

MatchQuery.Return(string[]) Method

Parameters

Returns

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

Type parameters

Parameters

Returns

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

Type parameters

Parameters

Returns

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

Type parameters

Parameters

Returns

MatchQuery.Skip(int) Method

Parameters

Returns

MatchQuery.Union(MatchQuery) Method

Parameters

Returns

MatchQuery.Where(string) Method