From b3077d44f6b8540531f8c07702c3d5e90633899d Mon Sep 17 00:00:00 2001 From: rob bygrave Date: Fri, 13 Dec 2019 13:48:53 +1300 Subject: [PATCH] #1890 - Deprecate createSqlUpdate() ... migrate to sqlUpdate() --- src/main/java/io/ebean/DB.java | 3 ++ src/main/java/io/ebean/Database.java | 11 +++---- src/main/java/io/ebean/Ebean.java | 13 ++++---- .../core/PersistDeferredRelationship.java | 2 +- .../server/deploy/IntersectionTable.java | 4 +-- src/test/java/io/ebean/DtoQueryTest.java | 2 +- .../sqlserver/SqlServerStepSequenceTest.java | 4 +-- .../dbmigration/DbMigrationTest.java | 30 +++++++++---------- .../org/tests/model/basic/ResetBasicData.java | 10 +++---- 9 files changed, 42 insertions(+), 37 deletions(-) diff --git a/src/main/java/io/ebean/DB.java b/src/main/java/io/ebean/DB.java index c2f92cf82..0c73686ee 100644 --- a/src/main/java/io/ebean/DB.java +++ b/src/main/java/io/ebean/DB.java @@ -760,8 +760,11 @@ public class DB { } /** + * Deprecated - migrate to sqlUpdate(). + *

