Add support for Postgres INSERT ON CONFLICT update | nothing

Adds InsertOptions with ability to control the options used
for insert with Postgres around ON CONFLICT.

ebean-core/src/main/java/io/ebeaninternal/server/core/DefaultServer.java

@@ -1651,41 +1651,44 @@ public final class DefaultServer implements SpiServer, SpiEbeanServer {
     }, transaction);
   }
 
-  /**
-   * Insert the bean.
-   */
   @Override
   public void insert(Object bean) {
-    insert(bean, null);
+    persister.insert(checkEntityBean(bean), null, null);
+  }
+
+  @Override
+  public void insert(Object bean, @Nullable InsertOptions insertOptions) {
+    persister.insert(checkEntityBean(bean), insertOptions, null);
   }
 
-  /**
-   * Insert the bean with a transaction.
-   */
   @Override
   public void insert(Object bean, @Nullable Transaction transaction) {
-    persister.insert(checkEntityBean(bean), transaction);
+    persister.insert(checkEntityBean(bean), null, transaction);
   }
 
-  /**
-   * Insert all beans in the collection.
-   */
   @Override
   public void insertAll(Collection<?> beans) {
-    insertAll(beans, null);
+    insertAll(beans, null, null);
+  }
+
+  @Override
+  public void insertAll(Collection<?> beans, InsertOptions options) {
+    insertAll(beans, options, null);
   }
 
