Uses of Annotation Interface
org.neo4j.cypherdsl.core.annotations.CheckReturnValue

Packages that use CheckReturnValue

Package	Description
org.neo4j.cypherdsl.core	Contains an internal DSL for creating Cypher.

Uses of CheckReturnValue in org.neo4j.cypherdsl.core

Methods in org.neo4j.cypherdsl.core with annotations of type CheckReturnValue

Modifier and Type	Method	Description
@NotNull Reduction.OngoingDefinitionWithInitial	Reduction.OngoingDefinitionWithReducer.accumulateOn(Expression accumulator)
T	ExposesLogicalOperators.and(Condition condition)	Adds an additional condition to the existing conditions, connected by an and.
default T	ExposesLogicalOperators.and(RelationshipPattern pathPattern)	Adds an additional condition based on a path pattern to the existing conditions, connected by an and.
@NotNull StatementBuilder.TerminalOngoingOrderDefinition	StatementBuilder.OngoingMatchAndReturnWithOrder.and(@NotNull Expression expression)	Adds another expression to the list of order items.
@NotNull StatementBuilder.OngoingOrderDefinition	StatementBuilder.OngoingReadingAndWithWithWhereAndOrder.and(@NotNull Expression expression)	Adds another expression to the list of order items.
@NotNull StatementBuilder.OngoingReading	StatementBuilder.OngoingUnwind.as(@NotNull String variable)	Adds an AS part that allows to define an alias for the iterable being unwound.
default @NotNull StatementBuilder.OngoingReading	StatementBuilder.OngoingUnwind.as(SymbolicName variable)	Reuse an existing symbolic name.
@NotNull StatementBuilder.OngoingReadingAndWithWithWhereAndOrder	StatementBuilder.OngoingOrderDefinition.ascending()	Specifies ascending order and jumps back to defining the match and return statement.
@NotNull StatementBuilder.OngoingMatchAndReturnWithOrder	StatementBuilder.TerminalOngoingOrderDefinition.ascending()	Specifies ascending order and jumps back to defining the match and return statement.
T	ExposesCall.call(String... namespaceAndProcedure)	Starts defining a procedure call of the procedure with the given qualified name.
default @NotNull ExposesSubqueryCall.BuildableSubquery	ExposesSubqueryCall.call(Statement statement)	The subquery parameter must be a valid subquery.
default @NotNull ExposesSubqueryCall.BuildableSubquery	ExposesSubqueryCall.call(Statement statement, String... imports)	The subquery parameter must be a valid subquery.
@NotNull ExposesSubqueryCall.BuildableSubquery	ExposesSubqueryCall.call(Statement statement, IdentifiableElement... imports)	The subquery parameter must be a valid sub-query.
default @NotNull ExposesSubqueryCall.BuildableSubquery	ExposesSubqueryCall.callInTransactions(Statement statement)	Starts building a new sub-query from a CALL ... IN TRANSACTIONS clause
default @NotNull ExposesSubqueryCall.BuildableSubquery	ExposesSubqueryCall.callInTransactions(Statement statement, Integer rows)	Creates a subquery running in its own transactions.
default @NotNull ExposesSubqueryCall.BuildableSubquery	ExposesSubqueryCall.callInTransactions(Statement statement, Integer rows, String... imports)	Creates a subquery running in its own transactions.
@NotNull ExposesSubqueryCall.BuildableSubquery	ExposesSubqueryCall.callInTransactions(Statement statement, Integer rows, IdentifiableElement... imports)	Creates a subquery running in its own transactions.
default @NotNull ExposesSubqueryCall.BuildableSubquery	ExposesSubqueryCall.callInTransactions(Statement statement, String... imports)	Creates a subquery running in its own transactions.
@NotNull ExposesSubqueryCall.BuildableSubquery	ExposesSubqueryCall.callRawCypher(String rawCypher, Object... args)	Starts building a new sub-query from a raw Cypher string that might also have arguments as supported through Cypher.raw(String, Object...).
StatementBuilder.OngoingUpdate	ExposesCreate.create(Collection<? extends PatternElement> pattern)
StatementBuilder.OngoingUpdate	ExposesCreate.create(PatternElement... pattern)
default @NotNull StatementBuilder.OngoingUpdate	StatementBuilder.ExposesDelete.delete(String... variables)	Renders a DELETE clause targeting the given variables.
@NotNull StatementBuilder.OngoingUpdate	StatementBuilder.ExposesDelete.delete(Collection<? extends Expression> expressions)	Creates a delete step with one or more expressions to be deleted.
@NotNull StatementBuilder.OngoingUpdate	StatementBuilder.ExposesDelete.delete(Expression... expressions)	Creates a delete step with one or more expressions to be deleted.
default @NotNull StatementBuilder.OngoingUpdate	StatementBuilder.ExposesDelete.delete(Named... variables)	Renders a DELETE clause targeting the given variables.
@NotNull StatementBuilder.OngoingReadingAndWithWithWhereAndOrder	StatementBuilder.OngoingOrderDefinition.descending()	Specifies descending order and jumps back to defining the match and return statement.
@NotNull StatementBuilder.OngoingMatchAndReturnWithOrder	StatementBuilder.TerminalOngoingOrderDefinition.descending()	Specifies descending order and jumps back to defining the match and return statement.
default @NotNull StatementBuilder.OngoingUpdate	StatementBuilder.ExposesDelete.detachDelete(String... variables)	Renders a DETACH DELETE clause targeting the given variables.
@NotNull StatementBuilder.OngoingUpdate	StatementBuilder.ExposesDelete.detachDelete(Collection<? extends Expression> expressions)	Starts building a delete step that will use DETACH to remove relationships.
@NotNull StatementBuilder.OngoingUpdate	StatementBuilder.ExposesDelete.detachDelete(Expression... expressions)	Starts building a delete step that will use DETACH to remove relationships.
default @NotNull StatementBuilder.OngoingUpdate	StatementBuilder.ExposesDelete.detachDelete(Named... variables)	Renders a DETACH DELETE clause targeting the given variables.
@NotNull Case	Case.CaseEnding.elseDefault(Expression defaultExpression)	Ends this case expression with a default expression to evaluate.
@NotNull ListComprehension.OngoingDefinitionWithList	ListComprehension.OngoingDefinitionWithVariable.in(Expression list)	Create a list comprehension past on a literal list.
@NotNull Predicates.OngoingListBasedPredicateFunctionWithList	Predicates.OngoingListBasedPredicateFunction.in(Expression list)
@NotNull Reduction.OngoingDefinitionWithList	Reduction.OngoingDefinitionWithVariable.in(Expression list)
@NotNull StatementBuilder.OngoingReadingAndWith	StatementBuilder.ExposesLimit.limit(Number number)	Limits the number of returned records.
@NotNull StatementBuilder.OngoingReadingAndWith	StatementBuilder.ExposesLimit.limit(Expression expression)	Limits the number of returned records.
@NotNull StatementBuilder.BuildableStatement<ResultStatement>	StatementBuilder.TerminalExposesLimit.limit(Number number)	Limits the number of returned records.
@NotNull StatementBuilder.BuildableStatement<ResultStatement>	StatementBuilder.TerminalExposesLimit.limit(Expression expression)	Limits the number of returned records.
@NotNull Reduction.OngoingDefinitionWithReducer	Reduction.OngoingDefinitionWithList.map(Expression mapper)
StatementBuilder.OngoingReadingWithoutWhere	ExposesMatch.match(boolean optional, PatternElement... pattern)	Adds (another) MATCH clause.
default StatementBuilder.OngoingReadingWithoutWhere	ExposesMatch.match(Collection<? extends PatternElement> pattern)	Adds (another) MATCH clause.
default StatementBuilder.OngoingReadingWithoutWhere	ExposesMatch.match(PatternElement... pattern)	Adds (another) MATCH clause.
StatementBuilder.OngoingMerge	ExposesMerge.merge(PatternElement... pattern)
@NotNull StatementBuilder.BuildableMatchAndUpdate	StatementBuilder.ExposesSet.mutate(Expression target, Expression properties)	Creates a += operation.
default @NotNull StatementBuilder.BuildableMatchAndUpdate	StatementBuilder.ExposesSet.mutate(Named variable, Expression properties)	Creates a += operation.
@NotNull StatementBuilder.BuildableOngoingMergeAction	StatementBuilder.OngoingMergeAction.mutate(Expression target, Expression properties)	Creates a += operation.
default @NotNull StatementBuilder.BuildableOngoingMergeAction	StatementBuilder.OngoingMergeAction.mutate(Named variable, Expression properties)	Creates a += operation.
@NotNull ExposesRelationships<RelationshipChain>	RelationshipPattern.named(String name)	Turns the pattern into a named chain of relationships.
@NotNull ExposesRelationships<RelationshipChain>	RelationshipPattern.named(SymbolicName name)	Turns the pattern into a named chain of relationships.
@NotNull StatementBuilder.OngoingMergeAction	StatementBuilder.ExposesMergeAction.onCreate()	This allows to specify the action that should happen when the merge clause lead to the creation of a new pattern.
@NotNull StatementBuilder.OngoingMergeAction	StatementBuilder.ExposesMergeAction.onMatch()	This allows to specify the action that should happen when the pattern of the merge clause already existed and matched.
default StatementBuilder.OngoingReadingWithoutWhere	ExposesMatch.optionalMatch(Collection<? extends PatternElement> pattern)	Adds (another) optional MATCH clause.
default StatementBuilder.OngoingReadingWithoutWhere	ExposesMatch.optionalMatch(PatternElement... pattern)	Adds (another) optional MATCH clause.
T	ExposesLogicalOperators.or(Condition condition)	Adds an additional condition to the existing conditions, connected by an or.
default T	ExposesLogicalOperators.or(RelationshipPattern pathPattern)	Adds an additional condition based on a path pattern to the existing conditions, connected by an or.
@NotNull StatementBuilder.OrderableOngoingReadingAndWithWithWhere	StatementBuilder.ExposesOrderBy.orderBy(Collection<SortItem> sortItem)	Order the result set by one or more sort items.
@NotNull StatementBuilder.OngoingOrderDefinition	StatementBuilder.ExposesOrderBy.orderBy(@NotNull Expression expression)	Order the result set by an expression.
@NotNull StatementBuilder.OrderableOngoingReadingAndWithWithWhere	StatementBuilder.ExposesOrderBy.orderBy(SortItem... sortItem)	Order the result set by one or more sort items.
@NotNull StatementBuilder.OngoingMatchAndReturnWithOrder	StatementBuilder.TerminalExposesOrderBy.orderBy(Collection<SortItem> sortItem)	Order the result set by one or more sort items.
@NotNull StatementBuilder.TerminalOngoingOrderDefinition	StatementBuilder.TerminalExposesOrderBy.orderBy(@NotNull Expression expression)	Order the result set by an expression.
@NotNull StatementBuilder.OngoingMatchAndReturnWithOrder	StatementBuilder.TerminalExposesOrderBy.orderBy(SortItem... sortItem)	Order the result set by one or more sort items.
@NotNull StatementBuilder.BuildableMatchAndUpdate	StatementBuilder.ExposesSetAndRemove.remove(Collection<Property> properties)	Creates SET clause for removing the enumerated properties
@NotNull StatementBuilder.BuildableMatchAndUpdate	StatementBuilder.ExposesSetAndRemove.remove(Node node, String... labels)	Creates SET clause for removing the given labels from a node.
@NotNull StatementBuilder.BuildableMatchAndUpdate	StatementBuilder.ExposesSetAndRemove.remove(Node node, Collection<String> labels)	Creates SET clause for removing the given labels from a node.
@NotNull StatementBuilder.BuildableMatchAndUpdate	StatementBuilder.ExposesSetAndRemove.remove(Property... properties)	Creates SET clause for removing the enumerated properties
default StatementBuilder.OngoingReadingAndReturn	ExposesReturning.returning(String... variables)	Creates the RETURN clause.
StatementBuilder.OngoingReadingAndReturn	ExposesReturning.returning(Collection<? extends Expression> expressions)	Create a match that returns one or more expressions.
default StatementBuilder.OngoingReadingAndReturn	ExposesReturning.returning(Expression... expressions)	Create a match that returns one or more expressions.
default StatementBuilder.OngoingReadingAndReturn	ExposesReturning.returning(Named... variables)	Creates the RETURN clause.
default StatementBuilder.OngoingReadingAndReturn	ExposesReturning.returningDistinct(String... variables)	Creates a RETURN clause containing the DISTINCT keyword.
StatementBuilder.OngoingReadingAndReturn	ExposesReturning.returningDistinct(Collection<? extends Expression> expressions)	Creates a RETURN clause returning the distinct set of one or more expressions.
default StatementBuilder.OngoingReadingAndReturn	ExposesReturning.returningDistinct(Expression... expressions)	Creates a RETURN clause returning the distinct set of one or more expressions.
default StatementBuilder.OngoingReadingAndReturn	ExposesReturning.returningDistinct(Named... variables)	Creates a RETURN clause containing the DISTINCT keyword.
StatementBuilder.OngoingReadingAndReturn	ExposesReturning.returningRaw(Expression rawExpression)	Creates a RETURN clause from a raw Cypher expression created via Cypher.raw(String, Object...).
@NotNull StatementBuilder.BuildableMatchAndUpdate	StatementBuilder.ExposesSet.set(Collection<? extends Expression> expressions)	Adds a SET clause to the statement.
@NotNull StatementBuilder.BuildableMatchAndUpdate	StatementBuilder.ExposesSet.set(Expression... expressions)	Adds a SET clause to the statement.
default @NotNull StatementBuilder.BuildableMatchAndUpdate	StatementBuilder.ExposesSet.set(Named variable, Expression expression)	Adds a SET clause to the statement, modifying the given named thing with an expression.
R	StatementBuilder.ExposesSetLabel.set(Node node, String... labels)	Creates SET clause for setting the given labels to a node.
R	StatementBuilder.ExposesSetLabel.set(Node node, Collection<String> labels)	Creates SET clause for setting the given labels to a node.
@NotNull StatementBuilder.BuildableOngoingMergeAction	StatementBuilder.OngoingMergeAction.set(Collection<? extends Expression> expressions)	Adds a SET clause to the statement.
@NotNull StatementBuilder.BuildableOngoingMergeAction	StatementBuilder.OngoingMergeAction.set(Expression... expressions)	Adds a SET clause to the statement.
default @NotNull StatementBuilder.BuildableOngoingMergeAction	StatementBuilder.OngoingMergeAction.set(Named variable, Expression expression)	Adds a SET clause to the statement, modifying the given named thing with an expression.
@NotNull StatementBuilder.OngoingReadingAndWithWithSkip	StatementBuilder.ExposesSkip.skip(Number number)	Adds a skip clause, skipping the given number of records.
@NotNull StatementBuilder.OngoingReadingAndWithWithSkip	StatementBuilder.ExposesSkip.skip(Expression expression)	Adds a skip clause.
@NotNull StatementBuilder.TerminalExposesLimit	StatementBuilder.TerminalExposesSkip.skip(Number number)	Adds a skip clause, skipping the given number of records.
@NotNull StatementBuilder.TerminalExposesLimit	StatementBuilder.TerminalExposesSkip.skip(Expression expression)	Adds a skip clause.
@NotNull Case.CaseEnding	Case.OngoingWhenThen.then(Expression expression)	Ends this WHEN block with an expression.
default StatementBuilder.OngoingUnwind	ExposesUnwind.unwind(String variable)	Starts building a new UNWIND clause.
default StatementBuilder.OngoingUnwind	ExposesUnwind.unwind(Expression... expressions)	Starts building a new UNWIND clause.
StatementBuilder.OngoingReadingWithoutWhere	ExposesHints.usingIndex(Property... properties)	Applies an INDEX hint for one or more properties.
StatementBuilder.OngoingReadingWithoutWhere	ExposesHints.usingIndexSeek(Property... properties)	Applies an INDEX SEEL hint for one or more properties.
default StatementBuilder.OngoingReadingWithoutWhere	ExposesHints.usingJoinOn(Node... nodes)	Applies a JOIN hint on one or more nodes.
StatementBuilder.OngoingReadingWithoutWhere	ExposesHints.usingJoinOn(SymbolicName... names)	Applies a JOIN hint on one or more nodes identified by their names.
StatementBuilder.OngoingReadingWithoutWhere	ExposesHints.usingScan(Node node)	Applies a SCAN hint on a node.
@NotNull Case.OngoingWhenThen	Case.CaseEnding.when(Expression expression)	Adds a new WHEN block.
@NotNull Case.OngoingWhenThen	Case.when(Expression nextExpression)	Creates a new case/when expression with an additional WHEN block.
T	ExposesWhere.where(Condition condition)	Adds a where clause to this fragement.
default T	ExposesWhere.where(RelationshipPattern pathPattern)	Adds a where clause based on a path pattern to this match.
@NotNull ListComprehension.OngoingDefinitionWithoutReturn	ListComprehension.OngoingDefinitionWithList.where(Condition condition)	Adds a WHERE clause to this comprehension.
@NotNull PatternComprehension.OngoingDefinitionWithPatternAndWhere	PatternComprehension.OngoingDefinitionWithPattern.where(Condition condition)	Adds a WHERE clause to the inner statement of the pattern comprehension
default @NotNull PatternComprehension.OngoingDefinitionWithPatternAndWhere	PatternComprehension.OngoingDefinitionWithPattern.where(RelationshipPattern pathPattern)	Adds a where clause based on a path pattern to the ongoing definition
@NotNull StatementBuilder.OrderableOngoingReadingAndWithWithWhere	StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere.where(@NotNull Condition condition)	Adds a where clause to this match.
default @NotNull StatementBuilder.OrderableOngoingReadingAndWithWithWhere	StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere.where(@NotNull RelationshipPattern pathPattern)	Adds a where clause based on a path pattern to this match.
default @NotNull StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere	ExposesWith.with(String... variables)	Starts a with clause by passing variables to it.
@NotNull StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere	ExposesWith.with(Collection<IdentifiableElement> elements)	Create a match that returns one or more identifiable elements.
default @NotNull StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere	ExposesWith.with(IdentifiableElement... elements)	Create a match that returns one or more identifiable elements.
T	ExposesCall.ExposesWithArgs.withArgs(Expression... arguments)	Adds the given arguments to the ongoing call and procedes.
default @NotNull StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere	ExposesWith.withDistinct(String... variables)	Create a match that returns the distinct set of one or more identifiable elements.
@NotNull StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere	ExposesWith.withDistinct(Collection<IdentifiableElement> expressions)	Create a match that returns the distinct set of one or more expressions.
default @NotNull StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere	ExposesWith.withDistinct(IdentifiableElement... elements)	Create a match that returns the distinct set of one or more identifiable elements.
default T	ExposesCall.ExposesYield.yield(String... yieldedItems)	Adds the given items to the YIELD clause of the generated call.
T	ExposesCall.ExposesYield.yield(AliasedExpression... aliasedResultFields)	Adds the given items to the YIELD clause of the generated call and uses new aliases in the generated call.
default T	ExposesCall.ExposesYield.yield(Named... yieldedItems)	Adds the given items to the YIELD clause of the generated call.
T	ExposesCall.ExposesYield.yield(SymbolicName... resultFields)	Adds the given items to the YIELD clause of the generated call.