dolphindb 2.0.949 → 2.0.951

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/docs.en.json +693 -596
  2. package/docs.zh.json +181 -139
  3. package/index.js +1 -1
  4. package/index.js.map +1 -1
  5. package/package.json +4 -4
package/docs.zh.json CHANGED
@@ -2562,7 +2562,13 @@
2562
2562
  {
2563
2563
  "type": "text",
2564
2564
  "value": [
2565
- "`engine` 是流数据 join 引擎，即 :doc:`../c/createAsofJoinEngine` 等函数返回的抽象表对象。目前支持流数据 asof join 引擎和流数据 equi join 引擎、流数据 window join 引擎和流数据 lookup join 引擎。",
2565
+ "`engine` 是流数据 join 引擎，即 :doc:`../c/createAsofJoinEngine` 等函数返回的抽象表对象。目前支持以下 join 引擎:",
2566
+ "",
2567
+ "* createAsofJoinEngine",
2568
+ "* createEquiJoinEngine",
2569
+ "* createLookupJoinEngine",
2570
+ "* createWindowJoinEngine",
2571
+ "* createLeftSemiJoinEngine",
2566
2572
  "",
2567
2573
  "`isLeftTable` 布尔类型，插入左表还是右表。",
2568
2574
  "",
@@ -2651,7 +2657,7 @@
2651
2657
  "",
2652
2658
  "`msgBody` 是将要写入流数据引擎的消息。",
2653
2659
  "",
2654
- "`msgId` 是写入数据之前，流数据引擎已接收到的的最后一条消息的ID。ID从订阅发布的第一条消息开始计数。"
2660
+ "`msgId` 是写入数据之前，流数据引擎已接收到的最后一条消息的ID。ID从订阅发布的第一条消息开始计数。"
2655
2661
  ]
2656
2662
  }
2657
2663
  ]
@@ -2870,9 +2876,7 @@
2870
2876
  {
2871
2877
  "type": "text",
2872
2878
  "value": [
2873
- "asFreq(X, rule, [closed], [label], [origin='start_day'])",
2874
- "",
2875
- "别名：asfreq"
2879
+ "asFreq(X, rule, [closed], [label], [origin='start_day'])"
2876
2880
  ]
2877
2881
  }
2878
2882
  ]
@@ -2921,9 +2925,9 @@
2921
2925
  "============ =================",
2922
2926
  "",
2923
2927
  ".. versionadded:: 2.00.9 ",
2924
- " 用户自定义交易日历",
2928
+ " 交易日历",
2925
2929
  "",
2926
- "`rule` 上述字符串亦可配合使用数字，例如 \"2M\" 表示频率为每两个月月末。此外，*rule* 也可指定为用户自定义交易日历的标识（配置参数 *marketHolidayDir* 指定目录下的文件名，系统将根据该交易日历进行计算）。",
2930
+ "`rule` 上述字符串亦可配合使用数字，例如 \"2M\" 表示频率为每两个月月末。除上述取值外，*rule* 也可指定交易日历的标识，以便基于交易日历进行计算。例如：国外交易所的 ISO Code、国内交易所简称或自定义交易日历名称。",
2927
2931
  "",
2928
2932
  ".. versionadded:: 2.00.6",
2929
2933
  " 参数 *closed*, *label*, *origin*",
@@ -3203,6 +3207,11 @@
3203
3207
  }
3204
3208
  ]
3205
3209
  },
3210
+ "asfreq": {
3211
+ "title": "asfreq",
3212
+ "type": "function",
3213
+ "children": []
3214
+ },
3206
3215
  "asin": {
3207
3216
  "title": "asin",
3208
3217
  "type": "function",
@@ -15306,7 +15315,10 @@
15306
15315
  "",
15307
15316
  ".. _keepOrder_rs:",
15308
15317
  "",
15309
- "`keepOrder` 可选参数，表示输出表数据是否按照输入时的顺序排序。设置 *keyOrder* = true，表示输出表按照输入时的顺序排序。当 *keyColumn* 包含有时间列时，*keyOrder* 默认值为 true，否则默认值为 false。",
15318
+ ".. versionadded:: 2.00.6",
15319
+ " 参数 *keepOrder*",
15320
+ "",
15321
+ "`keepOrder` 可选参数，表示输出表数据是否按照输入时的顺序排序。设置 *keepOrder* = true，表示输出表按照输入时的顺序排序。当 *keyColumn* 包含有时间列时，*keyOrder* 默认值为 true，否则默认值为 false。",
15310
15322
  "",
15311
15323
  ".. _keyPurgeFilter_rs:",
15312
15324
  "",
@@ -15363,9 +15375,9 @@
15363
15375
  " $ rse = createReactiveStateEngine(name=\"reactiveDemo\", metrics =[<time>, factor1], dummyTable=tickStream, outputTable=result, keyColumn=\"sym\", filter=<sym in [\"000001.SH\", \"000002.SH\"]>)",
15364
15376
  " $ subscribeTable(tableName=`tickStream, actionName=\"factors\", handler=tableInsert{rse})",
15365
15377
  " ",
15366
- " $ data1 = table(take(\"000001.SH\", 100) as sym, 2021.02.08T09:30:00 + 1..100 *3 as time, 10+cumsum(rand(0.1, 100)-0.05)as price)",
15367
- " $ data2 = table(take(\"000002.SH\", 100) as sym, 2021.02.08T09:30:00 + 1..100 *3 as time, 20+cumsum(rand(0.2, 100)-0.1)as price)",
15368
- " $ data3 = table(take(\"000003.SH\", 100) as sym, 2021.02.08T09:30:00 + 1..100 *3 as time, 30+cumsum(rand(0.3, 100)-0.15)as price)",
15378
+ " $ data1 = table(take(\"000001.SH\", 100) as sym, 2021.02.08T09:30:00 + 1..100 *3 as time, 10+cumsum(rand(0.1, 100)-0.05) as price)",
15379
+ " $ data2 = table(take(\"000002.SH\", 100) as sym, 2021.02.08T09:30:00 + 1..100 *3 as time, 20+cumsum(rand(0.2, 100)-0.1) as price)",
15380
+ " $ data3 = table(take(\"000003.SH\", 100) as sym, 2021.02.08T09:30:00 + 1..100 *3 as time, 30+cumsum(rand(0.3, 100)-0.15) as price)",
15369
15381
  " $ data = data1.unionAll(data2).unionAll(data3).sortBy!(`time)",
15370
15382
  " ",
15371
15383
  " $ replay(inputTables=data, outputTables=tickStream, timeColumn=`time)",
@@ -15812,7 +15824,7 @@
15812
15824
  {
15813
15825
  "type": "text",
15814
15826
  "value": [
15815
- "createTimeSeriesEngine(name, windowSize, step, metrics, dummyTable, outputTable, [timeColumn], [useSystemTime=false], [keyColumn], [garbageSize], [updateTime], [useWindowStartTime=false], [roundTime=true], [snapshotDir], [snapshotIntervalInMsgCount], [fill='none'], [forceTriggerTime], [raftGroup], [keyPurgeFreqInSec], [closed='left'])",
15827
+ "createTimeSeriesEngine(name, windowSize, step, metrics, dummyTable, outputTable, [timeColumn], [useSystemTime=false], [keyColumn], [garbageSize], [updateTime], [useWindowStartTime], [roundTime=true], [snapshotDir], [snapshotIntervalInMsgCount], [fill='none'], [forceTriggerTime], [raftGroup], [keyPurgeFreqInSec=-1], [closed='left'], [outputElapsedMicroseconds=false])",
15816
15828
  "",
15817
15829
  "别名：createTimeSeriesAggregator"
15818
15830
  ]
@@ -15838,19 +15850,19 @@
15838
15850
  ]
15839
15851
  },
