MatchPart

age-schema-client v0.3.0

---

age-schema-client / MatchPart

Class: MatchPart

Defined in: src/query/parts.ts:43

MATCH query part

Extends

• BaseQueryPart

Constructors

Constructor

new MatchPart(patterns, optional): MatchPart;

Defined in: src/query/parts.ts:65

Create a new MATCH part

Parameters

Parameter	Type	Default value	Description
patterns	MatchPattern[]	[]	Match patterns
optional	boolean	false	Whether this is an OPTIONAL MATCH

Returns

MatchPart

Overrides

BaseQueryPart.constructor

Properties

Property	Type	Default value	Description	Overrides	Defined in
type	QueryPartType	QueryPartType.MATCH	Query part type	BaseQueryPart.type	src/query/parts.ts:47

Methods

addPattern()

addPattern(pattern): void;

Defined in: src/query/parts.ts:76

Add a pattern

Parameters

Parameter	Type	Description
pattern	MatchPattern	Match pattern

Returns

void

---

setOptional()

setOptional(optional): void;

Defined in: src/query/parts.ts:85

Set optional flag

Parameters

Parameter	Type	Description
optional	boolean	Whether this is an OPTIONAL MATCH

Returns

void

---

getPatterns()

getPatterns(): MatchPattern[];

Defined in: src/query/parts.ts:94

Get patterns

Returns

MatchPattern[]

Patterns

---

toCypher()

toCypher(): string;

Defined in: src/query/parts.ts:101

Convert to Cypher string

Returns

string

Overrides

BaseQueryPart.toCypher

---

getParameters()

getParameters(): Record<string, any>;

Defined in: src/query/parts.ts:115

Get parameters used in this query part

Returns

Record<string, any>

Overrides

BaseQueryPart.getParameters