Package io.micronaut.data.model.query.builder.sql

Enum Class Dialect

java.lang.Object
java.lang.Enum<Dialect>
io.micronaut.data.model.query.builder.sql.Dialect
All Implemented Interfaces:
Serializable, Comparable<Dialect>, Constable
public enum Dialect extends Enum<Dialect>
The SQL dialect to use.
Since:
1.0.0
Author:
graemerocher

  • Enum Constant Details

    • H2

      public static final Dialect H2
      H2 database.

    • MYSQL

      public static final Dialect MYSQL
      MySQL 5.5 or above.

    • POSTGRES

      public static final Dialect POSTGRES
      Postgres 9.5 or later.

    • SQL_SERVER

      public static final Dialect SQL_SERVER
      SQL server 2012 or above.

    • ORACLE

      public static final Dialect ORACLE
      Oracle 12c or above.

    • ANSI

      public static final Dialect ANSI
      Ansi compliant SQL.

  • 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

    • allowBatch

      public final boolean allowBatch()
      Some drivers and dialects do not support JDBC batching. This allows customization.
      Returns:
      True if batch is supported.

    • getDataType

      public final DataType getDataType(@NonNull @NonNull DataType type)
      Returns compatible dialect dataype.
      Parameters:
      type - the type
      Returns:
      The dialect compatible DataType
      Since:
      2.0.1

    • requiresStringUUID

      public final boolean requiresStringUUID(@NonNull @NonNull DataType type)
      Determines whether the data type requires string based UUIDs.
      Parameters:
      type - the type
      Returns:
      True if a string UUID is required
      Since:
      1.1.3

    • supportsJoinType

      public final boolean supportsJoinType(@NonNull Join.Type joinType)
      Determines whether the join type is supported this dialect.
      Parameters:
      joinType - the join type
      Returns:
      True if the type is supported by this dialect.

    • supportsJsonEntity

      public boolean supportsJsonEntity()
      Gets an indicator whether JSON entity is supported by the database.
      Returns:
      true if JSON entity is supported
      Since:
      4.0.0

    • supportsUpdateReturning

      public boolean supportsUpdateReturning()
      Whether the dialect supports UPDATE ... RETURNING clause.
      Returns:
      true if it does support
      Since:
      4.2.0

    • supportsInsertReturning

      public boolean supportsInsertReturning()
      Whether the dialect supports INSERT ... RETURNING clause.
      Returns:
      true if it does support
      Since:
      4.2.0

    • supportsDeleteReturning

      public boolean supportsDeleteReturning()
      Whether the dialect supports DELETE ... RETURNING clause.
      Returns:
      true if it does support
      Since:
      4.2.0