Improve batch insertion for entities with auto-increment primary keys. (#1191)

This PR retrieves primary keys using `Statement.getGeneratedKeys()`
after executing `Statement.executeBatch()`, if supported by the DBMS.

Supported DBMS are as follows:

- H2
- MySQL
- PostgreSQL

Oracle Database and SQL Server do not support the combination of
`Statement.getGeneratedKeys()` and `Statement.executeBatch()`.
Therefore, Doma falls back to a process that repeatedly uses
`Statement.executeUpdate()` for each entity in the batch.

Previously, to speed up batch insertion in PostgreSQL, we used
`org.seasar.doma.jdbc.id.IdProvider` to retrieve IDs from the database
in advance. However, since this pull request provides an alternative
solution, `org.seasar.doma.jdbc.id.IdProvider` is now deprecated.

Author: nakamura-to

doma-core/src/main/java/org/seasar/doma/jdbc/command/BatchInsertCommand.java

@@ -46,4 +46,9 @@ protected int executeUpdate(PreparedStatement preparedStatement, PreparedSql sql
       throw e;
     }
   }
+
+  @Override
+  protected void postExecuteBatch(PreparedStatement preparedStatement, int position, int size) {
+    query.generateIds(preparedStatement, position, size);
+  }
 }

doma-core/src/main/java/org/seasar/doma/jdbc/command/BatchModifyCommand.java

@@ -96,6 +96,7 @@ protected int[] executeBatch(PreparedStatement preparedStatement, List<PreparedS
       if (i == sqlSize - 1 || (batchSize > 0 && (i + 1) % batchSize == 0)) {
         int[] rows = executeBatch(preparedStatement, sql);
         validateRows(preparedStatement, sql, rows);
+        postExecuteBatch(preparedStatement, pos, rows.length);
         System.arraycopy(rows, 0, updatedRows, pos, rows.length);
         pos = i + 1;
       }
@@ -118,6 +119,15 @@ protected int[] executeBatch(PreparedStatement preparedStatement, PreparedSql sq
     }
   }
 
