createSessionWindowEngine

createSessionWindowEngine(name, sessionGap, metrics, dummyTable, outputTable, [timeColumn], [useSystemTime=false], [keyColumn], [updateTime], [useSessionStartTime=true], [snapshotDir], [snapshotIntervalInMsgCount], [raftGroup], [forceTriggerTime])

创建流数据会话窗口引擎。

createSessionWindowEngine 的参数绝大多数与 createTimeSeriesEngine 一样，只有 sessionGap 和 useSessionStartTime 是它独有的参数。sessionGap 决定了一个会话窗口何时结束，useSessionStartTime 决定了输出表时间列的时间为各个窗口的起始时刻还是结束时刻。

更多流数据引擎的应用场景说明可以参考 流计算引擎。

自 2.00.11 版本开始，dummyTable 和 outputTable 支持 array vector，但不支持在计算中使用 array vector，即 metrics 中不能包含 array vector 列。

若某条数据之后，经过 sessionGap 指定的时间长度内，没有新数据到来，就进行一次窗口截断（以截断前最后一条数据的时间戳 + sessionGap 作为窗口的结束时刻）。窗口结束后新到来的一条数据将触发该窗口的计算。

由于会话窗口引擎的绝大多数参数与时间序列引擎重合，请参照 createTimeSeriesEngine 中参数介绍。这里仅介绍与时间序列引擎不同的参数：

sessionGap 必选参数，正整数标量，是判断窗口结束的时间指标，表示某条数据到来后若等待该时间仍无更新的数据到来，就终止当前窗口。此参数的时间精度取决于 useSystemTime 参数。

useSessionStartTime: 可选参数，布尔值，默认值为 true，表示输出表中的时刻是否为数据窗口起始时刻，即每个窗口中第一条数据的时间戳。若设置为 false，则表示输出表中的时刻为数据窗口结束时刻，即每个窗口中最后一条数据的时刻+ sessionGap。如果指定 updateTime ，useSessionStartTime 必须为 true。

forceTriggerTime 可选参数，非负整数，单位与 timeColumn 的时间精度一致。该参数仅在设置 useSystemTime = false 时起效。当系统收到最后一条数据后，经过 forceTriggerTime 时间，将强制触发未计算的窗口进行计算。

返回一个表对象。

例1. 下例展示按股票代码计算交易量：通过 createSessionWindowEngine 函数创建了一个表 engine_sw，然后通过订阅流数据表 trades 把数据写入到 engine_sw 中，按照 sym 列进行分组聚合运算，并把结果保存在表 output1 中。

share streamTable(1000:0, `time`sym`volume, [TIMESTAMP, SYMBOL, INT]) as trades
share table(10000:0, `time`sym`sumVolume, [TIMESTAMP, SYMBOL, INT]) as output1
engine_sw = createSessionWindowEngine(name = "engine_sw", sessionGap = 5, metrics = <sum(volume)>, dummyTable = trades, outputTable = output1, timeColumn = `time, keyColumn=`sym)
subscribeTable(tableName="trades", actionName="append_engine_sw", offset=0, handler=append!{engine_sw}, msgAsTable=true)

n = 5
timev = 2018.10.12T10:01:00.000 + (1..n)
symv=take(`A`B`C,n)
volumev = (1..n)%1000
insert into trades values(timev, symv, volumev)

n = 5
timev = 2018.10.12T10:01:00.010 + (1..n)
volumev = (1..n)%1000
symv=take(`A`B`C,n)
insert into trades values(timev, symv, volumev)

n = 6
timev = 2018.10.12T10:01:00.020 + 1 2 3 8 14 20
volumev = (1..n)%1000
symv=take(`A`B`C,n)
insert into trades values(timev, symv, volumev)

select * from output1;

输出返回：

指定 forceTriggerTime 为 1000 ms，收到最后一条消息后，经过 1000 ms，触发所有分组数据计算输出。用以下代码替换上述引擎创建部分的代码。

engine_sw = createSessionWindowEngine(name = "engine_sw", sessionGap = 5, metrics = <sum(volume)>, dummyTable = trades, outputTable = output1, timeColumn = `time, keyColumn=`sym, forceTriggerTime=1000)

再次查询输出表，可以得到以下结果：

例2. 下例简单展示使用该引擎捕捉传感器最后状态，通过设置 useSessionStartTime=false 输出每个会话窗口的结束时刻（最后数据时间+sessionGap）。

// 创建传感器数据流表
share streamTable(1000:0, `time`sensor`status, [TIMESTAMP, SYMBOL, INT]) as sensors
share table(10000:0, `time`sensor`lastStatus, [TIMESTAMP, SYMBOL, INT]) as output2

// 创建引擎（使用结束时刻）
engine_sw = createSessionWindowEngine(name = "sensor_engine", sessionGap = 5,
    metrics = <last(status)>, dummyTable = sensors,
    outputTable = output2, timeColumn = `time, keyColumn=`sensor,
    useSessionStartTime=false)
subscribeTable(tableName="sensors", actionName="sensor_monitor", 
    offset=0, handler=append!{engine_sw}, msgAsTable=true)

// 插入传感器数据
n = 5
timev = 2023.01.01T10:00:00.000 + (1..n)
sensorv = take(`SENSOR001`SENSOR002`SENSOR003, n)
statusv = rand(0..2, n)  // 0=离线, 1=正常, 2=故障
insert into sensors values(timev, sensorv, statusv)

n = 5
timev = 2023.01.01T10:00:00.010 + (1..n)
statusv = rand(0..2, n)
sensorv = take(`SENSOR001`SENSOR002`SENSOR003, n)
insert into sensors values(timev, sensorv, statusv)

n = 6
timev = 2023.01.01T10:00:00.020 + 1 2 3 8 14 20
statusv = rand(0..2, n)
sensorv = take(`SENSOR001`SENSOR002`SENSOR003, n)
insert into sensors values(timev, sensorv, statusv)

select * from output2;
// Output:
print(output2)
time                    sensor    lastStatus
----------------------- --------- ----------
2023.01.01T10:00:00.008 SENSOR003 0         
2023.01.01T10:00:00.009 SENSOR001 2         
2023.01.01T10:00:00.010 SENSOR002 1         
2023.01.01T10:00:00.018 SENSOR003 1         
2023.01.01T10:00:00.019 SENSOR001 2         
2023.01.01T10:00:00.020 SENSOR002 1         
2023.01.01T10:00:00.026 SENSOR001 2         
2023.01.01T10:00:00.027 SENSOR002 0         
2023.01.01T10:00:00.028 SENSOR003 1