15840
15852
  {
15841
- "title": "窗口划分",
15853
+ "title": "窗口",
15842
15854
  "children": [
15843
15855
  {
15844
15856
  "type": "text",
15845
15857
  "value": [
15846
15858
  "* 窗口边界规整：对起始窗口左边界进行规整。（详情请参考 :ref:`step <step_ts>` 和 :ref:`roundTime <roundTime_ts>` 的参数说明以及 :ref:`规整规则表 <alignment_ts>`）",
15847
- "* 确定窗口：",
15859
+ "* 窗口确定：",
15848
15860
  "",
15849
15861
  " * :ref:`windowSize <windowSize_ts>` 确定窗口长度。",
15850
15862
  " * :ref:`closed <closed_ts>` 确定窗口左闭右开或左开右闭。",
15851
15863
  " * :ref:`step <step_ts>` 确定滑动的步长。",
15852
15864
  "",
15853
- "其中，*windowSize* 与 *step* 的单位取决于 *useSystemTime* 参数。若 *useSystemTime* 为 true， *windowSize* 与 *step* 的单位是毫秒。若 *useSystemTime* = false，*windowSize* 与 *step* 的单位同 *timeColumn* 列的精度一致。",
15865
+ "其中，*windowSize* 与 *step* 的单位取决于 *useSystemTime* 参数。若 *useSystemTime* = true， *windowSize* 与 *step* 的单位是毫秒。若 *useSystemTime* = false，*windowSize* 与 *step* 的单位同 *timeColumn* 列的精度一致。",
15854
15866
  "",
15855
15867
  "* 窗口截取：:ref:`useSystemTime <useSystemTime_ts>` 参数决定了如何截取窗口，可以基于数据的时间列，亦可以基于数据注入系统的时间进行截取。"
15856
15868
  ]
@@ -15858,32 +15870,28 @@
15858
15870
  ]
15859
15871
  },
15860
15872
  {
15861
- "title": "计算规则",
15873
+ "title": "计算",
15862
15874
  "children": [
15863
15875
  {
15864
15876
  "type": "text",
15865
15877
  "value": [
15866
15878
  "* 计算前提：若指定了 :ref:`timeColumn <timeColumn_ts>`，则 *timeColumn* 的时间必须递增；若同时指定了 :ref:`keyColumn <keyColumn_ts>`，则按照分组分别进行滑动窗口计算，*timeColumn* 在每组内的时间必须递增。否则，时间乱序的数据在计算中会被直接丢弃。",
15867
15879
  "* 触发规则：若指定了 *timeColumn*，当前窗口的计算将由该窗口结束后收到的第一条数据触发；若设置 *useSystemTime* = true，窗口结束后会自动触发计算。",
15868
- "* 强制触发规则：对长时间未触发计算的窗口数据，可以通过设置 :ref:`updateTime <updateTime_ts>` 和 :ref:`forceTriggerTime <forceTriggerTime_ts>` 强制触发计算。具体规则请参考参数说明。",
15869
- "* 窗口填充规则：未指定 :ref:`fill <fill_ts>` 或指定 *fill* = \"none\" 时，只会输出计算结果不为空的窗口；若指定了 *fill*，则会输出所有窗口，且根据 *fill* 规则对结果为空的窗口进行填充。输出表的时间列由参数 :ref:`useWindowStartTime <useWindowStartTime_ts>` 决定。",
15870
- "",
15871
- "可以为不同因子指定不同长度的窗口：若 *metrics* 指定了多个元代码，则将 *windowSize* 指定为一个长度与元代码个数相同的向量。"
15880
+ "* 强制触发规则：对长时间未触发计算的窗口数据，可以通过设置 :ref:`updateTime <updateTime_ts>` 或 :ref:`forceTriggerTime <forceTriggerTime_ts>` 强制触发计算。具体规则请参考参数说明。",
15881
+ "* 窗口填充规则：未指定 :ref:`fill <fill_ts>` 或指定 *fill* = \"none\" 时，只会输出计算结果不为空的窗口；若指定了 *fill*，则会输出所有窗口，且根据 *fill* 规则对结果为空的窗口进行填充。"
15872
15882
  ]
15873
15883
  }
15874
15884
  ]
15875
15885
  },
15876
15886
  {
15877
- "title": "引擎的其它功能",
15887
+ "title": "其它功能",
15878
15888
  "children": [
15879
15889
  {
15880
15890
  "type": "text",
15881
15891
  "value": [
15882
15892
  "* 支持数据/状态清理：清理引擎中堆积的数据和不再需要的状态信息。（详情请参考 :ref:`garbageSize <garbageSize_ts>` 和 :ref:`keyPurgeFreqInSec <keyPurgeFreqInSec_ts>` 的参数说明）",
15883
15893
  "* 快照机制：启用快照机制之后，系统若出现异常，可及时将流数据引擎恢复到最新的快照状态。（详情请参考 :ref:`snapshotDir <snapshotDir_ts>` 和 :ref:`snapshotIntervalInMsgCount <snapshotIntervalInMsgCount_ts>` 的参数说明）",
15884
- "* 流数据引擎高可用：若要启用引擎高可用，需在订阅端 raft 组的 leader 节点创建引擎并通过 raftGroup 参数开启高可用。开启高可用后，当 leader 节点宕机时，会自动切换新 leader 节点重新订阅流数据表。（详情请参考 :ref:`raftGroup <raftGroup_ts>` 的参数说明）",
15885
- "",
15886
- ""
15894
+ "* 流数据引擎高可用：若要启用引擎高可用，需在订阅端 raft 组的 leader 节点创建引擎并通过 raftGroup 参数开启高可用。开启高可用后，当 leader 节点宕机时，会自动切换新 leader 节点重新订阅流数据表。（详情请参考 :ref:`raftGroup <raftGroup_ts>` 的参数说明）"
15887
15895
  ]
15888
15896
  }
15889
15897
  ]
@@ -15970,20 +15978,16 @@
15970
15978
  "",
15971
15979
  ".. _updateTime_ts:",
15972
15980
  "",
15973
- "`updateTime` 可选参数，正整数，用于指定比 *step* 更短的计算的时间间隔。*step* 必须是 *updateTime* 的整数倍。要设置 *updateTime*， *useSystemTime* 必须设为 false。",
15981
+ "`updateTime` 可选参数，正整数，单位与 timeColumn 的时间精度一致。用于指定比 *step* 更短的计算时间间隔。*step* 必须是 *updateTime* 的整数倍。要设置 *updateTime*， *useSystemTime* 必须设为 false。",
15974
15982
  "",
15975
15983
  "如果没有指定 *updateTime*，一个数据窗口结束前，不会发生对该数据窗口数据的计算。若一个窗口长时间未触发计算，可以指定 updateTime，分多次触发当前窗口数据的计算。",
15976
15984
  "",
15977
15985
  "计算触发的规则为：",
15978
15986
  " ",
15979
- "\\(1) 将窗口划分为多个长度为 *updateTime* 的小窗口，各个小窗口之间没有重叠。每个小窗口的计算将由窗口结束后的第一条数据触发。该次计算包括当前窗口内所有未参与计算的数据。注意：触发计算的数据不参与本次计算。",
15980
- "",
15981
- "\\(2) 系统每经过 2 \\* updateTime（若 2 \\* updateTime 不足 2 秒，则设置为 2 秒）会检查是否有数据未参与计算，若仍有数据未参与计算，则会触发计算。本次计算包括触发计算时当前窗口内的所有数据。",
15987
+ "从当前窗口的左边界开始，每隔 *updateTime* 时间，若有新的数据到来，则对当前窗口内该数据之前的所有数据进行计算。另外，如果系统经过 2 \\* *updateTime* （至少2秒）后仍有未被处理的数据，则触发对当前窗口内所有数据的计算。",
15982
15988
  "",
15983
15989
  "若分组计算，则每组内进行上述操作。",
15984
15990
  "",
15985
- "请注意，小窗口内每次触发的计算结果的时间戳均为其所属滑动窗口的开始时间或结束时间 （由参数 *useWindowStartTime* 决定），而非小窗口内的时刻。",
15986
- "",
15987
15991
  "指定 *updateTime* 后，建议使用键值内存表作为输出表。因为每次计算均会增加一条记录，输出表若使用普通内存表或流数据表，则会产生大量带有相同时间戳的结果。因为键值流数据表不可更新记录，输出表亦不推荐使用键值流数据表。",
15988
15992
  "",
15989
15993
  ".. _useWindowStartTime_ts:",
@@ -15993,7 +15997,7 @@
15993
15997
  "",
15994
15998
  ".. _roundTime_ts:",
15995
15999
  "",
15996
- "`roundTime` 可选参数，布尔值，表示若数据时间精度为毫秒或者秒且 *step* > 一分钟，如何对窗口边界值进行规整处理。默认值为 true，表示按照既定的多分钟规则（见以上表格）进行规整。若为 false，则按一分钟规则（见以上表格）进行窗口规整。",
16000
+ "`roundTime` 可选参数，布尔值，表示若数据时间精度为毫秒或者秒且 *step* > 一分钟，如何对窗口边界值进行规整处理。默认值为 true，表示按照既定的多分钟规则进行规整。若为 false，则按一分钟规则进行窗口规整（详见 :ref:`规整规则表 <alignment_ts>`）。",
15997
16001
  "",
15998
16002
  "若要开启快照机制 (snapshot)，必须指定 *snapshotDir* 与 *snapshotIntervalInMsgCount*。",
15999
16003
  "",
@@ -16030,18 +16034,17 @@
16030
16034
  ".. versionadded:: 2.00.1",
16031
16035
  " 参数 *forceTriggerTime*",
16032
16036
  "",
16033
- "`forceTriggerTime` 可选参数，是非负整数，单位与 *timeColumn* 的时间精度一致。用于强制触发各个分组未计算的窗口进行计算。强制触发计算及输出规则如下：",
16037
+ "`forceTriggerTime` 可选参数，是非负整数，单位与 *timeColumn* 的时间精度一致。用于强制触发各个分组未计算的窗口进行计算。要设置 *forceTriggerTime*， *useSystemTime* 必须设置为 false，且不能指定 *updateTime*。",
16038
+ "强制触发计算及输出规则如下：",
16034
16039
  "",
16035
16040
  "\\1. 未被触发计算的窗口结束后（窗口结束时刻为 t），若收到了其他分组的数据（时间戳为 t1），且满足 t1-t ≥ *forceTriggerTime*，则该窗口将被触发计算。",
16036
16041
  "",
16037
- "\\2. 窗口内不包含数据时，若未指定 *fill*，则不会输出结果；若指定了 *fill*，则会以 *fill* 指定的方式输出结果。",
16038
- "",
16039
- "注：要设置 *forceTriggerTime*， *useSystemTime* 必须设置为 false，且不能指定 *updateTime*。若强制触发计算后，仍有属于当前窗口的数据到达，则这些数据会被丢弃，建议不要设置太小的 *forceTriggerTime*。",
16042
+ "\\2. 如果某个分组在最后一个窗口被强制触发计算后，没有再收到新的数据，但其他分组仍然收到了新的数据，那么通过 *fill* 来填充该分组的所有缺失窗口，可以确保在最新时间截面上仍然输出该分组的窗口。如果不指定 *fill*，则最后一个窗口被触发计算后，该分组不会产生新的窗口。",
16040
16043
  "",
16041
16044
  "设置 *forceTriggerTime* 或 *updateTime* 时需注意以下几点：",
16042
16045
  "",
16043
- "* 只设置 *updateTime*，计算发生后仍有属于当前窗口的数据到达时，当前窗口计算结果会再次更新；",
16044
- "* 只设置 *forceTriggerTime*，则触发计算之后收到的数据会被丢弃。",
16046
+ "* 设置 *updateTime*，计算发生后仍有属于当前窗口的数据到达时，当前窗口计算结果会再次更新；",
16047
+ "* 设置 *forceTriggerTime*，则触发计算之后收到的数据会被丢弃，建议不要设置太小的 *forceTriggerTime*。",
16045
16048
  "",
16046
16049
  ".. _raftGroup_ts:",
16047
16050
  "",
@@ -16549,7 +16552,7 @@
16549
16552
  {
16550
16553
  "type": "text",
16551
16554
  "value": [
16552
- "createWindowJoinEngine(name, leftTable, rightTable, outputTable, window, metrics, matchingColumn, [timeColumn], [useSystemTime=false], [garbageSize = 5000], [maxDelayedTime], [nullFill])"
16555
+ "createWindowJoinEngine(name, leftTable, rightTable, outputTable, window, metrics, matchingColumn, [timeColumn], [useSystemTime=false], [garbageSize = 5000], [maxDelayedTime], [nullFill], [outputElapsedMicroseconds=false])"
16553
16556
  ]
16554
16557
  }
16555
16558
  ]
@@ -16571,27 +16574,37 @@
16571
16574
  "",
16572
16575
  " 触发计算的规则：",
16573
16576
  "",
16574
- " \\1. 当前窗口数据的计算将由该窗口结束后的第一条数据触发。触发计算的数据不参与该窗口的计算。",
16577
+ " * useSystemTime=false",
16575
16578
  "",
16576
- " \\2. 指定 :ref:`maxDelayedTime <maxDelayedTimeWJ>` 后，对于某个未发生计算的窗口，若其窗口右边界 + *maxDelayedTime* < 右表最新收到的任意一个分组数据的时间戳，则该窗口的计算将被新收到的这条数据触发。",
16579
+ " 同组数据触发：各分组当前窗口数据的计算将由该窗口结束后的第一条属于该分组的数据触发。触发计算的数据不参与该窗口的计算。",
16577
16580
  "",
16581
+ " 其它分组数据触发：对于某个分组中未发生计算的窗口，若其窗口右边界 + maxDelayedTime < 右表最新收到的任意一个分组数据的时间戳，则该窗口的计算将被新收到的这条数据触发。",
16578
16582
  "",
16579
- ".. versionadded:: 2.00.8",
16580
- " 特殊窗口规则",
16583
+ " * useSystemTime=true",
16584
+ " ",
16585
+ " 各个分组收到的左表数据将触发对应分组窗口的数据计算输出。",
16581
16586
  "",
16582
- "* *特殊窗口（window 指定为 0:0，此时不支持指定 maxDelayedTime）*：",
16587
+ ".. versionadded:: 2.00.8",
16588
+ " 特殊窗口",
16583
16589
  "",
16584
- " 右表的计算窗口将左表当前数据和其上一条数据的时间戳决定。假设左表当前记录的时间戳为 t，上一条记录的时间戳为 t0，则由左表当前记录时间戳确定的右表计算窗口为 [t0, t)。",
16590
+ "* *特殊窗口（window 为 0:0）*：",
16591
+ " ",
16592
+ " 右表的计算窗口将由左表当前数据和其上一条数据的时间戳决定。假设左表当前记录的时间戳为 t，上一条记录的时间戳为 t0，则右表计算窗口为 [t0, t)。",
16585
16593
  "",
16586
- " 触发规则：",
16594
+ " 触发计算的规则：",
16587
16595
  "",
16588
- " * 当 useSystemTime=false 时，计算将由窗口结束后的第一条右表数据触发。",
16596
+ " * useSystemTime=false",
16597
+ " ",
16598
+ " 各分组当前窗口数据的计算将由窗口结束后的第一条属于该分组的右表数据触发。",
16589
16599
  "",
16590
- " * 当 useSystemTime=true 时，左表每注入一条数据，就触发右表未计算数据的计算。",
16600
+ " * useSystemTime=true",
16601
+ " ",
16602
+ " 各个分组收到的左表数据将触发对应分组窗口的数据计算输出。",
16591
16603
  "",
16592
- " 注意：window=0:0 时，若 metrics 中指定了非聚合的指标，其输出列必须为对应类型的 array vector。",
16604
+ "注意：",
16593
16605
  "",
16594
- "更多流数据引擎的应用场景说明可以参考 :doc:`../../SeriesOfFunctions/streamingEngine`。"
16606
+ "* window=0:0 时，若 metrics 中指定了非聚合的指标，其输出列必须为对应类型的 array vector。",
16607
+ "* 更多流数据引擎的应用场景说明可以参考 :doc:`../../SeriesOfFunctions/streamingEngine`。"
16595
16608
  ]
