Module org.seasar.doma.core
Package org.seasar.doma.jdbc.dialect

Class MysqlDialect

java.lang.Object
org.seasar.doma.jdbc.dialect.StandardDialect
org.seasar.doma.jdbc.dialect.MysqlDialect
All Implemented Interfaces:
Dialect
public class MysqlDialect extends StandardDialect
A dialect for MySQL.

  • Field Details

    • UNIQUE_CONSTRAINT_VIOLATION_ERROR_CODES

      protected static final Set<Integer> UNIQUE_CONSTRAINT_VIOLATION_ERROR_CODES
      the set of SQLState code that represents unique violation

    • OPEN_QUOTE

      protected static final char OPEN_QUOTE
      the quotation mark of the start
      See Also:

    • CLOSE_QUOTE

      protected static final char CLOSE_QUOTE
      the quotation mark of the end
      See Also:

    • DEFAULT_VERSION

      public static final MysqlDialect.MySqlVersion DEFAULT_VERSION

    • version

      protected final MysqlDialect.MySqlVersion version

  • Constructor Details

  • Method Details

    • getName

      public String getName()
      Description copied from interface: Dialect
      Returns the name of this dialect.

      The dialect name typically identifies the database system that this dialect supports. This name can be used for logging, debugging, or to make decisions based on the specific database being used.

      Each dialect implementation should return a unique and descriptive name.

      Specified by:
      getName in interface Dialect
      Overrides:
      getName in class StandardDialect
      Returns:
      the name of this dialect

    • isUniqueConstraintViolated

      public boolean isUniqueConstraintViolated(SQLException sqlException)
      Description copied from interface: Dialect
      Determines whether the given SQLException represents a unique constraint violation.

      Different database systems use different error codes and states to indicate unique constraint violations. This method abstracts these differences.

      Specified by:
      isUniqueConstraintViolated in interface Dialect
      Overrides:
      isUniqueConstraintViolated in class StandardDialect
      Parameters:
      sqlException - the SQL exception to analyze
      Returns:
      true if the exception represents a unique constraint violation, false otherwise

    • supportsAutoGeneratedKeys

      public boolean supportsAutoGeneratedKeys()
      Description copied from interface: Dialect
      Determines whether this dialect supports retrieving auto-generated keys via Statement.getGeneratedKeys().

      This feature allows retrieving values that were automatically generated during an insert operation, such as identity column values, without executing a separate query.

      Specified by:
      supportsAutoGeneratedKeys in interface Dialect
      Overrides:
      supportsAutoGeneratedKeys in class StandardDialect
      Returns:
      true if this dialect supports retrieving auto-generated keys, false otherwise

    • supportsIdentity

      public boolean supportsIdentity()
      Description copied from interface: Dialect
      Determines whether this dialect supports the IDENTITY column.

      An IDENTITY column is a column that automatically generates a unique value for each row when data is inserted. The exact implementation varies by database system.

      Specified by:
      supportsIdentity in interface Dialect
      Overrides:
      supportsIdentity in class StandardDialect
      Returns:
      true if this dialect supports IDENTITY columns, false otherwise

    • supportsSelectForUpdate

      public boolean supportsSelectForUpdate(SelectForUpdateType type, boolean withTargets)
      Description copied from interface: Dialect
      Determines whether this dialect supports pessimistic locking with the specified options.

      Pessimistic locking (SELECT FOR UPDATE) prevents other transactions from modifying selected rows. Different database systems support different variations of this feature.

      Specified by:
      supportsSelectForUpdate in interface Dialect
      Overrides:
      supportsSelectForUpdate in class StandardDialect
      Parameters:
      type - the type of pessimistic locking (e.g., standard FOR UPDATE, NOWAIT, WAIT)
      withTargets - true if specific columns are targeted for locking, false for row-level locking
      Returns:
      true if this dialect supports the specified locking options, false otherwise

    • supportsAliasInDeleteClause

      public boolean supportsAliasInDeleteClause()
      Description copied from interface: Dialect
      Determines whether this object supports alias reference in DELETE clause as follows: 
       DELETE t FROM employee t
      Returns:
      true, if this object supports it

    • supportsBatchExecutionReturningGeneratedValues

      public boolean supportsBatchExecutionReturningGeneratedValues()
      Description copied from interface: Dialect
      Determines whether this dialect supports retrieving generated values from batch executions.

      Some database systems can return auto-generated values (like identity columns) even when executing statements in batch mode, while others cannot.

      The default implementation returns false.

      Returns:
      true if this dialect supports retrieving generated values from batch executions, false otherwise

    • toCountCalculatingSqlNode

      protected SqlNode toCountCalculatingSqlNode(SqlNode sqlNode)
      Overrides:
      toCountCalculatingSqlNode in class StandardDialect

    • toPagingSqlNode

      protected SqlNode toPagingSqlNode(SqlNode sqlNode, long offset, long limit)
      Overrides:
      toPagingSqlNode in class StandardDialect

    • toForUpdateSqlNode

      protected SqlNode toForUpdateSqlNode(SqlNode sqlNode, SelectForUpdateType forUpdateType, int waitSeconds, String... aliases)
      Overrides:
      toForUpdateSqlNode in class StandardDialect

    • toCountGettingSqlNode

      protected SqlNode toCountGettingSqlNode(SqlNode sqlNode)
      Overrides:
      toCountGettingSqlNode in class StandardDialect

    • getScriptBlockDelimiter

      public String getScriptBlockDelimiter()
      Description copied from interface: Dialect
      Returns the delimiter that is used as the end of an SQL block in a script.
      Specified by:
      getScriptBlockDelimiter in interface Dialect
      Overrides:
      getScriptBlockDelimiter in class StandardDialect
      Returns:
      the delimiter

    • createScriptBlockContext

      public ScriptBlockContext createScriptBlockContext()
      Description copied from interface: Dialect
      Creates the context object to process an SQL block in a script.
      Specified by:
      createScriptBlockContext in interface Dialect
      Overrides:
      createScriptBlockContext in class StandardDialect
      Returns:
      the context object

    • applyQuote

      public String applyQuote(String name)
      Description copied from interface: Dialect
      Encloses the name with quotation marks.
      Specified by:
      applyQuote in interface Dialect
      Overrides:
      applyQuote in class StandardDialect
      Parameters:
      name - the name of a database object such as a table, a column, and so on
      Returns:
      the name that is enclosed with quotation marks

    • getCriteriaBuilder

      public CriteriaBuilder getCriteriaBuilder()
      Description copied from interface: Dialect
      Returns the criteria builder for this dialect.

      The criteria builder is used to construct SQL queries using the criteria API, which provides a type-safe way to build queries programmatically. The returned builder will generate SQL that is compatible with the specific database dialect.

      Specified by:
      getCriteriaBuilder in interface Dialect
      Overrides:
      getCriteriaBuilder in class StandardDialect
      Returns:
      the criteria builder for this dialect

    • getUpsertAssembler

      public UpsertAssembler getUpsertAssembler(UpsertAssemblerContext context)
      Description copied from interface: Dialect
      Returns the UpsertAssembler implementation for the given context.
      Specified by:
      getUpsertAssembler in interface Dialect
      Overrides:
      getUpsertAssembler in class StandardDialect
      Parameters:
      context - the UpsertAssemblerContext object
      Returns:
      the UpsertAssembler object for the given context

    • supportsReturning

      public boolean supportsReturning()
      Description copied from interface: Dialect
      Determines if this dialect supports the SQL RETURNING clause in database operations.

      The RETURNING clause allows a DML statement (INSERT, UPDATE, DELETE) to return data from rows that were affected by the operation. This feature is particularly useful for retrieving auto-generated values or updated columns in a single database operation, without requiring a separate SELECT statement.

      The default implementation returns true, but dialect implementations for databases that don't support this feature should override this method to return false.

      Returns:
      true if the RETURNING clause is supported by this dialect, false otherwise