Class Foreach

See

Cypher Documentation

Hierarchy (View Summary)

WithWith
WithReturn
WithSetRemove
WithDelete
WithCreate
WithMerge
Clause
- Foreach

Index

Constructors

constructor

Methods

build create delete detachDelete do in merge noDetachDelete remove return set with

Constructors

constructor

new Foreach(variable: Variable): Foreach
Parameters
- variable: Variable
Returns Foreach
Inherited from WithWith.constructor
- Defined in clauses/Foreach.ts:53
new Foreach(
    variable: Variable,
    listExpr: Expr,
    mapClause: ForeachClauses,
): Foreach
Parameters
- variable: Variable
- listExpr: Expr
- mapClause: ForeachClauses
Returns Foreach
Deprecated
Use in and do instead of passing the constructor
Inherited from WithWith.constructor
- Defined in clauses/Foreach.ts:55

Methods

build

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

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:29

delete

delete(...deleteInput: DeleteInput): this
Add a DELETE subclause
Parameters
- ...deleteInput: DeleteInput
Returns this
See
Cypher Documentation
Inherited from WithDelete.delete
- Defined in clauses/mixins/sub-clauses/WithDelete.ts:30

detachDelete

detachDelete(...deleteInput: DeleteInput): this
Adds a DETACH DELETE subclause
Parameters
- ...deleteInput: DeleteInput
Returns this
See
Cypher Documentation
Inherited from WithDelete.detachDelete
- Defined in clauses/mixins/sub-clauses/WithDelete.ts:38

do

do(mapClause: ForeachClauses): this
Parameters
- mapClause: ForeachClauses
Returns this
- Defined in clauses/Foreach.ts:68

in

in(listExpr: Expr): this
Parameters
- listExpr: Expr
Returns this
- Defined in clauses/Foreach.ts:63

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:29

noDetachDelete

noDetachDelete(...deleteInput: DeleteInput): this
Add a NODETACH DELETE subclause
Parameters
- ...deleteInput: DeleteInput
Returns this
See
Cypher Documentation

Since
Neo4j 5.14
Inherited from WithDelete.noDetachDelete
- Defined in clauses/mixins/sub-clauses/WithDelete.ts:48

remove

remove(...properties: (Property | Label)[]): this
Append a REMOVE clause.
Parameters
- ...properties: (Property | Label)[]
Returns this
See
Cypher Documentation
Inherited from WithSetRemove.remove
- Defined in clauses/mixins/sub-clauses/WithSetRemove.ts:52

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:28
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:29

set

set(...params: SetParam[]): this
Append a SET clause. Allowing to assign variable properties to values.
Parameters
- ...params: SetParam[]
Returns this
See
Cypher Documentation
Inherited from WithSetRemove.set
- Defined in clauses/mixins/sub-clauses/WithSetRemove.ts:35

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:28
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:29

Class Foreach

See

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Foreach

Parameters

Returns Foreach

Deprecated

Methods

build

Parameters

Returns CypherResult

create

Parameters

Returns Create

See

delete

Parameters

Returns this

See

detachDelete

Parameters

Returns this

See

do

Parameters

Returns this

in

Parameters

Returns this

merge

Parameters

Returns Merge

See

noDetachDelete

Parameters

Returns this

See

Since

remove

Parameters

Returns this

See

return

Parameters

Returns Return

See

Parameters

Returns Return

See

set

Parameters

Returns this

See

with

Parameters

Returns With

See

Parameters

Returns With

See

Settings

On This Page