插件介绍与使用

• include(./include) 目录包含了 DolphinDB 的核心数据结构的类声明和一些工具类声明，这些类是实现插件的重要基础工具。
• demo(./demo) 目录包含了一个 demo 插件的实现。
• odbc(./odbc) 与 mysql (./mysql) 等目录包含了 ODBC 与 MySQL
• odbc/bin(./odbc/bin) 与 mysql/bin (./mysql/bin) 等目录包含了 ODBC 与 MySQL 等插件的预编译版本，可直接加载。 等插件的实现。

插件分支应与 DolphinDB Server 版本的前三位数字相匹配，即若 DolphinDB Server 是 1.30.21 版本，插件也应使用以 1.30.21 开头的版本，若 DolphinDB Server 是 2.00.9 版本，插件应使用以 2.00.9 开头的版本，其他版本依此类推。自 2.00.9/1.30.21 版本起，插件文件中增加了版本号信息。一旦插件与服务器版本号不匹配，在加载插件时会报错并停止加载。请在升级服务器后及时更新相应的插件，且不要随意修改已发布插件 txt 文件中的版本号。 使用 loadPlugin 函数加载外部插件。该函数接受一个文件路径，该文件描述插件的格式，例如：

loadPlugin("mysql"); 

DolphinDB 使用一个文本文件来描述插件。该文件格式如下：首行描述插件名字和共享库文件名，其后每一行都描述一个共享库函数和 DolphinDB 函数的映射关系。

module name, lib file, plugin version
function name in lib, function name in DolphinDB, function type, minParamCount, maxParamCount, isAggregate, isSequential
...
...

解释：

• module name: 模块名
• lib file: 共享文件库文件名
• plugin version: 插件版本号
• function name in lib: 共享库中导出的函数名
• function name in DolphinDB: DolphinDB 中的对应函数名
• function type: operator 或者 system，分别表示支持一个或两个参数的 Operator Functions 和支持任意数量参数的 System Functions
• minParamCount: 最少参数个数
• maxParamCount：最多参数个数
• isAggregate: 是否为聚合函数，可选值为 0（非聚合函数，默认值）或 1（聚合函数）
• isSequential：是否为序列函数，可选值为 0（非序列函数，默认值）或 1（序列函数）

PluginDemo.txt:

demo,libPluginDemo.so,2.00.9.1.1
minmax,minmax,operator,1,1,0
foo,foo,system,1,1,0

以上描述文件定义了一个名为 demo 的插件，共享库文件名为 libPluginDemo.so。插件版本号为 2.00.9.1.1。插件导出两个函数，第一个函数为 minmax，该函数在 DolphinDB 中名字同样是 minmax，operator 类型，接受一个参数；第二个函数名字为 echo，DolphinDB 中名字同样是 echo，system 类型，接受一个参数。

写完描述文件之后，即可开始编写插件。内容请参考 demo (./demo) 文件夹内容。

编译需要用到 DolphinDB 的核心库 libDolphinDB.so 或 libDolphinDB.dll，该核心库实现了 include(./include) 目录下声明的类。编译步骤如下（以 Linux 操作系统上编译为例）：

cd demo
g++ -DLINUX -fPIC -std=c++11 -D_GLIBCXX_USE_CXX11_ABI=0 -DLOCKFREE_SYMBASE -c src/Demo.cpp -I../include -o Demo.o
g++ -fPIC -shared -o libPluginDemo.so Demo.o -lDolphinDB -L/home/DolphinDB_Linux64_V1.20.0/server

请注意：

1. 插件分支应与 DolphinDB Server 的版本相匹配，即若 DolphinDB Server 是 1.00 版本，插件应用 release100 分支，若 DolphinDB Server 是 1.10 版本，插件应该用 release110 分支，其他版本依此类推，server 最新版匹配插件 master 分支。
2. 为了兼容旧的编译器，libDolphinDB.so 编译时使用了 -D_GLIBCXX_USE_CXX11_ABI=0 的选项，因此用户在编译插件的时候也应该加入该选项。若 server 是 ABI=1 的最新版，可不加。
3. 上面命令中编译选项-L 的路径，应根据 DolphinDB 动态库的实际路径修改。

编译成功后，目录下会生成一个名为 libPluginDemo.so 的共享文件。

在 DolphinDB 的控制台中输入下列命令加载插件并使用：

loadPlugin(PluginDemo.txt的路径); // 加载插件
(minmax,echo)
use demo; // 引入插件的命名空间
demo::minmax([12,3,4]); // 也可以使用minmax([12,3,4])
[3,12]
demo::echo("foo");
foo
echo(1);
1

• 建议使用 ld 命令检查下编译器链接是否成功，.so 文件中是否存在未定义的引用。如果 ld 报错，那么 DolphinDB 也无法正确加载插件。
• 如果载入插件之后出现了 crash，可以采取尝试以下步骤。
  1. 确保 include(./include) 下的头文件和 libDolphinDB.so 或 libDolphinDB.dll 实现保持一致。
  2. 确保用于编译插件的 gcc 版本和编译 libDolphinDB.so 或 libDolphinDB.dll 的版本保持一致，以免出现不同版本的编译器 ABI 不兼容的问题。
  3. 插件与 DolphinDB server 在同一个进程中运行，若插件 crash，那整个系统就会 crash。因此在开发的插件时候要注意完善错误检测机制，除了插件函数所在线程可以抛出异常（server 在调用插件函数时俘获了异常），其他线程都必须自己俘获异常，并不得抛出异常。
  4. 确保宏 LOCKFREE_SYMBASE 已经添加。
• 如果编译时出现链接问题（undefined reference），并且包含 std::__cxx11 字样，务必检查用于编译插件的 gcc 版本（gcc 6.2.0 且有--disable-libstdcxx-dual-abi）。