Merge pull request #1064 from momosetkn/feat/upsert

Support upsert

Author: nakamura-to

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

@@ -11,6 +11,7 @@
 import org.seasar.doma.jdbc.SqlFileNotFoundException;
 import org.seasar.doma.jdbc.SqlLogType;
 import org.seasar.doma.jdbc.UniqueConstraintException;
+import org.seasar.doma.jdbc.query.DuplicateKeyType;
 
 /**
  * Indicates a batch insert.
@@ -103,4 +104,15 @@
    * @return Whether auto-generated keys are not retrieved.
    */
   boolean ignoreGeneratedKeys() default false;
+
+  /**
+   * This variable represents the type of duplicate key handling strategy for an insert operation.
+   * It can have one of three values: - UPDATE: If a duplicate key is encountered, the existing row
+   * in the table will be updated. - IGNORE: If a duplicate key is encountered, the insert operation
+   * will be ignored, and no changes will be made to the table. - EXCEPTION: If a duplicate key is
+   * encountered, the operation will throw an exception, indicating that a duplicate key exists.
+   *
+   * @return the type of duplicate key handling strategy for an insert operation.
+   */
+  DuplicateKeyType duplicateKeyType() default DuplicateKeyType.EXCEPTION;
 }

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

@@ -10,6 +10,7 @@
 import org.seasar.doma.jdbc.SqlFileNotFoundException;
 import org.seasar.doma.jdbc.SqlLogType;
 import org.seasar.doma.jdbc.UniqueConstraintException;
+import org.seasar.doma.jdbc.query.DuplicateKeyType;
 
 /**
  * Indicates a insert.
@@ -91,4 +92,15 @@
    * @return the output format of SQL logs.
    */
   SqlLogType sqlLog() default SqlLogType.FORMATTED;
+
+  /**
+   * This variable represents the type of duplicate key handling strategy for an insert operation.
+   * It can have one of three values: - UPDATE: If a duplicate key is encountered, the existing row
+   * in the table will be updated. - IGNORE: If a duplicate key is encountered, the insert operation
+   * will be ignored, and no changes will be made to the table. - EXCEPTION: If a duplicate key is
+   * encountered, the operation will throw an exception, indicating that a duplicate key exists.
+   *
+   * @return the type of duplicate key handling strategy for an insert operation.
+   */
+  DuplicateKeyType duplicateKeyType() default DuplicateKeyType.EXCEPTION;
 }

doma-core/src/main/java/org/seasar/doma/internal/jdbc/entity/AbstractPostInsertContext.java

@@ -4,11 +4,21 @@
 import org.seasar.doma.jdbc.Config;
 import org.seasar.doma.jdbc.entity.EntityType;
 import org.seasar.doma.jdbc.entity.PostInsertContext;
