AlgorithmMatchClause

age-schema-client v0.3.0

---

age-schema-client / AlgorithmMatchClause

Class: AlgorithmMatchClause<T, L>

Defined in: src/query/algorithms.ts:126

Algorithm match clause class

Extends the analytics match clause with graph algorithm capabilities

Extends

• AnalyticsMatchClause<T, L>

Type Parameters

Type Parameter
T extends SchemaDefinition
L extends keyof T["vertices"]

Constructors

Constructor

new AlgorithmMatchClause<T, L>(
   queryBuilder, 
   matchPart, 
vertexPattern): AlgorithmMatchClause<T, L>;

Defined in: src/query/algorithms.ts:137

Create a new algorithm match clause

Parameters

Parameter	Type	Description
queryBuilder	AlgorithmQueryBuilder<T>	Query builder
matchPart	MatchPart	Match part
vertexPattern	VertexPattern	Vertex pattern

Returns

AlgorithmMatchClause<T, L>

Overrides

AnalyticsMatchClause.constructor

Methods

shortestPath()

shortestPath(
   startAlias, 
   endAlias, 
   resultAlias, 
options): AlgorithmQueryBuilder<T>;

Defined in: src/query/algorithms.ts:155

Find the shortest path between two vertices

Parameters

Parameter	Type	Default value	Description
startAlias	string	undefined	Start vertex alias
endAlias	string	undefined	End vertex alias
resultAlias	string	'path'	Result path alias
options	PathFindingOptions	{}	Path finding options

Returns

AlgorithmQueryBuilder<T>

This algorithm query builder

---

allShortestPaths()

allShortestPaths(
   startAlias, 
   endAlias, 
   resultAlias, 
options): AlgorithmQueryBuilder<T>;

Defined in: src/query/algorithms.ts:175

Find all shortest paths between two vertices

Parameters

Parameter	Type	Default value	Description
startAlias	string	undefined	Start vertex alias
endAlias	string	undefined	End vertex alias
resultAlias	string	'paths'	Result paths alias
options	PathFindingOptions	{}	Path finding options

Returns

AlgorithmQueryBuilder<T>

This algorithm query builder

---

dijkstra()

dijkstra(
   startAlias, 
   endAlias, 
   costProperty, 
   resultAlias, 
options): AlgorithmQueryBuilder<T>;

Defined in: src/query/algorithms.ts:196

Find the shortest weighted path between two vertices using Dijkstra's algorithm

Parameters

Parameter	Type	Default value	Description
startAlias	string	undefined	Start vertex alias
endAlias	string	undefined	End vertex alias
costProperty	string	undefined	Relationship property to use as cost
resultAlias	string	'path'	Result path alias
options	PathFindingOptions	{}	Path finding options

Returns

AlgorithmQueryBuilder<T>

This algorithm query builder

---

betweennessCentrality()

betweennessCentrality(
   vertexAlias, 
   resultAlias, 
options): AlgorithmQueryBuilder<T>;

Defined in: src/query/algorithms.ts:216

Calculate betweenness centrality for vertices

Parameters

Parameter	Type	Default value	Description
vertexAlias	string	undefined	Vertex alias
resultAlias	string	'centrality'	Result alias
options	CentralityOptions	{}	Centrality options

Returns

AlgorithmQueryBuilder<T>

This algorithm query builder

---

pageRank()

pageRank(
   vertexAlias, 
   resultAlias, 
   dampingFactor, 
iterations): AlgorithmQueryBuilder<T>;

Defined in: src/query/algorithms.ts:235

Calculate PageRank for vertices

Parameters

Parameter	Type	Default value	Description
vertexAlias	string	undefined	Vertex alias
resultAlias	string	'pagerank'	Result alias
dampingFactor	number	0.85	Damping factor (default: 0.85)
iterations	number	20	Number of iterations (default: 20)

Returns

AlgorithmQueryBuilder<T>

This algorithm query builder

---

louvain()

louvain(
   vertexAlias, 
   resultAlias, 
options): AlgorithmQueryBuilder<T>;

Defined in: src/query/algorithms.ts:254

Detect communities using the Louvain method

Parameters

Parameter	Type	Default value	Description
vertexAlias	string	undefined	Vertex alias
resultAlias	string	'community'	Result alias
options	CommunityDetectionOptions	{}	Community detection options

Returns

AlgorithmQueryBuilder<T>

This algorithm query builder

---

extractNodes()

