IMatchClause
age-schema-client / IMatchClause
Interface: IMatchClause<T, L>
Defined in: src/query/types.ts:321
Match clause interface
Type Parameters
| Type Parameter |
|---|
T extends SchemaDefinition |
L extends keyof T["vertices"] |
Methods
constraint()
constraint(properties): this;
Defined in: src/query/types.ts:332
Add property constraints to the vertex pattern
Parameters
| Parameter | Type | Description |
|---|---|---|
properties | Record<string, any> | Object with property-value pairs |
Returns
this
This match clause
Throws
Error if any property value is null, undefined, or NaN
where()
where(condition, params?): this;
Defined in: src/query/types.ts:341
Add WHERE clause
Parameters
| Parameter | Type | Description |
|---|---|---|
condition | string | Condition expression |
params? | Record<string, any> | Parameters |
Returns
this
This match clause
outgoing()
outgoing<E>(
label,
alias,
targetLabel,
targetAlias): this;
Defined in: src/query/types.ts:346
Add outgoing edge
Type Parameters
| Type Parameter |
|---|
E extends string | number | symbol |
Parameters
| Parameter | Type |
|---|---|
label | E |
alias | string |
targetLabel | keyof T["vertices"] |
targetAlias | string |
Returns
this
incoming()
incoming<E>(
label,
alias,
sourceLabel,
sourceAlias): this;
Defined in: src/query/types.ts:356
Add incoming edge
Type Parameters
| Type Parameter |
|---|
E extends string | number | symbol |
Parameters
| Parameter | Type |
|---|---|
label | E |
alias | string |
sourceLabel | keyof T["vertices"] |
sourceAlias | string |
Returns
this
related()
related<E>(
label,
alias,
otherLabel,
otherAlias): this;
Defined in: src/query/types.ts:366
Add bidirectional edge
Type Parameters
| Type Parameter |
|---|
E extends string | number | symbol |
Parameters
| Parameter | Type |
|---|---|
label | E |
alias | string |
otherLabel | keyof T["vertices"] |
otherAlias | string |
Returns
this
done()
done(): IQueryBuilder<T>;
Defined in: src/query/types.ts:376
Return to the main query builder