16596
16609
  }
16597
16610
  ]
@@ -16605,7 +16618,7 @@
16605
16618
  "value": [
16606
16619
  "`name` 必选参数，表示 window join 引擎的名称，作为其在一个数据节点/计算节点上的唯一标识。可包含字母，数字和下划线，但必须以字母开头。",
16607
16620
  "",
16608
- "`leftTable` 表对象。可以不包含数据，但结构必须与订阅的流数据表相同。",
16621
+ "`leftTable` 表对象。可以不包含数据，但结构必须与订阅的流数据表相同。2.00.9.3 版本开始支持 array vector 类型。",
16609
16622
  "",
16610
16623
  "`rightTable` 表对象。可以不包含数据，但结构必须与订阅的流数据表相同。",
16611
16624
  "",
@@ -16622,6 +16635,8 @@
16622
16635
  "",
16623
16636
  "\\(3) 计算结果列。可为多列。",
16624
16637
  "",
16638
+ "\\(4) 耗时列。若指定 *outputElapsedMicroseconds* = true，则需要增加一个 LONG 类型和一个 INT 类型的列，分别用于存储引擎内部每个 batch 的数据耗时（单位：微秒）和记录数。",
16639
+ "",
16625
16640
  "`window` 必选参数，表示滑动窗口区间的整型或 DURATION 数据对，其中左右边界都包含在内。",
16626
16641
  "",
16627
16642
  ".. _metricsWJ:",
@@ -16654,11 +16669,18 @@
16654
16669
  ".. _maxDelayedTimeWJ:",
16655
16670
  "",
16656
16671
  "`maxDelayedTime` 可选参数，是正整数，默认值为3，单位为秒。通过设置该参数，帮助触发引擎中长时间未输出的分组数据进行计算。",
16657
- "即若右表中最新到来的数据时间戳 - 未计算的分组数据窗口的右边界 > maxDelayedTime，则这条数据会触发满足条件的分组数据窗口计算输出。",
16672
+ "即若某个分组中未发生计算的窗口右边界 + maxDelayedTime < 右表最新收到的任意一个分组数据的时间戳，则这条数据会触发该窗口计算输出。",
16658
16673
  "请注意，指定该参数时，必须同时指定 timeColumn，且单位需和 timeColumn 精度一致。",
16659
16674
  "",
16660
16675
  "`nullFill` 和输出表列字段等长且类型一一对应的元组，用于填充以下列中的空值：输出表中包含的左表列、右表列、右表列被聚合计算后的计算结果列。",
16661
- "其中，右表列被填充范围仅限于某些不存在右表数据的窗口中；若窗口中包含了右表数据，但其值为 NULL，则不会被填充。"
16676
+ "其中，右表列被填充范围仅限于某些不存在右表数据的窗口中；若窗口中包含了右表数据，但其值为 NULL，则不会被填充。",
16677
+ "",
16678
+ ".. versionadded:: 2.00.9",
16679
+ " 参数 *outputElapsedMicroseconds*",
16680
+ "",
16681
+ "若同时有一批数据注入引擎，则引擎内部数据是分批进行计算的，每个批次的数据称为一个 batch，每个 batch 包含记录数由系统决定。",
16682
+ "",
16683
+ "`outputElapsedMicroseconds` 布尔值，表示是否输出每个 batch 中数据从注入引擎到计算输出的总耗时，以及每个 batch 包含的总记录数，默认为 false。指定参数 *outputElapsedMicroseconds* = true 后，在定义 *outputTables* 时需要在最后增加两列，详见 *outputTable* 参数说明。"
16662
16684
  ]
