Class LoadCSV

See

Cypher Documentation

Hierarchy (View Summary)

WithReturn
WithCreate
WithMerge
WithWith
WithWhere
WithCallProcedure
WithLet
Clause
- LoadCSV

Index

Constructors

constructor

Methods

and build callProcedure create let merge return where with withHeaders

Constructors

constructor

new LoadCSV(url: string, alias: Variable): LoadCSV
Parameters
- url: string
- alias: Variable
Returns LoadCSV
Inherited from WithReturn.constructor
- Defined in clauses/LoadCSV.ts:31

Methods

and

and(input: Predicate | undefined): this
Shorthand for AND operation after a WHERE subclause
Parameters
- input: Predicate | undefined
Returns this
Inherited from WithWhere.and
- Defined in clauses/mixins/sub-clauses/WithWhere.ts:38
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:39

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

callProcedure

callProcedure<T extends VoidProcedure | Procedure<string>>(procedure: T): T
Add a call Procedure clause
Type Parameters
- T extends VoidProcedure | Procedure<string>
Parameters
- procedure: T
Returns T
See
Cypher Documentation
Inherited from WithCallProcedure.callProcedure
- Defined in clauses/mixins/clauses/WithCallProcedure.ts:15

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

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

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

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

where

where(input: Predicate | undefined): this
Add a WHERE subclause
Parameters
- input: Predicate | undefined
Returns this
See
Cypher Documentation
Inherited from WithWhere.where
- Defined in clauses/mixins/sub-clauses/WithWhere.ts:29
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:30

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

withHeaders

withHeaders(): this
Returns this
- Defined in clauses/LoadCSV.ts:37

Class LoadCSV

See

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns LoadCSV

Methods

and

Parameters

Returns this

Parameters

Returns this

build

Parameters

Returns CypherResult

callProcedure

Type Parameters

Parameters

Returns T

See

create

Parameters

Returns Create

See

let

Parameters

Returns Let

See

Since

Parameters

Returns Let

See

Since

merge

Parameters

Returns Merge

See

return

Parameters

Returns Return

See

Parameters

Returns Return

See

where

Parameters

Returns this

See

Parameters

Returns this

See

with

Parameters

Returns With

See

Parameters

Returns With

See

withHeaders

Returns this

Settings

On This Page