INSIGHT

DolphinDB Server 2.00.10 及更高版本。支持 Linux x64。

1. 在 DolphinDB 客户端中使用 listRemotePlugins 命令查看插件仓库中的插件信息。

   注意：仅展示当前操作系统和 server 版本支持的插件。若无预期插件，可自行编译（请自行选择对应分支下的插件）或在 DolphinDB 用户社区进行反馈。

   login("admin", "123456")
   listRemotePlugins()

2. 使用 installPlugin 命令完成插件安装。

   installPlugin("insight")

3. 使用 loadPlugin 命令加载插件。

   loadPlugin("insight")

语法

insight::connect(handles, ip, port, user, password, [workPoolThreadCount=5], [options], [seqCheckMode=1], [certDirPath], [dataVersion="3.2.8"], backupList)

详情

注册消息接收接口并连接 Insight 服务器，返回 Insight tcpClient 连接的句柄。

参数

handles 类型为 Dictionary，Dictionary 的键为 StockTick, IndexTick, FuturesTick, OrderTransaction, Transaction, Order, FundTick, BondTick，OptionTick 或 SecurityLending，值为共享流表或者一个字典。

以上几种数据分别接入股票快照、指数快照、期货快照、逐笔合成类型、逐笔成交类型、逐笔委托类型、基金快照、债券快照、期权快照、融券通数据。

当值为字典时，key 为整型，代表 channel 号。value 为一个共享流表，即对应 channel 数据需要接入的数据表。

ip STRING 类型标量，表示服务器地址。

port 整型标量，表示服务器端口。

user STRING 类型标量，表示用户名。

password STRING 类型标量，表示密码。

workPoolThreadCount 可选，整型标量，表示处理线程池的线程数，默认为 5。大小需要在 1-32767 之间。

options 可选，是字典类型，表示扩展参数，key 为 STRING 类型，value 为 BOOL 类型。当前支持 ReceivedTime, OutputElapsed。 ReceivedTime 表示是否获取插件收到行情数据的时间戳，默认为 true。其指定为 dict(["ReceivedTime"], [true]) 时，插件处理输出的数据将包含行情数据的时间戳列。 OutputElapsed 表示是否获取 Insight 插件 接收数据处理的时延，默认为 false。其指定为 dict(["OutputElapsed"],[true]) 时，插件处理输出的数据将包含行情数据的时延列。

时延的定义：'insight 回调函数返回数据' 到 '准备开始 transform' 处理，或准备 append 到共享流表前’ 这段时间。该列的单位为纳秒。

seqCheckMode 可选，整型或 STRING 类型标量，默认为 1。在 OrderTransaction 合并类型订阅中生效，用于控制在数据不连续时插件接收数据的行为。

• seqCheckMode 为 0 或者 'check'：代表在数据不连续时，停止接收数据。
• seqCheckMode 为 1 或者 'ignoreWithLog'：代表在数据不连续时，继续接收数据，同时输出对应具体序号跳变情况到 INFO 级别的 Log。
• seqCheckMode 为 2 或者 'ignore'：代表在数据不连续时，继续接收数据，不输出任何 Log。

判断数据是否连续的方式（随着交易所规则改变，该规则也可能发生改变）：

• 上交所：不同标的 Order 和 Transaction 数据的 applSeqNum 共同连续递增。

• 深交所：不同标的 Order 和 Transaction 数据的 applSeqNum 共同连续递增。

certDirPath 可选，STRING 类型标量。如果未指定，默认会在 DolphinDB 当前节点的 Home 目录（可以通过 getHomeDir 函数进行查看，单节点、集群的各个节点之间的 Home 目录都不相同），以及 pluginDir 中的 insight 文件夹中进行查找。

如果指定了错误的且存在的文件夹，在连接时会报错：failed to registHandleAndLogin: create client failed。但如果在进行错误连接前已经进行过正确的连接，那么由于已经验证过，则使用错误参数进行的连接可能可以连上。