+import org.seasar.doma.jdbc.query.DuplicateKeyType;
 
 public class AbstractPostInsertContext<E> extends AbstractEntityListenerContext<E>
     implements PostInsertContext<E> {
 
-  protected AbstractPostInsertContext(EntityType<E> entityType, Method method, Config config) {
+  private final DuplicateKeyType duplicateKeyType;
+
+  protected AbstractPostInsertContext(
+      EntityType<E> entityType, Method method, Config config, DuplicateKeyType duplicateKeyType) {
     super(entityType, method, config);
+    this.duplicateKeyType = duplicateKeyType;
+  }
+
+  @Override
+  public DuplicateKeyType getDuplicateKeyType() {
+    return duplicateKeyType;
   }
 }

doma-core/src/main/java/org/seasar/doma/internal/jdbc/entity/AbstractPreInsertContext.java

@@ -4,11 +4,21 @@
 import org.seasar.doma.jdbc.Config;
 import org.seasar.doma.jdbc.entity.EntityType;
 import org.seasar.doma.jdbc.entity.PreInsertContext;
+import org.seasar.doma.jdbc.query.DuplicateKeyType;
 
 public class AbstractPreInsertContext<E> extends AbstractEntityListenerContext<E>
     implements PreInsertContext<E> {
 
-  protected AbstractPreInsertContext(EntityType<E> entityType, Method method, Config config) {
+  private final DuplicateKeyType duplicateKeyType;
+
+  protected AbstractPreInsertContext(
+      EntityType<E> entityType, Method method, Config config, DuplicateKeyType duplicateKeyType) {
     super(entityType, method, config);
+    this.duplicateKeyType = duplicateKeyType;
+  }
+
+  @Override
+  public DuplicateKeyType getDuplicateKeyType() {
+    return duplicateKeyType;
   }
 }

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

@@ -105,14 +105,14 @@ public <ENTITY> Statement<Result<ENTITY>> delete(
     return new EntityqlDeleteStatement<>(config, entityMetamodel, entity, settings);
   }
 
-  public <ENTITY> Statement<Result<ENTITY>> insert(
+  public <ENTITY> EntityqlInsertStatement<ENTITY> insert(
       EntityMetamodel<ENTITY> entityMetamodel, ENTITY entity) {
     Objects.requireNonNull(entityMetamodel);
     Objects.requireNonNull(entity);
     return insert(entityMetamodel, entity, settings -> {});
   }
 
-  public <ENTITY> Statement<Result<ENTITY>> insert(
+  public <ENTITY> EntityqlInsertStatement<ENTITY> insert(
       EntityMetamodel<ENTITY> entityMetamodel,
       ENTITY entity,
       Consumer<InsertSettings> settingsConsumer) {
@@ -162,14 +162,14 @@ public <ENTITY> Statement<BatchResult<ENTITY>> delete(
     return new EntityqlBatchDeleteStatement<>(config, entityMetamodel, entities, settings);
   }
 
-  public <ENTITY> Statement<BatchResult<ENTITY>> insert(
+  public <ENTITY> EntityqlBatchInsertStatement<ENTITY> insert(
       EntityMetamodel<ENTITY> entityMetamodel, List<ENTITY> entities) {
     Objects.requireNonNull(entityMetamodel);
     Objects.requireNonNull(entities);
     return insert(entityMetamodel, entities, settings -> {});
   }
 
-  public <ENTITY> Statement<BatchResult<ENTITY>> insert(
+  public <ENTITY> EntityqlBatchInsertStatement<ENTITY> insert(
       EntityMetamodel<ENTITY> entityMetamodel,
       List<ENTITY> entities,
       Consumer<InsertSettings> settingsConsumer) {

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

@@ -6,19 +6,28 @@
 import java.util.Map;
 import java.util.Objects;
 import org.seasar.doma.jdbc.criteria.metamodel.EntityMetamodel;
+import org.seasar.doma.jdbc.criteria.metamodel.PropertyMetamodel;
+import org.seasar.doma.jdbc.query.DuplicateKeyType;
 
 public class InsertContext implements Context {
   public final EntityMetamodel<?> entityMetamodel;
   public final List<EntityMetamodel<?>> entityMetamodels;
   public final Map<Operand.Prop, Operand.Param> values = new LinkedHashMap<>();
   public final InsertSettings settings = new InsertSettings();
   public SelectContext selectContext;
+  public OnDuplicateContext onDuplicateContext = new OnDuplicateContext();
 
   public InsertContext(EntityMetamodel<?> entityMetamodel) {
     this.entityMetamodel = Objects.requireNonNull(entityMetamodel);
     this.entityMetamodels = Collections.singletonList(entityMetamodel);
   }
 
+  public class OnDuplicateContext {
+    public DuplicateKeyType duplicateKeyType = DuplicateKeyType.EXCEPTION;
+    public List<PropertyMetamodel<?>> keys = Collections.emptyList();
+    public final Map<Operand.Prop, Operand> setValues = new LinkedHashMap<>();
+  }
+
   @Override
   public List<EntityMetamodel<?>> getEntityMetamodels() {
     return entityMetamodels;

doma-core/src/main/java/org/seasar/doma/jdbc/criteria/declaration/InsertDeclaration.java

@@ -24,6 +24,16 @@ public void values(Consumer<ValuesDeclaration> block) {
     block.accept(declaration);
   }
 
+  public void upsertSetValues(Consumer<InsertOnDuplicateKeyUpdateSetValuesDeclaration> block) {
+    Objects.requireNonNull(block);
+    InsertOnDuplicateKeyUpdateSetValuesDeclaration declaration =
+        new InsertOnDuplicateKeyUpdateSetValuesDeclaration(context);
+    block.accept(declaration);
+    if (context.onDuplicateContext.setValues.isEmpty()) {
+      context.onDuplicateContext.setValues.putAll(context.values);
+    }
+  }
+
   public void select(Function<InsertSelectDeclaration, SubSelectContext<?>> block) {
     InsertSelectDeclaration declaration = new InsertSelectDeclaration();
     SubSelectContext<?> subSelectContext = block.apply(declaration);

doma-core/src/main/java/org/seasar/doma/jdbc/criteria/declaration/InsertOnDuplicateKeyUpdateSetValuesDeclaration.java

@@ -0,0 +1,53 @@
+package org.seasar.doma.jdbc.criteria.declaration;
+
+import java.util.Objects;
+import org.seasar.doma.jdbc.criteria.context.InsertContext;
+import org.seasar.doma.jdbc.criteria.context.Operand;
+import org.seasar.doma.jdbc.criteria.metamodel.PropertyMetamodel;
+
+public class InsertOnDuplicateKeyUpdateSetValuesDeclaration {
+
+  private final InsertContext context;
+
+  public InsertOnDuplicateKeyUpdateSetValuesDeclaration(InsertContext context) {
+    this.context = Objects.requireNonNull(context);
+  }
+
+  /**
+   * Adds a value to the upsert set clause.
+   *
+   * @param left The left property metamodel.
+   * @param right The right value.
+   * @param <PROPERTY> The type of property.
+   */
+  public <PROPERTY> void value(PropertyMetamodel<PROPERTY> left, PROPERTY right) {
+    Objects.requireNonNull(left);
+    this.context.onDuplicateContext.setValues.put(
+        new Operand.Prop(left), new Operand.Param(left, right));
+  }
+
+  /**
+   * Adds a value to the upsert set clause.
+   *
+   * @param left The left property metamodel.
+   * @param right The right operand.
+   * @param <PROPERTY> The type of property.
+   */
+  public <PROPERTY> void value(PropertyMetamodel<PROPERTY> left, Operand.Prop right) {
+    Objects.requireNonNull(left);
+    this.context.onDuplicateContext.setValues.put(new Operand.Prop(left), right);
+  }
+
+  /**
+   * References the records that excluded from insertion into a table.
+   *
+   * @param excludedPropertyMeta Specifies columns excluded from the insert record.specify what is
+   *     in PropertyMetamodel set in `values`.
+   * @param <PROPERTY> The type of property.
+   * @return set clause operand
+   */
+  public <PROPERTY> Operand.Prop excluded(PropertyMetamodel<PROPERTY> excludedPropertyMeta) {
+    Objects.requireNonNull(excludedPropertyMeta);
+    return new Operand.Prop(excludedPropertyMeta);
+  }
+}

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

@@ -12,6 +12,7 @@
 import org.seasar.doma.jdbc.criteria.metamodel.EntityMetamodel;
 import org.seasar.doma.jdbc.entity.EntityType;
 import org.seasar.doma.jdbc.query.AutoBatchInsertQuery;
+import org.seasar.doma.jdbc.query.DuplicateKeyType;
 import org.seasar.doma.jdbc.query.Query;
 
 public class EntityqlBatchInsertStatement<ENTITY>
@@ -21,6 +22,7 @@ public class EntityqlBatchInsertStatement<ENTITY>
   private final EntityMetamodel<ENTITY> entityMetamodel;
   private final List<ENTITY> entities;
   private final InsertSettings settings;
+  private DuplicateKeyType duplicateKeyType = DuplicateKeyType.EXCEPTION;
 
   public EntityqlBatchInsertStatement(
       Config config,
@@ -33,6 +35,16 @@ public EntityqlBatchInsertStatement(
     this.settings = Objects.requireNonNull(settings);
   }
 
+  public Statement<BatchResult<ENTITY>> onDuplicateKeyUpdate() {
+    this.duplicateKeyType = DuplicateKeyType.UPDATE;
+    return this;
+  }
+
+  public Statement<BatchResult<ENTITY>> onDuplicateKeyIgnore() {
+    this.duplicateKeyType = DuplicateKeyType.IGNORE;
+    return this;
+  }
+
   /**
    * {@inheritDoc}
    *
@@ -62,6 +74,7 @@ protected Command<BatchResult<ENTITY>> createCommand() {
     query.setExcludedPropertyNames();
     query.setGeneratedKeysIgnored(settings.getIgnoreGeneratedKeys());
     query.setMessage(settings.getComment());
+    query.setDuplicateKeyType(this.duplicateKeyType);
     query.prepare();
     BatchInsertCommand command =
         config.getCommandImplementors().createBatchInsertCommand(EXECUTE_METHOD, query);

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

@@ -10,6 +10,7 @@
 import org.seasar.doma.jdbc.criteria.metamodel.PropertyMetamodel;
 import org.seasar.doma.jdbc.entity.EntityType;
 import org.seasar.doma.jdbc.query.AutoInsertQuery;
+import org.seasar.doma.jdbc.query.DuplicateKeyType;
 import org.seasar.doma.jdbc.query.Query;
 
 public class EntityqlInsertStatement<ENTITY>
@@ -18,6 +19,7 @@ public class EntityqlInsertStatement<ENTITY>
   private final EntityMetamodel<ENTITY> entityMetamodel;
   private final ENTITY entity;
   private final InsertSettings settings;
+  private DuplicateKeyType duplicateKeyType = DuplicateKeyType.EXCEPTION;
 
   public EntityqlInsertStatement(
       Config config,
@@ -30,6 +32,26 @@ public EntityqlInsertStatement(
     this.settings = Objects.requireNonNull(settings);
   }
 
+  /**
+   * Create statement that inserts or updates
+   *
+   * @return statement
+   */
+  public Statement<Result<ENTITY>> onDuplicateKeyUpdate() {
+    this.duplicateKeyType = DuplicateKeyType.UPDATE;
+    return this;
+  }
+
+  /**
+   * Create statement that inserts or ignore
+   *
+   * @return statement
+   */
+  public Statement<Result<ENTITY>> onDuplicateKeyIgnore() {
+    this.duplicateKeyType = DuplicateKeyType.IGNORE;
+    return this;
+  }
+
   /**
    * {@inheritDoc}
    *
@@ -60,6 +82,7 @@ protected Command<Result<ENTITY>> createCommand() {
     query.setExcludedPropertyNames(
         settings.exclude().stream().map(PropertyMetamodel::getName).toArray(String[]::new));
     query.setMessage(settings.getComment());
+    query.setDuplicateKeyType(duplicateKeyType);
     query.prepare();
     InsertCommand command =
         config.getCommandImplementors().createInsertCommand(EXECUTE_METHOD, query);