#993 - ENH: Add flush() to EbeanServer and Model to make it more accessible than the current transaction.flushBatch()

src/main/java/io/ebean/EbeanServer.java

@@ -613,6 +613,19 @@ public interface EbeanServer {
    */
   Transaction currentTransaction();
 
+  /**
+   * Flush the JDBC batch on the current transaction.
+   * <p>
+   * This only is useful when JDBC batch is used. Flush occurs automatically when the
+   * transaction commits or batch size is reached. This manually flushes the JDBC batch
+   * buffer.
+   * </p>
+   * <p>
+   * This is the same as <code>currentTransaction().flush()</code>.
+   * </p>
+   */
+  void flush();
+
   /**
    * Commit the current transaction.
    */

src/main/java/io/ebean/Model.java

@@ -190,6 +190,17 @@ public abstract class Model {
     db().save(this);
   }
 
+  /**
+   * Flush any batched changes to the database.
+   * <p>
+   * When using JDBC batch flushing occurs automatically at commit() time or when the batch size
+   * is reached. This provides the ability to manually flush the batch.
+   * </p>
+   */
+  public void flush() {
+    db().flush();
+  }
+
   /**
    * Update this entity.
    *

src/main/java/io/ebean/Transaction.java

@@ -429,6 +429,14 @@ public interface Transaction extends AutoCloseable {
    * <li>Transaction commit occurs</li>
    * </ul>
    */
+  void flush() throws PersistenceException;
+
+  /**
+   * This is a synonym for flush() and will be deprecated.
+   * <p>
+   * flush() is preferred as it matches the JPA flush() method.
+   * </p>
+   */
   void flushBatch() throws PersistenceException;
 
   /**

src/main/java/io/ebeaninternal/api/ScopedTransaction.java

@@ -295,9 +295,14 @@ public class ScopedTransaction implements SpiTransaction {
     return transaction.isBatchFlushOnQuery();
   }
 
+  @Override
+  public void flush() throws PersistenceException {
+    transaction.flush();
+  }
+
   @Override
   public void flushBatch() throws PersistenceException {
-    transaction.flushBatch();
+    flush();
   }
 
   @Override

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

@@ -840,6 +840,11 @@ public final class DefaultServer implements SpiServer, SpiEbeanServer {
     return transactionScopeManager.get();
   }
 
+  @Override
+  public void flush() {
+    currentTransaction().flush();
+  }
+
   /**
    * Commit the current transaction.
    */

src/main/java/io/ebeaninternal/server/transaction/JdbcTransaction.java

@@ -731,13 +731,18 @@ public class JdbcTransaction implements SpiTransaction {
    * </p>
    */
   @Override
-  public void flushBatch() {
+  public void flush() {
     if (!isActive()) {
       throw new IllegalStateException(illegalStateMessage);
     }
     internalBatchFlush();
   }
 
+  @Override
+  public void flushBatch() {
+    flush();
+  }
+
   /**
    * Flush the JDBC batch and execute derived relationship statements if necessary.
    */

src/test/java/io/ebeaninternal/api/TDSpiEbeanServer.java

@@ -460,6 +460,11 @@ public class TDSpiEbeanServer implements SpiEbeanServer {
     return null;
   }
 
+  @Override
+  public void flush() {
+
+  }
+
   @Override
   public void commitTransaction() {
 

src/test/java/org/tests/transaction/TestBatchModelFlush.java

@@ -0,0 +1,27 @@
+package org.tests.transaction;
+
+import io.ebean.BaseTestCase;
+import io.ebean.annotation.Transactional;
+import org.junit.Test;
+import org.tests.model.m2m.MnyB;
+
+public class TestBatchModelFlush extends BaseTestCase {
+
+  @Transactional(batchSize = 50)
+  @Test
+  public void insert() {
+
+    new MnyB("TestBatchModelFlush_0").save();
+    new MnyB("TestBatchModelFlush_1").save();
+
+    MnyB bean = new MnyB("TestBatchModelFlush_2");
+    bean.save();
+    bean.db().currentTransaction().flush();
+
+    MnyB bean2 = new MnyB("TestBatchModelFlush_3");
+    bean2.save();
+    bean2.db().flush();
+
+    new MnyB("TestBatchModelFlush_4").save();
+  }
+}