extractNodes(pathAlias, resultAlias): AlgorithmQueryBuilder<T>;

Defined in: src/query/algorithms.ts:271

Extract nodes from a path

Parameters

Parameter	Type	Default value	Description
pathAlias	string	'path'	Path alias
resultAlias	string	'nodes'	Result alias

Returns

AlgorithmQueryBuilder<T>

This algorithm query builder

---

extractRelationships()

extractRelationships(pathAlias, resultAlias): AlgorithmQueryBuilder<T>;

Defined in: src/query/algorithms.ts:287

Extract relationships from a path

Parameters

Parameter	Type	Default value	Description
pathAlias	string	'path'	Path alias
resultAlias	string	'relationships'	Result alias

Returns

AlgorithmQueryBuilder<T>

This algorithm query builder

---

pathLength()

pathLength(pathAlias, resultAlias): AlgorithmQueryBuilder<T>;

Defined in: src/query/algorithms.ts:303

Calculate the length of a path

Parameters

Parameter	Type	Default value	Description
pathAlias	string	'path'	Path alias
resultAlias	string	'length'	Result alias

Returns

AlgorithmQueryBuilder<T>

This algorithm query builder

---

match()

match<K>(label, alias): AlgorithmMatchClause<T, K>;

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

Add another match clause

Type Parameters

Type Parameter
K extends string | number | symbol

Parameters

Parameter	Type	Description
label	K	Vertex label
alias	string	Vertex alias

Returns

AlgorithmMatchClause<T, K>

A new algorithm match clause

Overrides

AnalyticsMatchClause.match

---

count()

count(
   alias, 
   resultAlias, 
distinct): AnalyticsQueryBuilder<T>;

Defined in: src/query/analytics.ts:55

Count vertices or edges

Parameters

Parameter	Type	Default value	Description
alias	string	undefined	Alias of the vertex or edge to count
resultAlias	string	'count'	Alias for the count result (default: 'count')
distinct	boolean	false	Whether to count distinct elements (default: false)

Returns

AnalyticsQueryBuilder<T>

The analytics query builder

Inherited from

AnalyticsMatchClause.count

---

sum()

sum(expression, resultAlias): AnalyticsQueryBuilder<T>;

Defined in: src/query/analytics.ts:69

Sum values of a property

Parameters

Parameter	Type	Default value	Description
expression	string	undefined	Expression to sum (e.g., 'n.age')
resultAlias	string	'sum'	Alias for the sum result (default: 'sum')

Returns

AnalyticsQueryBuilder<T>

The analytics query builder

Inherited from

AnalyticsMatchClause.sum

---

avg()

avg(expression, resultAlias): AnalyticsQueryBuilder<T>;

Defined in: src/query/analytics.ts:82

Calculate average of a property

Parameters

Parameter	Type	Default value	Description
expression	string	undefined	Expression to average (e.g., 'n.age')
resultAlias	string	'avg'	Alias for the average result (default: 'avg')

Returns

AnalyticsQueryBuilder<T>

The analytics query builder

Inherited from

AnalyticsMatchClause.avg

---

min()

min(expression, resultAlias): AnalyticsQueryBuilder<T>;

Defined in: src/query/analytics.ts:95

Find minimum value of a property

Parameters

Parameter	Type	Default value	Description
expression	string	undefined	Expression to find minimum (e.g., 'n.age')
resultAlias	string	'min'	Alias for the minimum result (default: 'min')

Returns

AnalyticsQueryBuilder<T>

The analytics query builder

Inherited from

AnalyticsMatchClause.min

---

max()

max(expression, resultAlias): AnalyticsQueryBuilder<T>;

Defined in: src/query/analytics.ts:108

Find maximum value of a property

Parameters

Parameter	Type	Default value	Description
expression	string	undefined	Expression to find maximum (e.g., 'n.age')
resultAlias	string	'max'	Alias for the maximum result (default: 'max')

Returns

AnalyticsQueryBuilder<T>

The analytics query builder

Inherited from

AnalyticsMatchClause.max

---

aggregate()

aggregate(
   functionName, 
   expression, 
resultAlias): AnalyticsQueryBuilder<T>;

Defined in: src/query/analytics.ts:122

Apply a custom aggregation function

Parameters

Parameter	Type	Description
functionName	string	Aggregation function name
expression	string	Expression to aggregate
resultAlias	string	Alias for the result

Returns

AnalyticsQueryBuilder<T>