16663
16685
  }
16664
16686
  ]
@@ -19205,7 +19227,7 @@
19205
19227
  " ",
19206
19228
  "`size` 是整型标量，必须满足 0<=size<size(X) 条件。",
19207
19229
  "",
19208
- "`cutPositions` 是单增的整型向量，用于指定切分点的索引。"
19230
+ "`cutPositions` 是单增的整型向量，用于指定切分段开始的索引。"
19209
19231
  ]
19210
19232
  }
19211
19233
  ]
@@ -19217,10 +19239,19 @@
19217
19239
  {
19218
19240
  "type": "text",
19219
19241
  "value": [
19220
- "将 X 分为一系列标量或向量，并返回其组成的 tuple。",
19242
+ "将 *X* 分为一系列标量、向量、矩阵（按列）或表（按行）。",
19243
+ "",
19244
+ "* 当 *X* 是标量时：第二个参数只能是 *size*，且 *size* 值只能为1，cut 函数返回由 *X* 组成的元组。",
19245
+ "",
19246
+ "* 当 *X* 是向量时：",
19247
+ "",
19248
+ " * 若第二个参数为 *size*：cut 函数把 *X* 分成一系列长度为 *size* 的标量（*size* =1时）或向量（*size* >1时）。",
19249
+ " * 若第二个参数为 *cutPositions*，cut 函数先根据 *cutPositions* 将 *X* 分段，然后返回每段子向量组成的元组。",
19250
+ "",
19251
+ "* 当 *X* 是矩阵（表）时：",
19221
19252
  "",
19222
- "* 若第二个参数为 size，cut 函数把 X 分成一系列长度为 size 的标量（size=1时）或向量（size>1时）。",
19223
- "* 若第二个参数为 cutPositions，cut 函数先根据 cutPositions 将 X 分段，然后返回每段子向量组成的元组。",
19253
+ " * 若第二个参数为 *size*：cut 函数把 *X* 分成一系列列数（行数）为 *size* 的矩阵（表）。",
19254
+ " * 若第二个参数为 *cutPositions*，cut 函数先根据 *cutPositions* 将 *X* 分段，然后返回每个子矩阵（子表）组成的元组。",
19224
19255
  "",
19225
19256
  "关于该函数的逆操作，参见 :doc:`../f/flatten` 函数。"
19226
19257
  ]
@@ -19259,6 +19290,34 @@
19259
19290
  "",
19260
19291
  " $ cut(a, 2 7);",
19261
19292
  " ([3,4,5,6,7],[8,9,10])",
19293
+ "",
19294
+ " $ m=matrix(1 5 9, 12 20 23, 25 29 32)",
19295
+ " $ cut(m,2)",
19296
+ "",
19297
+ " (#0 #1",
19298
+ " -- --",
19299
+ " 1 12",
19300
+ " 5 20",
19301
+ " 9 23",
19302
+ " ,#0",
19303
+ " --",
19304
+ " 25",
19305
+ " 29",
19306
+ " 32",
19307
+ " )",
19308
+ "",
19309
+ " $ cut(m, 1 2)",
19310
+ " (#0",
19311
+ " --",
19312
+ " 12",
19313
+ " 20",
19314
+ " 23",
19315
+ " ,#0",
19316
+ " --",
19317
+ " 25",
19318
+ " 29",
19319
+ " 32",
19320
+ " )",
19262
19321
  ""
19263
19322
  ]
