Add the ignoreGeneratedKeys options to improve performance (#861)

* Use default docker image for oracle database

* Add the ignoreGeneratedKeys options to improve performance

* Update documents

Author: nakamura-to

docs/criteria-api.rst

@@ -1195,6 +1195,7 @@ We support the following settings:
 * excludeNull
 * include
 * exclude
+* ignoreGeneratedKeys
 
 They are all optional.
 

docs/query/batch-insert.rst

@@ -47,6 +47,14 @@ If annotated with ``@GeneratedValue`` at :doc:`../entity` identifier, the identi
 
 You reference :ref:`identity-auto-generation` about cautionary point.
 
+If you don't use auto-generated keys in your application, you can enable the `ingoreGeneratedKeys` flag.
+This flag may improve performance.
+
+.. code-block:: java
+
+  @BatchInsert(ignoreGeneratedKeys = true)
+  int[] insert(List<Employee> entities);
+
 Version number
 ----------------
 

doma-core/src/main/java/org/seasar/doma/BatchInsert.java

@@ -91,4 +91,12 @@
 
   /** @return the output format of SQL logs. */
   SqlLogType sqlLog() default SqlLogType.FORMATTED;
+
+  /**
+   * Whether auto-generated keys are not retrieved from the database to improve performance. If this
+   * flag is enabled, entities won't have auto-generated keys.
+   *
+   * @return Whether auto-generated keys are not retrieved.
+   */
+  boolean ignoreGeneratedKeys() default false;
 }

doma-core/src/main/java/org/seasar/doma/jdbc/criteria/context/InsertSettings.java

@@ -13,6 +13,8 @@ public class InsertSettings extends Settings {
   private final List<PropertyMetamodel<?>> includedProperties = new ArrayList<>();
   private final List<PropertyMetamodel<?>> excludedProperties = new ArrayList<>();
 
+  private boolean ignoreGeneratedKeys;
+
   /**
    * Returns the batch size.
    *
@@ -91,4 +93,23 @@ public List<PropertyMetamodel<?>> exclude() {
   public void exclude(PropertyMetamodel<?>... propertyMetamodels) {
     Collections.addAll(excludedProperties, propertyMetamodels);
   }
+
+  /**
+   * Returns whether auto-generated keys are ignored.
+   *
+   * @return Whether auto-generated keys are ignored.
+   */
+  public boolean getIgnoreGeneratedKeys() {
+    return ignoreGeneratedKeys;
+  }
+
+  /**
+   * If this flag is enabled, performance may be improved. However, note that entities won't have
+   * auto-generated keys.
+   *
+   * @param ignoreGeneratedKeys whether auto-generated keys are ignored
+   */
+  public void setIgnoreGeneratedKeys(boolean ignoreGeneratedKeys) {
+    this.ignoreGeneratedKeys = ignoreGeneratedKeys;
+  }
 }

doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/EntityqlBatchInsertStatement.java

