Class Filter

See

Cypher Documentation

Since

Neo4j 2025.06

Hierarchy (View Summary)

WithReturn
WithWith
WithMatch
WithMerge
WithCreate
WithUnwind
WithFilter
WithLet
Clause
- Filter

Index

Constructors

constructor

Methods

and build create filter let match merge optionalMatch return unwind with

Constructors

constructor

new Filter(filterInput: Predicate): Filter
Parameters
- filterInput: Predicate
Returns Filter
Inherited from WithReturn.constructor
- Defined in clauses/Filter.ts:32

Methods

and

and(predicate: Predicate): this
Parameters
- predicate: Predicate
Returns this
- Defined in clauses/Filter.ts:38

build

build(
    config?: Partial<
        {
            cypherVersion: "5"
            | "25";
            extraParams: Record<string, unknown>;
            prefix: string;
            unsafeEscapeOptions: Partial<
                {
                    disableNodeLabelEscaping: boolean;
                    disableRelationshipTypeEscaping: boolean;
                },
            >;
        },
    >,
): CypherResult
Compiles a clause into Cypher and params
Parameters
- Optionalconfig: Partial<
      {
          cypherVersion: "5"
          | "25";
          extraParams: Record<string, unknown>;
          prefix: string;
          unsafeEscapeOptions: Partial<
              {
                  disableNodeLabelEscaping: boolean;
                  disableRelationshipTypeEscaping: boolean;
              },
          >;
      },
  >
Returns CypherResult
Inherited from Clause.build
- Defined in clauses/Clause.ts:61

create

create(clauseOrPattern: Pattern | Create): Create
Add a Create clause
Parameters
- clauseOrPattern: Pattern | Create
Returns Create
See
Cypher Documentation
Inherited from WithCreate.create
- Defined in clauses/mixins/clauses/WithCreate.ts:17

filter

filter(predicate: Predicate): Filter
Add a Filter clause
Parameters
- predicate: Predicate
Returns Filter
See
Cypher Documentation

Since
Neo4j 2025.06
Inherited from WithFilter.filter
- Defined in clauses/mixins/clauses/WithFilter.ts:17

let

let(clause: Let): Let
Append a Let clause.
Parameters
- clause: Let
Returns Let
See
Cypher Documentation

Since
Neo4j 2025.06
Inherited from WithLet.let
- Defined in clauses/mixins/clauses/WithLet.ts:17
let(...bindings: [Variable, Expr][]): Let
Append a Let clause.
Parameters
- ...bindings: [Variable, Expr][]
Returns Let
See
Cypher Documentation

Since
Neo4j 2025.06
Inherited from WithLet.let
- Defined in clauses/mixins/clauses/WithLet.ts:18

match

match(clauseOrPattern: Match | MatchClausePattern): Match
Add a Match clause
Parameters
- clauseOrPattern: Match | MatchClausePattern
Returns Match
See
Cypher Documentation
Inherited from WithMatch.match
- Defined in clauses/mixins/clauses/WithMatch.ts:17

merge

merge(clauseOrPattern: Pattern | Merge): Merge
Add a Merge clause
Parameters
- clauseOrPattern: Pattern | Merge
Returns Merge
See
Cypher Documentation
Inherited from WithMerge.merge
- Defined in clauses/mixins/clauses/WithMerge.ts:17

optionalMatch

optionalMatch(
clauseOrPattern: MatchClausePattern | OptionalMatch,
): OptionalMatch
Add an OptionalMatch clause
Parameters
- clauseOrPattern: MatchClausePattern | OptionalMatch
Returns OptionalMatch
See
Cypher Documentation
Inherited from WithMatch.optionalMatch
- Defined in clauses/mixins/clauses/WithMatch.ts:33

return

return(clause: Return): Return
Append a Return clause
Parameters
- clause: Return
Returns Return
See
Cypher Documentation
Inherited from WithReturn.return
- Defined in clauses/mixins/clauses/WithReturn.ts:16
return(...columns: ("*" | ProjectionColumn)[]): Return
Append a Return clause
Parameters
- ...columns: ("*" | ProjectionColumn)[]
Returns Return
See
Cypher Documentation
Inherited from WithReturn.return
- Defined in clauses/mixins/clauses/WithReturn.ts:17

unwind

unwind(clause: Unwind): Unwind
Append an Unwind clause.
Parameters
- clause: Unwind
Returns Unwind
See
Cypher Documentation
Inherited from WithUnwind.unwind
- Defined in clauses/mixins/clauses/WithUnwind.ts:16
unwind(projection: UnwindProjectionColumn): Unwind
Append an Unwind clause.
Parameters
- projection: UnwindProjectionColumn
Returns Unwind
See
Cypher Documentation
Inherited from WithUnwind.unwind
- Defined in clauses/mixins/clauses/WithUnwind.ts:17

with

with(clause: With): With
Add a With clause
Parameters
- clause: With
Returns With
See
Cypher Documentation
Inherited from WithWith.with
- Defined in clauses/mixins/clauses/WithWith.ts:16
with(
    ...columns: (
        "*"
        | Variable | [Expr, string | Variable | Literal<LiteralValue>]
    )[],
): With
Add a With clause
Parameters
- ...columns: ("*" | Variable | [Expr, string | Variable | Literal<LiteralValue>])[]
Returns With
See
Cypher Documentation
Inherited from WithWith.with
- Defined in clauses/mixins/clauses/WithWith.ts:17

Class Filter

See

Since

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Filter

Methods

and

Parameters

Returns this

build

Parameters

Returns CypherResult

create

Parameters

Returns Create

See

filter

Parameters

Returns Filter

See

Since

let

Parameters

Returns Let

See

Since

Parameters

Returns Let

See

Since

match

Parameters

Returns Match

See

merge

Parameters

Returns Merge

See

optionalMatch

Parameters

Returns OptionalMatch

See

return

Parameters

Returns Return

See

Parameters

Returns Return

See

unwind

Parameters

Returns Unwind

See

Parameters

Returns Unwind

See

with

Parameters

Returns With

See

Parameters

Returns With

See

Settings

On This Page