Merge pull request #40 from xiaowing/master

add the "delta" support for SubQuery

Author: Rocky0714

src/main/java/com/aliyun/hitsdb/client/value/request/DeltaOptions.java

@@ -0,0 +1,85 @@
+package com.aliyun.hitsdb.client.value.request;
+
+/**
+ * Created By jianhong.hjh
+ * Date: 2019/08/30
+ */
+public class DeltaOptions {
+
+    private Boolean counter;
+
+    private Boolean dropResets;
+
+    private Long counterMax;
+
+    public static class Builder {
+
+        private Boolean counter;
+
+        private Boolean dropResets;
+
+        private Long counterMax;
+
+        public Builder() {
+
+        }
+
+        public Builder counter(boolean counter) {
+            this.counter = counter;
+            return this;
+        }
+
+        public Builder dropResets(boolean dropResets) {
+            this.dropResets = dropResets;
+            return this;
+        }
+
+        public Builder counterMax(long counterMax) {
+            this.counterMax = counterMax;
+            return this;
+        }
+
+        public DeltaOptions build() {
+            DeltaOptions rateOptions = new DeltaOptions();
+            if (counter != null) {
+                rateOptions.counter = counter;
+            }
+            if (dropResets != null) {
+                rateOptions.dropResets = dropResets;
+            }
+            if (counterMax != null) {
+                rateOptions.counterMax = counterMax;
+            }
+            return rateOptions;
+        }
+    }
+
+
+    public static Builder newBuilder() {
+        return new Builder();
+    }
+
+    public Boolean getCounter() {
+        return counter;
+    }
+
+    public void setCounter(Boolean counter) {
+        this.counter = counter;
+    }
+
+    public Boolean getDropResets() {
+        return dropResets;
+    }
+
+    public void setDropResets(Boolean dropResets) {
+        this.dropResets = dropResets;
+    }
+
+    public Long getCounterMax() {
+        return counterMax;
+    }
+
+    public void setCounterMax(Long counterMax) {
+        this.counterMax = counterMax;
+    }
+}

src/main/java/com/aliyun/hitsdb/client/value/request/SubQuery.java

