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

Interface BatchModifyQuery

All Superinterfaces:
Query
All Known Subinterfaces:
BatchDeleteQuery, BatchInsertQuery, BatchUpdateQuery
All Known Implementing Classes:
AutoBatchDeleteQuery, AutoBatchInsertQuery, AutoBatchModifyQuery, AutoBatchUpdateQuery, SqlBatchDeleteQuery, SqlBatchInsertQuery, SqlBatchModifyQuery, SqlBatchUpdateQuery, SqlFileBatchDeleteQuery, SqlFileBatchInsertQuery, SqlFileBatchModifyQuery, SqlFileBatchUpdateQuery
public interface BatchModifyQuery extends Query
A query that performs batch operations to modify data in a database.

This interface defines operations specific to batch data modification statements such as batch INSERT, UPDATE, and DELETE.

  • Method Details

    • getSqls

      List<PreparedSql> getSqls()
      Returns the list of prepared SQL statements for this batch query.
      Returns:
      the list of prepared SQL statements

    • getSql

      PreparedSql getSql()
      Returns a representative prepared SQL statement for this batch query.

      This method is typically used for logging purposes.

      Specified by:
      getSql in interface Query
      Returns:
      a representative prepared SQL statement

    • isOptimisticLockCheckRequired

      boolean isOptimisticLockCheckRequired()
      Returns whether optimistic lock checking is required for this batch query.
      Returns:
      true if optimistic lock checking is required

    • isAutoGeneratedKeysSupported

      boolean isAutoGeneratedKeysSupported()
      Returns whether auto-generated keys are supported for this batch query.
      Returns:
      true if auto-generated keys are supported

    • isExecutable

      boolean isExecutable()
      Returns whether this batch query is executable.
      Returns:
      true if this batch query is executable

    • getSqlExecutionSkipCause

      SqlExecutionSkipCause getSqlExecutionSkipCause()
      Returns the cause if SQL execution should be skipped.
      Returns:
      the cause of SQL execution skip, or null if execution should not be skipped

    • getBatchSize

      int getBatchSize()
      Returns the batch size for this query.
      Returns:
      the batch size

    • getSqlLogType

      SqlLogType getSqlLogType()
      Returns the SQL log type for this batch query.
      Returns:
      the SQL log type