Class Call

Adds a CALL subquery

Param: subquery

A clause to be wrapped in a CALL clause

Param: variableScope

A list of variables to pass to the scope of the clause: CALL (var0) {

See

Cypher Documentation

Hierarchy (View Summary)

WithReturn
WithWith
WithUnwind
WithSetRemove
WithDelete
WithMatch
WithCreate
WithMerge
WithOrder
Clause
- Call
  - OptionalCall

Index

Constructors

constructor

Methods

build create delete detachDelete importWith inTransactions limit match merge noDetachDelete offset optional optionalMatch orderBy remove return set skip unwind with

Constructors

constructor

new Call(subquery: Clause, variableScope?: "*" | Variable[]): Call
Parameters
- subquery: Clause
- OptionalvariableScope: "*" | Variable[]
Returns Call
Inherited from WithReturn.constructor
- Defined in clauses/Call.ts:77

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

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

importWith

importWith(...params: (Variable | "*")[]): this
Adds a WITH statement inside CALL {, this WITH can is used to import variables outside of the subquery
Parameters
- ...params: (Variable | "*")[]
Returns this
See
Cypher Documentation

Deprecated
Use constructor parameter variableScope instead
- Defined in clauses/Call.ts:89

inTransactions

inTransactions(config?: CallInTransactionOptions): this
Parameters
- config: CallInTransactionOptions = {}
Returns this
- Defined in clauses/Call.ts:103

limit

limit(value: number | Expr): this
Add a LIMIT subclause.
Parameters
- value: number | Expr
Returns this
See
Cypher Documentation
Inherited from WithOrder.limit
- Defined in clauses/mixins/sub-clauses/WithOrder.ts:69

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

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

offset

offset(value: number | Expr): this
Add a OFFSET subclause. An alias to SKIP
Parameters
- value: number | Expr
Returns this
See
Cypher Documentation

Since
Neo4j 5.24
Inherited from WithOrder.offset
- Defined in clauses/mixins/sub-clauses/WithOrder.ts:60

optional

optional(): this
Makes the subquery an OPTIONAL CALL

Returns this
See
Cypher Documentation

Since
Neo4j 5.24
- Defined in clauses/Call.ts:112

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

orderBy

orderBy(...exprs: (Expr | [Expr, Order] | [Expr])[]): this
Add an ORDER BY subclause. Note that ASC is the default sorting order
Parameters
- ...exprs: (Expr | [Expr, Order] | [Expr])[]
Returns this
See
Cypher Documentation
Inherited from WithOrder.orderBy
- Defined in clauses/mixins/sub-clauses/WithOrder.ts:33

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

skip

skip(value: number | Expr): this
Add a SKIP subclause.
Parameters
- value: number | Expr
Returns this
See
Cypher Documentation
Inherited from WithOrder.skip
- Defined in clauses/mixins/sub-clauses/WithOrder.ts:50

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

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 Call

Param: subquery

Param: variableScope

See

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Call

Methods

build

Parameters

Returns CypherResult

create

Parameters

Returns Create

See

delete

Parameters

Returns this

See

detachDelete

Parameters

Returns this

See

importWith

Parameters

Returns this

See

Deprecated

inTransactions

Parameters

Returns this

limit

Parameters

Returns this

See

match

Parameters

Returns Match

See

merge

Parameters

Returns Merge

See

noDetachDelete

Parameters

Returns this

See

Since

offset

Parameters

Returns this

See

Since

optional

Returns this

See

Since

optionalMatch

Parameters

Returns OptionalMatch

See

orderBy

Parameters

Returns this

See

remove

Parameters

Returns this

See

return

Parameters

Returns Return

See

Parameters

Returns Return