文档

配置自定义Topic数据存储

更新时间:

通过数据存储的时序数据存储规则功能,可将指定的自定义Topic数据流转到时序数据存储空间进行存储。本文介绍如何通过配置时序存储规则,将自定义Topic数据存储到时序存储空间中。

前提条件

  • 当前实例为标准型或尊享型企业版实例,并已购买需要的时序数据存储IOPS和时序数据存储空间。具体操作,请参见购买企业版实例

  • 设备已添加自定义Topic。具体操作,请参见自定义Topic

使用场景

  • 如果需要存储自定义Topic数据用于查询,必须先创建时序数据存储规则。创建规则后,如果需要将其他自定义Topic数据写入时序存储,可以在控制台中修改时序数据存储规则,或者调用WriteDevicesHotStorageData

  • 如果需要长时间存储自定义Topic数据、降低存储成本、进一步处理自定义Topic数据例如数据分析数据报表数据API,可以开启数据备份,会自动在离线存储中创建相应的自定义存储表,表名称的格式为时序存储规则${规则ID}-随机ID。关闭后再打开数据备份,会继续写入已创建的自定义存储表。

创建时序数据存储规则

说明

每个实例下最多创建1000个时序数据存储规则。

  1. 登录物联网平台控制台

  2. 实例概览页面,找到对应的企业版实例,单击实例进入实例详情页面。

  3. 在左侧导航栏,选择数据服务 > 数据存储

  4. 时序存储页签下的存储规则页签,单击创建规则

  5. 在配置向导页面,完成以下操作。

步骤一:配置基本信息

  1. 输入规则名称和规则描述。

    参数

    描述

    规则名称

    输入规则名称。支持中文、英文字母、日文、数字、下划线(_)和短划线(-),长度为1~30个字符,一个中文或日文占2个字符。

    规则描述

    规则描述信息。

  2. 单击下一步。如果单击取消,规则也已创建成功,可在存储规则列表查看已添加的存储规则,再配置数据源Topic和数据处理脚本。具体操作,请参见查看和更新时序数据存储规则

步骤二:添加数据源Topic

说明

每个规则下最多添加1,000个Topic。

  1. 添加数据源Topic向导页面,单击添加Topic

  2. 在弹出的对话框中,根据页面提示,选择产品、设备和自定义Topic。Topic支持以下通配符:

    • 全部设备(+):指定产品下所有设备。

    • user/#:指定设备的所有自定义Topic。

      image.png

  3. 单击确定

    添加自定义Topic成功后,数据源Topic列表显示已添加的Topic信息。

    重要

    已添加自定义Topic不支持修改,您可先删除,然后重新添加。

    image

  4. (可选)重复以上步骤,可添加多个数据源Topic。

  5. 单击下一步。如果单击取消,可在规则详情页面,查看已添加的数据源Topic列表。具体操作,请参见查看和更新时序数据存储规则

步骤三:编辑数据处理脚本

  1. 编辑数据处理脚本向导页面的编辑脚本输入框中输入脚本,该脚本会解析自定义Topic数据,然后将解析结果存储到时序存储中。

    重要

    同一时序数据存储规则下,同一字段Key和Value的数据类型必须保持不变。若发生改变(例如:int32类型改为text类型),则新数据的写入会失败,且无法再查询历史存储数据。

  2. 单击页面下方的保存,完成脚本编辑。

  3. 单击页面下方的调试。此时也会自动保存脚本草稿。

  4. 在右侧调试面板,根据页面提示,选择产品和设备,输入Topic和Payload数据,单击调试,验证脚本。

    输入的TopicPayload数据,与脚本解析逻辑相符即可。脚本编辑方法和示例,请参见脚本语法image

    运行结果中会显示脚本中声明的变量值和执行的数据存储函数。image

  5. 单击调试面板的关闭

  6. (可选)单击页面下方的发布。此时还可以编辑、重新调试或发布脚本。

  7. 单击完成并发布。此时会关闭配置向导页面,完成规则的所有的配置。

  8. 返回时序存储>规则存储页签,单击规则对应的启动。规则启动后,设备上报的自定义Topic数据即可按照解析脚本进行存储。

查看和更新时序数据存储规则

  1. 时序存储页签下的存储规则页签下, 找到对应的存储规则,单击对应操作列的查看

  2. 规则详情页面,查看规则信息,包括规则ID、创建时间、数据源Topic数量及列表、数据处理脚本信息等。

  3. 按照以下操作步骤,查看和更新规则。

编辑规则基本信息

  1. 单击右上角编辑

  2. 编辑规则对话框,修改规则名称规则描述

更新数据源Topic

数据源Topic页签:

  • 单击添加Topic,参考上文步骤二:添加数据源Topic,新增更多数据源Topic。

  • 在Topic列表中,单击目标Topic操作列的删除,会从数据源Topic列表删除对应Topic。

更新数据处理脚本

  1. 单击数据处理脚本页签。

  2. 在编辑脚本输入框上方,单击编辑草稿

  3. 在编辑脚本输入框中,修改脚本。

  4. 依次单击页面下方保存调试发布,完成脚本更新。

可选操作

时序存储>规则存储页签:

  • 停止:单击操作列的停止。停止成功后,对应自定义Topic数据不再存入时序数据存储空间。

  • 删除:单击操作列的删除。必须先停止规则,然后才能删除规则。

  • 数据备份:打开数据备份列的开关,会将时序存储中的自定义Topic数据写入自定义存储表,可用于数据分析数据报表数据API等功能。

    如果需要关闭数据备份,关闭前,不可以删除存储自定义Topic数据的自定义存储表。您需要在关闭数据备份后,才能删除对应的自定义存储表。