MDL

createHandle

语法

参数

• name: String 型标量，作为句柄的唯一标识，不可重复。
• host: String 型向量，服务器的IP或者域名。
• port: Int 型向量，端口号，个数需要与 host 参数的数量一致。
• username: String 型标量，用户 ID。
• workerNum: Int 型标量，MDL 工作线程的数量，可选参数。

作用

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

getSchema

语法

参数

• 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) 获取用于 subscribeByChannelNo 中 dict 字典中表的结构。

subscribe

语法

参数

• 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 创建多个句柄，分别进行订阅并指定要写入到的流表。

unsubscribe

语法

参数

• 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: MDL 句柄。

作用

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

deleteHandle

语法

参数

• handle: MDL 句柄。

作用

手动关闭 MDL 句柄并释放掉资源。

getHandle

语法

参数

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

作用

获取对应 name 的 MDL 句柄。

getHandleStatus

语法

作用

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

示例1

loadPlugin("/path/to/DolphinDBPlugin/mdl/PluginMDL.txt") // 加载插件

schema = MDL::getSchema(`MDLSID_MDL_SHL2, 4) // 获取 MDLSID_MDL_SHL2 即上交所 L2 的 4 号行情的表结构
tb1 = streamTable(10000:0, schema[`name], schema[`type])
enableTableShareAndPersistence(table=tb1, tableName=`Tb1, cacheSize=10000)

schema = MDL::getSchema(`MDLSID_MDL_SHL2, 6)
tb2 = streamTable(10000:0, schema[`name], schema[`type])
enableTableShareAndPersistence(table=tb2, tableName=`Tb2, cacheSize=10000)

host = ["mdl-XXX.datayes.com"]
port = [端口号]
handle = MDL::createHandle(`handle1, host, port, 用户token) // 创建 MDL 句柄

MDL::subscribe(handle, tb1, `MDLSID_MDL_SHL2, `MDLVID_MDL_SHL2, 4, "SecurityID", [`603238, `510650])
MDL::subscribe(handle, tb2, `MDLSID_MDL_SHL2, `MDLVID_MDL_SHL2, 6)

MDL::connectMDL(handle) // 连接服务器，host 和 port 在 createHandle 创建句柄时指定

handle2 = MDL::getHandle(`handle1) // 获取名为 "handle1" 的 MDL 句柄

status = MDL::getHandleStatus() // 获取当前所有句柄的消息，并以表形式返回

MDL::deleteHandle(handle) // 删除句柄

示例2

loadPlugin("/path/to/DolphinDBPlugin/mdl/PluginMDL.txt");

dropStreamTable(`Tb1)
dropStreamTable(`Tb2)
dropStreamTable(`Tb3)

// 创建 4 个相同的目标表
schema = MDL::getSchema("SHL2_SZL2_ORDER_AND_TRANSACTION", 0)
tb1 = streamTable(10000:0, schema[`name], schema[`type])
enableTableShareAndPersistence(table=tb1, tableName=`Tb1, cacheSize=10000)
tb2 = streamTable(10000:0, schema[`name], schema[`type])
enableTableShareAndPersistence(table=tb2, tableName=`Tb2, cacheSize=10000)
tb3 = streamTable(10000:0, schema[`name], schema[`type])
enableTableShareAndPersistence(table=tb3, tableName=`Tb3, cacheSize=10000)

// 创建两个句柄，分别对应上交所 L2 和 深交所 L2
handle1 = MDL::createHandle(`handle1, ["mdlXXX.datayes.com"], [端口号], 用户token) // 上交 L2
handle2 = MDL::createHandle(`handle2, ["mdlXXX.datayes.com"], [端口号], 用户token) // 深交 L2

// 订阅
dict1 = dict([1, 2],[tb1, tb2]) // channelNo -> streamTable
MDL::subscribeByChannelNo(handle1, dict1, `SHL2_ORDER_AND_TRANSACTION) // 按 chennelno 订阅上交 L2 的 order 和 transaction

dict2 = dict([2011, 2012],[tb2, tb3])
MDL::subscribeByChannelNo(handle2, dict2, `SZL2_ORDER_AND_TRANSACTION) // 按 chennelno 订阅深交 L2 的 order 和 transaction

// 连接并开始接受数据
MDL::connectMDL(handle1)
MDL::connectMDL(handle2)

MDL::deleteHandle(handle1)
MDL::deleteHandle(handle2)

MDL 插件数据品类参数表

MDL 插件目前支持了下表中出现的数据品类。在订阅时可以查询该表，找到想要订阅的数据入参。表中为空的项，对应字段在订阅时填空即可。

注：行情快照合成类型是为了对接 DolphinDB 快照合成流计算引擎的特殊处理，指将逐笔成交和逐笔委托处理为同构数据写入一张 DolphinDB 表中。