+  /**
+   * Invoked after the batch execution.
+   *
+   * @param preparedStatement the prepared statement
+   * @param position the position of the first element in the batch
+   * @param size the size of the executed batch
+   */
+  protected void postExecuteBatch(PreparedStatement preparedStatement, int position, int size) {}
+
   protected void log(PreparedSql sql) {
     JdbcLogger logger = query.getConfig().getJdbcLogger();
     logger.logSql(query.getClassName(), query.getMethodName(), sql);

doma-core/src/main/java/org/seasar/doma/jdbc/dialect/Dialect.java

@@ -129,6 +129,7 @@ default boolean supportsBatchExecutionReturningGeneratedValues() {
    *
    * @return {@code true}, if this object supports it
    */
+  @Deprecated
   boolean supportsIdentityReservation();
 
   /**
@@ -218,6 +219,7 @@ Sql<?> getIdentitySelectSql(
    * @throws DomaNullPointerException if either the {@code tableName} or the {@code columnName} is
    *     {@code null}
    */
+  @Deprecated
   Sql<?> getIdentityReservationSql(
       String catalogName,
       String schemaName,

doma-core/src/main/java/org/seasar/doma/jdbc/dialect/H2Dialect.java

@@ -47,6 +47,11 @@ public boolean supportsUpsertEmulationWithMergeStatement() {
     return true;
   }
 
+  @Override
+  public boolean supportsBatchExecutionReturningGeneratedValues() {
+    return true;
+  }
+
   public static class H2JdbcMappingVisitor extends H214199JdbcMappingVisitor {}
 
   public static class H2SqlLogFormattingVisitor extends H214199SqlLogFormattingVisitor {}

doma-core/src/main/java/org/seasar/doma/jdbc/dialect/MysqlDialect.java

@@ -156,6 +156,11 @@ public boolean supportsAliasInDeleteClause() {
     return true;
   }
 
+  @Override
+  public boolean supportsBatchExecutionReturningGeneratedValues() {
+    return true;
+  }
+
   @Override
   protected SqlNode toCountCalculatingSqlNode(SqlNode sqlNode) {
     switch (version) {

doma-core/src/main/java/org/seasar/doma/jdbc/dialect/PostgresDialect.java

@@ -227,6 +227,11 @@ public boolean supportsAutoGeneratedKeys() {
     return true;
   }
 
+  @Override
+  public boolean supportsBatchExecutionReturningGeneratedValues() {
+    return true;
+  }
+
   @Override
   public JdbcType<ResultSet> getResultSetType() {
     return RESULT_SET;

doma-core/src/main/java/org/seasar/doma/jdbc/dialect/StandardDialect.java

@@ -306,6 +306,7 @@ public boolean supportsSequence() {
     return false;
   }
 
+  @SuppressWarnings("deprecation")
   @Override
   public boolean supportsIdentityReservation() {
     return false;
@@ -342,6 +343,7 @@ public Sql<?> getIdentitySelectSql(
     throw new JdbcUnsupportedOperationException(getClass().getName(), "getIdentitySelectSql");
   }
 
+  @SuppressWarnings("deprecation")
   @Override
   public Sql<?> getIdentityReservationSql(
       String catalogName,

doma-core/src/main/java/org/seasar/doma/jdbc/id/BuiltinIdentityIdGenerator.java

@@ -19,39 +19,26 @@ public class BuiltinIdentityIdGenerator extends AbstractIdGenerator implements I
 
   @Override
   public boolean supportsBatch(IdGenerationConfig config) {
-    return config.getIdProvider().isAvailable();
+    return config.getDialect().supportsBatchExecutionReturningGeneratedValues();
   }
 
   @Override
   public boolean includesIdentityColumn(IdGenerationConfig config) {
-    if (config.getIdProvider().isAvailable()) {
-      return true;
-    }
     return config.getDialect().includesIdentityColumn();
   }
 
   @Override
   public boolean supportsAutoGeneratedKeys(IdGenerationConfig config) {
-    if (config.getIdProvider().isAvailable()) {
-      return false;
-    }
     return config.getDialect().supportsAutoGeneratedKeys();
   }
 
   @Override
   public Long generatePreInsert(IdGenerationConfig config) {
-    IdProvider idProvider = config.getIdProvider();
-    if (idProvider.isAvailable()) {
-      return idProvider.get();
-    }
     return null;
   }
 
   @Override
   public Long generatePostInsert(IdGenerationConfig config, Statement statement) {
-    if (config.getIdProvider().isAvailable()) {
-      return null;
-    }
     if (config.getDialect().supportsAutoGeneratedKeys()) {
       return getGeneratedValue(config, statement);
     }

doma-core/src/main/java/org/seasar/doma/jdbc/id/IdGenerationConfig.java

@@ -17,6 +17,7 @@ public class IdGenerationConfig {
 
   protected final EntityType<?> entityType;
 
+  @SuppressWarnings("deprecation")
   protected final IdProvider idProvider;
 
   public IdGenerationConfig(Config config, EntityType<?> entityType) {
@@ -70,10 +71,13 @@ public EntityType<?> getEntityType() {
     return entityType;
   }
 
+  @SuppressWarnings("deprecation")
   public IdProvider getIdProvider() {
     return idProvider;
   }
 
+  @SuppressWarnings("DeprecatedIsStillUsed")
+  @Deprecated
   protected static class UnavailableIdProvider implements IdProvider {
     @Override
     public boolean isAvailable() {

doma-core/src/main/java/org/seasar/doma/jdbc/id/IdProvider.java

@@ -1,6 +1,7 @@
 package org.seasar.doma.jdbc.id;
 
 /** An identity provider. */
+@Deprecated
 public interface IdProvider {
 
   /**