Class Pattern

Represents a pattern of a single node or n-relationships to be used in clauses.

See

Cypher Documentation

Hierarchy

WithWhere
PatternElement
- Pattern

Index

Constructors

Methods

and assignTo quantifier related where

Constructors

constructor

new Pattern(nodeConfig?: NodePatternOptions): Pattern
Parameters
- OptionalnodeConfig: NodePatternOptions
Returns Pattern
Inherited from WithWhere.constructor
- Defined in pattern/Pattern.ts:70
new Pattern(node: undefined | Variable, options?: NodePatternOptions): Pattern
Parameters
- node: undefined | Variable
- Optionaloptions: NodePatternOptions
Returns Pattern
Inherited from WithWhere.constructor
- Defined in pattern/Pattern.ts:71

Methods

and

and(input: undefined | Predicate): this
Shorthand for AND operation after a WHERE subclause
Parameters
- input: undefined | Predicate
Returns this
Inherited from WithWhere.and
- Defined in clauses/mixins/sub-clauses/WithWhere.ts:49
and(
target: Variable | Property,
params: Record<string, Variable | Property | Literal<LiteralValue>>,
): this
Shorthand for AND operation after a WHERE subclause
Parameters
- target: Variable | Property
- params: Record<string, Variable | Property | Literal<LiteralValue>>
Returns this
Inherited from WithWhere.and
- Defined in clauses/mixins/sub-clauses/WithWhere.ts:50

assignTo

assignTo(variable: PathVariable): PathAssign<Pattern>
Parameters
- variable: PathVariable
Returns PathAssign<Pattern>
- Defined in pattern/Pattern.ts:100

quantifier

quantifier(quantifier: Quantifier): QuantifiedPattern
Adds a quantifier to the pattern such as {1,3}, to be used as part of a QuantifiedPath
Parameters
- quantifier: Quantifier
Returns QuantifiedPattern
- Defined in pattern/Pattern.ts:96

related(ref?: Variable, options?: RelationshipPatternOptions): PartialPattern
Parameters
- Optionalref: Variable
- Optionaloptions: RelationshipPatternOptions
Returns PartialPattern
- Defined in pattern/Pattern.ts:85
related(ref: RelationshipPatternOptions): PartialPattern
Parameters
- ref: RelationshipPatternOptions
Returns PartialPattern
- Defined in pattern/Pattern.ts:86

where

where(input: undefined | Predicate): this
Add a WHERE subclause
Parameters
- input: undefined | Predicate
Returns this
See
Cypher Documentation
Inherited from WithWhere.where
- Defined in clauses/mixins/sub-clauses/WithWhere.ts:40
where(
target: Variable | Property,
params: Record<string, Variable | Property | Literal<LiteralValue>>,
): this
Add a WHERE subclause
Parameters
- target: Variable | Property
- params: Record<string, Variable | Property | Literal<LiteralValue>>
Returns this
See
Cypher Documentation
Inherited from WithWhere.where
- Defined in clauses/mixins/sub-clauses/WithWhere.ts:41