Merge pull request #20959 from taosdata/enh/TS-3149

enh: add param for to_unixtimestamp to return timestamp type

docs/en/12-taos-sql/10-function.md

@@ -459,12 +459,17 @@ TO_JSON(str_literal)
 #### TO_UNIXTIMESTAMP
 
 ```sql
-TO_UNIXTIMESTAMP(expr)
+TO_UNIXTIMESTAMP(expr [, return_timestamp])
+
+return_timestamp: {
+    0
+  | 1
+}
 ```
 
 **Description**: UNIX timestamp converted from a string of date/time format
 
-**Return value type**: BIGINT
+**Return value type**: BIGINT, TIMESTAMP
 
 **Applicable column types**: VARCHAR and NCHAR
 
@@ -476,6 +481,7 @@ TO_UNIXTIMESTAMP(expr)
 
 - The input string must be compatible with ISO8601/RFC3339 standard, NULL will be returned if the string can't be converted
 - The precision of the returned timestamp is same as the precision set for the current data base in use
+- return_timestamp indicates whether the returned value type is TIMESTAMP or not. If this parameter set to 1, function will return TIMESTAMP type. Otherwise function will return BIGINT type. If parameter is omitted, default return value type is BIGINT.
 
 
 ### Time and Date Functions

docs/zh/12-taos-sql/10-function.md

@@ -459,12 +459,17 @@ TO_JSON(str_literal)
 #### TO_UNIXTIMESTAMP
 
 ```sql
-TO_UNIXTIMESTAMP(expr)
+TO_UNIXTIMESTAMP(expr [, return_timestamp])
+
+return_timestamp: {
+    0
+  | 1
+}
 ```
 
 **功能说明**：将日期时间格式的字符串转换成为 UNIX 时间戳。
 
-**返回结果数据类型**：BIGINT。
+**返回结果数据类型**：BIGINT, TIMESTAMP。
 
 **应用字段**：VARCHAR, NCHAR。
 
@@ -476,6 +481,7 @@ TO_UNIXTIMESTAMP(expr)
 
 - 输入的日期时间字符串须符合 ISO8601/RFC3339 标准，无法转换的字符串格式将返回 NULL。
 - 返回的时间戳精度与当前 DATABASE 设置的时间精度一致。
+- return_timestamp 指定函数返回值是否为时间戳类型，设置为1时返回 TIMESTAMP 类型，设置为0时返回 BIGINT 类型。如不指定缺省返回 BIGINT 类型。
 
 
 ### 时间和日期函数

source/libs/function/src/builtins.c