dataVersion 可选，STRING 类型标量。可以指定华泰 INSIGHT 数据 schema 的版本。目前仅支持 "3.2.8" 版本支持 "3.2.8"，"3.2.11" 。"3.2.11" 版本 Order 数据较 "3.2.8" 版本多了字段 TradeQty。

backupList 可选，STRING 类型向量，表示 insight 服务器的 IP 地址。如果有多个服务器，可以通过此参数实现与 Insight 服务器之间的高可用。地址需要以 IP:PORT 形式填写，如：218.94.125.135:8162。

语法

insight::subscribe(tcpClient, marketDataTypes, securityIDSource, securityType)

详情

订阅数据，并将所订阅的数据保存在由 connect 的 handles 参数指定的表中。

注意：插件所接收的数据不会对华泰 INSIGHT 本身的倍率进行处理，使用时倍率的转换请参考华泰 INSIGHT 数据字典的相关介绍，本文不做赘述。

参数

tcpClient connect 的返回值。

marketDataTypes STRING 类型向量，表示行情数据类型，支持以下值：MD_TICK, MD_ORDER, MD_TRANSACTION, MD_ORDER_TRANSACTION 和 MD_SECURITY_LENDING。MD_ORDER_TRANSACTION 为特殊的订阅类型，指的是逐笔合成类型，其他类型均与 insight 规定的 EMarketDataType 枚举类型含义相同。

securityIDSource STRING 类型标量，表示交易所类型，支持以下值：XSHE, XSHG, CCFX, CSI, XBSE, XDCE, XSGE, NEEQ, XZCE, HKSC, HGHQ, CNI, HTSM, HTIS。类型含义与 insight 规定的 ESecurityIDSource 枚举类型含义相同，具体含义详见华泰 Insight 官方数据字典。

securityType STRING 类型标量，表示产品类型，支持以下值：StockType, FundType, BondType, IndexType, FuturesType, OptionType。类型含义与 insight 规定的 ESecurityType 枚举类型含义相同，具体含义详见华泰 INSIGHT 官方数据字典。

语法

insight::unsubscribe(tcpClient)

详情

取消当前所有订阅。

参数

tcpClient insight 连接句柄，即 connect 函数的返回值。

语法

insight::close(tcpClient)

详情

关闭连接。

参数

tcpClient connect 的返回值。

语法

insight::getSchema(type, [options], [dataVersion="3.2.8"])

详情

获取对应表结构。返回一个表，包含 name 和 type 两列。

参数

dataType STRING 类型标量，指需要获取 schema 的类型 OrderTransaction, StockTick, IndexTick, FuturesTick, Transaction, Order, FundTick, BondTick, OptionTick 或 OrderTransaction。

options 可选，是字典类型，表示扩展参数，key 为 STRING 类型，value 为 BOOL 类型。当前支持 ReceivedTime, OutputElapsed。 ReceivedTime 表示是否获取插件收到行情数据的时间戳，默认为 true。其指定为 dict(["ReceivedTime"],\ ) 时，getSchema 获取的表结构中将包含插件收到行情数据的时间戳列。 OutputElapsed 表示是否获取 Insight 插件 接收数据处理的时延，默认为 false。其指定为 dict(["OutputElapsed"], [true]) 时，getSchema 获取的表结构中将包含插件收到行情数据的时延列。时延的定义：'insight 回调函数返回数据' 到 '准备开始 transform' 处理，或准备 append 到共享流表前’ 这段时间。该列的单位为纳秒。

dataVersion 可选，STRING 类型标量，用于指定华泰 INSIGHT 数据 schema 的版本。目前支持 "3.2.8"，"3.2.11" 。"3.2.11" 版本 Order 数据较 "3.2.8" 版本多了字段 TradeQty。

语法

insight::getStatus(tcpClient)

详情

返回一个表格，包含各种已订阅数据的状态信息，包含数据类型 StockTick, IndexTick, FuturesTick, OrderTransaction, Transaction, Order, FundTick, BondTick，OptionTick 或 SecurityLending。

参数

tcpClient insight 连接句柄，即 connect 函数的返回值。

语法

handle = insight::getHandle()

详情

返回已有的 insight 连接句柄，如果插件没有被连接过，会抛出异常。