19264
19323
  },
@@ -22100,7 +22159,7 @@
22100
22159
  {
22101
22160
  "type": "text",
22102
22161
  "value": [
22103
- "用户 \"AlexSmith\" 不能创建或删除数据库：",
22162
+ "用户 \"AlexSmith\" 不能删除数据库：",
22104
22163
  ""
22105
22164
  ]
22106
22165
  },
@@ -22486,9 +22545,13 @@
22486
22545
  "value": [
22487
22546
  "对于第一种情形，`keyObj` 是表示键的向量，`valueObj` 是表示值的向量。",
22488
22547
  "",
22489
- "对于第二种情形，`keyType` 是字典键的数据类型，`valueType` 是字典值的数据类型。系统支持以下键的数据类型：Logical, Integral, Floating和Temporal。字典中的值不支持 COMPLEX, POINT 和 Decimal 类别。",
22548
+ "对于第二种情形，`keyType` 是字典键的数据类型，`valueType` 是字典值的数据类型。系统支持以下键的数据类型：Literal, Integral, Floating和Temporal。字典中的值不支持 COMPLEX, POINT 和 Decimal 类别。",
22490
22549
  "",
22491
- "`ordered` 一个布尔值，默认为 false，表示创建一个无序字典。当 ordered = true 时，创建一个有序字典。无序字典在输出或进行遍历时，其键值对不保留输入时的顺序；有序字典在输出或进行遍历时，键值对的顺序与输入顺序保持一致。"
22550
+ ".. versionadded:: 2.00.9",
22551
+ " 参数 *ordered*",
22552
+ "",
22553
+ "`ordered` 一个布尔值，默认为 false，表示创建一个无序字典。当 ordered = true 时，创建一个有序字典。无序字典在输出或进行遍历时，其键值对不保留输入时的顺序；有序字典在输出或进行遍历时，键值对的顺序与输入顺序保持一致。",
22554
+ ""
22492
22555
  ]
