IEdgeMatchClause
age-schema-client / IEdgeMatchClause
Interface: IEdgeMatchClause<T>
Defined in: src/query/types.ts:382
Edge match clause interface
Type Parameters
| Type Parameter |
|---|
T extends SchemaDefinition |
Methods
constraint()
constraint(properties): this;
Defined in: src/query/types.ts:390
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
where()
where(condition, params?): this;
Defined in: src/query/types.ts:399
Add WHERE clause
Parameters
| Parameter | Type | Description |
|---|---|---|
condition | string | Condition expression |
params? | Record<string, any> | Parameters |
Returns
this
This edge match clause
return()
return(...expressions): this;
Defined in: src/query/types.ts:404
Add RETURN clause
Parameters
| Parameter | Type |
|---|---|
...expressions | string[] |
Returns
this
orderBy()
orderBy(expression, direction?): this;
Defined in: src/query/types.ts:409
Add ORDER BY clause
Parameters
| Parameter | Type |
|---|---|
expression | string |
direction? | OrderDirection |
Returns
this
limit()
limit(count): this;
Defined in: src/query/types.ts:414
Add LIMIT clause
Parameters
| Parameter | Type |
|---|---|
count | number |
Returns
this
skip()
skip(count): this;
Defined in: src/query/types.ts:419
Add SKIP clause
Parameters
| Parameter | Type |
|---|---|
count | number |
Returns
this
with()
with(...expressions): this;
Defined in: src/query/types.ts:424
Add WITH clause
Parameters
| Parameter | Type |
|---|---|
...expressions | string[] |
Returns
this
unwind()
unwind(expression, alias): this;
Defined in: src/query/types.ts:429
Add UNWIND clause
Parameters
| Parameter | Type |
|---|---|
expression | string |
alias | string |
Returns
this
withParam()
withParam(name, value): this;
Defined in: src/query/types.ts:434
Add a parameter to the query
Parameters
| Parameter | Type |
|---|---|
name | string |
value | any |
Returns
this
execute()
execute<R>(options?): QueryBuilderResult<R>;
Defined in: src/query/types.ts:439
Execute the query
Type Parameters
| Type Parameter | Default type |
|---|---|
R | any |
Parameters
| Parameter | Type |
|---|---|
options? | QueryExecutionOptions |
Returns
toCypher()
toCypher(): string;
Defined in: src/query/types.ts:444
Get the Cypher query string
Returns
string
done()
done(): IQueryBuilder<T>;
Defined in: src/query/types.ts:449
Return to the main query builder