Kdb+

Kdb+ 是可以用于存储、分析、处理和检索大型数据集的列式关系型时间序列数据库。为便于从 Kdb+ 迁移数据,DolphinDB 提供了 kdb+ 插件,支持导入 kdb+ 数据库存储在磁盘上的数据。通过 loadTable 和 loadFile 接口导入 DolphinDB 内存表。

安装插件

版本要求

DolphinDB Server: 2.00.10 及更高版本,支持 Linux x86-64, Linux JIT, Windows x86-64。

安装步骤

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

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

login("admin", "123456")
listRemotePlugins()
  1. 使用 installPlugin 命令完成插件安装。
installPlugin("kdb")
  1. 使用 loadPlugin 命令加载插件。
loadPlugin("kdb")

接口说明

connect

语法

connect(host, port, [usernamePassword])

详情

建立与 kdb+ 服务器之间的连接。返回一个连接句柄。

如果建立连接失败,则会抛出异常。包括以下三种情况:

  1. 身份认证异常,用户名或密码错误。
  2. 连接端口异常,对应主机的端口不存在。
  3. 超时异常,建立连接超时。

参数

host STRING 类型标量,表示要连接的 kdb+ 数据库所在的主机地址。

port INT 类型标量,表示要连接的 kdb+ 数据库所在的监听端口。

usernamePassword STRING 类型标量,表示所要连接的 kdb+ 数据库的登录用户名和密码。格式为 "username:password"。若启动 kdb+ 时没有指定用户名和密码,则该参数为空或任意字符串。

例子 假设登录 kdb+ 数据库的用户名和密码(admin:123456)存储在 ../passwordfiles/usrs 中,且 kdb+ 服务器和 DolphinDB server 都位于同一个主机上。

kdb+ 终端执行:

kdb shell:         q -p 5000 -U ../passwordfiles/usrs   // 注意 -U 一定需要大写

DolphinDB 客户端执行:

// 若开启 kdb+ 时指定了用户名和密码
handle = connect("127.0.0.1", 5000, "admin:123456")

// 若开启 kdb+ 时未指定用户名和密码
handle = connect("127.0.0.1", 5000)

loadTable

语法

loadTable(handle, tablePath, [symPath])

详情

连接 kdb+ 数据库,通过 kdb+ 数据库加载数据,再将数据导入 DolphinDB 内存表。

在 kdb+ 数据库中,symbol 类型可以通过枚举存入 sym 文件,在表中使用 int 类型代替字符串进行存储,以减少字符串重复存储所占的空间。因此如果需要读取的表包含了枚举的 symbol 列,则需要读入 sym 文件才能正确读取表内的 symbol 列。

参数

handle connect 返回的连接句柄。

tablePath STRING 类型标量,表示需要读取的表文件路径。如果是 splayed table, partitioned table 或 segmented table,则指定为表文件目录;如果是 single object,则指定为表文件。

symPath STRING 类型标量,表示表文件对应的 sym 文件路径。为可选参数,默认为空。此参数省略时,必须保证表内不包含被枚举的 symbol 列。

注意:路径中建议使用'/'分隔。

例子

// 表中存在被枚举的 symbol 列
DATA_DIR="/path/to/data/kdb_sample"
Txns = loadTable(handle, DATA_DIR + "/2022.06.17/Txns", DATA_DIR + "/sym")

// 拓展表中不存在 symbol 类型,或者单张表中的 symbol 列未进行枚举
DATA_DIR="/path/to/data/kdb_sample"
Txns = loadTable(handle, DATA_DIR + "/2022.06.17/Txns", DATA_DIR)

loadFile

语法

loadFile(tablePath, symPath)

详情

直接读取磁盘上的 kdb+ 数据文件,将其存入 DolphinDB 内存表。

在 kdb+ 数据库中,symbol 类型可以通过枚举存入 sym 文件,在表中使用 int 类型代替字符串进行存储,以减少字符串重复存储所占的空间。因此如果需要读取的表包含了被枚举的 symbol 列,则需要读入 sym 文件才能正确读取表内的 symbol 列。

参数

tablePath STRING 类型标量,表示需要读取的表文件路径。只能是 splayed table, partitioned table 或 segmented table 的表文件目录。

symPath STRING 类型标量,表示表文件对应的 sym 文件路径。此参数省略时,必须保证表内不包含被枚举的 symbol 列。

注意:路径中建议使用'/'分隔。

例子

//表中存在 symbol 类型,并进行了枚举
DATA_DIR="/path/to/data/kdb_sample"
Txns = loadFile(handle, DATA_DIR + "/2022.06.17/Txns", DATA_DIR + "/sym")

表中不存在 symbol 类型
DATA_DIR="/path/to/data/kdb_sample"
Txns = loadFile(handle, DATA_DIR + "/2022.06.17/Txns", DATA_DIR)

close

语法

close(handle)

详情

关闭与 kdb+ 服务器建立的连接。

参数

handle connect 返回的连接句柄。

例子

close(handle)

使用示例

loadPlugin("/home/DolphinDBPlugin/kdb/build/PluginKDB.txt")
go
// 连接 kdb+ 数据库
handle = connect("127.0.0.1", 5000, "admin:123456")

// 指定文件路径
DATA_DIR="/home/kdb/data/kdb_sample"