22493
22556
  }
22494
22557
  ]
@@ -31617,7 +31680,12 @@
31617
31680
  {
31618
31681
  "type": "text",
31619
31682
  "value": [
31620
- "获取当前节点上的分布式数据库。返回的结果是字典，key是数据库名称，不包含dfs://部分，value是表名，后面的数字分别是该数据库中表的编号（从1开始）和是否已被删除。"
31683
+ "获取当前节点上的分布式数据库。返回的结果是字典，key是数据库名称，不包含dfs://部分，value是表名，后面的数字分别是该数据库中表的编号（从1开始）和是否已被删除。",
31684
+ "",
31685
+ "1.30.21 版本起，",
31686
+ "",
31687
+ "* 当该函数由管理员或拥有 DB_MANAGE 权限的用户执行时，返回当前节点上所有分布式数据库；",
31688
+ "* 否则，仅返回该用户有 DB_OWNER 权限的数据库。"
31621
31689
  ]
31622
31690
  }
31623
31691
  ]
@@ -32340,8 +32408,12 @@
32340
32408
  {
32341
32409
  "type": "text",
32342
32410
  "value": [
32343
- "返回集群中所有的分布式表。",
32344
- ""
32411
+ "返回集群中的分布式表。",
32412
+ "",
32413
+ "1.30.21 版本起，",
32414
+ "",
32415
+ "* 该函数由管理员或拥有 DB_MANAGE 权限的用户执行时，返回集群中所有的分布式表；",
32416
+ "* 否则，仅返回该用户有访问权限的分布式表。其中，访问权限包含 DB_OWNER, TABLE_READ, TABLE_WRITE, TABLE_INSERT, TABLE_UPDATE, TABLE_DELETE, DB_READ, DB_WRITE, DB_INSERT, DB_UPDATE, DB_DELETE。 "
32345
32417
  ]
32346
32418
  }
32347
32419
  ]
@@ -33250,7 +33322,12 @@
33250
33322
  {
33251
33323
  "type": "text",
33252
33324
  "value": [
33253
- "返回当前节点上所有分布式数据库。"
33325
+ "返回当前节点上的分布式数据库。",
33326
+ "",
33327
+ "1.30.21 版本起，",
33328
+ "",
33329
+ "* 当该函数由管理员或拥有 DB_MANAGE 权限的用户执行时，返回当前节点上所有分布式数据库；",
33330
+ "* 否则，仅返回该用户有 DB_OWNER 权限的数据库。"
33254
33331
  ]
33255
33332
  }
33256
33333
  ]
@@ -33307,7 +33384,12 @@
33307
33384
  {
33308
33385
  "type": "text",
33309
33386
  "value": [
33310
- "返回分布式数据库中的表。"
33387
+ "返回分布式数据库中的表。",
33388
+ "",
33389
+ "1.30.21 版本起，",
33390
+ "",
33391
+ "* 当该函数由管理员或拥有 DB_MANAGE 权限的用户执行时，返回当前节点上所有分布式表；",
33392
+ "* 否则，仅返回该用户有 DB_OWNER 权限的数据库中的分布式表。"
33311
33393
  ]
33312
33394
  }
33313
33395
  ]
@@ -34225,7 +34307,8 @@
34225
34307
  "* createAsofJoinEngine",
34226
34308
  "* createEquiJoinEngine",
34227
34309
  "* createLookupJoinEngine",
34228
- "* createWindowJoinEngine"
34310
+ "* createWindowJoinEngine",
34311
+ "* createLeftSemiJoinEngine"
34229
34312
  ]
34230
34313
  }
34231
34314
  ]
@@ -35798,7 +35881,7 @@
35798
35881
  "* ChunkPath：分区的 DFS 路径。",
35799
35882
  "* Source：恢复数据的源节点，即正常的数据节点。",
35800
35883
  "* Dest：需要进行数据恢复的节点(目的节点)。",
35801
- "* Status：数据恢复的状态，包括 “Waiting”, “In-Progress”, “Finish”。",
35884
+ "* Status：数据恢复的状态，包括 “Waiting”, “In-Progress”, “Finished”, “Aborted”。",
35802
35885
  "* AttemptCount：恢复任务尝试的次数。",
35803
35886
  "* DeleteSource：是否删除源节点的数据。当 TaskType 是 ChunkRecovery 时，只能返回 false；当 TaskType 是 LoadRebalance 时，可以返回 true 或 false。",
35804
35887
  "* StartTime：创建恢复任务的时间。",
@@ -36080,7 +36163,8 @@
36080
36163
  "* createAsofJoinEngine",
