0.3.0 |
|
---|
#20 in #orderbook
125KB
3K SLoC
tectonicdb
crate | docs.rs | crate.io |
---|---|---|
tectonicdb | ||
tdb-core | ||
tdb-server-core | ||
tdb-cli |
tectonicdb是一个快速、高度压缩的独立数据库和订单簿ticks流协议。
为什么
-
使用简单高效的二进制文件格式:密集tick格式(DTF)
-
存储订单簿tick数据元组,形状如下:
(时间戳, 序号, 是否为交易, 是否为买入, 价格, 大小)
。 -
按时间戳 + 序号排序
-
每个订单簿事件12字节
-
每秒每个线程600,000次插入
安装
安装tectonicdb有多种方式。
- 二进制文件
二进制文件可供下载。请确保将二进制文件的路径添加到您的PATH。目前仅支持Linux x86_64构建。
- Crates
cargo install tectonicdb
此命令将从crates.io下载tdb
、tdb-server
、dtftools
二进制文件并在本地构建。
- GitHub
要贡献,您需要在本地机器上获取源代码副本。
git clone https://github.com/0b01/tectonicdb
cd tectonicdb
cargo build --release
cargo run --release tdb-server
二进制文件位于target/release
下。
如何使用
设置非常简单。
./tdb-server --help
例如
./tdb-server -vv -a -i 10000
# run the server on INFO verbosity
# turn on autoflush for every 10000 inserts per orderbook
配置
为了配置Google Cloud Storage和数据收集后端集成,使用以下环境变量
变量名称 | 默认值 | 描述 |
---|---|---|
TDB_HOST |
0.0.0.0 | 数据库将绑定到的主机 |
TDB_PORT |
9001 | 数据库将监听端口号 |
TDB_DTF_FOLDER |
db | DTF文件将存储的目录名称 |
TDB_AUTOFLUSH |
false | 如果设置为true ,则记录的订单簿数据将在每interval 次插入后自动刷新到DTF文件。 |
TDB_FLUSH_INTERVAL |
1000 | 每interval 次插入,如果启用了autoflush,则DTF文件将从内存写入磁盘。 |
TDB_GRANULARITY |
0 | 记录历史粒度级别 |
TDB_LOG_FILE_NAME |
tdb.log | 数据库的日志文件名称 |
TDB_Q_CAPACITY |
300 | 记录历史的环形队列容量 |
客户端API
命令 | 描述 |
---|---|
HELP | 打印帮助信息 |
PING | 响应PONG |
INFO | 返回有关表模式的信息 |
PERF | 返回物品随时间变化的answercount |
加载[orderbook] | 从磁盘加载orderbook到内存 |
使用[orderbook] | 切换当前orderbook |
创建[orderbook] | 创建orderbook |
从[orderbook]获取[n] | 返回物品 |
获取[n] | 从当前orderbook返回n个物品 |
计数 | 当前orderbook中物品的计数 |
计数全部 | 返回所有orderbook的总计数 |
清除 | 删除当前orderbook中的所有内容 |
清除全部 | 删除内存中的所有内容 |
刷新 | 将当前orderbook刷新到硬盘 |
刷新全部 | 将内存中的所有内容刷新到硬盘 |
订阅[orderbook] | 订阅orderbook的更新 |
检查[orderbook]是否存在 | 检查orderbook是否存在 |
订阅[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
$ tdb --influx-db market_data --influx-host https://127.0.0.1:8086 --influx-log-interval 20
...
TectonicDB将以标签ob={ORDERBOOK}
发送字段值disk={COUNT_DISK},size={COUNT_MEM}
到market_data
测量,这与dbname相同。
此外,您可以直接使用INFO
和PERF
命令查询使用信息
-
INFO
报告内存和磁盘中的当前tick计数。 -
PERF
返回记录的tick计数历史,其粒度可以配置。
日志记录
默认的日志文件为tdb.log
。
测试
export RUST_TEST_THREADS=1
cargo test
测试必须按顺序运行,因为某些测试依赖于其他测试生成的dtf文件。
基准测试
tdb客户端包含一个基准测试模式。此命令将1M条记录插入tdb。
tdb -b 1000000
使用dtf文件
Tectonic附带一个命令行工具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.5.0: InfluxDB监控插件和改进的命令行参数
- 0.4.0: 处理DTF文件的基于迭代器的API和各种质量改进
- 0.3.0: 重构为异步
依赖项
~7MB
~103K SLoC