函数列表

表达式

说明

toBoolean(Object)

Object值转换为Boolean值。参数支持以下类型的取值：

• Boolean：返回对应的布尔值。

• Number：参数为0，返回false。否则，返回true。

• String：参数为"true"，返回true。否则，返回false。

• 参数值为null：返回false。

toNumber(Object)

Object值转换为Number值。参数支持以下类型的取值：

• Boolean：参数为true，返回1，参数为false，返回0。

• Number：返回对应的数值。

• String：按照数值类型解析。

• 参数值为null：返回0。

toString(Object)

Object值转换为String值。

参数值类型不限，返回对应String类型值。参数值为null，返回空字符。

当参数为二进制类型时，按照UTF-8编码返回对应值。

toMap(Object)

Object值转换为Map值。参数支持以下类型的取值：

• Map：返回对应的值。

• String：按照JSON格式解析为Map。

• 参数值为null：返回空Map。

toArray(Object)

Object值转换为Array值。参数支持以下类型的取值：

• Array：返回对应的值。

• String：按照JSON格式解析为Array。

• 参数值为null：返回空Array。

toBinary(Object)

Object值转换为二进制值。参数支持以下类型的取值：

• Binary：返回对应的值。

• String：按照UTF-8编码返回值。

• 参数值为null：返回空Binary。

函数表达式

说明

format_date(timestamp, patten, timeZone)

将时间戳毫秒值转换为指定格式的时间。返回String类型的时间。

• timestamp：时间戳毫秒值。

• patten：待转换的时间格式。例如yyyy-MM-dd HH:mm:ss。

• timeZone：时区。例如GMT、UTC、CST等。建议主动设置时区，若未设置，默认为北京时间（GMT+8）。

to_timestamp(dateString, patten, timeZone)

将指定格式的时间转换为时间戳毫秒值。返回数值类型的时间戳。

• dateString：时间字符串。

• patten：指定的时间格式。例如yyyy-MM-dd HH:mm:ss。

• timeZone：时区。例如GMT、UTC、CST等。建议主动设置时区，若未设置，默认为北京时间（GMT+8）。

函数表达式

说明

示例

writeAmqp(destinationId, payload, tag)

流转数据到AMQP消费组。

tag：可选参数。设置tag后，所有通过该操作流转到AMQP服务端订阅消费组里的消息都会携带该tag。

数据转发到AMQP服务端订阅消费组消费

writeDatahub(destinationId, data)

流转数据到DataHub。

data：写入DataHub的数据。仅支持Map和Binary类型数据。

数据转发到DataHub

writeFc(destinationId, data)

流转数据到函数计算（FC）。

data：流转到FC的数据。

数据转发到函数计算（FC）

writeKafka(destinationId, payload, key)

流转数据到消息对列Kafka。

key：可选参数，流转到Kafka Topic消息中携带的key。

您可以在Kafka消息消费端，通过标签进行消息路由。

数据转发到消息队列Kafka

writeMns(destinationId, payload)

流转数据到轻量消息队列（原 MNS） SMQ（Simple Message Queue (formerly MNS)）。

数据转发到消息服务（MNS）

writeMq(destinationId, payload, tag)

流转数据到消息队列（RocketMQ）。

tag：可选参数。设置标签后，所有通过该操作流转到RocketMQ对应Topic里的消息都会携带该标签。您可以在RocketMQ消息消费端，通过标签进行消息过滤。

数据转发到消息队列RocketMQ

writeTableStore(destinationId, data，flowType)

流转数据到表格存储（Tablestore）宽表模型。

• data：写入表格存储的数据。仅支持Map类型数据，其中键（Key）值对应表格列名，值（Value）对应列值。

  data中必须包含Tablestore的主键。

• flowType：可选参数。设置非主键字段的数据类型。

  • flowType为true时，非主键字段都按照String数据类型流转到Tablestore中。

  • flowType为false或不传入时，非主键字段按照对应值的数据类型流转到Tablestore中。

数据转发到表格存储（Tablestore）宽表模型

writeTableStoreTs(destinationId, timeInUs, metricName, tags, fields, dataSource)

流转数据到表格存储（Tablestore）时序模型。

• timeInUs：时间戳，表示该数据记录对应的生成时间。单位为微秒。整型数据。

• metricName：时间线数据所度量的物理量或者监控指标的名称。字符串类型数据。

• tags：时间线的标签信息。Map类型数据。标签的key和value为字符串类型数据。

• fields：时间线数据。Map类型数据。在一个时间点上可以设置多个数据值。每个值对应数据库中的一列，包括列名和列值。

  列名为字符串类型数据；列值可为布尔型、整型、浮点型、字符串类型和二进制类型的数据。

• dataSource：产生时间线的数据源标识，字符串类型数据。仅该参数可以为空。

该函数表达式是单行写入数据至Tablestore，您可使用下面表达式，写入多行数据：

writeTableStoreTs(destinationId, [
    {
        "timeInUs": timestamp() * 1000,
        "metricName": "name1",
        "tags":{},
        "fields":{},
        "dataSource": ""
    },
    {
        "timeInUs": timestamp() * 1000,
        "metricName": "name2",
        "tags":{},
        "fields":{},
        "dataSource": ""
    }
]);

参数的更多说明，请参见时序模型介绍。

数据转发到表格存储（Tablestore）时序模型

