Connect IoT - 数据库驱动程序#

数据库驱动程序的目的是允许与数据库服务器通信（在这个版本中只有MSSQL可用）。

它负责根据驱动程序定义动态创建必要的SQL查询，以执行命令或处理事件。

数据类型#

这些是受支持的特定数据类型：

异常流程参数#

异常流程支持以下参数：

事件#

为了处理事件，数据库驱动程序会创建一个查询，该查询将轮询数据库（触发查询），并在发现更改时执行另一个查询来检索所需的数据（结果查询）。

触发查询和结果查询都是根据驱动程序定义上的配置构建的：

事件属性#

事件属性表示将作为结果检索的表列。属性和数据库列之间的关联可按如下所示进行指定：

事件示例#

示例1：订阅ROW_NUMBER事件

事件配置：

table: [Table01], argument: "Column01", pollingInterval: 1000, triggerType: "OnNewRows", trigger: "RowNumber", resultDataFormat: "AllNew", maxRowsToProcess: 2, orderByColumn: "Column01", orderByType: "DESC", processingMode: "FireAndForget", ignoreInitialValues: true

事件属性配置：

name: "EventPropName", deviceId: "EventPropID", columnName: "Column02"

在此示例中，将每秒执行一次的触发器查询(pollingInterval: 1000)如下：

Select TOP 1 ROW_NUMBER() OVER(ORDER BY Column01) as Column01 from [Table01] order by Column01 DESC

它将检索Column02的所有新值（在事件属性上指定）。请注意，maxRowsToProcess设置为2，因此如果结果超过2行，事件将被引发多次，每个事件只返回2行。此外，这是一个FireAndForget事件，这意味着引发事件后，无需任何回复即可继续轮询。

结果示例：

EventPropName value:
[
    {"Column02": "Value01"},
  {"Column02": "Value02"}
]

示例2：订阅COUNT事件

事件配置：

table: [Table01], argument: "Column01", pollingInterval: 1000, triggerType: "OnNewRows", trigger: "Count", resultDataFormat: "SingleRow", orderByColumn: "Column01" , orderByType: "DESC", processingTimeout: 3000, maxRetries: 3, processingMode: "ContinueOnProcessingConfirmation", ignoreInitialValues: false

事件属性配置：

name: "EventPropName01", deviceId: "EventPropID01", columnName: "Column01"

name: "EventPropName02", deviceId: "EventPropID02", columnName: "Column02"

在此示例中，将每秒执行一次的触发器查询(pollingInterval: 1000)如下：

Select TOP 1 Count(Column01) as Column01 from [Table01]

在这种情况下，Column01和Column02值（作为SingleRow）都将在事件上发送（因为它在事件属性配置中指定）。

引发事件后，驱动程序将等待确认回复(processingMode: "ContinueOnProcessingConfirmation")。要回复事件，我们需要执行ConfirmationDataProcessing类型的命令。如果在配置的(processingTimeout: 3000)时间内未收到回复，则事件将被再次发送（直到达到maxRetries中定义的最大次数）。之后，事件数据将丢失，轮询过程将再次启动。

如果ignoreInitialValues设置为false且相应表中存在值，则会立即触发事件。

结果示例：

EventPropName01 value:
{"Column01": 000100}

EventPropName02 value:
{"Column02": "Value01"}

示例3：订阅FIELD事件

事件配置：

table: [Table01], argument: "Column01", pollingInterval: 1000, triggerType: "OnNewRows", trigger: "Field", resultDataFormat: "SingleRow", orderByColumn: "Column01", orderByType: "DESC", processingMode: "FireAndForget", ignoreInitialValues: true

事件属性配置：

name: "EventPropName01", deviceId: "EventPropID01", columnName: "Column01"

name: "EventPropName02", deviceId: "EventPropID02", columnName: "Column02"

在此示例中，将每秒执行一次的触发器查询(pollingInterval: 1000)如下：

Select TOP 1 Column02 from Table01 order by Column02 DESC

在这种情况下，Column01和Column02值（作为SingleRow）都将在事件上发送（因为它在事件属性配置中指定）。

结果示例：

EventPropName01 value:
{"Column01": "Value01"}

EventPropName02 value:
{"Column02": 20200920}

命令#

命令是将在数据库上执行的SQL查询。

命令参数#

命令参数表示命令的输入，可以根据以下信息进行配置：

备注/行为#

• 如果命令类型为Select且未定义任何参数值，则将检索所有列。

