You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@inlong.apache.org by he...@apache.org on 2022/04/19 11:27:44 UTC

[incubator-inlong] branch master updated: [INLONG-3791][Sort] Add WatermarkField definition to support transform (#3821)

This is an automated email from the ASF dual-hosted git repository.

healchow pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-inlong.git


The following commit(s) were added to refs/heads/master by this push:
     new a574a314b [INLONG-3791][Sort] Add WatermarkField definition to support transform (#3821)
a574a314b is described below

commit a574a314bfe6bab8fc9ae338be8ed56bec9c7dc2
Author: yunqingmoswu <44...@users.noreply.github.com>
AuthorDate: Tue Apr 19 19:27:38 2022 +0800

    [INLONG-3791][Sort] Add WatermarkField definition to support transform (#3821)
---
 .../sort/protocol/transformation/Function.java     |  4 ++
 .../protocol/transformation/FunctionParam.java     |  3 +-
 .../transformation/TimeWindowFunction.java         |  4 ++
 .../protocol/transformation/WatermarkField.java    | 67 ++++++++++++++++++++++
 .../transformation/WaterMarkFieldTest.java         | 56 ++++++++++++++++++
 5 files changed, 133 insertions(+), 1 deletion(-)

diff --git a/inlong-sort/sort-common/src/main/java/org/apache/inlong/sort/protocol/transformation/Function.java b/inlong-sort/sort-common/src/main/java/org/apache/inlong/sort/protocol/transformation/Function.java
index 9108da8ae..3fb189e06 100644
--- a/inlong-sort/sort-common/src/main/java/org/apache/inlong/sort/protocol/transformation/Function.java
+++ b/inlong-sort/sort-common/src/main/java/org/apache/inlong/sort/protocol/transformation/Function.java
@@ -18,6 +18,7 @@
 package org.apache.inlong.sort.protocol.transformation;
 
 import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonIgnore;
+import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonSubTypes;
 import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonTypeInfo;
 
 import java.util.List;
@@ -26,6 +27,9 @@ import java.util.List;
         use = JsonTypeInfo.Id.NAME,
         include = JsonTypeInfo.As.PROPERTY,
         property = "type")
+@JsonSubTypes({
+        @JsonSubTypes.Type(value = WatermarkField.class, name = "watermark")
+})
 public interface Function extends FunctionParam {
 
     @JsonIgnore
diff --git a/inlong-sort/sort-common/src/main/java/org/apache/inlong/sort/protocol/transformation/FunctionParam.java b/inlong-sort/sort-common/src/main/java/org/apache/inlong/sort/protocol/transformation/FunctionParam.java
index 4bb5a8b36..dbe39c852 100644
--- a/inlong-sort/sort-common/src/main/java/org/apache/inlong/sort/protocol/transformation/FunctionParam.java
+++ b/inlong-sort/sort-common/src/main/java/org/apache/inlong/sort/protocol/transformation/FunctionParam.java
@@ -31,7 +31,8 @@ import org.apache.inlong.sort.protocol.FieldInfo;
         @JsonSubTypes.Type(value = FieldInfo.class, name = "base"),
         @JsonSubTypes.Type(value = BuiltInFieldInfo.class, name = "builtin"),
         @JsonSubTypes.Type(value = ConstantParam.class, name = "constant"),
-        @JsonSubTypes.Type(value = TimeUnitConstantParam.class, name = "timeUnitConstant")
+        @JsonSubTypes.Type(value = TimeUnitConstantParam.class, name = "timeUnitConstant"),
+        @JsonSubTypes.Type(value = WatermarkField.class, name = "watermark")
 })
 public interface FunctionParam {
 
diff --git a/inlong-sort/sort-common/src/main/java/org/apache/inlong/sort/protocol/transformation/TimeWindowFunction.java b/inlong-sort/sort-common/src/main/java/org/apache/inlong/sort/protocol/transformation/TimeWindowFunction.java
index d2ab2dcec..e84eb5b63 100644
--- a/inlong-sort/sort-common/src/main/java/org/apache/inlong/sort/protocol/transformation/TimeWindowFunction.java
+++ b/inlong-sort/sort-common/src/main/java/org/apache/inlong/sort/protocol/transformation/TimeWindowFunction.java
@@ -17,12 +17,16 @@
 
 package org.apache.inlong.sort.protocol.transformation;
 
+import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonSubTypes;
 import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonTypeInfo;
 
 @JsonTypeInfo(
         use = JsonTypeInfo.Id.NAME,
         include = JsonTypeInfo.As.PROPERTY,
         property = "type")
+@JsonSubTypes({
+        @JsonSubTypes.Type(value = WatermarkField.class, name = "watermark")
+})
 public interface TimeWindowFunction extends Function {
 
     TimeUnitConstantParam getTimeUnit();
diff --git a/inlong-sort/sort-common/src/main/java/org/apache/inlong/sort/protocol/transformation/WatermarkField.java b/inlong-sort/sort-common/src/main/java/org/apache/inlong/sort/protocol/transformation/WatermarkField.java
new file mode 100644
index 000000000..810106faa
--- /dev/null
+++ b/inlong-sort/sort-common/src/main/java/org/apache/inlong/sort/protocol/transformation/WatermarkField.java
@@ -0,0 +1,67 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.inlong.sort.protocol.transformation;
+
+import com.google.common.base.Preconditions;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonCreator;
+import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonProperty;
+import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonTypeName;
+import org.apache.inlong.sort.protocol.FieldInfo;
+
+import java.util.Arrays;
+import java.util.List;
+
+@JsonTypeName("watermark")
+@Data
+@NoArgsConstructor
+public class WatermarkField implements TimeWindowFunction {
+
+    @JsonProperty("timeAttr")
+    private FieldInfo timeAttr;
+    @JsonProperty("interval")
+    private ConstantParam interval;
+    @JsonProperty("timeUnit")
+    private TimeUnitConstantParam timeUnit;
+
+    @JsonCreator
+    public WatermarkField(@JsonProperty("timeAttr") FieldInfo timeAttr,
+            @JsonProperty("interval") ConstantParam interval,
+            @JsonProperty("timeUnit") TimeUnitConstantParam timeUnit) {
+        this.timeAttr = Preconditions.checkNotNull(timeAttr, "timeAttr is null");
+        this.interval = Preconditions.checkNotNull(interval, "interval is null");
+        this.timeUnit = Preconditions.checkNotNull(timeUnit, "timeUnit is null");
+    }
+
+    @Override
+    public String format() {
+        return String.format("%s FOR %s AS %s - INTERVAL %s %s", getName(), timeAttr.format(),
+                timeAttr.format(), interval.format(), timeUnit.format());
+    }
+
+    @Override
+    public List<FunctionParam> getParams() {
+        return Arrays.asList(timeAttr, interval, timeUnit);
+    }
+
+    @Override
+    public String getName() {
+        return "WATERMARK";
+    }
+}
diff --git a/inlong-sort/sort-common/src/test/java/org/apache/inlong/sort/protocol/transformation/WaterMarkFieldTest.java b/inlong-sort/sort-common/src/test/java/org/apache/inlong/sort/protocol/transformation/WaterMarkFieldTest.java
new file mode 100644
index 000000000..2c15a977c
--- /dev/null
+++ b/inlong-sort/sort-common/src/test/java/org/apache/inlong/sort/protocol/transformation/WaterMarkFieldTest.java
@@ -0,0 +1,56 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.inlong.sort.protocol.transformation;
+
+import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.core.JsonProcessingException;
+import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.databind.ObjectMapper;
+import org.apache.inlong.sort.formats.common.TimestampFormatInfo;
+import org.apache.inlong.sort.protocol.FieldInfo;
+import org.apache.inlong.sort.protocol.transformation.TimeUnitConstantParam.TimeUnit;
+import org.junit.Test;
+
+import static org.junit.Assert.assertEquals;
+
+public class WaterMarkFieldTest {
+
+    @Test
+    public void testSerialize() throws JsonProcessingException {
+        WatermarkField waterMarkField = new WatermarkField(new FieldInfo("ts", new TimestampFormatInfo()),
+                new ConstantParam("10"), new TimeUnitConstantParam(TimeUnit.HOUR));
+        ObjectMapper objectMapper = new ObjectMapper();
+        String expected = "{\"type\":\"watermark\",\"timeAttr\":{\"type\":\"base\",\"name\":\"ts\","
+                + "\"formatInfo\":{\"type\":\"timestamp\",\"format\":\"yyyy-MM-dd HH:mm:ss\"}},"
+                + "\"interval\":{\"type\":\"constant\",\"value\":\"10\"},"
+                + "\"timeUnit\":{\"type\":\"timeUnitConstant\",\"timeUnit\":\"HOUR\",\"value\":\"HOUR\"}}";
+        assertEquals(expected, objectMapper.writeValueAsString(waterMarkField));
+    }
+
+    @Test
+    public void testDeserialize() throws JsonProcessingException {
+        WatermarkField waterMarkField = new WatermarkField(new FieldInfo("ts", new TimestampFormatInfo()),
+                new ConstantParam("10"), new TimeUnitConstantParam(TimeUnit.HOUR));
+        ObjectMapper objectMapper = new ObjectMapper();
+        String str = "{\"type\":\"watermark\",\"timeAttr\":{\"type\":\"base\",\"name\":\"ts\","
+                + "\"formatInfo\":{\"type\":\"timestamp\",\"format\":\"yyyy-MM-dd HH:mm:ss\"}},"
+                + "\"interval\":{\"type\":\"constant\",\"value\":\"10\"},\"timeUnit\":{\"type\":"
+                + "\"timeUnitConstant\"," + "\"timeUnit\":\"HOUR\",\"value\":\"HOUR\"}}";
+        WatermarkField expected = objectMapper.readValue(str, WatermarkField.class);
+        assertEquals(expected, waterMarkField);
+    }
+
+}