All Classes

Class	Description
Aliased	An element with an alias.
AliasedExpression	An aliased expression, that deals with named expressions when accepting visitors.
Assertions	Assertions used throughout the Cypher-DSL.
Asterisk	The *.
BooleanLiteral	The boolean literal.
Case	See CaseExpression.
Case.CaseEnding	Specification for a renderable, complete CASE statement
Case.GenericCase	Extension of the Case interface to support generic case.
Case.OngoingWhenThen	Helper class to collect `when` expressions and create CaseWhenThen instances when the `then` is provided.
Case.SimpleCase	Extension the Case interface to support simple case with an initial expression / condition.
CaseElse	Represents a finalizing `else` expression.
CaseWhenThen	Represents a pair of `when-then` expressions.
CheckReturnValue	Simple version of the JSR 305 annotation that allows detecting accidentally omitted calls to Cypher.match(org.neo4j.cypherdsl.core.PatternElement...) ()} and the likes in IntelliJ.
Clause	This is a marker interface for top level clauses.
Clauses	Builder / factory for various clauses.
Comparison	A concrete condition representing a comparision between two expressions.
Condition	Shared interface for all conditions.
Conditions	Builder for various conditions.
Configuration	This class provides some configuration settings for the Cypher-DSL, mainly around rendering of a statement.
Configuration.Builder	Use this builder to create new Configuration instances.
Configuration.IndentStyle	Enum for the available indent styles.
ConflictingParametersException	Exception thrown when extracting parameters from a statement leads to one parameter with a given name appearing with different values.
ConstantCondition	A constant condition that is either always true or false.
ConstantParameterHolder	An internal holder for a constant value that might be rendered as a parameter.
Create	See Create.
Cypher	The main entry point into the Cypher DSL.
CypherContext
Delete	See Delete.
Distinct	AST representation of the DISTINCT keyword.
ExecutableResultStatement	This interface extends ExecutableStatement and adds several fetchWithXXX methods that can be used with any ResultStatement to retrieve their results.
ExecutableStatement	This interface spots several methods that allow statements to be used with an instance of the Neo4j Java Driver.
ExistentialSubquery	An existential subquery can only be used in a where clause.
ExposesCall<T>	Entrypoint for building procedure calls.
ExposesCall.AsFunction	Interface to allow creating an expression instead of a statement from an ongoing definition.
ExposesCall.ExposesWithArgs<T>	Used to provide arguments to procedure calls.
ExposesCall.ExposesYield<T>	Used to yield procedure result fields.
ExposesCreate	A step exposing a ExposesCreate.create(PatternElement...) method.
ExposesHints	A step exposing a several using methods that are provide entry points of adding advanced query hints.
ExposesLoadCSV	Exposes methods to configure a LOAD CSV clause.
ExposesLogicalOperators<T>	A step exposing logical operators and and or after a where clause.
ExposesMatch	A step exposing a ExposesMatch.match(PatternElement...) method.
ExposesMerge	A step exposing a ExposesMerge.merge(PatternElement...) method.
ExposesPatternLengthAccessors<T extends RelationshipPattern>	This interface is used to derive new relationship patterns from existing relationships or chains of relationships with new lengths (min, max or unbounded) configured.
ExposesProperties<T extends ExposesProperties<?> & PropertyContainer>	A container that exposes methods to add properties with values to nodes or relationships.
ExposesRelationships<T extends RelationshipPattern & ExposesPatternLengthAccessors<?>>	A marker interface for things that expose methods to create new relationships to other elements.
ExposesReturning	Return part of a statement.
ExposesSubqueryCall	This exposes a call method taking in a statement that represents a valid, correlated subquery.
ExposesUnwind	A step exposing a ExposesUnwind.unwind(Expression...),ExposesUnwind.unwind(Expression), ExposesUnwind.unwind(String) and method.
ExposesWhere	A step exposing a several where methods that are provide entry points of adding conditions.
Expression	An expression can be used in many places, i.e.
Foreach	Represents the FOREACH clause and is currently only producible via the Cypher-Parser.
ForeignAdapter<FE>	Represents an adapter that allows to turn foreign expressions into Cypher-DSL expressions.
FunctionInvocation	See FunctionInvocation
FunctionInvocation.FunctionDefinition	Defines metadata for a function.
Functions	Factory methods for creating instances of functions.
HasLabelCondition	A condition checking for the presence of labels on nodes or types on relationships.
Hint	Visitable implementing hints.
IdentifiableElement	This interface represents an element that can be for example an identifiable part of the WITH clause.
KeyValueMapEntry	Helper class, only for internal use.
Limit
ListComprehension	See ListComprehension and the corresponding cypher manual entry.
ListComprehension.OngoingDefinitionWithList	Allows to add a where clause into the definition of the list.
ListComprehension.OngoingDefinitionWithoutReturn	Provides the final step of defining a list comprehension.
ListComprehension.OngoingDefinitionWithVariable	ListComprehension.OngoingDefinitionWithVariable.in(Expression) must be used to define the source list.
ListExpression	Represents a list expression as in [expression1, expression2, ..., expressionN]
ListLiteral	A list of literals.
ListOperator	Represents a range literal applied to another expression.
Literal<T>	Represents a literal with an optional content.
Literal.UnsupportedLiteralException	Thrown when a given object cannot be used as a Cypher-DSL-Literal.
LiteralBase<T>	Represents a literal with an optional content.
LoadCSV	A representation of the LOAD CSV clause, including it's periodic commit and field terminator configuration.
LoadCSVStatementBuilder
LoadCSVStatementBuilder.OngoingLoadCSV	An instance of this interface will be provided after pointing the database to a valid URI of a CSV resource.
LRUCache<K,V>	A non thread safe least recently used (LRU) cache.
MapExpression	A dedicated map expression.
MapProjection	Represents a map projection as described here.
Match	See Match.
Merge	See Create.
MergeAction	An action or event that happens after a MERGE clause.
MergeAction.Type	The type of the action.
Named	A named thing exposes Named.getSymbolicName(), making the thing identifiable.
NamedPath	Represents a named path.
NamedPath.OngoingDefinitionWithName	Partial path that has a name (p = ).
NamedPath.OngoingShortestPathDefinitionWithName	Partial path that has a name (p = ) and is based on a graph algorithm function.
Namespace
Neo4jVersion	This annotation provides information which Neo4j version is required to be able to successfully run a query containing a fragment generated via a method annotated with it.
NestedExpression
Node	See NodePattern.
NodeBase<SELF extends Node>	This is the base class for all nodes.
NodeLabel	Expression for a single Node label.
NullLiteral	Represents the literal value null.
NumberLiteral
Operation	A binary operation.
Operations	A set of operations.
Operator	An operator.
Operator.Type	Operator type.
Order	Represents the list of sort items that make up the order of records in a result set.
Parameter<T>	Represents a named parameter inside a Cypher statement.
PatternComprehension	See PatternComprehension and the corresponding cypher manual entry.
PatternComprehension.OngoingDefinitionWithoutReturn	Provides the final step of defining a pattern comprehension.
PatternComprehension.OngoingDefinitionWithPattern	Allows to add a where clause into the definition of the pattern.
PatternComprehension.OngoingDefinitionWithPatternAndWhere	Intermediate step that allows expressing additional, logical operators.
PatternElement	See PatternElement.
Predicates	Factory methods for creating predicates.
Predicates.OngoingListBasedPredicateFunction	Allows to define the source of the list predicate.
Predicates.OngoingListBasedPredicateFunctionWithList	Allows to specify the where condition for the list based predicate.
ProcedureCall	See StandaloneCall.
ProcedureName
Properties	Represents the properties of a node or a relationship when used as part of the whole pattern (inside a MATCH, CREATE or MERGE clause as {p1: v1, p2: v2, pn: vn}.
Property	A property.
PropertyContainer	A container having properties.
PropertyLookup	See PropertyLookup
ProvidesAffixes
ReactiveExecutableResultStatement	This interface extends ReactiveExecutableStatement and adds several fetchWithXXX methods that can be used with any ResultStatement to retrieve their results in a reactive fashion.
ReactiveExecutableStatement	This is an extended version of the ExecutableStatement, spotting an additional ReactiveExecutableStatement.executeWith(RxQueryRunner) that runs a statement in a reactive fashion.
Reduction	A typed subtree representing the arguments of a call to the reduce() function.
Reduction.OngoingDefinitionWithInitial	Step 4b: Define the initial value
Reduction.OngoingDefinitionWithList	Step 3: Define the map expression
Reduction.OngoingDefinitionWithReducer	Step 4a: Define the accumulator
Reduction.OngoingDefinitionWithVariable	Step 2: Define the list
ReflectiveVisitor	This is a convenience class implementing a Visitor and it takes care of choosing the right methods to dispatch the Visitor.enter(Visitable) and Visitor.leave(Visitable) calls to.
Relationship	See RelationshipPattern.
Relationship.Details	See RelationshipDetail.
Relationship.Direction	While the direction in the schema package is centered around the node, the direction here is the direction between two nodes.
RelationshipBase<S extends NodeBase<?>,E extends NodeBase<?>,SELF extends RelationshipBase<S,E,SELF>>	This is the base class for all relationships.
RelationshipChain	Represents a chain of relationships.
RelationshipLength	Expresses the length of a relationship.
RelationshipPattern	A shared, public interface for relationships and chains of relationships.
RelationshipPatternCondition	Internal wrapper for marking a path pattern as a condition.
RelationshipTypes	See RelationshipTypes
Remove	See Remove.
Renderer	Instances of this class are supposed to be thread-safe.
ResultStatement	A statement that returns items from the graph.
Return	See Return.
ReturnBody	The container or "body" for return items, order and optional skip and things.
ScopingStrategy	A strategy to keep track of named variables inside a scope.
Set	See Set.
Skip
SortItem	A sort item can be used in an ORDER BY clause and changes the order of the items being returned from a query.
SortItem.Direction	Sort direction.
Statement	Shall be the common interfaces for queries that we support.
Statement.RegularQuery	Represents RegularQuery.
Statement.SingleQuery	Represents a SingleQuery.
StatementBuilder
StatementBuilder.BuildableMatchAndUpdate	A buildable ongoing MATCH and UPDATE.
StatementBuilder.BuildableOngoingMergeAction	An interface combining a buildable MATCH and UPDATE with the possibility to add actions after a MERGE clause.
StatementBuilder.BuildableStatement<T extends Statement>	A statement that has all information required to be build and exposes a build method.
StatementBuilder.ExposesDelete	A step that exposes only the delete clause.
StatementBuilder.ExposesExistentialSubqueryCall	A shared marker interface for things that can be turned into a subquery to be used inside the WHERE clause.
StatementBuilder.ExposesLimit	A step that exposes the StatementBuilder.ExposesLimit.limit(Number) method.
StatementBuilder.ExposesMergeAction	Provides a way to specify an action that happens after a MERGE clause.
StatementBuilder.ExposesOrderBy	See StatementBuilder.TerminalExposesOrderBy, but on a with clause.
StatementBuilder.ExposesSet	Set part of a statement.
StatementBuilder.ExposesSetAndRemove	A step that exposes the set clause.
StatementBuilder.ExposesSkip	A step that exposes the StatementBuilder.ExposesSkip.skip(Number) method.
StatementBuilder.ExposesUpdatingClause	A step providing all the supported updating clauses (DELETE, SET)
StatementBuilder.ExposesWith	A step that exposes the WITH clause.
StatementBuilder.OngoingInQueryCallWithArguments	The union of an in-query call exposing yields.
StatementBuilder.OngoingInQueryCallWithoutArguments	The union of an in-query call exposing new arguments and yields.
StatementBuilder.OngoingInQueryCallWithReturnFields	An in-query call exposing where and return clauses.
StatementBuilder.OngoingMatchAndReturnWithOrder	Combines the capabilities of skip, limit and adds additional expressions to the order-by items.
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.
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.
StatementBuilder.OngoingMergeAction	A variant of StatementBuilder.ExposesSet that allows for further chaining of actions.
StatementBuilder.OngoingOrderDefinition	An intermediate step while defining the order of a with clause.
StatementBuilder.OngoingReading	A match that exposes returning and for which it is not decided whether the optional where part has been used or note.
StatementBuilder.OngoingReadingAndReturn	A match that knows what to return and which is ready to be build.
StatementBuilder.OngoingReadingAndWith	Represents a reading statement ending in a with clause, potentially already having an order and not exposing order methods.
StatementBuilder.OngoingReadingAndWithWithSkip	The union type of an ongoing reading with a WITH and a SKIP clause.
StatementBuilder.OngoingReadingAndWithWithWhereAndOrder	Combines the capabilities of skip, limit and adds additional expressions to the order-by items.
StatementBuilder.OngoingReadingWithoutWhere	A match that exposes returning and where methods to add required information.
StatementBuilder.OngoingReadingWithWhere	A match that has a non-empty where-part.
StatementBuilder.OngoingStandaloneCallWithArguments	The union of a buildable statement and call exposing yields.
StatementBuilder.OngoingStandaloneCallWithoutArguments	The union of a buildable statement and call exposing new arguments and yields.
StatementBuilder.OngoingStandaloneCallWithReturnFields	A buildable statement exposing where and return clauses.
StatementBuilder.OngoingUnwind	Builder part for unwinding.
StatementBuilder.OngoingUpdate	An ongoing update statement that can be used to chain more update statements or add a with or return clause.
StatementBuilder.OrderableOngoingReadingAndWith
StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere	A match that knows what to pipe to the next part of a multipart query.
StatementBuilder.OrderableOngoingReadingAndWithWithWhere
StatementBuilder.TerminalExposesLimit	A step that exposes the StatementBuilder.TerminalExposesLimit.limit(Number) method.
StatementBuilder.TerminalExposesOrderBy	A step that exposes several methods to specify ordering.
StatementBuilder.TerminalExposesSkip	A step that exposes the StatementBuilder.TerminalExposesSkip.skip(Number) method.
StatementBuilder.TerminalOngoingOrderDefinition	An intermediate step while defining the order of a result set.
StatementContext	Context for while rendering a statement.
StringLiteral	The string representation of a string literal will be a quoted Cypher string in single tickmarks with escaped reserved characters.
Strings	The usual, static class with helper methods centered around missing functionality in String.
Subquery	Represents a "callable" subquery.
SymbolicName	A symbolic name to identify nodes, relationships and aliased items.
TemporalLiteral	Thrown when a QueryDSL operator cannot be used with the Cypher-DSL predicate converter.
ToCypherFormatStringVisitor	This is basically a copy of Query-DSL's ToStringVisitor.
TypedSubtree<T extends Visitable>	This class helps to group items of the same type on the same level of the tree into a list structure that can be recognized by visitors.
UnionPart	Represents a part of an union.
UnsupportedOperatorException	Thrown when a QueryDSL operator cannot be used with the Cypher-DSL predicate converter.
Unwind	See Unwind.
UsingPeriodicCommit	A visitable representing a USING PERIODIC COMMIT clause.
Visitable	Interface for implementations that accepts visitors.
Visitor
Where	Roughly corresponding to Where.
With	See With.
YieldItems	Items yielded by a stand alone or in query call.