• 对于命令类型Select，可以使用函数（如COUNT()、ROW_NUMBER())、MAX()等）。在这种情况下，必须为特定参数值在columnName上设置相应函数。

  • 示例：如果将columnName设置为Count(column01) as Quantity，则查询将为 Select Count(column01) as Quantity From table01

• ParameterValue有一个默认值，当没有为命令提供其他值时，将使用该值。

命令示例#

示例1： 执行Select命令

命令配置：

type: "Select" , argument: "[Table01]", operation: "None", resultType: "ArrayOfResults"

命令参数配置：

name: "ParamValue", type: "ParameterValue", columnName: "Column01", operation: "None"

name: "ParamQuery", type: "ParameterQuery", columnName: "Column02", operation: "Equal"

执行命令时，必须提供parameterQuery的值（本示例中为10），将执行的查询如下所示：

Select Column01 From [Table01] Where Column02 = 10

由于该命令的resultType被定义为ArrayOfResults，因此查询结果将以数组的形式返回：

[
    {"Column01":"Value01"},
    {"Column01":"Value02"},
    {"Column01":"Value03"}
]

示例2：执行Update命令

命令配置：

type: "Update" , argument: "[Table01]", operation: "AND", resultType: "SingleRow"

命令参数配置：

name: "ParamValue01", type: "ParameterValue", columnName: "Column01", operation: "None"

name: "ParamQuery01", type: "ParameterQuery", columnName: "Column01", operation: "Equal"

name: "ParamQuery02", type: "ParameterQuery", columnName: "Column02", operation: "GreaterThanOrEqualTo"

在此示例中，我们需要在命令执行时提供所有3个参数。假设值为ParamValue01 = false, ParamQuery01 = true, ParamQuery02 = 20，我们将执行以下查询：

Update [Table01] Set Column01 = false Where Column01 = true AND Column02 >= 20

驱动程序扩展#

此异常流程驱动程序提供了一组扩展，允许自定义执行独立于关联的驱动程序定义的操作。这意味着您可以使用自定义项执行命令，甚至注册/侦听事件，而无需对其进行描述。

• 这在访问共享的设备数据或者由于过于复杂而无法使用常规机制访问的设备数据时特别有用。在需要访问命名约定可能因设备而异的数据时也很有用。
• 要使用这些扩展，您可以实施自己的任务，也可以使用提供的任务Send Notification to Driver和Subscribe in Driver。

对象#

对象是作为参数传递的结构。

事件#

属性#

RegisterHandler#

UnregisterHandler#

方法#

注册事件#

通知异常流程驱动程序在特定事件发生时引发该事件。

void connect.iot.driver.database.registerEvent(data: RegisterHandler)

示例#

{
    type:"connect.iot.driver.database.registerEvent",
    content: {
        name: "CustomEvent",
        isEnabled: true,
        extendedData: {
         table: tableName,
         argument: "ColumnName",
         pollingInterval: 1000,
         triggerType: "OnNewRows",
         trigger: "RowNumber",
         resultDataFormat: "AllNew",
      processingTimeout: 3000,
         maxRetries: 3,
         maxRowsToProcess: 2,
         orderByColumn: "ColumnName",
         orderByType: "DESC",
         processingMode: "FireAndForget",
         ignoreInitialValues: true,
         rawResultQuery: ""
     },
        properties: {
            name: "PropertyName",
            deviceId: "PropertyID",
            dataType: "String",
            deviceType: "NVARCHAR",
            extendedData: {
                columnName: "ColumnName"
            }
        }
    }
}

注销事件#

通知异常流程驱动程序在发生特定事件时停止引发事件。

void connect.iot.driver.database.unregisterEvent(data: UnregisterHandler)

示例#

{
  type:"connect.iot.driver.database.registerEvent",
    content: {
        name: "CustomEvent",
    }
}

发送命令#

向要执行的驱动程序发送命令

void connect.iot.driver.database.executeCommand(data: ExecuteCommandHandler)

示例#

{
    type: "connect.iot.driver.database.executeCommand",
    content: {
        command: {
            name: "SelectCustomCommand",
            deviceId: "SelectCustomCommandID",
            extendedData: {
                type: "Select",
                argument: "Table01",
                operation: "None",
                resultType: "ArrayOfResults"
            },
            parameters: [
                {
                    name: "ParamName", deviceId: "ParamID", dataType: "String", deviceType: "NVARCHAR",      extendedData: { type: "ParameterValue", columnName: "ColumnName", operation: "None" }
                }
            ]
        },
        parameters: { "ParamName": "Value"}
    }
}