@@ -1933,14 +1933,35 @@ static int32_t translateToIso8601(SFunctionNode* pFunc, char* pErrBuf, int32_t l
 }
 
 static int32_t translateToUnixtimestamp(SFunctionNode* pFunc, char* pErrBuf, int32_t len) {
-  if (1 != LIST_LENGTH(pFunc->pParameterList)) {
+  int32_t numOfParams = LIST_LENGTH(pFunc->pParameterList);
+  int16_t resType = TSDB_DATA_TYPE_BIGINT;
+
+  if (1 != numOfParams && 2 != numOfParams) {
     return invaildFuncParaNumErrMsg(pErrBuf, len, pFunc->functionName);
   }
 
-  if (!IS_STR_DATA_TYPE(((SExprNode*)nodesListGetNode(pFunc->pParameterList, 0))->resType.type)) {
+  uint8_t para1Type = ((SExprNode*)nodesListGetNode(pFunc->pParameterList, 0))->resType.type;
+  if (!IS_STR_DATA_TYPE(para1Type)) {
     return invaildFuncParaTypeErrMsg(pErrBuf, len, pFunc->functionName);
   }
 
+  if (2 == numOfParams) {
+    uint8_t para2Type = ((SExprNode*)nodesListGetNode(pFunc->pParameterList, 1))->resType.type;
+    if (!IS_INTEGER_TYPE(para2Type)) {
+      return invaildFuncParaTypeErrMsg(pErrBuf, len, pFunc->functionName);
+    }
+
+    SValueNode* pValue = (SValueNode*)nodesListGetNode(pFunc->pParameterList, 1);
+    if (pValue->datum.i == 1) {
+      resType = TSDB_DATA_TYPE_TIMESTAMP;
+    } else if (pValue->datum.i == 0) {
+      resType = TSDB_DATA_TYPE_BIGINT;
+    } else {
+      return buildFuncErrMsg(pErrBuf, len, TSDB_CODE_FUNC_FUNTION_ERROR,
+                             "TO_UNIXTIMESTAMP function second parameter should be 0/1");
+    }
+  }
+
   // add database precision as param
   uint8_t dbPrec = pFunc->node.resType.precision;
   int32_t code = addDbPrecisonParam(&pFunc->pParameterList, dbPrec);
@@ -1948,7 +1969,7 @@ static int32_t translateToUnixtimestamp(SFunctionNode* pFunc, char* pErrBuf, int
     return code;
   }
 
-  pFunc->node.resType = (SDataType){.bytes = tDataTypes[TSDB_DATA_TYPE_BIGINT].bytes, .type = TSDB_DATA_TYPE_BIGINT};
+  pFunc->node.resType = (SDataType){.bytes = tDataTypes[resType].bytes, .type = resType};
   return TSDB_CODE_SUCCESS;
 }
 

source/libs/scalar/src/sclfunc.c

@@ -1124,7 +1124,8 @@ _end:
 int32_t toUnixtimestampFunction(SScalarParam *pInput, int32_t inputNum, SScalarParam *pOutput) {
   int32_t type = GET_PARAM_TYPE(pInput);
   int64_t timePrec;
-  GET_TYPED_DATA(timePrec, int64_t, GET_PARAM_TYPE(&pInput[1]), pInput[1].columnData->pData);
+  int32_t idx = (inputNum == 2) ? 1 : 2;
+  GET_TYPED_DATA(timePrec, int64_t, GET_PARAM_TYPE(&pInput[idx]), pInput[idx].columnData->pData);
 
   for (int32_t i = 0; i < pInput[0].numOfRows; ++i) {
     if (colDataIsNull_s(pInput[0].columnData, i)) {

tests/system-test/2-query/To_unixtimestamp.py

@@ -26,7 +26,7 @@ class TDTestCase:
             'c1':'int',
             'c2':'float',
             'c3':'binary(20)'
-            
+
         }
         # structure of tag
         self.tag_dict = {
@@ -60,7 +60,7 @@ class TDTestCase:
             if tb_type == 'ntb' or tb_type == 'ctb':
                 tdSql.checkRows(len(values_list))
             elif tb_type == 'stb':
-                tdSql.checkRows(len(self.values_list)*tb_num)    
+                tdSql.checkRows(len(self.values_list)*tb_num)
         for time in ['2020-01-32T08:00:00','2020-13-32T08:00:00','acd']:
             tdSql.query(f"select to_unixtimestamp('{time}') from {tbname}")
             if tb_type == 'ntb' or tb_type == 'ctb':
@@ -74,7 +74,7 @@ class TDTestCase:
             if tb_type == 'ntb' or tb_type == 'ctb':
                 tdSql.checkRows(len(values_list))
             elif tb_type == 'stb':
-                tdSql.checkRows(len(values_list)*tb_num)    
+                tdSql.checkRows(len(values_list)*tb_num)
         for time in self.error_param:
             tdSql.error(f"select to_unixtimestamp({time}) from {tbname}")
     def timestamp_change_check_ntb(self):
@@ -95,9 +95,20 @@ class TDTestCase:
             self.data_check(f'{self.stbname}_{i}',self.values_list,'ctb')
         self.data_check(self.stbname,self.values_list,'stb',self.tbnum)
         tdSql.execute(f'drop database {self.dbname}')
+    def timestamp_change_return_type(self):
+        tdSql.query(f"select to_unixtimestamp('1970-01-01 08:00:00+08:00', 0);")
+        tdSql.checkEqual(tdSql.queryResult[0][0], 0)
+        tdSql.query(f"select to_unixtimestamp('1970-01-01 00:00:00', 1);")
+        tdSql.checkData(0, 0, '1970-01-01 00:00:00')
+        tdSql.error(f"select to_unixtimestamp('1970-01-01 08:00:00+08:00', 2);")
+        tdSql.error(f"select to_unixtimestamp('1970-01-01 08:00:00+08:00', 1.5);")
+        tdSql.error(f"select to_unixtimestamp('1970-01-01 08:00:00+08:00', 'abc');")
+        tdSql.error(f"select to_unixtimestamp('1970-01-01 08:00:00+08:00', true);")
+        tdSql.error(f"select to_unixtimestamp('1970-01-01 08:00:00+08:00', 1, 3);")
     def run(self):  # sourcery skip: extract-duplicate-method
         self.timestamp_change_check_ntb()
         self.timestamp_change_check_stb()
+        self.timestamp_change_return_type()
     def stop(self):
         tdSql.close()
         tdLog.success(f"{__file__} successfully executed")