36081
36164
  "* createEquiJoinEngine",
36082
36165
  "* createLookupJoinEngine",
36083
- "* createWindowJoinEngine"
36166
+ "* createWindowJoinEngine",
36167
+ "* createLeftSemiJoinEngine"
36084
36168
  ]
36085
36169
  }
36086
36170
  ]
@@ -38915,7 +38999,7 @@
38915
38999
  {
38916
39000
  "type": "text",
38917
39001
  "value": [
38918
- "授予用户\"AlexSmith\"创建和删除数据库的权限：",
39002
+ "授予用户\"AlexSmith\"删除数据库的权限：",
38919
39003
  ""
38920
39004
  ]
38921
39005
  },
@@ -66139,9 +66223,12 @@
66139
66223
  {
66140
66224
  "type": "text",
66141
66225
  "value": [
66142
- "将数据文件并行加载到内存中。*ploadText* 返回的结果是顺序分区的内存表。",
66226
+ "将数据文件并行加载到内存中。当文件大于 16MB 时，ploadText 返回一个顺序分区的内存表；否则返回一个普通内存表。",
66227
+ "",
66228
+ "注意：",
66143
66229
  "",
66144
- "与 :doc:`../l/loadText` 函数相比，*ploadText* 速度更快。"
66230
+ "* ploadTable 返回的分区表数据均匀分配到各个分区，且每个分区中的数据量介于8MB与16MB之间。",
66231
+ "* 与 :doc:`../l/loadText` 函数相比，进行并行加载时，*ploadText* 速度更快。"
66145
66232
  ]
66146
66233
  }
66147
66234
  ]
@@ -73354,7 +73441,7 @@
73354
73441
  " $ if(existsDatabase(\"dfs://test_stock\")){",
73355
73442
  " $ dropDatabase(\"dfs://test_stock\")",
73356
73443
  " $ }",
73357
- " $ db1=database(\"\",RANGE, 2021.01.04..2021.01.06)",
73444
+ " $ db1=database(\"\",RANGE, 2021.01.04..2021.01.07)",
73358
73445
  " $ db2=database(\"\",VALUE,`IBM`GS)",
73359
73446
  " $ db=database(\"dfs://test_stock\",COMPO,[db1, db2])",
73360
73447
  " $ trades=db.createPartitionedTable(t,`trades,`date`sym)",
@@ -73533,9 +73620,9 @@
73533
73620
  "============= ===================",
73534
73621
  "",
73535
73622
  ".. versionadded:: 2.00.9 ",
73536
- " 用户自定义交易日历",
73623
+ " 交易日历",
73537
73624
  "",
73538
- "`rule` 上述字符串亦可配合使用数字，例如 \"2M\" 表示频率为每两个月月末。此外，*rule* 也可指定为用户自定义交易日历的标识（配置参数 *marketHolidayDir* 指定目录下的文件名，系统将根据该交易日历进行计算）。",
73625
+ "`rule` 上述字符串亦可配合使用数字，例如 \"2M\" 表示频率为每两个月月末。此外，*rule* 也可以是交易日历标识，例如：国外交易所的 ISO Code、国内交易所简称或自定义交易日历名称。",
73539
73626
  "",
73540
73627
  "`func` 一个聚合函数。",
73541
73628
  "",
@@ -73572,7 +73659,7 @@
73572
73659
  {
73573
73660
  "type": "text",
73574
73661
  "value": [
73575
- "依照指定时间频率（或用户自定义的交易日历），对给定数据使用给定函数。注意，*rule* 指定为交易日历标识时，对于非交易日的数据，将并入上一个交易日计算。"
73662
+ "依照指定时间频率（或交易日历），对给定数据使用给定函数。注意，*rule* 指定为交易日历标识时，对于非交易日的数据，将并入上一个交易日计算。"
73576
73663
  ]
73577
73664
  }
73578
73665
  ]
@@ -85009,6 +85096,7 @@
85009
85096
  "type": "text",
