Support to include/exclude properties in the Criteria INSERT/UPDATE statements (#789)

* Support to include/exclude properties in the Criteria INSERT/UPDATE statements

* Update documentation

Author: nakamura-to

docs/criteria-api.rst

@@ -1193,6 +1193,8 @@ We support the following settings:
 * sqlLogType
 * batchSize
 * excludeNull
+* include
+* exclude
 
 They are all optional.
 
@@ -1221,6 +1223,16 @@ You can apply them as follows:
                 })
             .execute();
 
+.. code-block:: java
+
+    Department_ d = new Department_();
+
+    Department department = ...;
+
+    Result<Department> result = entityql.insert(d, department, settings ->
+        settings.exclude(d.departmentName, d.location)
+    ).execute();
+
 Insert statement (Entityql)
 ----------------------------
 
@@ -1330,6 +1342,8 @@ We support the following settings:
 * sqlLogType
 * suppressOptimisticLockException
 * excludeNull
+* include
+* exclude
 
 They are all optional.
 
@@ -1352,6 +1366,16 @@ You can apply them as follows:
       c.value(e.employeeName, "aaa");
     }).execute();
 
+.. code-block:: java
+
+    Employee_ e = new Employee_();
+
+    Employee employee = ...;
+
+    Result<Employee> result = entityql.update(e, employee, settings ->
+      settings.exclude(e.hiredate, e.salary)
+    ).execute();
+
 .. note::
 
     If you want to build a update statement without a WHERE clause,

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

@@ -1,11 +1,17 @@
 package org.seasar.doma.jdbc.criteria.context;
 
 import java.sql.PreparedStatement;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import org.seasar.doma.jdbc.criteria.metamodel.PropertyMetamodel;
 
 /** Represents the settings for an INSERT criteria query. */
 public class InsertSettings extends Settings {
   private int batchSize = 0;
   private boolean excludeNull;
+  private final List<PropertyMetamodel<?>> includedProperties = new ArrayList<>();
+  private final List<PropertyMetamodel<?>> excludedProperties = new ArrayList<>();
 
   /**
    * Returns the batch size.
@@ -49,4 +55,40 @@ public boolean getExcludeNull() {
   public void setExcludeNull(boolean excludeNull) {
     this.excludeNull = excludeNull;
   }
+
+  /**
+   * Returns the included properties.
+   *
+   * @return the included properties
+   */
+  public List<PropertyMetamodel<?>> include() {
+    return includedProperties;
+  }
+
+  /**
+   * Sets the included properties.
+   *
+   * @param propertyMetamodels the included properties
+   */
+  public void include(PropertyMetamodel<?>... propertyMetamodels) {
+    Collections.addAll(includedProperties, propertyMetamodels);
+  }
+
+  /**
+   * Returns the excluded properties.
+   *
+   * @return the excluded properties
+   */
+  public List<PropertyMetamodel<?>> exclude() {
+    return excludedProperties;
+  }
+
+  /**
+   * Sets the excluded properties.
+   *
+   * @param propertyMetamodels the excluded properties
+   */
+  public void exclude(PropertyMetamodel<?>... propertyMetamodels) {
+    Collections.addAll(excludedProperties, propertyMetamodels);
+  }
 }

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

