add updateFullRow option; update to 5.17.4

Author: zhanghaochenFCB

README.md

@@ -9,19 +9,19 @@
  - 阿里云表格存储是阿里云自主研发的NoSQL数据存储服务，提供海量结构化数据的存储和实时访问。
 
 ## 版本
- - 当前版本：5.17.3
+ - 当前版本：5.17.4
 
 ## 运行环境
  - JDK 6及其以上
 
 ## 安装
 #### Maven方式
-下载[最新版JAR包](https://search.maven.org/remotecontent?filepath=com/aliyun/openservices/tablestore/5.17.3/tablestore-5.17.3.jar)或者通过Maven：
+下载[最新版JAR包](https://search.maven.org/remotecontent?filepath=com/aliyun/openservices/tablestore/5.17.4/tablestore-5.17.4.jar)或者通过Maven：
 ```xml
 <dependency>
   <groupId>com.aliyun.openservices</groupId>
   <artifactId>tablestore</artifactId>
-  <version>5.17.3</version>
+  <version>5.17.4</version>
 </dependency>
 ```
 

pom.xml

@@ -3,7 +3,7 @@
   <modelVersion>4.0.0</modelVersion>  
   <groupId>com.aliyun.openservices</groupId>  
   <artifactId>tablestore</artifactId>  
-  <version>5.17.3</version>
+  <version>5.17.4</version>
   <packaging>jar</packaging>  
   <name>AliCloud TableStore SDK for Java</name>  
   <url>http://www.aliyun.com</url>

src/main/java/com/alicloud/openservices/tablestore/core/Constants.java

@@ -5,7 +5,7 @@
 public class Constants {
     // ALL HTTP HEADERS SHOULD BE DEFINED IN LOWERCASE
     // request headers
-    public static final String USER_AGENT = "ots-java-sdk 5.17.3";
+    public static final String USER_AGENT = "ots-java-sdk 5.17.4";
     public static final String OTS_HEADER_API_VERSION = "x-ots-apiversion";
     public static final String OTS_HEADER_ACCESS_KEY_ID = "x-ots-accesskeyid";
     public static final String OTS_HEADER_OTS_CONTENT_MD5 = "x-ots-contentmd5";

src/main/java/com/alicloud/openservices/tablestore/core/protocol/OTSProtocolBuilder.java

@@ -379,7 +379,7 @@ public static OtsInternalApi.CreateTableRequest buildCreateTableExRequest(Create
         return builder.build();
     }
 
-    private static OtsInternalApi.TableOptions buildTableOptions(TableOptions x) {
+    public static OtsInternalApi.TableOptions buildTableOptions(TableOptions x) {
         OtsInternalApi.TableOptions.Builder builder = OtsInternalApi.TableOptions.newBuilder();
 
         if (x.hasSetMaxVersions()) {
@@ -398,6 +398,10 @@ private static OtsInternalApi.TableOptions buildTableOptions(TableOptions x) {
             builder.setAllowUpdate(x.getAllowUpdate());
         }
 
+        if (x.hasSetUpdateFullRow()) {
+            builder.setUpdateFullRow(x.getUpdateFullRow());
+        }
+
         return builder.build();
     }
 

src/main/java/com/alicloud/openservices/tablestore/core/protocol/OTSProtocolParser.java

@@ -190,6 +190,10 @@ public static TableOptions parseTableOptions(OtsInternalApi.TableOptions tableOp
             result.setAllowUpdate(tableOptions.getAllowUpdate());
         }
 
+        if (tableOptions.hasUpdateFullRow()) {
+            result.setUpdateFullRow(tableOptions.getUpdateFullRow());
+        }
+
         return result;
     }
 

src/main/java/com/alicloud/openservices/tablestore/core/protocol/OtsInternalApi.java

@@ -46,6 +46,7 @@ message TableOptions {
     optional int32 max_versions = 2;
     optional int64 deviation_cell_version_in_sec = 5;
     optional bool allow_update = 6;
+    optional bool update_full_row = 7;
 }
 
 enum IndexUpdateMode {

src/main/java/com/alicloud/openservices/tablestore/core/protocol/ots_internal_api.proto

@@ -41,6 +41,20 @@ public class TableOptions implements Jsonizable {
      */
     private OptionalValue<Boolean> allowUpdate = new OptionalValue<Boolean>("AllowUpdate");
 
+    /**
+     * 表中的数据在Update时是否必须整行一起更新。
+     * 整行更新：Update部分列，会自动将原始列的版本号填充到行上。
+     * 比如某一行有列pk、a、b、c，Update的列参数只包含pk、a，则b、c列的版本号会被自动填充（和pk、a列的版本号一致）。
+     * 该配置项默认设置为false。
+     * 如果设置为true，
+     * 优势（为什么要整行一起更新）：对应的表在allow_update为true时，也能支持二级索引和多元索引的TTL功能；
+     *      如果配置项为false且allow_update为true，则不支持索引TTL。
+     * 劣势：1. Update操作会自动填充原始列的版本号，会增加Update请求的写负载。
+     *      2. 同时，由于要自动填充原始列，Update操作的读负载（写前读取原始列），并增加读CU。
+     * 在表创建后，该配置不可动态修改。
+     */
+    private OptionalValue<Boolean> updateFullRow = new OptionalValue<Boolean>("UpdateFullRow");
+
     /**
      * 构造TableOptions对象。
      */
@@ -87,6 +101,17 @@ public TableOptions(boolean allowUpdate) {
          setAllowUpdate(allowUpdate);
      }
 
+    /**
+     * 构造TableOptions对象。
+     *
+     * @param allowUpdate 是否允许有Update操作
+     * @param updateFullRow Update时是否必须整行一起更新
+     */
+    public TableOptions(boolean allowUpdate, boolean updateFullRow) {
+        setAllowUpdate(allowUpdate);
+        setUpdateFullRow(updateFullRow);
+    }
+
     /**
      * 获取TTL时间，单位为秒。
      *
@@ -226,9 +251,35 @@ public boolean getAllowUpdate() {
         return allowUpdate.getValue();
     }
 
+    /**
+     * 查询是否调用{@link #setUpdateFullRow(boolean)}来设置在数据Update时，是否必须整行一起更新
+     * @return 是否有设置UpdateFullRow
+     */
+    public boolean hasSetUpdateFullRow() { return this.updateFullRow.isValueSet(); }
+
+    /**
+     * 获取数据Update时是否必须整行一起更新
+     * @return Update时是否必须整行一起更新
+     * @throws java.lang.IllegalStateException 若没有配置该参数
+     */
+    public boolean getUpdateFullRow() {
+        if (!this.updateFullRow.isValueSet()) {
+            throw new IllegalStateException("The value of UpdateFullRow is not set.");
+        }
+        return this.updateFullRow.getValue();
+    }
+
+    /**
+     * 设置表在数据Update时，是否必须整行一起更新
+     * @param updateFullRow
+     */
+    public void setUpdateFullRow(boolean updateFullRow) {
+        this.updateFullRow.setValue(updateFullRow);
+    }
+
     @Override
     public String toString() {
-        return timeToLive + ", " + maxVersions + ", " + maxTimeDeviation + ", " + allowUpdate;
+        return timeToLive + ", " + maxVersions + ", " + maxTimeDeviation + ", " + allowUpdate + ", " + updateFullRow;
     }
 
     @Override
@@ -282,6 +333,15 @@ protected boolean jsonizeFields(StringBuilder sb, boolean firstItem) {
             sb.append("\"AllowUpdate\": ");
             sb.append(this.allowUpdate.getValue());
         }
+        if (this.updateFullRow.isValueSet()) {
+            if (firstItem) {
+                firstItem = false;
+            } else {
+                sb.append(", ");
+            }
+            sb.append("\"UpdateFullRow\": ");
+            sb.append(this.updateFullRow.getValue());
+        }
         return firstItem;
     }
 

src/main/java/com/alicloud/openservices/tablestore/model/TableOptions.java

@@ -1,6 +1,7 @@
 package com.alicloud.openservices.tablestore.common;
 
 import com.alicloud.openservices.tablestore.model.*;
+import junit.framework.AssertionFailedError;
 
 import java.lang.reflect.Field;
 import java.util.ArrayList;
@@ -9,6 +10,7 @@
 import java.util.Random;
 
 import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
 
 public class TestUtil {
 
@@ -152,4 +154,22 @@ public static void injectEnvironmentVariable(String key, String value)
         Map<String, String> map = (Map<String, String>) mapField.get(null);
         map.put(key, value);
     }
+
+    public static <T extends Throwable> T expectThrowsAndMessages(Class<T> expectedType, Runnable runnable, String... messageKeys) {
+        try {
+            runnable.run();
+        } catch (Throwable e) {
+            if (expectedType.isInstance(e)) {
+                String message = e.getMessage();
+                for (String key : messageKeys) {
+                    assertTrue("message key[" + key + "] not in message:" + message, message.contains(key));
+                }
+                return expectedType.cast(e);
+            }
+            AssertionFailedError assertion = new AssertionFailedError("Unexpected exception type, expected " + expectedType.getSimpleName() + " but got " + e);
+            assertion.initCause(e);
+            throw assertion;
+        }
+        throw new AssertionFailedError("Expected exception " + expectedType.getSimpleName() + " but no exception was thrown");
+    }
 }

src/test/java/com/alicloud/openservices/tablestore/common/TestUtil.java

@@ -5,10 +5,7 @@
 import com.alicloud.openservices.tablestore.common.ServiceSettings;
 import com.alicloud.openservices.tablestore.model.*;
 import com.alicloud.openservices.tablestore.model.timeseries.*;
-import org.junit.AfterClass;
-import org.junit.Assert;
-import org.junit.BeforeClass;
-import org.junit.Test;
+import org.junit.*;
 
 import java.util.ArrayList;
 import java.util.HashMap;
@@ -153,6 +150,7 @@ public void testCustomPrimaryKeys() {
         }
     }
 
+    @Ignore
     @Test
     public void testCustomPrimaryKeysMeta() throws InterruptedException {
         // create table