Module org.neo4j.cypherdsl.core
Package org.neo4j.cypherdsl.core.renderer

Enum Class Dialect

java.lang.Object
java.lang.Enum<Dialect>
org.neo4j.cypherdsl.core.renderer.Dialect
All Implemented Interfaces:
Serializable, Comparable<Dialect>, Constable
@API(status=STABLE, since="2022.3.0") public enum Dialect extends Enum<Dialect>
The dialect to be used when rendering a statement into Cypher.
Since:
2022.3.0
Author:
Michael J. Simons

  • Enum Constant Details

    • NEO4J_4

      public static final Dialect NEO4J_4
      Neo4j 4.4 and earlier.

    • NEO4J_5

      public static final Dialect NEO4J_5
      Neo4j 5.

    • NEO4J_5_23

      public static final Dialect NEO4J_5_23
      Enhanced Neo4j 5 dialect that renders importing with statements for call subqueries as variable scoped subqueries, suitable for Neo4j >= 5.23.
      Since:
      2024.1.0

    • NEO4J_5_26

      @Deprecated(forRemoval=true) public static final Dialect NEO4J_5_26
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use NEO4J_5_CYPHER_5 if necessary or NEO4J_5_DEFAULT_CYPHER in all other cases.
      A Neo4j 5.26 and higher dialect that always renders the CYPHER 5 prefix.
      Since:
      2024.5.0

    • NEO4J_5_DEFAULT_CYPHER

      public static final Dialect NEO4J_5_DEFAULT_CYPHER
      Essentially the same as NEO4J_5_23 using the databases default Cypher version. This is the default dialect for Cypher-DSL 2025.0.0 and onwards.
      Since:
      2025.0.0

    • NEO4J_5_CYPHER_5

      public static final Dialect NEO4J_5_CYPHER_5
      Essentially the same as NEO4J_5_23 but also enabling the CYPHER 5 prefix on generated statements. This dialect works on Neo4j 5.26 and higher. Genrally, NEO4J_5_DEFAULT_CYPHER is preferrable.
      Since:
      2025.0.0

    • NEO4J_5_CYPHER_25

      public static final Dialect NEO4J_5_CYPHER_25
      Essentially the same as NEO4J_5_23 but also enabling the CYPHER 25 prefix on generated statements. This dialect works on Neo4j 5.26 and higher. Genrally, NEO4J_5_23 is preferable.
      Since:
      2025.0.0

    • NEO4J_2025

      public static final Dialect NEO4J_2025
      A placeholder for Neo4j 2025 calver. Same behaviour as NEO4J_5_DEFAULT_CYPHER in this version of Cypher-DSL.
      Since:
      2025.0.0

  • Method Details

    • values

      public static Dialect[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static Dialect valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null