Backport to branch(3) : Introduce operation attributes (#2339)

Co-authored-by: Toshihiro Suzuki <[email protected]>

core/src/main/java/com/scalar/db/api/Delete.java

@@ -3,6 +3,7 @@
 import static com.google.common.base.Preconditions.checkNotNull;
 
 import com.google.common.base.MoreObjects;
+import com.google.common.collect.ImmutableMap;
 import com.scalar.db.api.DeleteBuilder.BuildableFromExisting;
 import com.scalar.db.api.DeleteBuilder.Namespace;
 import com.scalar.db.io.Key;
@@ -25,8 +26,9 @@ public class Delete extends Mutation {
       Key partitionKey,
       @Nullable Key clusteringKey,
       @Nullable Consistency consistency,
+      ImmutableMap<String, String> attributes,
       @Nullable MutationCondition condition) {
-    super(namespace, tableName, partitionKey, clusteringKey, consistency, condition);
+    super(namespace, tableName, partitionKey, clusteringKey, consistency, attributes, condition);
   }
 
   /**
@@ -172,6 +174,7 @@ public String toString() {
         .add("partitionKey", getPartitionKey())
         .add("clusteringKey", getClusteringKey())
         .add("consistency", getConsistency())
+        .add("attributes", getAttributes())
         .add("condition", getCondition())
         .toString();
   }

core/src/main/java/com/scalar/db/api/DeleteBuilder.java

@@ -2,6 +2,9 @@
 
 import static com.google.common.base.Preconditions.checkNotNull;
 
+import com.google.common.collect.ImmutableMap;
+import com.scalar.db.api.OperationBuilder.Attribute;
+import com.scalar.db.api.OperationBuilder.ClearAttribute;
 import com.scalar.db.api.OperationBuilder.ClearClusteringKey;
 import com.scalar.db.api.OperationBuilder.ClearCondition;
 import com.scalar.db.api.OperationBuilder.ClearNamespace;
@@ -11,6 +14,8 @@
 import com.scalar.db.api.OperationBuilder.PartitionKeyBuilder;
 import com.scalar.db.api.OperationBuilder.TableBuilder;
 import com.scalar.db.io.Key;
+import java.util.HashMap;
+import java.util.Map;
 import javax.annotation.Nullable;
 
 public class DeleteBuilder {
@@ -60,10 +65,14 @@ public Buildable partitionKey(Key partitionKey) {
   }
 
   public static class Buildable extends OperationBuilder.Buildable<Delete>
-      implements ClusteringKey<Buildable>, Consistency<Buildable>, Condition<Buildable> {
+      implements ClusteringKey<Buildable>,
+          Consistency<Buildable>,
+          Condition<Buildable>,
+          Attribute<Buildable> {
     @Nullable Key clusteringKey;
     @Nullable com.scalar.db.api.Consistency consistency;
     @Nullable MutationCondition condition;
+    final Map<String, String> attributes = new HashMap<>();
 
     private Buildable(@Nullable String namespace, String table, Key partitionKey) {
       super(namespace, table, partitionKey);
@@ -90,10 +99,31 @@ public Buildable consistency(com.scalar.db.api.Consistency consistency) {
       return this;
     }
 
+    @Override
+    public Buildable attribute(String name, String value) {
+      checkNotNull(name);
+      checkNotNull(value);
+      attributes.put(name, value);
+      return this;
+    }
+
+    @Override
+    public Buildable attributes(Map<String, String> attributes) {
+      checkNotNull(attributes);
+      this.attributes.putAll(attributes);
+      return this;
+    }
+
     @Override
     public Delete build() {
       return new Delete(
-          namespaceName, tableName, partitionKey, clusteringKey, consistency, condition);
+          namespaceName,
+          tableName,
+          partitionKey,
+          clusteringKey,
+          consistency,
+          ImmutableMap.copyOf(attributes),
+          condition);
     }
   }
 
@@ -103,17 +133,18 @@ public static class BuildableFromExisting extends Buildable
           OperationBuilder.PartitionKey<BuildableFromExisting>,
           ClearCondition<BuildableFromExisting>,
           ClearClusteringKey<BuildableFromExisting>,
-          ClearNamespace<BuildableFromExisting> {
+          ClearNamespace<BuildableFromExisting>,
+          ClearAttribute<BuildableFromExisting> {
 
     BuildableFromExisting(Delete delete) {
       super(
           delete.forNamespace().orElse(null),
           delete.forTable().orElse(null),
           delete.getPartitionKey());
-
       this.clusteringKey = delete.getClusteringKey().orElse(null);
       this.consistency = delete.getConsistency();
       this.condition = delete.getCondition().orElse(null);
+      this.attributes.putAll(delete.getAttributes());
     }
 
     @Override
@@ -149,6 +180,18 @@ public BuildableFromExisting consistency(com.scalar.db.api.Consistency consisten
       return this;
     }
 
+    @Override
+    public BuildableFromExisting attribute(String name, String value) {
+      super.attribute(name, value);
+      return this;
+    }
+
+    @Override
+    public BuildableFromExisting attributes(Map<String, String> attributes) {
+      super.attributes(attributes);
+      return this;
+    }
+
     @Override
     public BuildableFromExisting condition(MutationCondition condition) {
       super.condition(condition);
@@ -172,5 +215,17 @@ public BuildableFromExisting clearNamespace() {
       this.namespaceName = null;
       return this;
     }
+
+    @Override
+    public BuildableFromExisting clearAttributes() {
+      this.attributes.clear();
+      return this;
+    }
+
+    @Override
+    public BuildableFromExisting clearAttribute(String name) {
+      this.attributes.remove(name);
+      return this;
+    }
   }
 }

core/src/main/java/com/scalar/db/api/Get.java

@@ -3,6 +3,7 @@
 import static com.google.common.base.Preconditions.checkNotNull;
 
 import com.google.common.base.MoreObjects;
+import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.ImmutableSet;
 import com.scalar.db.api.GetBuilder.BuildableGetOrGetWithIndexFromExisting;
 import com.scalar.db.api.GetBuilder.Namespace;
@@ -26,10 +27,18 @@ public class Get extends Selection {
       Key partitionKey,
       @Nullable Key clusteringKey,
       @Nullable Consistency consistency,
+      ImmutableMap<String, String> attributes,
       List<String> projections,
       ImmutableSet<Conjunction> conjunctions) {
     super(
-        namespace, tableName, partitionKey, clusteringKey, consistency, projections, conjunctions);
+        namespace,
+        tableName,
+        partitionKey,
+        clusteringKey,
+        consistency,
+        attributes,
+        projections,
+        conjunctions);
   }
 
   /**
@@ -178,9 +187,10 @@ public String toString() {
         .add("table", forTable())
         .add("partitionKey", getPartitionKey())
         .add("clusteringKey", getClusteringKey())
+        .add("consistency", getConsistency())
+        .add("attributes", getAttributes())
         .add("projections", getProjections())
         .add("conjunctions", getConjunctions())
-        .add("consistency", getConsistency())
         .toString();
   }
 }