Package org.neo4j.cypherdsl.core

Interface LoadCSVStatementBuilder

All Superinterfaces:

ExposesCreate, ExposesMatch, ExposesMerge, ExposesReturning, ExposesSubqueryCall, ExposesUnwind, StatementBuilder

@API(status=STABLE,
     since="2021.2.1")
public interface LoadCSVStatementBuilder
extends StatementBuilder

Since:

2021.2.1

Author:

Michael J. Simons

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	LoadCSVStatementBuilder.OngoingLoadCSV	An instance of this interface will be provided after pointing the database to a valid URI of a CSV resource.

Nested classes/interfaces inherited from interface org.neo4j.cypherdsl.core.StatementBuilder

StatementBuilder.BuildableMatchAndUpdate, StatementBuilder.BuildableOngoingMergeAction, StatementBuilder.BuildableStatement<T extends Statement>, StatementBuilder.ExposesDelete, StatementBuilder.ExposesExistentialSubqueryCall, StatementBuilder.ExposesLimit, StatementBuilder.ExposesMergeAction, StatementBuilder.ExposesOrderBy, StatementBuilder.ExposesSet, StatementBuilder.ExposesSetAndRemove, StatementBuilder.ExposesSkip, StatementBuilder.ExposesUpdatingClause, StatementBuilder.ExposesWith, StatementBuilder.OngoingInQueryCallWithArguments, StatementBuilder.OngoingInQueryCallWithoutArguments, StatementBuilder.OngoingInQueryCallWithReturnFields, StatementBuilder.OngoingMatchAndReturnWithOrder, StatementBuilder.OngoingMatchAndUpdate, StatementBuilder.OngoingMerge, StatementBuilder.OngoingMergeAction, StatementBuilder.OngoingOrderDefinition, StatementBuilder.OngoingReading, StatementBuilder.OngoingReadingAndReturn, StatementBuilder.OngoingReadingAndWith, StatementBuilder.OngoingReadingAndWithWithSkip, StatementBuilder.OngoingReadingAndWithWithWhereAndOrder, StatementBuilder.OngoingReadingWithoutWhere, StatementBuilder.OngoingReadingWithWhere, StatementBuilder.OngoingStandaloneCallWithArguments, StatementBuilder.OngoingStandaloneCallWithoutArguments, StatementBuilder.OngoingStandaloneCallWithReturnFields, StatementBuilder.OngoingUnwind, StatementBuilder.OngoingUpdate, StatementBuilder.OrderableOngoingReadingAndWith, StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere, StatementBuilder.OrderableOngoingReadingAndWithWithWhere, StatementBuilder.TerminalExposesLimit, StatementBuilder.TerminalExposesOrderBy, StatementBuilder.TerminalExposesSkip, StatementBuilder.TerminalOngoingOrderDefinition

Method Summary

Modifier and Type	Method	Description
static @NotNull LoadCSVStatementBuilder.OngoingLoadCSV	loadCSV(URI from, boolean withHeaders)	Starts building a LOAD CSV.
static @NotNull ExposesLoadCSV	usingPeriodicCommit(@Nullable Integer rate)	Starts building a LOAD CSV clause by using a periodic commit.
@NotNull StatementBuilder	withFieldTerminator(String fieldTerminator)	Configure a field terminator in case the fields aren't separated with the default ,

Methods inherited from interface org.neo4j.cypherdsl.core.ExposesCreate

create, create

Methods inherited from interface org.neo4j.cypherdsl.core.ExposesMatch

match, match, match, optionalMatch, optionalMatch

Methods inherited from interface org.neo4j.cypherdsl.core.ExposesMerge

merge

Methods inherited from interface org.neo4j.cypherdsl.core.ExposesReturning

returning, returning, returning, returning, returningDistinct, returningDistinct, returningDistinct, returningDistinct, returningRaw

Methods inherited from interface org.neo4j.cypherdsl.core.ExposesSubqueryCall

call, call, call

Methods inherited from interface org.neo4j.cypherdsl.core.ExposesUnwind

unwind, unwind, unwind

Methods inherited from interface org.neo4j.cypherdsl.core.StatementBuilder

with, with, with, with, with, with, with

Method Detail

usingPeriodicCommit

@NotNull
@Contract(pure=true)
static @NotNull ExposesLoadCSV usingPeriodicCommit(@Nullable
                                                   @Nullable Integer rate)

Starts building a LOAD CSV clause by using a periodic commit.

Parameters:

rate - The rate to be used. No checks are done on the rate, the database will verify valid values.

Returns:

An ongoing definition of a LOAD CSV clause

loadCSV

@NotNull
@Contract(pure=true)
static @NotNull LoadCSVStatementBuilder.OngoingLoadCSV loadCSV(URI from,
                                                               boolean withHeaders)

Starts building a LOAD CSV.

Parameters:

from - The URI to load data from. Any uri that is resolvable by the database itself is valid.

withHeaders - Set to true if the csv file contains header

Returns:

An ongoing definition of a LOAD CSV clause

withFieldTerminator

@NotNull
@Contract(pure=true)
@NotNull StatementBuilder withFieldTerminator(String fieldTerminator)

Configure a field terminator in case the fields aren't separated with the default ,

Parameters:

fieldTerminator - A new field terminator

Returns:

A statement builder supporting all available clauses