85010
85097
  "value": [
85011
85098
  "若 *str* 为标量：",
85099
+ "",
85012
85100
  "* 如果没有指定 *delimiter*，把str分割为CHAR类型向量。",
85013
85101
  "* 如果指定了 *delimiter*，把它作为分隔符，把 *str* 分成CHAR类型或STRING类型的向量。",
85014
85102
  "",
@@ -88895,7 +88983,11 @@
88895
88983
  "",
88896
88984
  "`offset` 是订阅任务开始后的第一条消息所在的位置。消息是流数据表中的行。如果未指定，或设为-1，订阅将会从流数据表的当前行开始。如果 *offset* \\= -2，系统会获取持久化到磁盘上的 *offset*，并从该位置开始订阅。*offset* 与流数据表创建时的第一行对应。如果某些行因为内存限制被删除，在决定订阅开始的位置时，这些行仍然考虑在内。",
88897
88985
  "",
88898
- "`handler` 是一元函数或数据表，用于处理订阅的数据。如果它是一个函数，它唯一的参数是订阅的数据。订阅的数据可以是一个表或元组，订阅数据表的每个列是元组的一个元素。鉴于经常需要把订阅的数据插入到数据表中，为了方便使用，*handler* 也可以是一个表，订阅数据会直接插入到该表中。",
88986
+ "`handler` 是一元函数、二元函数或数据表，用于处理订阅的数据。",
88987
+ "",
88988
+ "* 一元函数：它唯一的参数是订阅的数据。订阅的数据可以是一个表或元组，订阅数据表的每个列是元组的一个元素。",
88989
+ "* *handlerNeedMsgId* = true 时，*handler* 必须是二元函数，其两个参数分别是订阅的数据（msgBody）和数据偏移量（msgId）。详见 *handlerNeedMsgId* 参数说明。",
88990
+ "* 数据表：可以是流数据引擎、共享流表、共享内存表、共享键值表、共享索引表或 DFS 表。订阅数据会直接插入到该表中。",
88899
88991
  "",
88900
88992
  "`msgAsTable` 是布尔值，表示订阅的数据是否为表。默认值是false，表示订阅的数据是由列组成的元组。",
88901
88993
  "",
@@ -88939,7 +89031,10 @@
88939
89031
  "",
88940
89032
  "`timeTrigger` 是一个布尔值。若设为 true，表示即使没有新的消息进入，*handler* 也会在 *throttle* 参数所设定的时间间隔被触发。",
88941
89033
  "",
88942
- "`handlerNeedMsgId` 是一个布尔值，默认值为 false。若设为 true，*handler* 必须支持两个参数：一个是 msgBody，一个是 msgId。调用 *handler* 时，传入消息以及消息的偏移量。一个例子为函数 ```appendMsg``。 若设为 false，*handler* 仅支持一个参数：msgBody。调用 *handler* 时，只传入消息本身。",
89034
+ "`handlerNeedMsgId` 是一个布尔值，默认值为 false。",
89035
+ "",
89036
+ "* 若设为 true，*handler* 必须支持两个参数：一个是 msgBody（传入的消息），一个是 msgId（消息的偏移量）。如：以部分应用的形式固定 :doc:`../a/appendMsg` 的 *engine* 参数后，将其作为二元应用传入 *handler*。",
89037
+ "* 若设为 false，*handler* 仅支持一个参数：msgBody。调用 *handler* 时，只传入消息本身。",
88943
89038
  "",
88944
89039
  "`raftGroup` 是 raft 组的 ID。设置该参数表示开启订阅端高可用，不设置则表示普通订阅。设置 *raftGroup* 参数以指定 raft 组后，在对应 raft 组内 leader 发生切换时，新的 leader 会重新订阅。",
88945
89040
  "",
@@ -91974,11 +92069,15 @@
91974
92069
  ".. versionadded:: 2.00.9",
91975
92070
  " 用户自定义交易日历",
91976
92071
  "",
91977
- "`unit` 是一个字符串标量。它表示 *duration* 的单位或用户自定义交易日历的标识。",
92072
+ "`unit` 是一个字符串标量。",
91978
92073
  "",
91979
- "- 若为 *duration* 的单位，它的取值可以是：\"ns\"(nanosecond), \"us\"(microsecond), \"ms\"(millisecond), \"s\"(second), \"m\"(minute), \"H\"(hour), \"d\"(day), \"w\"(week), \"M\"(month), \"y\"(year), “B”(business day)。",
91980
- "- 若需要基于交易日历增加值，须填写 *marketHolidayDir* 保存的文件名（即交易日历的标识）。",
91981
- "- 当 *duration* 取 DURATION 类型数据时，该参数无需设置。",
92074
+ "* duration 是整数时，*unit* 表示：",
92075
+ "",
92076
+ " * duration 的单位，取值可以是：\"ns\"(nanosecond), \"us\"(microsecond), \"ms\"(millisecond), \"s\"(second), \"m\"(minute), \"H\"(hour), \"d\"(day), \"w\"(week), \"M\"(month), \"y\"(year), “B”(business day) ",
92077
+ "",
92078
+ " * 交易日历的标识，例如：国外交易所的 ISO Code、国内交易所简称或自定义交易日历名称。对应的文件必须保存在 marketHolidayDir 中。",
92079
+ "",
92080
+ "* duration 是 DURATION 类型数据时，*unit* 无需设置。",
91982
92081
  "",
91983
92082
  "注：时间单位为 year 或 month 时，计算结果与 mysql 保持一致。Pandas 提供了一个时间偏移对象（Date offsets）来完成时间偏移工作，当 DateOffset 参数取 months 或 years 时，与 ``temporalAdd`` 单位为 M 或 y 的计算结果也一致。"
91984
92083
  ]
@@ -96082,63 +96181,6 @@
96082
96181
  }
96083
96182
  ]
96084
96183
  },
96085
- "toggleAsyncReplicationTaskSkipFlag": {
96086
- "title": "toggleAsyncReplicationTaskSkipFlag",
96087
- "type": "command",
96088
- "children": [
96089
- {
96090
- "title": "语法",
96091
- "type": "grammer",
96092
- "children": [
96093
- {
96094
- "type": "text",
96095
- "value": [
96096
- "toggleAsyncReplicationTaskSkipFlag(cid)"
96097
- ]
96098
- }
96099
- ]
96100
- },
96101
- {
96102
- "title": "参数",
96103
- "type": "parameters",
96104
- "children": [
96105
- {
96106
- "type": "text",
96107
- "value": [
96108
- "`cid` 指定磁盘上的任务编号。"
96109
- ]
96110
- }
96111
- ]
96112
- },
96113
- {
96114
- "title": "详情",
96115
- "type": "detail",
96116
- "children": [
96117
- {
96118
- "type": "text",
96119
- "value": [
96120
- "启用集群间的异步复制后，在主集群的数据节点上执行，用于切换任务的 Skip 标记位状态，可以通过函数 getAsyncReplicationTasks 获取任务的 Skip 标记状态。运行此命令前，异步复制应当处于 stop 状态。"
96121
- ]
96122
- }
96123
- ]
96124
- },
96125
- {
96126
- "title": "例子",
96127
- "type": "example",
96128
- "children": [
96129
- {
96130
- "type": "code",
96131
- "language": "console",
96132
- "value": [
96133
- " ",
96134
- " $ toggleAsyncReplicationTaskSkipFlag(cid);",
96135
- ""
96136
- ]
96137
- }
96138
- ]
96139
- }
96140
- ]
96141
- },
96142
96184
  "topRange": {
96143
96185
  "title": "topRange",
96144
96186
  "type": "function",
@@ -96397,9 +96439,9 @@
96397
96439
  "================ =======================",
96398
96440
  "",
96399
96441
  ".. versionadded:: 2.00.9 ",
96400
- " 用户自定义交易日历",
96442
+ " 交易日历",
96401
96443
  "",
96402
- "`rule` 上述字符串亦可配合使用数字，例如 \"2M\" 表示频率为每两个月月末。此外，*rule* 也可指定为用户自定义交易日历的标识（配置参数 *marketHolidayDir* 指定目录下的文件名，系统将根据该交易日历进行计算）。",
96444
+ "`rule` 上述字符串亦可配合使用数字，例如 \"2M\" 表示频率为每两个月月末。除上述取值外，*rule* 也可指定交易日历的标识，以便基于交易日历进行计算。例如：国外交易所的 ISO Code、国内交易所简称或自定义交易日历名称。",
96403
96445
  "",
96404
96446
  ".. versionadded:: 2.00.6",
96405
96447
  " 参数 *closed*, *label*, *origin*",