@@ -1,6 +1,10 @@
 package org.seasar.doma.jdbc.criteria.context;
 
 import java.sql.PreparedStatement;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import org.seasar.doma.jdbc.criteria.metamodel.PropertyMetamodel;
 
 /** Represents the settings for an UPDATE criteria query. */
 public class UpdateSettings extends Settings {
@@ -9,6 +13,8 @@ public class UpdateSettings extends Settings {
   private boolean ignoreVersion;
   private boolean suppressOptimisticLockException;
   private boolean excludeNull;
+  private final List<PropertyMetamodel<?>> includedProperties = new ArrayList<>();
+  private final List<PropertyMetamodel<?>> excludedProperties = new ArrayList<>();
 
   /**
    * Returns the batch size.
@@ -115,4 +121,40 @@ public boolean getExcludeNull() {
   public void setExcludeNull(boolean excludeNull) {
     this.excludeNull = excludeNull;
   }
+
+  /**
+   * Returns the included properties.
+   *
+   * @return the included properties
+   */
+  public List<PropertyMetamodel<?>> include() {
+    return includedProperties;
+  }
+
+  /**
+   * Sets the included properties.
+   *
+   * @param propertyMetamodels the included properties
+   */
+  public void include(PropertyMetamodel<?>... propertyMetamodels) {
+    Collections.addAll(includedProperties, propertyMetamodels);
+  }
+
+  /**
+   * Returns the excluded properties.
+   *
+   * @return the excluded properties
+   */
+  public List<PropertyMetamodel<?>> exclude() {
+    return excludedProperties;
+  }
+
+  /**
+   * Sets the excluded properties.
+   *
+   * @param propertyMetamodels the excluded properties
+   */
+  public void exclude(PropertyMetamodel<?>... propertyMetamodels) {
+    Collections.addAll(excludedProperties, propertyMetamodels);
+  }
 }

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

@@ -7,6 +7,7 @@
 import org.seasar.doma.jdbc.command.InsertCommand;
 import org.seasar.doma.jdbc.criteria.context.InsertSettings;
 import org.seasar.doma.jdbc.criteria.metamodel.EntityMetamodel;
+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.Query;
@@ -54,8 +55,10 @@ protected Command<Result<ENTITY>> createCommand() {
     query.setQueryTimeout(settings.getQueryTimeout());
     query.setSqlLogType(settings.getSqlLogType());
     query.setNullExcluded(settings.getExcludeNull());
-    query.setIncludedPropertyNames();
-    query.setExcludedPropertyNames();
+    query.setIncludedPropertyNames(
+        settings.include().stream().map(PropertyMetamodel::getName).toArray(String[]::new));
+    query.setExcludedPropertyNames(
+        settings.exclude().stream().map(PropertyMetamodel::getName).toArray(String[]::new));
     query.setMessage(settings.getComment());
     query.prepare();
     InsertCommand command =

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

@@ -8,6 +8,7 @@
 import org.seasar.doma.jdbc.command.UpdateCommand;
 import org.seasar.doma.jdbc.criteria.context.UpdateSettings;
 import org.seasar.doma.jdbc.criteria.metamodel.EntityMetamodel;
+import org.seasar.doma.jdbc.criteria.metamodel.PropertyMetamodel;
 import org.seasar.doma.jdbc.entity.EntityType;
 import org.seasar.doma.jdbc.query.AutoUpdateQuery;
 import org.seasar.doma.jdbc.query.Query;
@@ -60,8 +61,10 @@ protected Command<Result<ENTITY>> createCommand() {
     query.setSqlLogType(settings.getSqlLogType());
     query.setNullExcluded(settings.getExcludeNull());
     query.setVersionIgnored(settings.getIgnoreVersion());
-    query.setIncludedPropertyNames();
-    query.setExcludedPropertyNames();
+    query.setIncludedPropertyNames(
+        settings.include().stream().map(PropertyMetamodel::getName).toArray(String[]::new));
+    query.setExcludedPropertyNames(
+        settings.exclude().stream().map(PropertyMetamodel::getName).toArray(String[]::new));
     query.setUnchangedPropertyIncluded(false);
     query.setOptimisticLockExceptionSuppressed(settings.getSuppressOptimisticLockException());
     query.setMessage(settings.getComment());

doma-core/src/test/java/org/seasar/doma/jdbc/criteria/EntityqlInsertTest.java

@@ -46,4 +46,35 @@ void excludeNull() {
     assertEquals(
         "insert into EMP (ID, SALARY, VERSION) values (1, 1000, 1)", sql.getFormattedSql());
   }
+
+  @Test
+  void include() {
+    Emp emp = new Emp();
+    emp.setId(1);
+    emp.setName("aaa");
+    emp.setSalary(new BigDecimal("1000"));
+    emp.setVersion(1);
+
+    Emp_ e = new Emp_();
+    Buildable<?> stmt = entityql.insert(e, emp, settings -> settings.include(e.salary));
+
+    Sql<?> sql = stmt.asSql();
+    assertEquals(
+        "insert into EMP (ID, SALARY, VERSION) values (1, 1000, 1)", sql.getFormattedSql());
+  }
+
+  @Test
+  void exclude() {
+    Emp emp = new Emp();
+    emp.setId(1);
+    emp.setName("aaa");
+    emp.setSalary(new BigDecimal("1000"));
+    emp.setVersion(1);
+
+    Emp_ e = new Emp_();
+    Buildable<?> stmt = entityql.insert(e, emp, settings -> settings.exclude(e.salary));
+
+    Sql<?> sql = stmt.asSql();
+    assertEquals("insert into EMP (ID, NAME, VERSION) values (1, 'aaa', 1)", sql.getFormattedSql());
+  }
 }

doma-core/src/test/java/org/seasar/doma/jdbc/criteria/EntityqlUpdateTest.java

@@ -31,6 +31,40 @@ void test() {
         sql.getFormattedSql());
   }
 
+  @Test
+  void include() {
+    Emp emp = new Emp();
+    emp.setId(1);
+    emp.setName("aaa");
+    emp.setSalary(new BigDecimal("1000"));
+    emp.setVersion(1);
+
+    Emp_ e = new Emp_();
+    Buildable<?> stmt = entityql.update(e, emp, settings -> settings.include(e.salary));
+
+    Sql<?> sql = stmt.asSql();
+    assertEquals(
+        "update EMP set SALARY = 1000, VERSION = 1 + 1 where ID = 1 and VERSION = 1",
+        sql.getFormattedSql());
+  }
+
+  @Test
+  void exclude() {
+    Emp emp = new Emp();
+    emp.setId(1);
+    emp.setName("aaa");
+    emp.setSalary(new BigDecimal("1000"));
+    emp.setVersion(1);
+
+    Emp_ e = new Emp_();
+    Buildable<?> stmt = entityql.update(e, emp, settings -> settings.exclude(e.salary));
+
+    Sql<?> sql = stmt.asSql();
+    assertEquals(
+        "update EMP set NAME = 'aaa', VERSION = 1 + 1 where ID = 1 and VERSION = 1",
+        sql.getFormattedSql());
+  }
+
   @Test
   void ignoreVersion() {
     Emp emp = new Emp();