Package org.neo4j.cypherdsl.core

Interface StatementBuilder

All Superinterfaces:

ExposesCreate, ExposesMatch, ExposesMerge, ExposesReturning, ExposesSubqueryCall, ExposesUnwind

@API(status=EXPERIMENTAL,
     since="1.0")
public interface StatementBuilder
extends ExposesMatch, ExposesCreate, ExposesMerge, ExposesUnwind, ExposesReturning, ExposesSubqueryCall

Since:

1.0

Author:

Michael J. Simons, Gerrit Meier, Andreas Berger

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	StatementBuilder.BuildableMatchAndUpdate	A buildable ongoing MATCH and UPDATE.
static interface	StatementBuilder.BuildableOngoingMergeAction	An interface combining a buildable MATCH and UPDATE with the possibility to add actions after a MERGE clause.
static interface	StatementBuilder.BuildableStatement	A statement that has all information required to be build and exposes a build method.
static interface	StatementBuilder.ExposesDelete	A step that exposes only the delete clause.
static interface	StatementBuilder.ExposesExistentialSubqueryCall	A shared marker interface for things that can be turned into a subquery to be used inside the WHERE clause.
static interface	StatementBuilder.ExposesLimit	A step that exposes the StatementBuilder.ExposesLimit.limit(Number) method.
static interface	StatementBuilder.ExposesMergeAction	Provides a way to specify an action that happens after a MERGE clause.
static interface	StatementBuilder.ExposesOrderBy	See StatementBuilder.TerminalExposesOrderBy, but on a with clause.
static interface	StatementBuilder.ExposesSet	Set part of a statement.
static interface	StatementBuilder.ExposesSetAndRemove	A step that exposes the set clause.
static interface	StatementBuilder.ExposesSkip	A step that exposes the StatementBuilder.ExposesSkip.skip(Number) method.
static interface	StatementBuilder.ExposesUpdatingClause	A step providing all the supported updating clauses (DELETE, SET)
static interface	StatementBuilder.ExposesWith	A step that exposes the WITH clause.
static interface	StatementBuilder.OngoingMatchAndReturnWithOrder	Combines the capabilities of skip, limit and adds additional expressions to the order-by items.
static interface	StatementBuilder.OngoingMatchAndUpdate	After a MATCH..UPDATE chain has been established, a RETURN can be added, a pipeline with WITH can be started or more mutating steps can be added.
static interface	StatementBuilder.OngoingMerge	An ongoing update statement that can be used to chain more updating statements, define actions on a merge or add a with or return clause.
static interface	StatementBuilder.OngoingMergeAction	A variant of StatementBuilder.ExposesSet that allows for further chaining of actions.
static interface	StatementBuilder.OngoingOrderDefinition	An intermediate step while defining the order of a with clause.
static interface	StatementBuilder.OngoingReading	A match that exposes returning and for which it is not decided whether the optional where part has been used or note.
static interface	StatementBuilder.OngoingReadingAndReturn	A match that knows what to return and which is ready to be build.
static interface	StatementBuilder.OngoingReadingAndWith	Represents a reading statement ending in a with clause, potentially already having an order and not exposing order methods.
static interface	StatementBuilder.OngoingReadingAndWithWithSkip	The union type of an ongoing reading with a WITH and a SKIP clause.
static interface	StatementBuilder.OngoingReadingAndWithWithWhereAndOrder	Combines the capabilities of skip, limit and adds additional expressions to the order-by items.
static interface	StatementBuilder.OngoingReadingWithoutWhere	A match that exposes returning and where methods to add required information.
static interface	StatementBuilder.OngoingReadingWithWhere	A match that has a non-empty where-part.
static interface	StatementBuilder.OngoingUnwind	Builder part for unwinding.
static interface	StatementBuilder.OngoingUpdate	An ongoing update statement that can be used to chain more update statements or add a with or return clause.
static interface	StatementBuilder.OrderableOngoingReadingAndWith
static interface	StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere	A match that knows what to pipe to the next part of a multi part query.
static interface	StatementBuilder.OrderableOngoingReadingAndWithWithWhere
static interface	StatementBuilder.TerminalExposesLimit	A step that exposes the StatementBuilder.TerminalExposesLimit.limit(Number) method.
static interface	StatementBuilder.TerminalExposesOrderBy	A step that exposes several methods to specify ordering.
static interface	StatementBuilder.TerminalExposesSkip	A step that exposes the StatementBuilder.TerminalExposesSkip.skip(Number) method.
static interface	StatementBuilder.TerminalOngoingOrderDefinition	An intermediate step while defining the order of a result set.

Method Summary

Modifier and Type	Method	Description
StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere	with(java.lang.String... variables)	Starts a with clause by passing variables to it.
StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere	with(Expression... expressions)	Allows for queries starting with with range(1,10) as x return x or similar.
StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere	with(Named... expressions)	Starts a with clause by passing named expressions to it.

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

create

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

match, match, optionalMatch

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

merge

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

returning, returning, returning, returningDistinct, returningDistinct, returningDistinct

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

call

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

unwind, unwind, unwind

Method Detail

with

StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere with(java.lang.String... variables)

Starts a with clause by passing variables to it.

Parameters:

variables - The variables to start the query with

Returns:

An ongoing read, exposing return and further matches.

Since:

2020.1.2

with

StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere with(Named... expressions)

Starts a with clause by passing named expressions to it.

Parameters:

expressions - The expressions to start the query with

Returns:

An ongoing read, exposing return and further matches.

Since:

2020.1.2

with

StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere with(Expression... expressions)

Allows for queries starting with with range(1,10) as x return x or similar.

Parameters:

expressions - The expressions to start the query with

Returns:

An ongoing read, exposing return and further matches.