You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@iotdb.apache.org by "JackieTien97 (via GitHub)" <gi...@apache.org> on 2024/02/01 07:24:22 UTC

Re: [PR] Introduce UDAF(User-Defined Aggregation Functions) [iotdb]

JackieTien97 commented on code in PR #12005:
URL: https://github.com/apache/iotdb/pull/12005#discussion_r1473870500


##########
iotdb-api/udf-api/src/main/java/org/apache/iotdb/udf/api/UDAF.java:
##########
@@ -0,0 +1,70 @@
+/*
+ * 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.iotdb.udf.api;
+
+import org.apache.iotdb.tsfile.read.common.block.column.Column;
+import org.apache.iotdb.tsfile.utils.BitMap;
+import org.apache.iotdb.udf.api.customizer.config.UDAFConfigurations;
+import org.apache.iotdb.udf.api.customizer.parameter.UDFParameters;
+import org.apache.iotdb.udf.api.utils.ResultValue;
+
+public interface UDAF extends UDF {
+  void beforeStart(UDFParameters parameters, UDAFConfigurations configurations);
+
+  /** Create and initialize state. You may bind some resource in this method. */
+  State createState();
+
+  /**
+   * Batch update state with data columns. You shall iterate columns and update state with raw
+   * values
+   *
+   * @param state state to be updated
+   * @param column input columns from IoTDB TsBlock

Review Comment:
   Should remind users that column[0] will always be TimeColumn, the remaining Columns will be their parameter value column.



##########
iotdb-api/udf-api/src/main/java/org/apache/iotdb/udf/api/customizer/config/UDAFConfigurations.java:
##########
@@ -0,0 +1,38 @@
+/*
+ * 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.iotdb.udf.api.customizer.config;
+
+import org.apache.iotdb.udf.api.type.Type;
+
+import java.time.ZoneId;
+
+public class UDAFConfigurations extends UDFConfigurations {
+
+  protected final ZoneId zoneId;

Review Comment:
   ```suggestion
   ```
   If we don't use this field now, we should remove it.



##########
iotdb-api/udf-api/src/main/java/org/apache/iotdb/udf/api/UDAF.java:
##########
@@ -0,0 +1,70 @@
+/*
+ * 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.iotdb.udf.api;
+
+import org.apache.iotdb.tsfile.read.common.block.column.Column;
+import org.apache.iotdb.tsfile.utils.BitMap;
+import org.apache.iotdb.udf.api.customizer.config.UDAFConfigurations;
+import org.apache.iotdb.udf.api.customizer.parameter.UDFParameters;
+import org.apache.iotdb.udf.api.utils.ResultValue;
+
+public interface UDAF extends UDF {
+  void beforeStart(UDFParameters parameters, UDAFConfigurations configurations);
+
+  /** Create and initialize state. You may bind some resource in this method. */
+  State createState();
+
+  /**
+   * Batch update state with data columns. You shall iterate columns and update state with raw
+   * values
+   *
+   * @param state state to be updated
+   * @param column input columns from IoTDB TsBlock
+   * @param bitMap define some filtered position in columns
+   */
+  void addInput(State state, Column[] column, BitMap bitMap);

Review Comment:
   ```suggestion
     void addInput(State state, Column[] columns, BitMap bitMap);
   ```



##########
iotdb-core/datanode/src/main/java/org/apache/iotdb/db/queryengine/execution/operator/AggregationUtil.java:
##########
@@ -58,6 +60,9 @@ public class AggregationUtil {
 
   private static final String PARTIAL_SUFFIX = "_partial";
 
+  private static final List<String> builtinAggregationNames =

Review Comment:
   Use `BuiltinAggregationFunction.NATIVE_FUNCTION_NAMES` instead.



##########
iotdb-core/datanode/src/main/java/org/apache/iotdb/db/queryengine/plan/planner/plan/parameter/AggregationDescriptor.java:
##########
@@ -63,18 +64,29 @@ public class AggregationDescriptor {
 
   protected String parametersString;
 
+  private List<String> builtinAggregationNames;
+

Review Comment:
   ```suggestion
   ```
   
   never used.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@iotdb.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org