* This is an alias for {@link #sqlUpdate(String)}. */ + @Deprecated public static SqlUpdate createSqlUpdate(String sql) { return sqlUpdate(sql); } diff --git a/src/main/java/io/ebean/Database.java b/src/main/java/io/ebean/Database.java index 5d68b42b4..b6acd2eec 100644 --- a/src/main/java/io/ebean/Database.java +++ b/src/main/java/io/ebean/Database.java @@ -3,7 +3,6 @@ package io.ebean; import io.ebean.annotation.TxIsolation; import io.ebean.cache.ServerCacheManager; import io.ebean.config.DatabaseConfig; -import io.ebean.config.ServerConfig; import io.ebean.meta.MetaInfoManager; import io.ebean.plugin.Property; import io.ebean.plugin.SpiServer; @@ -485,8 +484,11 @@ public interface Database { SqlUpdate sqlUpdate(String sql); /** + * Deprecated - migrate to sqlUpdate(). + *

* This is an alias for {@link #sqlUpdate(String)}. */ + @Deprecated SqlUpdate createSqlUpdate(String sql); /** @@ -856,7 +858,7 @@ public interface Database { * 

{@code
    *   public class Order { ...
    *
-   * 	   @OneToMany(cascade=CascadeType.ALL, mappedBy="order")
+   *     @OneToMany(cascade=CascadeType.ALL, mappedBy="order")
    * 	   List details;
    * 	   ...
    *   }
@@ -1051,7 +1053,6 @@ public interface Database {
    *   Integer returnValue = (Integer) cs.getObject(3);
    *
    * }
- * */ int execute(CallableSql callableSql); @@ -1299,7 +1300,7 @@ public interface Database { * public void run() { * User u1 = database.find(User.class, 1); * ... - * } + * } * }); * * } @@ -1348,7 +1349,7 @@ public interface Database { * User u1 = database.find(User.class, 1); * ... * return u1.getEmail(); - * } + * } * }); * * } diff --git a/src/main/java/io/ebean/Ebean.java b/src/main/java/io/ebean/Ebean.java index 1826dd651..75f502796 100644 --- a/src/main/java/io/ebean/Ebean.java +++ b/src/main/java/io/ebean/Ebean.java @@ -462,7 +462,7 @@ public final class Ebean { * 
{@code
    *   public class Order { ...
    *
-   * 	   @OneToMany(cascade=CascadeType.ALL, mappedBy="order")
+   *     @OneToMany(cascade=CascadeType.ALL, mappedBy="order")
    * 	   List details;
    * 	   ...
    *   }
@@ -877,17 +877,18 @@ public final class Ebean {
   }
 
   /**
+   * Deprecated - migrate to DB.sqlUpdate().
+   * 

    * Create a sql update for executing native dml statements.
    * 

    * Use this to execute a Insert Update or Delete statement. The statement will
    * be native to the database and contain database table and column names.
-   * 

    * 

    * See {@link SqlUpdate} for example usage.
-   * 

    */
+  @Deprecated
   public static SqlUpdate createSqlUpdate(String sql) {
-    return serverMgr.getDefaultServer().createSqlUpdate(sql);
+    return serverMgr.getDefaultServer().sqlUpdate(sql);
   }
 
   /**
@@ -1193,7 +1194,7 @@ public final class Ebean {
    * 	   public void run() {
    * 		   User u1 = Ebean.find(User.class, 1);
    * 		   ...
-   * 	   }
+   *     }
    *   });
    *
    * }
@@ -1245,7 +1246,7 @@ public final class Ebean { * User u1 = Ebean.find(User.class, 1); * ... * return u1.getEmail(); - * } + * } * }); * * } diff --git a/src/main/java/io/ebeaninternal/server/core/PersistDeferredRelationship.java b/src/main/java/io/ebeaninternal/server/core/PersistDeferredRelationship.java index 790dc691a..ff81f49da 100644 --- a/src/main/java/io/ebeaninternal/server/core/PersistDeferredRelationship.java +++ b/src/main/java/io/ebeaninternal/server/core/PersistDeferredRelationship.java @@ -36,7 +36,7 @@ public class PersistDeferredRelationship { public void execute(SpiTransaction transaction) { String sql = beanDescriptor.getUpdateImportedIdSql(importedId); - SqlUpdate sqlUpdate = ebeanServer.createSqlUpdate(sql); + SqlUpdate sqlUpdate = ebeanServer.sqlUpdate(sql); // bind the set clause for the importedId int pos = importedId.bind(1, sqlUpdate, assocBean); diff --git a/src/main/java/io/ebeaninternal/server/deploy/IntersectionTable.java b/src/main/java/io/ebeaninternal/server/deploy/IntersectionTable.java index 785c2be4c..8c11654b5 100644 --- a/src/main/java/io/ebeaninternal/server/deploy/IntersectionTable.java +++ b/src/main/java/io/ebeaninternal/server/deploy/IntersectionTable.java @@ -21,14 +21,14 @@ public class IntersectionTable { * Return a SqlUpdate for inserting into the intersection table. */ public SqlUpdate insert(EbeanServer server, boolean draft) { - return server.createSqlUpdate(draft ? draftInsertSql : insertSql); + return server.sqlUpdate(draft ? draftInsertSql : insertSql); } /** * Return a SqlUpdate for deleting from the intersection table. */ public SqlUpdate delete(EbeanServer server, boolean draft) { - return server.createSqlUpdate(draft ? draftDeleteSql : deleteSql); + return server.sqlUpdate(draft ? draftDeleteSql : deleteSql); } } diff --git a/src/test/java/io/ebean/DtoQueryTest.java b/src/test/java/io/ebean/DtoQueryTest.java index bbde60351..8f325ea75 100644 --- a/src/test/java/io/ebean/DtoQueryTest.java +++ b/src/test/java/io/ebean/DtoQueryTest.java @@ -164,7 +164,7 @@ public class DtoQueryTest extends BaseTestCase { List ids = Arrays.asList(999999999, 999999998); - int rows = server().createSqlUpdate("update o_customer set name = ? where id = any(?)") + int rows = server().sqlUpdate("update o_customer set name = ? where id = any(?)") .setParameter(1, "Junk") .setParameter(2, ids) .execute(); diff --git a/src/test/java/io/ebean/config/dbplatform/sqlserver/SqlServerStepSequenceTest.java b/src/test/java/io/ebean/config/dbplatform/sqlserver/SqlServerStepSequenceTest.java index 3745ef4fa..b89049b8c 100644 --- a/src/test/java/io/ebean/config/dbplatform/sqlserver/SqlServerStepSequenceTest.java +++ b/src/test/java/io/ebean/config/dbplatform/sqlserver/SqlServerStepSequenceTest.java @@ -23,8 +23,8 @@ public class SqlServerStepSequenceTest extends BaseTestCase { public void seq() { - server().createSqlUpdate("drop sequence if exists sqls_testseq_9876").execute(); - server().createSqlUpdate("create sequence sqls_testseq_9876 start with 1 increment by 50").execute(); + server().sqlUpdate("drop sequence if exists sqls_testseq_9876").execute(); + server().sqlUpdate("create sequence sqls_testseq_9876 start with 1 increment by 50").execute(); BackgroundExecutor be = server().getBackgroundExecutor(); DataSource ds = server().getPluginApi().getDataSource(); diff --git a/src/test/java/io/ebeaninternal/dbmigration/DbMigrationTest.java b/src/test/java/io/ebeaninternal/dbmigration/DbMigrationTest.java index 4cfe08c94..cb461820c 100644 --- a/src/test/java/io/ebeaninternal/dbmigration/DbMigrationTest.java +++ b/src/test/java/io/ebeaninternal/dbmigration/DbMigrationTest.java @@ -88,15 +88,15 @@ public class DbMigrationTest extends BaseTestCase { runScript(false, "1.0__initial.sql"); if (isOracle() || isHana()) { - SqlUpdate update = server().createSqlUpdate("insert into migtest_e_basic (id, old_boolean, user_id) values (1, :false, 1)"); + SqlUpdate update = server().sqlUpdate("insert into migtest_e_basic (id, old_boolean, user_id) values (1, :false, 1)"); update.setParameter("false", false); assertThat(server().execute(update)).isEqualTo(1); - update = server().createSqlUpdate("insert into migtest_e_basic (id, old_boolean, user_id) values (2, :true, 1)"); + update = server().sqlUpdate("insert into migtest_e_basic (id, old_boolean, user_id) values (2, :true, 1)"); update.setParameter("true", true); assertThat(server().execute(update)).isEqualTo(1); } else { - SqlUpdate update = server().createSqlUpdate("insert into migtest_e_basic (id, old_boolean, user_id) values (1, :false, 1), (2, :true, 1)"); + SqlUpdate update = server().sqlUpdate("insert into migtest_e_basic (id, old_boolean, user_id) values (1, :false, 1), (2, :true, 1)"); update.setParameter("false", false); update.setParameter("true", true); @@ -157,34 +157,34 @@ public class DbMigrationTest extends BaseTestCase { * */ private void createHistoryEntities() { - SqlUpdate update = server().createSqlUpdate("insert into migtest_e_history (id, test_string) values (1, '42')"); + SqlUpdate update = server().sqlUpdate("insert into migtest_e_history (id, test_string) values (1, '42')"); assertThat(server().execute(update)).isEqualTo(1); - update = server().createSqlUpdate("update migtest_e_history set test_string = '45' where id = 1"); + update = server().sqlUpdate("update migtest_e_history set test_string = '45' where id = 1"); assertThat(server().execute(update)).isEqualTo(1); - update = server().createSqlUpdate("insert into migtest_e_history2 (id, test_string, obsolete_string1, obsolete_string2) values (1, 'foo', 'bar', null)"); + update = server().sqlUpdate("insert into migtest_e_history2 (id, test_string, obsolete_string1, obsolete_string2) values (1, 'foo', 'bar', null)"); assertThat(server().execute(update)).isEqualTo(1); - update = server().createSqlUpdate("update migtest_e_history2 set test_string = 'baz' where id = 1"); + update = server().sqlUpdate("update migtest_e_history2 set test_string = 'baz' where id = 1"); assertThat(server().execute(update)).isEqualTo(1); - update = server().createSqlUpdate("insert into migtest_e_history3 (id, test_string) values (1, '42')"); + update = server().sqlUpdate("insert into migtest_e_history3 (id, test_string) values (1, '42')"); assertThat(server().execute(update)).isEqualTo(1); - update = server().createSqlUpdate("update migtest_e_history3 set test_string = '45' where id = 1"); + update = server().sqlUpdate("update migtest_e_history3 set test_string = '45' where id = 1"); assertThat(server().execute(update)).isEqualTo(1); - update = server().createSqlUpdate("insert into migtest_e_history4 (id, test_number) values (1, 42)"); + update = server().sqlUpdate("insert into migtest_e_history4 (id, test_number) values (1, 42)"); assertThat(server().execute(update)).isEqualTo(1); - update = server().createSqlUpdate("update migtest_e_history4 set test_number = 45 where id = 1"); + update = server().sqlUpdate("update migtest_e_history4 set test_number = 45 where id = 1"); assertThat(server().execute(update)).isEqualTo(1); - update = server().createSqlUpdate("insert into migtest_e_history5 (id, test_number) values (1, 42)"); + update = server().sqlUpdate("insert into migtest_e_history5 (id, test_number) values (1, 42)"); assertThat(server().execute(update)).isEqualTo(1); - update = server().createSqlUpdate("update migtest_e_history5 set test_number = 45 where id = 1"); + update = server().sqlUpdate("update migtest_e_history5 set test_number = 45 where id = 1"); assertThat(server().execute(update)).isEqualTo(1); - update = server().createSqlUpdate("insert into migtest_e_history6 (id, test_number1, test_number2) values (1, 2, 7)"); + update = server().sqlUpdate("insert into migtest_e_history6 (id, test_number1, test_number2) values (1, 2, 7)"); assertThat(server().execute(update)).isEqualTo(1); - update = server().createSqlUpdate("update migtest_e_history6 set test_number2 = 45 where id = 1"); + update = server().sqlUpdate("update migtest_e_history6 set test_number2 = 45 where id = 1"); assertThat(server().execute(update)).isEqualTo(1); } diff --git a/src/test/java/org/tests/model/basic/ResetBasicData.java b/src/test/java/org/tests/model/basic/ResetBasicData.java index d1b7468a3..084f4bf08 100644 --- a/src/test/java/org/tests/model/basic/ResetBasicData.java +++ b/src/test/java/org/tests/model/basic/ResetBasicData.java @@ -60,9 +60,9 @@ public class ResetBasicData { Ebean.execute(() -> { // orm update use bean name and bean properties - server.createSqlUpdate("delete from o_cached_bean_child").execute(); - server.createSqlUpdate("delete from o_cached_bean_country").execute(); - server.createSqlUpdate("delete from o_cached_bean").execute(); + server.sqlUpdate("delete from o_cached_bean_child").execute(); + server.sqlUpdate("delete from o_cached_bean_country").execute(); + server.sqlUpdate("delete from o_cached_bean").execute(); server.createUpdate(OrderShipment.class, "delete from orderShipment").execute(); @@ -77,8 +77,8 @@ public class ResetBasicData { server.createUpdate(Address.class, "delete from address").execute(); // sql update uses table and column names - server.createSqlUpdate("delete from o_country").execute(); - server.createSqlUpdate("delete from o_product").execute(); + server.sqlUpdate("delete from o_country").execute(); + server.sqlUpdate("delete from o_product").execute(); }); }