writeRds(destinationId, data)

流转数据到云数据库RDS，新增数据到云数据库表。

data：写入云数据库表的数据。仅支持Map类型数据，其中键（Key）值对应数据库表列名，值（Value）对应列值。

数据转发到云数据库RDS

updateRds(destinationId, data, condition, limit)

流转数据到云数据库RDS，更新已写入云数据库表中的数据。

• data：更新写入云数据库表的数据。仅支持Map类型数据，其中键（Key）值对应数据库表列名，值（Value）对应列值。

• condition：更新数据的条件，不可空。仅支持String类型，作为SQL语句的WHERE条件。例如：a = 3 and b = 3。

• limit：更新数据的限制行数，可为空。默认为1行，最大值为50。

例如：

• 如果满足condition的有多行数据，默认从SQL返回结果的第一行数据开始更新。limit为1，更新第一行数据。limit为10，更新第一行至第10行数据。

• 如果满足condition的仅一行数据，则仅更新一行数据。

writeTsdb(destinationId, timestamp, metricName, value, tag)

流转数据到时序数据库（TSDB）中。

• timestamp：时间戳。

• metricName：TSDB中存储的指标名称。

• value：TSDB中存储的数据点值。支持String和Map类型数据。

• tag：设置标记数据的标签键值对，Map类型数据。

数据转发到时序数据库（TSDB）

writeIotTopic(destinationId, topic, payload, deviceName)

流转数据到另一个Topic。

• Topic：数据转发目的地Topic，支持以下Topic。

  • 自定义Topic：该自定义Topic的设备操作权限需为订阅，即所属设备可订阅这个Topic，获取转发的消息。

  • 物模型数据下发Topic：/sys/${productKey}/${deviceName}/thing/service/property/set。该Topic为设备接收设置属性值指令的Topic，设备从该Topic接收转发数据，并根据数据内容，设置属性值。用于目的地Topic所属设备根据转发的数据更改属性值的场景。

  Topic中${productKey}必须与destinationId对应数据目的中设置的产品相同。函数中Topic必须指定具体Topic，不支持使用通配符。

  更多信息，请参见步骤一：创建数据目的。

  重要

  目的地Topic所属设备若未订阅该Topic，则收不到转发的消息。

  例如使用MQTT.fx工具接入物联网平台的设备A，不会自动订阅设备Topic，若设备B向设备A的Topic：thing/service/property/set转发数据，而设备A未手动订阅该Topic，则设备A收不到设备B转发的消息。

  设备Topic自动订阅的详细说明，请参见自动订阅Topic说明。

• deviceName：对于开源MQTT托管形态下产品和设备，及MQTT云网关产品和设备，流转数据到另一个Topic时，需传入该参数。其他业务场景不可以传入该参数。

  数据格式为Map类型，Key为"deviceName"，Value为deviceName()，表示发送该Topic消息的设备名称。

  更多说明，请参见消息通信说明。

数据转发到其他Topic

writeLindorm(destinationId, timestamp, tags, fields)

流转数据到时序数据库（Lindorm）。

• timestamp：时间戳，表示该数据记录对应的生成时间。

• tags：标签，表示指标项针对的具体对象属性。一个标签由一个标签键（Key）和一个标签值（Value）组成。Map类型数据。

• fields：数据记录，一条数据记录可以有多个字段值，表示指标项的不同对象。支持Object数据类型。

数据转发到云原生多模数据库Lindorm

writePolarDB(destinationId, data)

流转数据到云原生数据库PolarDB MySQL版。

data：写入云数据库表的数据。仅支持Map类型数据，其中键（Key）值对应数据库表列名，值（Value）对应列值。

数据转发到云原生数据库PolarDB MySQL版

表达式

说明

endWith(input, suffix)

判断字符串input中是否以字符串suffix结尾。

返回结果类型为布尔型。

productKey()

返回当前产品的ProductKey值。

getDeviceTag(key)

返回key所对应的设备标签。如果设备没有该key对应的标签，则返回值为空。

getOrNull(data, "items", ......)

返回JSON格式数据data中指定字段的值。

该函数中传入的字段个数没有限制，但必须逐级传入。函数返回最后一个字段的值，若最后一个字段不存在或值为空，则函数返回值为null。

例如data中数据：

"items": {
    "Humidity": {
        "value": 25,
        "time": 1626948134319
    }
}

函数示例如下：

• getOrNull(data, "items")返回字段items值"Humidity": {"value": 25,"time": 1626948134319}。

• getOrNull(data, "items", "Humidity", "value")返回字段value值25。

• getOrNull(data, "items", "Temperature")，字段Temperature不存在，返回值null。

payload(textEncoding)

返回设备发布消息payload的转义数据。textEncoding表示payload的转义字符编码，取值如下：

• 不传入参数：默认按照UTF-8编码转换为字符串，即payload()等价于payload('utf-8')。

• 'json'：将payload数据转换成Map格式变量。如果payload不是JSON格式，则返回异常。

• 'binary'：将payload数据转换成二进制变量进行透传。

parseNumber(numberString, radix)

将字符串numberString按指定的进制radix转换为数字。

// 设备上报数据。
var content = '0xFF';
// 获取待转换字符串FF.
var x = content.substring(2);
// 将FF转换为16进制数字。
var value = parseNumber(x, 16);