The analytics query builder

Inherited from

AnalyticsMatchClause.aggregate

---

where()

where(condition, params?): this;

Defined in: src/query/analytics.ts:147

Add WHERE clause

Parameters

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

Returns

this

This analytics match clause

Inherited from

AnalyticsMatchClause.where

---

return()

return(...expressions): AnalyticsQueryBuilder<T>;

Defined in: src/query/analytics.ts:161

Add RETURN clause

Parameters

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

Returns

AnalyticsQueryBuilder<T>

This analytics query builder

Inherited from

AnalyticsMatchClause.return

---

groupBy()

groupBy(...fields): AnalyticsQueryBuilder<T>;

Defined in: src/query/analytics.ts:173

Add GROUP BY clause

Parameters

Parameter	Type	Description
...fields	string[]	Fields to group by

Returns

AnalyticsQueryBuilder<T>

This analytics query builder

Inherited from

AnalyticsMatchClause.groupBy

---

windowFunction()

windowFunction(
   functionType, 
   resultAlias, 
options): AnalyticsQueryBuilder<T>;

Defined in: src/query/analytics.ts:187

Add a window function to the query

Parameters

Parameter	Type	Description
functionType	string	Window function type
resultAlias	string	Alias for the window function result
options	WindowFunctionOptions	Window function options

Returns

AnalyticsQueryBuilder<T>

This analytics query builder

Inherited from

AnalyticsMatchClause.windowFunction

---

rowNumber()

rowNumber(resultAlias, options): AnalyticsQueryBuilder<T>;

Defined in: src/query/analytics.ts:204

Add ROW_NUMBER window function

Parameters

Parameter	Type	Description
resultAlias	string	Alias for the result
options	WindowFunctionOptions	Window function options

Returns

AnalyticsQueryBuilder<T>

This analytics query builder

Inherited from

AnalyticsMatchClause.rowNumber

---

rank()

rank(resultAlias, options): AnalyticsQueryBuilder<T>;

Defined in: src/query/analytics.ts:217

Add RANK window function

Parameters

Parameter	Type	Description
resultAlias	string	Alias for the result
options	WindowFunctionOptions	Window function options

Returns

AnalyticsQueryBuilder<T>

This analytics query builder

Inherited from

AnalyticsMatchClause.rank

---

denseRank()

denseRank(resultAlias, options): AnalyticsQueryBuilder<T>;

Defined in: src/query/analytics.ts:230

Add DENSE_RANK window function

Parameters

Parameter	Type	Description
resultAlias	string	Alias for the result
options	WindowFunctionOptions	Window function options

Returns

AnalyticsQueryBuilder<T>

This analytics query builder

Inherited from

AnalyticsMatchClause.denseRank

---

constraint()

constraint(properties): this;

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

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

Inherited from

AnalyticsMatchClause.constraint

---

outgoing()

outgoing<E>(
   label, 
   alias, 
   targetLabel, 
   targetAlias): this;

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

Add outgoing edge

Type Parameters

Type Parameter
E extends string | number | symbol

Parameters

Parameter	Type	Description
label	E	Edge label
alias	string	Edge alias
targetLabel	keyof T["vertices"]	Target vertex label
targetAlias	string	Target vertex alias

Returns

this

This match clause

Inherited from

AnalyticsMatchClause.outgoing

---

incoming()

incoming<E>(
   label, 
   alias, 
   sourceLabel, 
   sourceAlias): this;

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

Add incoming edge

Type Parameters

Type Parameter
E extends string | number | symbol

Parameters

Parameter	Type	Description
label	E	Edge label
alias	string	Edge alias
sourceLabel	keyof T["vertices"]	Source vertex label
sourceAlias	string	Source vertex alias

Returns

this

This match clause

Inherited from

AnalyticsMatchClause.incoming

---

related()

related<E>(
   label, 
   alias, 
   otherLabel, 
   otherAlias): this;

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

Add bidirectional edge

Type Parameters

Type Parameter
E extends string | number | symbol

Parameters

Parameter	Type	Description
label	E	Edge label
alias	string	Edge alias
otherLabel	keyof T["vertices"]	Other vertex label
otherAlias	string	Other vertex alias

Returns

this

This match clause

Inherited from

AnalyticsMatchClause.related

---

done()

done(): IQueryBuilder<T>;

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

Return to the main query builder

Returns

IQueryBuilder<T>

Query builder

Inherited from

AnalyticsMatchClause.done