EdgeMatchClause

age-schema-client v0.3.0

---

age-schema-client / EdgeMatchClause

Class: EdgeMatchClause<T>

Defined in: src/query/clauses.ts:252

Edge match clause implementation

Type Parameters

Type Parameter
T extends SchemaDefinition

Implements

• IEdgeMatchClause<T>

Constructors

Constructor

new EdgeMatchClause<T>(
   queryBuilder, 
   matchPart, 
edgePattern): EdgeMatchClause<T>;

Defined in: src/query/clauses.ts:260

Create a new edge match clause

Parameters

Parameter	Type	Description
queryBuilder	IQueryBuilder<T>	Query builder
matchPart	MatchPart	Match part
edgePattern	EdgePattern	Edge pattern

Returns

EdgeMatchClause<T>

Methods

constraint()

constraint(properties): this;

Defined in: src/query/clauses.ts:273

Add property constraints to the edge pattern

Parameters

Parameter	Type	Description
properties	Record<string, any>	Object with property-value pairs

Returns

this

This edge match clause

Throws

Error if any property value is null, undefined, or NaN

Implementation of

IEdgeMatchClause.constraint

---

where()

where(condition, params?): this;

Defined in: src/query/clauses.ts:307

Add WHERE clause

Parameters

Parameter	Type	Description
condition	string	Condition expression
params?	Record<string, any>	Parameters

Returns

this

This edge match clause

Implementation of

IEdgeMatchClause.where

---

return()

return(...expressions): this;

Defined in: src/query/clauses.ts:319

Add RETURN clause

Parameters

Parameter	Type	Description
...expressions	string[]	Return expressions

Returns

this

This edge match clause

Implementation of

IEdgeMatchClause.return

---

orderBy()

orderBy(expression, direction?): this;

Defined in: src/query/clauses.ts:331

Add ORDER BY clause

Parameters

Parameter	Type	Description
expression	string	Expression to order by
direction?	OrderDirection	Order direction

Returns

this

This edge match clause

Implementation of

IEdgeMatchClause.orderBy

---

limit()

limit(count): this;

Defined in: src/query/clauses.ts:342

Add LIMIT clause

Parameters

Parameter	Type	Description
count	number	Limit count

Returns

this

This edge match clause

Implementation of

IEdgeMatchClause.limit

---

skip()

skip(count): this;

Defined in: src/query/clauses.ts:353

Add SKIP clause

Parameters

Parameter	Type	Description
count	number	Skip count

Returns

this

This edge match clause

Implementation of

IEdgeMatchClause.skip

---

with()

with(...expressions): this;

Defined in: src/query/clauses.ts:364

Add WITH clause

Parameters

Parameter	Type	Description
...expressions	string[]	With expressions

Returns

this

This edge match clause

Implementation of

IEdgeMatchClause.with

---

unwind()

unwind(expression, alias): this;

Defined in: src/query/clauses.ts:376

Add UNWIND clause

Parameters

Parameter	Type	Description
expression	string	Expression to unwind
alias	string	Alias for unwound items

Returns

this

This edge match clause

Implementation of

IEdgeMatchClause.unwind

---

withParam()

withParam(name, value): this;

Defined in: src/query/clauses.ts:388

Add a parameter to the query

Parameters

Parameter	Type	Description
name	string	Parameter name
value	any	Parameter value

Returns

this

This edge match clause

Implementation of

IEdgeMatchClause.withParam

---

execute()

execute<R>(options?): QueryBuilderResult<R>;

Defined in: src/query/clauses.ts:399

Execute the query

Type Parameters

Type Parameter	Default type
R	any

Parameters

Parameter	Type	Description
options?	QueryExecutionOptions	Query execution options

Returns

QueryBuilderResult<R>

Query result

Implementation of

IEdgeMatchClause.execute

---

toCypher()

toCypher(): string;

Defined in: src/query/clauses.ts:408

Get the Cypher query string

Returns

string

Cypher query string

Implementation of

IEdgeMatchClause.toCypher

---

done()

done(): IQueryBuilder<T>;

Defined in: src/query/clauses.ts:417

Return to the main query builder

Returns

IQueryBuilder<T>

Query builder

Implementation of

IEdgeMatchClause.done