-  /**
-   * Insert all beans in the collection with a transaction.
-   */
   @Override
   public void insertAll(@Nullable Collection<?> beans, @Nullable Transaction transaction) {
+    insertAll(beans, null, transaction);
+  }
+
+  private void insertAll(@Nullable Collection<?> beans, InsertOptions options, @Nullable Transaction transaction) {
     if (beans == null || beans.isEmpty()) {
       return;
     }
     executeInTrans((txn) -> {
+      txn.checkBatchEscalationOnCollection();
       for (Object bean : beans) {
-        persister.insert(checkEntityBean(bean), txn);
+        persister.insert(checkEntityBean(bean), options, txn);
       }
       return 0;
     }, transaction);

ebean-core/src/main/java/io/ebeaninternal/server/core/PersistRequestBean.java

@@ -1,5 +1,6 @@
 package io.ebeaninternal.server.core;
 
+import io.ebean.InsertOptions;
 import io.ebean.ValuePair;
 import io.ebean.annotation.DocStoreMode;
 import io.ebean.bean.EntityBean;
@@ -124,6 +125,7 @@ public final class PersistRequestBean<T> extends PersistRequest implements BeanP
    * Many-to-many intersection table changes that are held for later batch processing.
    */
   private List<SaveMany> saveMany;
+  private InsertOptions insertOptions;
 
   public PersistRequestBean(SpiEbeanServer server, T bean, Object parentBean, BeanManager<T> mgr, SpiTransaction t,
                             PersistExecute persistExecute, PersistRequest.Type type, int flags) {
@@ -1408,4 +1410,12 @@ public final class PersistRequestBean<T> extends PersistRequest implements BeanP
   private void setGeneratedId() {
     beanDescriptor.setGeneratedId(entityBean, transaction);
   }
+
+  public void setInsertOptions(InsertOptions insertOptions) {
+    this.insertOptions  = insertOptions;
+  }
+
+  public InsertOptions insertOptions() {
+    return insertOptions;
+  }
 }

ebean-core/src/main/java/io/ebeaninternal/server/core/Persister.java

@@ -1,11 +1,7 @@
 package io.ebeaninternal.server.core;
 
-import io.ebean.CallableSql;
-import io.ebean.MergeOptions;
-import io.ebean.Query;
-import io.ebean.SqlUpdate;
-import io.ebean.Transaction;
-import io.ebean.Update;
+import io.avaje.lang.Nullable;
+import io.ebean.*;
 import io.ebean.bean.EntityBean;
 import io.ebean.meta.MetricVisitor;
 import io.ebeaninternal.api.SpiSqlUpdate;
@@ -31,9 +27,9 @@ public interface Persister {
   void update(EntityBean entityBean, Transaction t);
 
   /**
-   * Force an Insert using the given bean.
+   * Perform an Insert using the given bean.
    */
-  void insert(EntityBean entityBean, Transaction t);
+  void insert(EntityBean entityBean, @Nullable InsertOptions insertOptions, @Nullable Transaction t);
 
   /**
    * Insert or update the bean depending on its state.
@@ -44,7 +40,6 @@ public interface Persister {
    * Delete a bean given it's type and id value.
    * <p>
    * This will also cascade delete one level of children.
-   * </p>
    */
   int delete(Class<?> beanType, Object id, Transaction transaction, boolean permanent);
 

ebean-core/src/main/java/io/ebeaninternal/server/persist/DefaultPersister.java

@@ -411,7 +411,7 @@ public final class DefaultPersister implements Persister {
     if (bean._ebean_getIntercept().isUpdate()) {
       update(bean, t);
     } else {
-      insert(bean, t);
+      insert(bean, null, t);
     }
   }
 
@@ -419,12 +419,15 @@ public final class DefaultPersister implements Persister {
    * Insert this bean.
    */
   @Override
-  public void insert(EntityBean bean, Transaction t) {
+  public void insert(EntityBean bean, InsertOptions insertOptions, Transaction t) {
     PersistRequestBean<?> req = createRequest(bean, t, PersistRequest.Type.INSERT);
     if (req.isSkipReference()) {
       // skip insert on reference bean
       return;
     }
+    if (insertOptions != null) {
+      req.setInsertOptions(insertOptions);
+    }
     try {
       req.initTransIfRequiredWithBatchCascade();
       insert(req);

ebean-core/src/main/java/io/ebeaninternal/server/persist/dml/GenerateDmlRequest.java

@@ -1,11 +1,15 @@
 package io.ebeaninternal.server.persist.dml;
 
+import java.util.ArrayList;
+import java.util.List;
+
 /**
  * Helper to support the generation of DML statements.
  */
 public final class GenerateDmlRequest {
 
   private final StringBuilder sb = new StringBuilder(100);
+  private final List<String> columns = new ArrayList<>();
   private StringBuilder insertBindBuffer;
   private String prefix;
   private String prefix2;
@@ -26,7 +30,7 @@ public final class GenerateDmlRequest {
     ++bindColumnCount;
     sb.append(prefix);
     sb.append(column);
-    //sb.append(expr);
+    columns.add(column);
     if (insertMode > 0) {
       if (insertMode++ > 1) {
         insertBindBuffer.append(',');
@@ -75,4 +79,8 @@ public final class GenerateDmlRequest {
   public boolean isUpdate() {
     return insertMode == 0;
   }
+
+  public List<String> columns() {
+    return columns;
+  }
 }

ebean-core/src/main/java/io/ebeaninternal/server/persist/dml/InsertHandler.java

@@ -69,7 +69,7 @@ public final class InsertHandler extends DmlHandler {
 
     SpiTransaction t = persistRequest.transaction();
     // get the appropriate sql
-    sql = meta.getSql(withId, persistRequest.isPublish());
+    sql = meta.sql(withId, persistRequest.isPublish(), persistRequest.insertOptions());
     PreparedStatement pstmt;
     if (persistRequest.isBatched()) {
       pstmt = pstmtBatch(t, sql, persistRequest, useGeneratedKeys);
@@ -134,7 +134,8 @@ public final class InsertHandler extends DmlHandler {
       if (idValue != null) {
         persistRequest.setGeneratedKey(idValue);
       }
-    } else {
+    } else if (persistRequest.insertOptions() == null) {
+      // insert on conflict do nothing can not return generated key
       throw new PersistenceException("Autoincrement getGeneratedKeys() returned no rows?");
     }
   }

ebean-core/src/main/java/io/ebeaninternal/server/persist/dml/InsertMeta.java

@@ -1,5 +1,6 @@
 package io.ebeaninternal.server.persist.dml;
 
+import io.ebean.InsertOptions;
 import io.ebean.annotation.Platform;
 import io.ebean.bean.EntityBean;
 import io.ebean.config.dbplatform.DatabasePlatform;
@@ -36,9 +37,11 @@ final class InsertMeta {
   private final Bindable shadowFKey;
   private final String[] identityDbColumns;
   private final Platform platform;
+  private final InsertMetaOptions options;
 
   InsertMeta(DatabasePlatform dbPlatform, BeanDescriptor<?> desc, Bindable shadowFKey, BindableId id, BindableList all) {
     this.platform = dbPlatform.platform();
+    this.options = InsertMetaPlatform.create(platform, desc, this);
     this.discriminator = discriminator(desc);
     this.id = id;
     this.all = all;
@@ -47,8 +50,8 @@ final class InsertMeta {
 
     String tableName = desc.baseTable();
     String draftTableName = desc.draftTable();
-    this.sqlWithId = genSql(false, tableName, false);
-    this.sqlDraftWithId = desc.isDraftable() ? genSql(false, draftTableName, true) : sqlWithId;
+    this.sqlWithId = sql(false, tableName, false);
+    this.sqlDraftWithId = desc.isDraftable() ? sql(false, draftTableName, true) : sqlWithId;
 
     // only available for single Id property
     if (id.isConcatenated()) {
@@ -72,8 +75,8 @@ final class InsertMeta {
         this.supportsGetGeneratedKeys = dbPlatform.dbIdentity().isSupportsGetGeneratedKeys();
         this.supportsSelectLastInsertedId = desc.supportsSelectLastInsertedId();
       }
-      this.sqlNullId = genSql(true, tableName, false);
-      this.sqlDraftNullId = desc.isDraftable() ? genSql(true, draftTableName, true) : sqlNullId;
+      this.sqlNullId = sql(true, tableName, false);
+      this.sqlDraftNullId = desc.isDraftable() ? sql(true, draftTableName, true) : sqlNullId;
     }
   }
 
@@ -137,9 +140,20 @@ final class InsertMeta {
   }
 
   /**
-   * get the sql based whether the id value(s) are null.
+   * Return the sql for the given options.
    */
-  public String getSql(boolean withId, boolean publish) {
+  public String sql(boolean withId, boolean publish, InsertOptions insertOptions) {
+    if (insertOptions == null) {
+      return sql(withId, publish);
+    }
+    return options.sql(withId, insertOptions);
+  }
+
+  String sqlFor(boolean withId) {
+    return withId ? sqlWithId : sqlNullId;
+  }
+
+  private String sql(boolean withId, boolean publish) {
     if (withId) {
       return publish ? sqlWithId : sqlDraftWithId;
     } else {
@@ -147,12 +161,18 @@ final class InsertMeta {
     }
   }
 
-  private String genSql(boolean nullId, String table, boolean draftTable) {
+  private String sql(boolean nullId, String table, boolean draftTable) {
     GenerateDmlRequest request = new GenerateDmlRequest();
+    sql(request, nullId, table, draftTable);
+    return request.toString();
+  }
+
+  void sql(GenerateDmlRequest request, boolean nullId, String table, boolean draftTable) {
     request.setInsertSetMode();
     request.append("insert into ").append(table);
     if (nullId && noColumnsForInsert(draftTable)) {
-      return request.append(defaultValues()).toString();
+      request.append(defaultValues());
+      return;
     }
     request.append(" (");
     if (!nullId) {
@@ -172,7 +192,6 @@ final class InsertMeta {
     request.append(") values (");
     request.append(request.insertBindBuffer());
     request.append(")");
-    return request.toString();
   }
 
   private String defaultValues() {
@@ -196,5 +215,4 @@ final class InsertMeta {
       && discriminator == null
       && (draftTable ? all.isEmpty() : allExcludeDraftOnly.isEmpty());
   }
-
 }

ebean-core/src/main/java/io/ebeaninternal/server/persist/dml/InsertMetaOptions.java

@@ -0,0 +1,14 @@
+package io.ebeaninternal.server.persist.dml;
+
+import io.ebean.InsertOptions;
+
+/**
+ * Generator for insert SQL with options.
+ */
+interface InsertMetaOptions {
+
+  /**
+   * Generate the SQL for the given insert options.
+   */
+  String sql(boolean withId, InsertOptions insertOptions);
+}

ebean-core/src/main/java/io/ebeaninternal/server/persist/dml/InsertMetaOptionsPostgres.java

@@ -0,0 +1,113 @@
+package io.ebeaninternal.server.persist.dml;
+
+import io.ebean.InsertOptions;
+import io.ebeaninternal.server.deploy.BeanDescriptor;
+import io.ebeaninternal.server.deploy.BeanProperty;
+
+import java.util.Arrays;
+import java.util.List;
+import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.stream.Collectors;
+
+/**
+ * Postgres specific generation of insert on conflict.
+ */
+final class InsertMetaOptionsPostgres implements InsertMetaOptions {
+
+  private final InsertMeta meta;
+  private final BeanDescriptor<?> desc;
+  private final String baseTable;
+  private final Map<String, String> sqlCache = new ConcurrentHashMap<>();
+
+  InsertMetaOptionsPostgres(InsertMeta meta, BeanDescriptor<?> desc) {
+    this.meta = meta;
+    this.desc = desc;
+    this.baseTable = desc.baseTable();
+  }
+
+  @Override
+  public String sql(boolean withId, InsertOptions options) {
+    String key = withId + options.key();
+    return sqlCache.computeIfAbsent(key, k -> generate(withId, options));
+  }
+
+  private String generate(boolean withId, InsertOptions options) {
+    char type = options.key().charAt(0);
+    switch (type) {
+      case 'U':
+        return generate(withId, false, options);
+      case 'N':
+        return generate(withId, true, options);
+      default:
+        return meta.sqlFor(withId);
+    }
+  }
+
+  private String generate(boolean withId, boolean doNothing, InsertOptions options) {
+    GenerateDmlRequest request = new GenerateDmlRequest();
+    meta.sql(request, !withId, baseTable, false);
+    request.append(" on conflict ");
+
+    List<String> uniqueColumns = desc.uniqueProps().stream()
+      .flatMap(Arrays::stream)
+      .map(BeanProperty::dbColumn)
+      .collect(Collectors.toList());
+
+    String constraintName = options.constraint();
+    if (constraintName != null) {
+      request.append("on constraint ").append(constraintName);
+    } else {
+      request.append("(");
+      String cols = options.uniqueColumns();
+      if (cols != null) {
+        request.append(cols);
+      } else {
+        appendUniqueColumns(uniqueColumns, request);
+      }
+      request.append(")");
+    }
+    if (doNothing) {
+      request.append(" do nothing");
+      return request.toString();
+    }
+    request.append(" do update set ");
+    String updateSet = options.updateSet();
+    if (updateSet != null) {
+      request.append(updateSet);
+    } else {
+      setColumns(withId, request, uniqueColumns);
+    }
+    return request.toString();
+  }
+
+  private void setColumns(boolean withId, GenerateDmlRequest request, List<String> uniqueColumns) {
+    List<String> columns = request.columns();
+    columns.removeAll(uniqueColumns);
+    if (withId) {
+      BeanProperty idProperty = desc.idProperty();
+      if (idProperty != null && !idProperty.isEmbedded()) {
+        columns.remove(idProperty.dbColumn());
+      }
+    }
+    for (int i = 0; i < columns.size(); i++) {
+      if (i > 0) {
+        request.append(", ");
+      }
+      String col = columns.get(i);
+      request.append(col).append("=excluded.").append(col);
+    }
+  }
+
+  private static void appendUniqueColumns(List<String> uniqueColumns, GenerateDmlRequest request) {
+    if (uniqueColumns.isEmpty()) {
+      throw new IllegalStateException("Unable to identify unique columns for INSERT ON CONFLICT - Add mapping like @Column(unique=true) or @Index(unique=true)");
+    }
+    for (int i = 0; i < uniqueColumns.size(); i++) {
+      if (i > 0) {
+        request.append(", ");
+      }
+      request.append(uniqueColumns.get(i));
+    }
+  }
+}

ebean-core/src/main/java/io/ebeaninternal/server/persist/dml/InsertMetaPlatform.java

@@ -0,0 +1,29 @@
+package io.ebeaninternal.server.persist.dml;
+
+import io.ebean.InsertOptions;
+import io.ebean.annotation.Platform;
+import io.ebeaninternal.server.deploy.BeanDescriptor;
+
+final class InsertMetaPlatform {
+
+  private static final NotSupported NOT_SUPPORTED = new NotSupported();
+
+  static InsertMetaOptions create(Platform platform, BeanDescriptor<?> desc, InsertMeta meta) {
+    switch (platform.base()) {
+      case POSTGRES:
+      case YUGABYTE:
+      case COCKROACH:
+        return new InsertMetaOptionsPostgres(meta, desc);
+      default:
+        return NOT_SUPPORTED;
+    }
+  }
+
+  static final class NotSupported implements InsertMetaOptions {
+    @Override
+    public String sql(boolean withId, InsertOptions insertOptions) {
+      throw new UnsupportedOperationException("InsertOptions not supported on this database platform");
+    }
+  }
+
+}