MDL

DolphinDB Server 2.00.10 及更高版本，支持 Linux x86-64。

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

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

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

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

   installPlugin("mdl");

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

   loadPlugin("mdl");

语法

createHandle(name, host, port, username, [workerNum=1])

参数

name STRING 类型标量，作为句柄的唯一标识，不可重复。

host STRING 类型向量，服务器的 IP 或者域名。

port INT 类型向量，端口号，个数需要与 host 参数的数量一致。

username STRING 类型标量，用户 ID。

workerNum INT 类型标量，MDL 工作线程的数量，可选参数。

详情

返回一个 MDL 句柄，用于之后的操作。

语法

getSchema(svrID, msgID, [extraOrderLevel=0])

参数

svrID STRING 类型标量，数据服务 ID。

msgID INT 类型标量，消息 ID。

extraOrderLevel INT 类型标量，值为 0-10，默认为 0。在指定 svrID、msgID 为 "MDLSID_MDL_SZL2", 28 或者 "MDLSID_MDL_SHL2", 4 即订阅 snapshot 时有效，会决定是否在表末尾增加 order queue 相关信息的字段。有 10 档可选，所以可以指定为 0-10。

详情

获取对应消息的表结构。 另外，可以通过 schema = getSchema("SHL2_SZL2_ORDER_AND_TRANSACTION", 0) 获取用于 order transaction 合并类型表的结构。

语法

subscribe(handle, output, svrID, [svrVersion], [msgID], [fieldName], [fieldValues], [extraOrderLevel=0])

参数

handle MDL 句柄。

output 可以为一个共享流表，需要在订阅前创建，该表的 schema 可以通过插件提供的 getSchema 函数来获取。连接服务器后会将订阅的数据实时刷新到这个流表中。也可以为字典类型，key 是 Int 类型的 channelNo，value 是对应 channelNo 行情要写入的共享流表，该表的结构通过 getSchema 函数来获取（getSchema("SHL2_SZL2_ORDER_AND_TRANSACTION", 0)），目前支持 "SHL2_SZL2_ORDER_AND_TRANSACTION" 一种，对应上交所 L2 和深交所 L2 的 order 和 transaction 合并类型行情。这种情况下，不支持填写 svrVersion、msgID、fieldName、fieldValues、extraOrderLevel 字段。

svrID STRING 类型标量，要订阅的数据服务 ID。如果 output 为字典类型，还支持 "SHL2_ORDER_AND_TRANSACTION" 和 "SZL2_ORDER_AND_TRANSACTION" 两种，每一种分别订阅对应交易所的 order 和 transaction 行情。

svrVersion STRING 类型标量，要订阅的数据服务版本号。

msgID INT 类型标量，要订阅的消息 ID。

fieldName STRING 类型标量，要过滤的字段名，可选参数。

fieldValues STRING 类型向量，要过滤的字段对应的值，可选参数，对于日期类型，"0" 用于订阅日期为空的情况，"20230808" 这种形式用于订阅指定的日期。

extraOrderLevel INT 类型标量，值为 0-10，默认为 0。在指定 svrID、msgID 为 "MDLSID_MDL_SZL2", 28 或者 "MDLSID_MDL_SHL2", 4 即订阅 snapshot 时有效，会决定是否在表末尾增加 order queue 相关信息的字段。有 10 档可选，所以可以指定为 0-10。

详情

记录要订阅的消息，然后在连接到服务器时提交订阅请求，必须在调用 connect 之前调用。可以使用字段名与字段值对要订阅的服务进行过滤，如可以通过 fieldName 指定股票编码字段，通过 fieldValues 指定要订阅的股票编码。 一个 MDL 句柄订阅的一种消息只能指定一个流表，如果需要对一个消息订阅多次并分别写入到多个流表，可以通过 createHandle 创建多个句柄，分别进行订阅并指定要写入到的流表。

注意：

1. 因为通联 MDL 不支持同时订阅在不同服务器的数据源，也就是当同时订阅上交所 L2 和深交所 L2 时，只能收到其中一个数据源的行情。为了解决这个问题，需要创建两个句柄，分别订阅上交所 L2 和深交所 L2 的数据，一个句柄只订阅一个数据源的行情。
2. 如果订阅了 order transaction 合并类型，MDDate 字段为 handle 创建日期，如果需要跨天订阅，该字段无效。
3. 如果订阅了 order transaction 合并类型，上交所 SecurityType 字段为 marketInfo 回调所得，因此如果在盘中订阅，最开始记录的 SecurityType 字段可能为空。

语法

unsubscribe(handle, svrID, [svrVersion], [msgID], [fieldName], [fieldValues])

参数

handle MDL 句柄。

svrID STRING 类型标量，要取消订阅的数据服务 ID。另外支持指定 "SHL2_ORDER_AND_TRANSACTION" 和 "SZL2_ORDER_AND_TRANSACTION" 两种用于取消 order transaction 合并类型的订阅。这种情况下不支持后续参数的指定。

svrVersion STRING 类型标量，要取消订阅的数据服务版本号。

msgID INT 类型标量，要取消订阅的消息 ID。

fieldName STRING 类型标量，要过滤的字段名，可选参数。

fieldValues STRING 类型向量，要过滤的字段对应的值，可选参数。

详情

取消订阅，必须在调用 connect 之前调用。

语法

connectMDL(handle)

参数

handle MDL 句柄。

详情

连接服务器并提交用户的订阅请求。

语法

deleteHandle(handle)

参数

handle MDL 句柄。

详情

手动关闭 MDL 句柄并释放掉资源。注意会话结束时 MDL 句柄不会断开连接和释放资源，之后可以通过 getHandle 来重新获取句柄来释放。

语法

getHandle(name)

参数

name STRING 类型标量，是 createHandle 创建时给该 MDL 句柄赋予的标识名。

详情

获取对应 name 的 MDL 句柄。

语法

getHandleStatus()

详情

返回一张表，表中保存着 MDL 实例的各种信息。

• HandleName 记录着句柄名。
• Address 记录着连接服务器的地址，格式是 “host1:port1; host2:port2;…”。
• UserName 记录着用户名；CreateTime 记录着 MDL 实例创建的时间。
• IsConnect 记录着是否已建立连接。

MDL::getStatus(handle)

参数

handle MDL 句柄。

详情

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

有关 MDL 插件对数据品类的支持情况，请联系 DolphinDB 技术支持。