@@ -19,6 +19,13 @@ public class SubQuery {
     private String downsample;
     private Boolean rate;
     private RateOptions rateOptions;
+    /**
+     * the delta field of SubQuery is supported at the Server side from v.2.5.9
+     * @since v0.2.5
+     */
+    private Boolean delta;
+    private DeltaOptions deltaOptions;
+    
     private Map<String, String> tags;
     private Granularity granularityType;
     private String granularity;
@@ -36,6 +43,8 @@ public static class Builder {
         private String downsample;
         private Boolean rate;
         private RateOptions rateOptions;
+        private Boolean delta;
+        private DeltaOptions deltaOptions;
         private Integer limit;
         private Integer offset;
         private String dpValue;
@@ -64,6 +73,17 @@ public Builder rate(RateOptions rateOptions) {
             return this;
         }
 
+        public Builder delta() {
+            this.delta = true;
+            return this;
+        }
+
+        public Builder delta(DeltaOptions deltaOptions) {
+            this.delta = true;
+            this.deltaOptions = deltaOptions;
+            return this;
+        }
+
         public Builder limit() {
             this.limit = 0;
             return this;
@@ -192,6 +212,13 @@ public Builder rate(Boolean rate) {
             return this;
         }
 
+        public Builder delta(Boolean delta) {
+            if (delta != null) {
+                this.delta = delta;
+            }
+            return this;
+        }
+
         public Builder limit(Integer limit) {
             if (limit != null) {
                 this.limit = limit;
@@ -294,10 +321,18 @@ public SubQuery build() {
             subQuery.downsample = this.downsample;
             subQuery.metric = this.metric;
             subQuery.tags = this.tags;
+
+            if ((this.delta != null) && (this.delta == true) && (this.rate != null) && (this.rate == true)) {
+                throw new IllegalArgumentException("\"delta\" and \"rate\" cannot be specified at the same time");
+            }
             subQuery.rate = this.rate;
             if (this.rateOptions != null) {
 				subQuery.rateOptions = this.rateOptions;
             }
+            subQuery.delta = this.delta;
+            if (this.deltaOptions != null) {
+                subQuery.deltaOptions = this.deltaOptions;
+            }
             subQuery.granularityType = this.granularityType;
             subQuery.realTimeSeconds = this.realTimeSeconds;
             subQuery.explicitTags = this.explicitTags;
@@ -442,4 +477,12 @@ public String getDpValue() {
     public String getPreDpValue() {
         return preDpValue;
     }
+
+    public Boolean getDelta() {
+        return delta;
+    }
+
+    public DeltaOptions getDeltaOptions() {
+        return deltaOptions;
+    }
 }

src/test/java/com/aliyun/hitsdb/client/value/TestQuery.java

@@ -6,6 +6,7 @@
 import java.util.HashMap;
 import java.util.Map;
 
+import com.aliyun.hitsdb.client.value.request.DeltaOptions;
 import org.junit.Assert;
 import org.junit.Test;
 
@@ -255,4 +256,40 @@ public void testQueryMsResolution() throws ParseException {
         Assert.assertEquals(json,
                 "{\"end\":1501564455,\"msResolution\":true,\"queries\":[{\"aggregator\":\"sum\",\"index\":0,\"metric\":\"test1\",\"rate\":true,\"tags\":{\"tagk1\":\"tagv1\",\"tagk2\":\"tagv2\"}},{\"aggregator\":\"avg\",\"index\":1,\"metric\":\"test2\",\"rate\":true,\"tags\":{\"tagk1\":\"tagv1\",\"tagk2\":\"tagv2\"}}],\"start\":1501560855}");
     }
+
+    @Test
+    public void testQueryDelta() throws ParseException {
+        String strDate = "2017-08-01 13:14:15";
+        SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
+        Date date = sdf.parse(strDate);
+
+        int endTime = (int) (date.getTime() / 1000);
+        int startTime = endTime - 60 * 60;
+
+        SubQuery subQuery1 = SubQuery.metric("test1").aggregator(Aggregator.NONE).delta().tag("tagk1", "tagv1")
+                .tag("tagk2", "tagv2").build();
+        SubQuery subQuery2 = SubQuery.metric("test1").aggregator(Aggregator.NONE)
+                .delta(DeltaOptions.newBuilder().counter(true).counterMax(100).dropResets(true).build())
+                .tag("tagk1", "tagv1").tag("tagk2", "tagv2").build();
+
+        Query query = Query.timeRange(startTime, endTime)
+                .sub(subQuery1).sub(subQuery2).build();
+        String json = query.toJSON();
+        Assert.assertEquals("{\"end\":1501564455,\"queries\":[{\"aggregator\":\"none\",\"delta\":true,\"index\":0,\"metric\":\"test1\",\"tags\":{\"tagk1\":\"tagv1\",\"tagk2\":\"tagv2\"}},{\"aggregator\":\"none\",\"delta\":true,\"deltaOptions\":{\"counter\":true,\"counterMax\":100,\"dropResets\":true},\"index\":1,\"metric\":\"test1\",\"tags\":{\"tagk1\":\"tagv1\",\"tagk2\":\"tagv2\"}}],\"start\":1501560855}",
+                json);
+    }
+
+    @Test(expected = IllegalArgumentException.class)
+    public void testQueryDeltaAndRate() throws ParseException {
+        String strDate = "2017-08-01 13:14:15";
+        SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
+        Date date = sdf.parse(strDate);
+
+        int endTime = (int) (date.getTime() / 1000);
+        int startTime = endTime - 60 * 60;
+
+        SubQuery subQuery1 = SubQuery.metric("test1").aggregator(Aggregator.NONE).delta().rate().tag("tagk1", "tagv1")
+                .tag("tagk2", "tagv2").build();
+
+    }
 }