@@ -60,6 +60,7 @@ protected Command<BatchResult<ENTITY>> createCommand() {
     query.setSqlLogType(settings.getSqlLogType());
     query.setIncludedPropertyNames();
     query.setExcludedPropertyNames();
+    query.setGeneratedKeysIgnored(settings.getIgnoreGeneratedKeys());
     query.setMessage(settings.getComment());
     query.prepare();
     BatchInsertCommand command =

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

@@ -99,6 +99,10 @@ public interface Dialect {
    */
   boolean supportsBatchUpdateResults();
 
+  default boolean supportsBatchExecutionReturningGeneratedValues() {
+    return false;
+  }
+
   /**
    * Whether this object supports pessimistic locking.
    *

doma-core/src/main/java/org/seasar/doma/jdbc/query/AutoBatchInsertQuery.java

@@ -33,10 +33,16 @@ public class AutoBatchInsertQuery<ENTITY> extends AutoBatchModifyQuery<ENTITY>
 
   protected boolean batchSupported = true;
 
+  protected boolean generatedKeysIgnored = false;
+
   public AutoBatchInsertQuery(EntityType<ENTITY> entityType) {
     super(entityType);
   }
 
+  public void setGeneratedKeysIgnored(boolean generatedKeysIgnored) {
+    this.generatedKeysIgnored = generatedKeysIgnored;
+  }
+
   @Override
   public void prepare() {
     super.prepare();
@@ -88,8 +94,10 @@ protected void prepareIdAndVersionPropertyTypes() {
                 config, entityType, new ReservedIdProvider(config, entityType, entities.size()));
         generatedIdPropertyType.validateGenerationStrategy(idGenerationConfig);
         autoGeneratedKeysSupported =
-            generatedIdPropertyType.isAutoGeneratedKeysSupported(idGenerationConfig);
-        batchSupported = generatedIdPropertyType.isBatchSupported(idGenerationConfig);
+            !generatedKeysIgnored
+                && generatedIdPropertyType.isAutoGeneratedKeysSupported(idGenerationConfig);
+        batchSupported =
+            generatedKeysIgnored || generatedIdPropertyType.isBatchSupported(idGenerationConfig);
       }
     }
   }

doma-processor/src/main/java/org/seasar/doma/internal/apt/annot/BatchModifyAnnot.java

@@ -22,6 +22,8 @@ public abstract class BatchModifyAnnot extends AbstractAnnot {
   public static final String INCLUDE = "include";
   public static final String EXCLUDE = "exclude";
 
+  public static final String IGNORE_GENERATED_KEYS = "ignoreGeneratedKeys";
+
   private final AnnotationValue sqlFile;
 
   private final AnnotationValue queryTimeout;
@@ -38,6 +40,8 @@ public abstract class BatchModifyAnnot extends AbstractAnnot {
 
   private final AnnotationValue sqlLog;
 
+  private final AnnotationValue ignoreGeneratedKeys;
+
   BatchModifyAnnot(AnnotationMirror annotationMirror, Map<String, AnnotationValue> values) {
     super(annotationMirror);
 
@@ -52,6 +56,7 @@ public abstract class BatchModifyAnnot extends AbstractAnnot {
     this.suppressOptimisticLockException = values.get(SUPPRESS_OPTIMISTIC_LOCK_EXCEPTION);
     this.include = values.get(INCLUDE);
     this.exclude = values.get(EXCLUDE);
+    this.ignoreGeneratedKeys = values.get(IGNORE_GENERATED_KEYS);
   }
 
   public AnnotationValue getSqlFile() {
@@ -86,6 +91,10 @@ public AnnotationValue getSqlLog() {
     return sqlLog;
   }
 
+  public AnnotationValue getIgnoreGeneratedKeys() {
+    return ignoreGeneratedKeys;
+  }
+
   public int getQueryTimeoutValue() {
     Integer value = AnnotationValueUtil.toInteger(queryTimeout);
     if (value == null) {
@@ -133,4 +142,8 @@ public boolean getSqlFileValue() {
     }
     return value;
   }
+
+  public Boolean getIgnoreGeneratedKeysValues() {
+    return AnnotationValueUtil.toBoolean(ignoreGeneratedKeys);
+  }
 }

doma-processor/src/main/java/org/seasar/doma/internal/apt/generator/DaoImplQueryMethodGenerator.java

@@ -387,6 +387,11 @@ public Void visitAutoBatchModifyQueryMeta(AutoBatchModifyQueryMeta m) {
           "__query.setOptimisticLockExceptionSuppressed(%1$s);%n", suppressOptimisticLockException);
     }
 
+    Boolean ignoreGeneratedKeys = m.getIgnoreGeneratedKeysValues();
+    if (ignoreGeneratedKeys != null) {
+      iprint("__query.setGeneratedKeysIgnored(%1$s);%n", ignoreGeneratedKeys);
+    }
+
     iprint("__query.prepare();%n");
     iprint(
         "%1$s __command = __support.getCommandImplementors().create%2$s(%3$s, __query);%n",

doma-processor/src/main/java/org/seasar/doma/internal/apt/meta/query/AutoBatchModifyQueryMeta.java

@@ -71,6 +71,10 @@ public SqlLogType getSqlLogType() {
     return batchModifyAnnot.getSqlLogValue();
   }
 
+  public Boolean getIgnoreGeneratedKeysValues() {
+    return batchModifyAnnot.getIgnoreGeneratedKeysValues();
+  }
+
   @Override
   public <R> R accept(QueryMetaVisitor<R> visitor) {
     return visitor.visitAutoBatchModifyQueryMeta(this);