1个不稳定版本

0.6.0 2023年6月25日

#81 in 财务


3 crates 中使用

MIT 许可证

140KB
3.5K SLoC

SeismicDB

Rust crate.io doc.rs Minimum Rust version Rust stable

crate docs.rs crate.io
tectonicdb doc.rs crate.io
tdb-core doc.rs crate.io
tdb-server-core doc.rs crate.io
tdb-cli doc.rs crate.io

SeismicDB 是一个快速、高度压缩的独立数据库和流式协议,用于订单簿tick。

SeismicDB 是从已停用但非常出色的 TectonicDB 衍生出来的。 https://github.com/0b01/tectonicdb

为什么

  • 使用简单高效的二进制文件格式:密集tick格式(DTF)

  • 存储订单簿tick数据元组,形状为: (timestamp, seq, is_trade, is_bid, price, size)

  • 按时间戳 + 序号排序

  • 每个订单簿事件12字节

  • 每秒每个线程600,000个插入

安装

安装seismicdb有几种方法。

  1. 二进制文件

二进制文件可供 下载。确保将二进制文件的路径放入您的PATH中。目前只有Linux x86_64的构建。

  1. Crates
cargo install seismicdb

此命令将从crates.io下载 sdbsdb-serverdtftools 二进制文件并本地构建。

  1. GitHub

要贡献,您需要在您的本地机器上拥有源代码的副本。

git clone https://github.com/alice-comfy/SeismicDB
cd seismicdb
cargo build --release
cargo run --release sdb-server

二进制文件可以在 target/release 下找到。

如何使用

设置非常简单。

./sdb-server --help

例如

./sdb-server -vv -a -i 10000
# run the server on INFO verbosity
# turn on autoflush for every 10000 inserts per orderbook

配置

为了配置Google Cloud Storage和数据收集后端集成,使用以下环境变量

变量名称 默认值 描述
SDB_HOST 0.0.0.0 数据库将绑定到的主机
SDB_PORT 9001 数据库将监听的端口
SDB_DTF_FOLDER db DTF文件将存储的目录名称
SDB_AUTOFLUSH false 如果设置为 true,则记录的订单簿数据将每隔 interval 次插入自动刷新到DTF文件中。
SDB_FLUSH_INTERVAL 1000 每个interval插入,如果启用了autoflush,DTF文件将从小写写入磁盘。
SDB_GRANULARITY 0 记录历史粒度级别
SDB_LOG_FILE_NAME sdb.log 数据库日志文件名
SDB_Q_CAPACITY 300 记录历史循环队列的容量

客户端API

命令 描述
HELP 打印帮助信息
PING 响应PONG
INFO 返回表模式的详细信息
PERF 返回随时间变化的项的answercount
LOAD [orderbook] 从磁盘将orderbook加载到内存中
USE [orderbook] 切换当前orderbook
CREATE [orderbook] 创建orderbook
GET [n] FROM [orderbook] 返回项目
GET [n] 从当前orderbook返回n个项目
COUNT 当前orderbook中项的计数
COUNT ALL 从所有orderbook返回总计
CLEAR 删除当前orderbook中的所有内容
CLEAR ALL 删除内存中的所有内容
FLUSH 将当前orderbook刷新到“硬盘可”
FLUSHALL 将所有内容从内存刷新到磁盘
SUBSCRIBE [orderbook] 订阅orderbook的更新
EXISTS [orderbook] 检查orderbook是否存在
SUBSCRIBE [orderbook] 订阅orderbook

数据命令

USE [dbname]
ADD [ts], [seq], [is_trade], [is_bid], [price], [size];
INSERT 1505177459.685, 139010, t, f, 0.0703620, 7.65064240; INTO dbname

监控

TectonicDB支持通过定期向InfluxDB实例发送其使用信息来实现监控/警报

    --influx-db <influx_db>                        influxdb db
    --influx-host <influx_host>                    influxdb host
    --influx-log-interval <influx_log_interval>    influxdb log interval in seconds (default is 60)

具体示例,

...
$ influx
> CREATE DATABASE market_data;
> ^D
$ sdb --influx-db market_data --influx-host http://localhost:8086 --influx-log-interval 20
...

TectonicDB将发送字段值disk={COUNT_DISK},size={COUNT_MEM}带有标签ob={ORDERBOOK}market_data度量,它与dbname相同。

此外,您可以使用INFOPERF命令直接查询使用信息

  1. INFO报告内存和磁盘中的当前tick计数

  2. PERF返回记录的tick计数历史,其粒度可以配置

日志记录

日志文件默认为sdb.log

测试

export RUST_TEST_THREADS=1
cargo test

测试必须顺序运行,因为一些测试依赖于其他测试生成的dtf文件。

基准测试

sdb客户端附带基准测试模式。此命令将1M条记录插入sdb。

sdb -b 1000000

使用dtf文件

Seismic附带一个命令行工具dtfcat,用于检查文件元数据和存储的所有事件,可以是JSON或CSV。

选项

USAGE:
    dtfcat [FLAGS] --input <INPUT>

FLAGS:
    -c, --csv         output csv
    -h, --help        Prints help information
    -m, --metadata    read only the metadata
    -V, --version     Prints version information

OPTIONS:
    -i, --input <INPUT>    file to read

作为库

可以在不同的应用程序中使用Dense Tick Format流式协议/文件格式。与任何实现Write特质的缓冲区配合使用效果良好。

需求

TectonicDB是一个独立的服务。

  • Linux

  • macOS

语言绑定

  • TypeScript

  • Rust

  • Python

  • JavaScript

其他特性

  • 类似Cloud SQL的使用统计信息

  • dtf文件格式的命令行检查工具

  • 日志记录

  • 按时间戳查询

更改日志

  • 0.6.0: 第一个seismicDB分支发布。升级依赖项和rust版本到2021/最新版本。重命名并在crates.io上发布新版本。
  • 0.5.0: InfluxDB监控插件和改进的命令行参数
  • 0.4.0: 基于迭代器的API用于处理DTF文件以及各种生活质量的改进
  • 0.3.0: 异步重构

依赖关系

~4–5.5MB
~90K SLoC