Module org.neo4j.cypherdsl.core

Package org.neo4j.cypherdsl.core

Interface ExposesWith

All Known Subinterfaces:

ExposesSubqueryCall.BuildableSubquery, LoadCSVStatementBuilder, StatementBuilder, StatementBuilder.BuildableMatchAndUpdate, StatementBuilder.BuildableOngoingMergeAction, StatementBuilder.OngoingInQueryCallWithReturnFields, StatementBuilder.OngoingMatchAndUpdate, StatementBuilder.OngoingMerge, StatementBuilder.OngoingReading, StatementBuilder.OngoingReadingAndWith, StatementBuilder.OngoingReadingAndWithWithSkip, StatementBuilder.OngoingReadingAndWithWithWhereAndOrder, StatementBuilder.OngoingReadingWithoutWhere, StatementBuilder.OngoingReadingWithWhere, StatementBuilder.OngoingStandaloneCallWithReturnFields, StatementBuilder.OngoingUpdate, StatementBuilder.OrderableOngoingReadingAndWith, StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere, StatementBuilder.OrderableOngoingReadingAndWithWithWhere, StatementBuilder.VoidCall

@API(status=STABLE,
     since="2023.0.0")
public interface ExposesWith

A step that exposes the WITH clause. This interface used to be part of the StatementBuilder and moved out of it to unify the WITH clause taking in identifable elements.

Since:

2023.0.0

Author:

Michael J. Simons

Method Summary

Modifier and Type	Method	Description
default @NotNull StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere	with(String... variables)	Starts a with clause by passing variables to it.
@NotNull StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere	with(Collection<IdentifiableElement> elements)	Create a match that returns one or more identifiable elements.
default @NotNull StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere	with(IdentifiableElement... elements)	Create a match that returns one or more identifiable elements.
default @NotNull StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere	withDistinct(String... variables)	Create a match that returns the distinct set of one or more identifiable elements.
@NotNull StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere	withDistinct(Collection<IdentifiableElement> expressions)	Create a match that returns the distinct set of one or more expressions.
default @NotNull StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere	withDistinct(IdentifiableElement... elements)	Create a match that returns the distinct set of one or more identifiable elements.

Method Details

with

@NotNull
@CheckReturnValue
default @NotNull StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere with(String... variables)

Starts a with clause by passing variables to it.

Parameters:

variables - The variables to pass on to the next part

Returns:

A match that can be build now

with

@NotNull
@CheckReturnValue
default @NotNull StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere with(IdentifiableElement... elements)

Create a match that returns one or more identifiable elements.

Parameters:

elements - The variables to pass on to the next part

Returns:

A match that can be build now

with

@NotNull
@CheckReturnValue
@NotNull StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere with(Collection<IdentifiableElement> elements)

Create a match that returns one or more identifiable elements.

Parameters:

elements - The expressions to be returned. Must not be null and be at least one expression.

Returns:

A match that can be build now

withDistinct

@NotNull
@CheckReturnValue
default @NotNull StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere withDistinct(String... variables)

Create a match that returns the distinct set of one or more identifiable elements.

Parameters:

variables - The variables to pass on to the next part

Returns:

A match that can be build now

See Also:

• withDistinct(IdentifiableElement...)

withDistinct

@NotNull
@CheckReturnValue
default @NotNull StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere withDistinct(IdentifiableElement... elements)

Create a match that returns the distinct set of one or more identifiable elements.

Parameters:

elements - The variables to pass on to the next part

Returns:

A match that can be build now

See Also:

• withDistinct(IdentifiableElement...)

withDistinct

@NotNull
@CheckReturnValue
@NotNull StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere withDistinct(Collection<IdentifiableElement> expressions)

Create a match that returns the distinct set of one or more expressions.

Parameters:

expressions - The expressions to be returned. Must not be null and be at least one expression.

Returns:

A match that can be build now