Package org.neo4j.cypherdsl.core

Interface ExposesSubqueryCall

All Known Subinterfaces:

ExposesSubqueryCall.BuildableSubquery, LoadCSVStatementBuilder, StatementBuilder, StatementBuilder.OngoingInQueryCallWithReturnFields, StatementBuilder.OngoingReading, StatementBuilder.OngoingReadingAndWith, StatementBuilder.OngoingReadingAndWithWithSkip, StatementBuilder.OngoingReadingAndWithWithWhereAndOrder, StatementBuilder.OngoingReadingWithoutWhere, StatementBuilder.OngoingReadingWithWhere, StatementBuilder.OngoingStandaloneCallWithReturnFields, StatementBuilder.OrderableOngoingReadingAndWith, StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere, StatementBuilder.OrderableOngoingReadingAndWithWithWhere, StatementBuilder.VoidCall

@API(status=STABLE,
     since="2020.1.2")
@Neo4jVersion(minimum="4.0.0")
public interface ExposesSubqueryCall

This exposes a call method taking in a statement that represents a valid, correlated subquery.

Since:

2020.1.2

Author:

Michael J. Simons

Neo4j version required

4.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ExposesSubqueryCall.BuildableSubquery	Subqueries can be valid without any further return statement (i.e when the subquery is a void (unit) one, meaning it doesn't yield or return its results.

Method Summary

Modifier and Type	Method	Description
default StatementBuilder.OngoingReadingWithoutWhere	call(Statement statement)	The subquery parameter must be a valid subquery.
default StatementBuilder.OngoingReadingWithoutWhere	call(Statement statement, String... imports)	The subquery parameter must be a valid subquery.
StatementBuilder.OngoingReadingWithoutWhere	call(Statement statement, IdentifiableElement... imports)	The subquery parameter must be a valid subquery.
default @NotNull ExposesSubqueryCall.BuildableSubquery	callInTransactions(Statement statement)
default @NotNull ExposesSubqueryCall.BuildableSubquery	callInTransactions(Statement statement, Integer rows)	Creates a subquery running in its own transactions.
default @NotNull ExposesSubqueryCall.BuildableSubquery	callInTransactions(Statement statement, Integer rows, String... imports)	Creates a subquery running in its own transactions.
@NotNull ExposesSubqueryCall.BuildableSubquery	callInTransactions(Statement statement, Integer rows, IdentifiableElement... imports)	Creates a subquery running in its own transactions.
default @NotNull ExposesSubqueryCall.BuildableSubquery	callInTransactions(Statement statement, String... imports)	Creates a subquery running in its own transactions.
default ExposesSubqueryCall.BuildableSubquery	callInTransactions(Statement statement, IdentifiableElement... imports)	Creates a subquery running in its own transactions.

Method Detail

call

@NotNull
@CheckReturnValue
default StatementBuilder.OngoingReadingWithoutWhere call(Statement statement)

The subquery parameter must be a valid subquery.

• must end with a RETURN clause
• cannot refer to variables from the enclosing query
• cannot return variables with the same names as variables in the enclosing query
• All variables that are returned from a subquery are afterwards available in the enclosing query

Parameters:

statement - The statement representing the subquery.

Returns:

An ongoing reading

call

@NotNull
@CheckReturnValue
default StatementBuilder.OngoingReadingWithoutWhere call(Statement statement,
                                                         String... imports)

The subquery parameter must be a valid subquery.

• must end with a RETURN clause
• cannot refer to variables from the enclosing query
• cannot return variables with the same names as variables in the enclosing query
• All variables that are returned from a subquery are afterwards available in the enclosing query

Parameters:

statement - The statement representing the subquery.

imports - Additional things that should be imported into the subquery.

Returns:

An ongoing reading

Since:

2021.3.0

call

@NotNull
@CheckReturnValue
StatementBuilder.OngoingReadingWithoutWhere call(Statement statement,
                                                 IdentifiableElement... imports)

The subquery parameter must be a valid subquery.

• must end with a RETURN clause
• cannot refer to variables from the enclosing query
• cannot return variables with the same names as variables in the enclosing query
• All variables that are returned from a subquery are afterwards available in the enclosing query

Parameters:

statement - The statement representing the subquery.

imports - Additional things that should be imported into the subquery. aliased expressions will automatically imported twice (once as WITH a, then WITH a AS alias).

Returns:

An ongoing reading

Since:

2021.3.0

callInTransactions

@NotNull
@CheckReturnValue
default @NotNull ExposesSubqueryCall.BuildableSubquery callInTransactions(Statement statement)

callInTransactions

@NotNull
@CheckReturnValue
default @NotNull ExposesSubqueryCall.BuildableSubquery callInTransactions(Statement statement,
                                                                          Integer rows)

Creates a subquery running in its own transactions. The statement won't be checked for a RETURN or YIELD clause to accommodate for CREATE or other clauses that are void and work in a subquery if the outer query is void, too.

Parameters:

statement - The statement representing the subquery.

rows - The number of rows per transactional batch, leave NULL for the default value

Returns:

An ongoing reading, that is also buildable for outer queries that are void.

Since:

2022.3.0

callInTransactions

@NotNull
@CheckReturnValue
default @NotNull ExposesSubqueryCall.BuildableSubquery callInTransactions(Statement statement,
                                                                          String... imports)

Creates a subquery running in its own transactions. The statement won't be checked for a RETURN or YIELD clause to accommodate for CREATE or other clauses that are void and work in a subquery if the outer query is void, too.

Parameters:

statement - The statement representing the subquery.

imports - Additional things that should be imported into the subquery.

Returns:

An ongoing reading, that is also buildable for outer queries that are void.

Since:

2022.3.0

callInTransactions

@NotNull
@CheckReturnValue
default @NotNull ExposesSubqueryCall.BuildableSubquery callInTransactions(Statement statement,
                                                                          Integer rows,
                                                                          String... imports)

Creates a subquery running in its own transactions. The statement won't be checked for a RETURN or YIELD clause to accommodate for CREATE or other clauses that are void and work in a subquery if the outer query is void, too.

Parameters:

statement - The statement representing the subquery.

rows - The number of rows per transactional batch, leave NULL for the default value

imports - Additional things that should be imported into the subquery.

Returns:

An ongoing reading, that is also buildable for outer queries that are void.

Since:

2022.3.0

callInTransactions

default ExposesSubqueryCall.BuildableSubquery callInTransactions(Statement statement,
                                                                 IdentifiableElement... imports)

Creates a subquery running in its own transactions. The statement won't be checked for a RETURN or YIELD clause to accommodate for CREATE or other clauses that are void and work in a subquery if the outer query is void, too.

Parameters:

statement - The statement representing the subquery.

imports - Additional things that should be imported into the subquery. aliased expressions will automatically imported twice (once as WITH a, then WITH a AS alias).

Returns:

An ongoing reading, that is also buildable for outer queries that are void.

Since:

2022.3.0

callInTransactions

@NotNull
@CheckReturnValue
@NotNull ExposesSubqueryCall.BuildableSubquery callInTransactions(Statement statement,
                                                                  Integer rows,
                                                                  IdentifiableElement... imports)

Creates a subquery running in its own transactions. The statement won't be checked for a RETURN or YIELD clause to accommodate for CREATE or other clauses that are void and work in a subquery if the outer query is void, too.

Parameters:

statement - The statement representing the subquery.

rows - The number of rows per transactional batch, leave NULL for the default value

imports - Additional things that should be imported into the subquery. aliased expressions will automatically imported twice (once as WITH a, then WITH a AS alias).

Returns:

An ongoing reading, that is also buildable for outer queries that are void.

Since:

2022.3.0