// 通过 loadTable,加载数据到 DolphinDB
Daily = loadTable(handle, DATA_DIR + "/2022.06.17/Daily/", DATA_DIR + "/sym")
Minute = loadTable(handle, DATA_DIR + "/2022.06.17/Minute", DATA_DIR + "/sym")
Ticks = loadTable(handle, DATA_DIR + "/2022.06.17/Ticks/", DATA_DIR + "/sym")
Orders = loadTable(handle, DATA_DIR + "/2022.06.17/Orders", DATA_DIR + "/sym")
Syms = loadTable(handle, DATA_DIR + "/2022.06.17/Syms/", DATA_DIR + "/sym")
Txns = loadTable(handle, DATA_DIR + "/2022.06.17/Txns", DATA_DIR + "/sym")
close(handle)

// 直接读磁盘文件,加载数据到 DolphinDB
Daily2 = loadFile(DATA_DIR + "/2022.06.17/Daily", DATA_DIR + "/sym")
Minute2= loadFile(DATA_DIR + "/2022.06.17/Minute/", DATA_DIR + "/sym")
Ticks2 = loadFile(DATA_DIR + "/2022.06.17/Ticks/", DATA_DIR + "/sym")
Orders2 = loadFile(DATA_DIR + "/2022.06.17/Orders/", DATA_DIR + "/sym")
Syms2 = loadFile(DATA_DIR + "/2022.06.17/Syms/", DATA_DIR + "/sym")
Txns2 = loadFile(DATA_DIR + "/2022.06.17/Txns/", DATA_DIR + "/sym")

4 导入方法说明

4.1 通过 loadTable 导入

操作顺序:connect() -> loadTable() -> close()

注意事项:

  1. 待导入的表中不应包含除 char 类型以外的 nested column。
  2. loadTable 指定的加载路径应为单个表文件,或表路径(表为拓展表、分区表或分段表时)。

4.2 通过 loadFile 导入

操作顺序:loadFile()

注意事项:

  1. 无法读取单个表(single object)。
  2. 只能读取采用 gzip 压缩方法持久化的数据。
  3. 待导入的表中不应包含除 char 类型以外的 nested column。
  4. loadFile 指定的加载路径分区下的表路径。
  5. 如果导入的表中存在 sorted、unique 、partitioned 、true index 等列属性,建议使用 loadTable,减少出错的可能

5 kdb+ 各类表文件加载方式说明

分别说明 kdb+ 四种表文件的导入方式:

  • 单张表(single object)

    只能使用 loadTable 导入。

    举例:

    目录结构:
    path/to/data
    ├── sym
    └── table_name
    handle = connect("127.0.0.1", 5000, "username:password");
    table = loadTable(handle, "path/to/data/table_name", "path/to/data/sym");
  • 拓展表(splayed table)

    使用 loadTableloadFile 导入。

    如果未压缩或使用 gzip 压缩,则推荐使用第二种方法,导入效率会更高。

    举例:

    目录结构:
    path/to/data
    ├── sym
    └── table_name
        ├── date
        ├── p
        └── ti
    handle = connect("127.0.0.1", 5000, "username:password");
    table1 = loadTable(handle, "path/to/data/table_name/", "path/to/data/sym");
    
    table2 = loadTable("path/to/data/table_name/", "path/to/data/sym");
  • 分区表(partitioned table)

    本插件无法通过指定根目录,加载整个分区表、数据库。

    但是可以将 tablePath 指定为每个分区下的表,分别加载其中的数据,然后通过脚本在 DolphinDB 中组成一张完整的表。

    举例:

    目录结构:
    path/to/data
    ├── sym
    ├── 2019.01.01
    │   └── table_name
    │       ├── p
    │       └── ti
    ├── 2019.01.02
    │   └── table_name
    │       ├── p
    │       └── ti
    └── 2019.01.03
        └── table_name
            ├── p
            └── ti
    // 获取文件夹下的所有文件信息
    fileRes=files("path/to/data");
    
    // 删除 sym 条目,避免影响数据文件夹读取
    delete from fileRes where filename='sym';
    name='table_name';
    files = exec filename from fileRes;
    
    // 新建数据表,指定 schema
    table=table(10:0,`p`ti`date, [SECOND,DOUBLE,DATE])
    
    // 读取各个分区数据
    for (file in files) {
            t = loadFile("path/to/data" +'/' + file +'/' + tablename + '/');
    
            // 添加分区名所代表的数据
            addColumn(t, ["date"],[DATE])
            length=count(t)
            newCol=take(date(file), length)
            replaceColumn!(t, "date", newCol)
    
            // 追加数据到 table 中
            table.append!(t);
    }
  • 分段表(segmented table)

    同 partitioned table,可以将各分段的各分区中的表读入,然后通过脚本在 DolphinDB 中组成一张完整的表。

6 kdb+ 与 DolphinDB 数据类型转换表

kdb+ 基本类型

kdb+DolphinDB字节长度备注
kdb+DolphinDB字节长度备注
booleanBOOL1
guidUUID16
byteCHAR1DolphinDB 中没有独立的 byte 类型,转换为长度相同的 CHAR
shortSHORT2
intINT4
longLONG8
realFLOAT4
floatDOUBLE8
charCHAR1kdb+ 中 char 空值("")当空格(" ")处理,因此不会转换为 DolphinDB CHAR 类型的空值
symbolSYMBOL4
timestampNANOTIMESTAMP8
monthMONTH4
dataDATE4
datetimeTIMESTAMP8
timespanNANOTIME8
minuteMINUTE4
secondSECOND4
timeTIME4

kdb+ 其他类型

由于 kdb+ 中常常使用 char nested list 存储字符串类型数据,因此 dolphindb kdb+ 插件支持了 char nested list 到 dolphindb string 类型的转换。

其他复杂类型如 anymap、dictionary 以及其他基本类型的 nested list 无法支持到 dolphindb 内置类型的转换。

kdb+DolphinDB字节长度备注
char nested listSTRING不超过65535