Module org.neo4j.cypherdsl.core

Package org.neo4j.cypherdsl.core

Interface ExposesReturning

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="1.0")
public interface ExposesReturning

Return part of a statement.

Since:

1.0

Author:

Michael J. Simons

Method Summary

Modifier and Type	Method	Description
default StatementBuilder.OngoingReadingAndReturn	returning(String... variables)	Creates the RETURN clause.
StatementBuilder.OngoingReadingAndReturn	returning(Collection<? extends Expression> expressions)	Create a match that returns one or more expressions.
default StatementBuilder.OngoingReadingAndReturn	returning(Expression... expressions)	Create a match that returns one or more expressions.
default StatementBuilder.OngoingReadingAndReturn	returning(Named... variables)	Creates the RETURN clause.
default StatementBuilder.OngoingReadingAndReturn	returningDistinct(String... variables)	Creates a RETURN clause containing the DISTINCT keyword.
StatementBuilder.OngoingReadingAndReturn	returningDistinct(Collection<? extends Expression> expressions)	Creates a RETURN clause returning the distinct set of one or more expressions.
default StatementBuilder.OngoingReadingAndReturn	returningDistinct(Expression... expressions)	Creates a RETURN clause returning the distinct set of one or more expressions.
default StatementBuilder.OngoingReadingAndReturn	returningDistinct(Named... variables)	Creates a RETURN clause containing the DISTINCT keyword.
StatementBuilder.OngoingReadingAndReturn	returningRaw(Expression rawExpression)	Creates a RETURN clause from a raw Cypher expression created via Cypher.raw(String, Object...).

Method Details

returning

@NotNull
@CheckReturnValue
default StatementBuilder.OngoingReadingAndReturn returning(String... variables)

Creates the RETURN clause. All variables passed via variables must be valid symbolic names. Expression.property(String...) must be used to return single properties.

Parameters:

variables - The named things to return

Returns:

A build step with a defined list of things to return.

returning

@NotNull
@CheckReturnValue
default StatementBuilder.OngoingReadingAndReturn returning(Named... variables)

Creates the RETURN clause.

Parameters:

variables - The named things to return

Returns:

A build step with a defined list of things to return.

returning

@NotNull
@CheckReturnValue
default StatementBuilder.OngoingReadingAndReturn returning(Expression... expressions)

Create a match that returns 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

returning

@NotNull
@CheckReturnValue
StatementBuilder.OngoingReadingAndReturn returning(Collection<? extends Expression> expressions)

Create a match that returns 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

returningDistinct

@NotNull
@CheckReturnValue
default StatementBuilder.OngoingReadingAndReturn returningDistinct(String... variables)

Creates a RETURN clause containing the DISTINCT keyword. All variables passed via variables must be valid symbolic names. Expression.property(String...) must be used to return single properties.

Parameters:

variables - The variables to return

Returns:

A build step with a defined list of things to return.

returningDistinct

@NotNull
@CheckReturnValue
default StatementBuilder.OngoingReadingAndReturn returningDistinct(Named... variables)

Creates a RETURN clause containing the DISTINCT keyword.

Parameters:

variables - The named things to return

Returns:

A build step with a defined list of things to return.

returningDistinct

@NotNull
@CheckReturnValue
default StatementBuilder.OngoingReadingAndReturn returningDistinct(Expression... expressions)

Creates a RETURN clause returning 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

returningDistinct

@NotNull
@CheckReturnValue
StatementBuilder.OngoingReadingAndReturn returningDistinct(Collection<? extends Expression> expressions)

Creates a RETURN clause returning 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

returningRaw

@NotNull
@CheckReturnValue
StatementBuilder.OngoingReadingAndReturn returningRaw(Expression rawExpression)

Creates a RETURN clause from a raw Cypher expression created via Cypher.raw(String, Object...). The expression maybe aliased but it must resolve to a raw element

Parameters:

rawExpression - Must be a plain raw or an aliased raw expression. To eventually render as valid Cypher, it must contain the RETURN keyword.

Returns:

A match that can be build now

Since:

2021.2.1