feat: switched from lock-scanned ranges to FOR UPDATE (GoogleCloudPlatform#3215)

Author: shobhitsg

benchmarks/tpcc/README.md

@@ -33,7 +33,6 @@ mvn spring-boot:run -Dspring-boot.run.arguments="
   --tpcc.truncate-before-load=false
   --tpcc.run-benchmark=false
   --tpcc.use-read-only-transactions=false
-  --tpcc.lock-scanned-ranges=false
   --spanner.project=my-project
   --spanner.instance=my-instance
   --spanner.database=my-database
@@ -53,7 +52,6 @@ mvn spring-boot:run -Dspring-boot.run.arguments="
   --tpcc.run-benchmark=false
   --tpcc.benchmark-runner=client_lib_gsql
   --tpcc.use-read-only-transactions=false
-  --tpcc.lock-scanned-ranges=false
   --spanner.project=my-project
   --spanner.instance=my-instance
   --spanner.database=my-database
@@ -77,7 +75,6 @@ mvn spring-boot:run -Dspring-boot.run.arguments="
   --tpcc.run-benchmark=true
   --tpcc.benchmark-runner=pgadapter
   --tpcc.use-read-only-transactions=true
-  --tpcc.lock-scanned-ranges=false
   --spanner.project=my-project
   --spanner.instance=my-instance
   --spanner.database=my-database
@@ -97,7 +94,6 @@ mvn spring-boot:run -Dspring-boot.run.arguments="
   --tpcc.run-benchmark=true
   --tpcc.benchmark-runner=spanner_jdbc
   --tpcc.use-read-only-transactions=true
-  --tpcc.lock-scanned-ranges=false
   --spanner.project=my-project
   --spanner.instance=my-instance
   --spanner.database=my-database
@@ -117,7 +113,6 @@ mvn spring-boot:run -Dspring-boot.run.arguments="
   --tpcc.run-benchmark=true
   --tpcc.benchmark-runner=client_lib_pg
   --tpcc.use-read-only-transactions=true
-  --tpcc.lock-scanned-ranges=false
   --spanner.project=my-project
   --spanner.instance=my-instance
   --spanner.database=my-database
@@ -137,7 +132,6 @@ mvn spring-boot:run -Dspring-boot.run.arguments="
   --tpcc.run-benchmark=true
   --tpcc.benchmark-runner=client_lib_gsql
   --tpcc.use-read-only-transactions=true
-  --tpcc.lock-scanned-ranges=false
   --spanner.project=my-project
   --spanner.instance=my-instance
   --spanner.database=my-database

benchmarks/tpcc/src/main/java/com/google/cloud/pgadapter/tpcc/AbstractBenchmarkRunner.java

@@ -180,10 +180,9 @@ private void newOrder() throws SQLException {
     executeStatement("begin transaction");
     row =
         paramQueryRow(
-            (tpccConfiguration.isLockScannedRanges() ? "/*@ lock_scanned_ranges=exclusive */" : "")
-                + "SELECT c_discount, c_last, c_credit, w_tax "
+            "SELECT c_discount, c_last, c_credit, w_tax "
                 + "FROM customer c, warehouse w "
-                + "WHERE w.w_id = ? AND c.w_id = w.w_id AND c.d_id = ? AND c.c_id = ?",
+                + "WHERE w.w_id = ? AND c.w_id = w.w_id AND c.d_id = ? AND c.c_id = ? FOR UPDATE",
             new Object[] {warehouseId, districtId, customerId});
     BigDecimal discount = (BigDecimal) row[0];
     String last = (String) row[1];
@@ -192,10 +191,9 @@ private void newOrder() throws SQLException {
 
     row =
         paramQueryRow(
-            (tpccConfiguration.isLockScannedRanges() ? "/*@ lock_scanned_ranges=exclusive */" : "")
-                + "SELECT d_next_o_id, d_tax "
+            "SELECT d_next_o_id, d_tax "
                 + "FROM district "
-                + "WHERE w_id = ? AND d_id = ?",
+                + "WHERE w_id = ? AND d_id = ? FOR UPDATE",
             new Object[] {warehouseId, districtId});
     long districtNextOrderId = (long) row[0];
     BigDecimal districtTax = (BigDecimal) row[1];
@@ -235,12 +233,9 @@ private void newOrder() throws SQLException {
 
       row =
           paramQueryRow(
-              (tpccConfiguration.isLockScannedRanges()
-                      ? "/*@ lock_scanned_ranges=exclusive */"
-                      : "")
-                  + "SELECT s_quantity, s_data, s_dist_01, s_dist_02, s_dist_03, s_dist_04, s_dist_05, s_dist_06, s_dist_07, s_dist_08, s_dist_09, s_dist_10 "
+              "SELECT s_quantity, s_data, s_dist_01, s_dist_02, s_dist_03, s_dist_04, s_dist_05, s_dist_06, s_dist_07, s_dist_08, s_dist_09, s_dist_10 "
                   + "FROM stock "
-                  + "WHERE s_i_id = ? AND w_id= ?",
+                  + "WHERE s_i_id = ? AND w_id= ? FOR UPDATE",
               new Object[] {orderLineItemId, orderLineSupplyWarehouseId});
       long stockQuantity = (long) row[0];
       String stockData = (String) row[1];
@@ -375,10 +370,9 @@ private void payment() throws SQLException {
     }
     row =
         paramQueryRow(
-            (tpccConfiguration.isLockScannedRanges() ? "/*@ lock_scanned_ranges=exclusive */" : "")
-                + "SELECT c_first, c_middle, c_last, c_street_1, c_street_2, c_city, c_state, c_zip, c_phone, c_credit, c_credit_lim, c_discount, c_balance, c_ytd_payment, c_since "
+            "SELECT c_first, c_middle, c_last, c_street_1, c_street_2, c_city, c_state, c_zip, c_phone, c_credit, c_credit_lim, c_discount, c_balance, c_ytd_payment, c_since "
                 + "FROM customer "
-                + "WHERE w_id = ? AND d_id= ? AND c_id=?",
+                + "WHERE w_id = ? AND d_id= ? AND c_id=? FOR UPDATE",
             new Object[] {customerWarehouseId, customerDistrictId, customerId});
     String firstName = (String) row[0];
     String middleName = (String) row[1];
@@ -556,14 +550,11 @@ private void delivery() throws SQLException {
       long districtId = Long.reverse(district);
       row =
           paramQueryRow(
-              (tpccConfiguration.isLockScannedRanges()
-                      ? "/*@ lock_scanned_ranges=exclusive */"
-                      : "")
-                  + "SELECT o_id, c_id "
+              "SELECT o_id, c_id "
                   + "FROM new_orders "
                   + "WHERE d_id = ? AND w_id = ? "
                   + "ORDER BY o_id ASC "
-                  + "LIMIT 1",
+                  + "LIMIT 1 FOR UPDATE",
               new Object[] {districtId, warehouseId});
       if (row != null) {
         long newOrderId = (long) row[0];

benchmarks/tpcc/src/main/java/com/google/cloud/pgadapter/tpcc/Statistics.java

@@ -49,7 +49,6 @@ void print(Duration runtime) {
                 \rNum threads:    %d\t
                 \rDuration:       %s\t
                 \rRead-only tx:   %s\t
-                \rExclusive lock: %s\t
                 \r
                 \rNew orders:     %d (%.2f/s)\t
                 \rPayments:       %d (%.2f/s)\t
@@ -67,7 +66,6 @@ void print(Duration runtime) {
         tpccConfiguration.getBenchmarkThreads(),
         runtime,
         tpccConfiguration.isUseReadOnlyTransactions(),
-        tpccConfiguration.isLockScannedRanges(),
         getNewOrder(),
         getNewOrderPerSecond(runtime),
         getPayment(),

benchmarks/tpcc/src/main/java/com/google/cloud/pgadapter/tpcc/config/TpccConfiguration.java

@@ -54,8 +54,6 @@ public class TpccConfiguration {
   /** --- Optimizations --- */
   private boolean useReadOnlyTransactions;
 
-  private boolean lockScannedRanges;
-
   public boolean isLoadData() {
     return loadData;
   }
@@ -151,12 +149,4 @@ public boolean isUseReadOnlyTransactions() {
   public void setUseReadOnlyTransactions(boolean useReadOnlyTransactions) {
     this.useReadOnlyTransactions = useReadOnlyTransactions;
   }
-
-  public boolean isLockScannedRanges() {
-    return lockScannedRanges;
-  }
-
-  public void setLockScannedRanges(boolean lockScannedRanges) {
-    this.lockScannedRanges = lockScannedRanges;
-  }
 }

benchmarks/tpcc/src/main/resources/application.properties

@@ -40,7 +40,6 @@ tpcc.item-count=100000
 
 # --- Possible optimizations for TPC-C --- #
 tpcc.use-read-only-transactions=false
-tpcc.lock-scanned-ranges=false
 
 # Change these to match your Cloud Spanner PostgreSQL-dialect database.
 spanner.project=my-project

benchmarks/tpcc/src/test/java/com/google/cloud/pgadapter/tpcc/BenchmarkApplicationTest.java

@@ -77,7 +77,6 @@ public void testRunApplication() throws Exception {
       System.setProperty("tpcc.run-benchmark", "false");
       System.setProperty("tpcc.benchmark-runner", "pgadapter");
       System.setProperty("tpcc.use-read-only-transactions", "true");
-      System.setProperty("tpcc.lock-scanned-ranges", "false");
       System.setProperty("spanner.project", "test-project");
       System.setProperty("spanner.instance", "test-instance");
       System.setProperty("spanner.database", "tpcc");