| 0.3.0 |  | 
|---|
#10 in #datastore
用于 2 crate
110KB
 2.5K  SLoC
tectonicdb
| crate | docs.rs | crate.io | 
|---|---|---|
| tectonicdb | ||
| tdb-core | ||
| tdb-server-core | ||
| tdb-cli | 
tectonicdb是一个快速、高度压缩的独立数据库和流协议,用于订单簿tick。
为什么
- 
使用简单高效的二进制文件格式:密集tick格式(DTF) 
- 
存储订单簿tick数据元组,形状为: (时间戳, seq, 是否交易, 是否出价, 价格, 大小)。
- 
按时间戳 + seq排序 
- 
每个订单簿事件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 | 
| LOAD [orderbook] | 从磁盘将订单簿加载到内存 | 
| USE [orderbook] | 切换当前订单簿 | 
| CREATE [orderbook] | 创建订单簿 | 
| GET [n] FROM [orderbook] | 返回项目 | 
| GET [n] | 从当前订单簿返回n个项目 | 
| COUNT | 当前订单簿中项目的数量 | 
| COUNT ALL | 从所有订单簿返回总数 | 
| CLEAR | 删除当前订单簿中的所有内容 | 
| CLEAR ALL | 删除内存中的所有内容 | 
| FLUSH | 将当前订单簿刷新到"Howdisk can | 
| FLUSHALL | 将所有内容从内存刷新到磁盘 | 
| SUBSCRIBE [orderbook] | 订阅订单簿的更新 | 
| EXISTS [orderbook] | 检查订单簿是否存在 | 
| SUBSCRIBE [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://: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: 重构为异步
依赖关系
~6.5MB
~99K SLoC