2 releases
0.1.0-beta.0 | Apr 9, 2023 |
---|---|
0.1.0-alpha.0 | Oct 14, 2022 |
#506 in Database interfaces
28 downloads per month
430KB
6K
SLoC
KipDB - Keep it Public DB
KipDB 轻量级键值存储引擎
整体设计参考LevelDB,旨在作为NewSQL分布式数据库的存储引擎
- 支持嵌入式/单机存储/远程调用等多应用场景
- 以Kiss作为开发理念,设计以简单而高效为主
- 实现MVCC以支持ACID
- 高性能,BenchMark写入吞吐量约为Sled的两倍,且大数据量下的顺序读取平均延迟为1μs左右
- 远程连接使用ProtoBuf实现,支持多语言通信
- 极小的内存占用(待机/大量冷数据)
- 并发安全,读读、读写并行
快速上手 🤞
直接调用
/// 指定文件夹以开启一个KvStore
let kip_db = LsmStore::open("/welcome/kip_db").await?;
// 插入数据
kip_db.set(&vec![b'k'], vec![b'v']).await?;
// 获取数据
let key_1 = kip_db.get(&vec![b'k']).await?;
// 已占有硬盘大小
kip_db.size_of_disk().await?
// 已有数据数量
kip_db.len().await?;
// 删除数据
kip_db.remove(&vec![b'k']).await?;
// 创建事务
let mut transaction = kip_db.new_transaction().await?;
// 插入数据至事务中
transaction.set(&vec![b'k'], vec![b'v']);
// 删除该事务中key对应的value
transaction.remove(&vec![b'k']).await?;
// 获取此事务中key对应的value
let key_2 = transaction.get(&vec![b'k']).await?;
// 提交事务
transaction.commit().await?;
// 强制数据刷入硬盘
kip_db.flush().await?;
远程应用
服务启动
/// 服务端启动!
let listener = TcpListener::bind("127.0.0.1:8080").await?;
kip_db::net::server::run(listener, tokio::signal::ctrl_c()).await;
远程调用
/// 客户端调用!
let mut client = Client::connect("127.0.0.1:8080").await?;
// 插入数据
client.set(&vec![b'k'], vec![b'v']).await?
// 获取数据
client.get(&vec![b'k']).await?
// 已占有硬盘大小
client.size_of_disk().await?
// 存入指令数
client.len().await?
// 数据刷入硬盘
client.flush().await?
// 删除数据
client.remove(&vec![b'k']).await?;
// 批量指令执行(可选 并行/同步 执行)
let vec_batch_cmd = vec![CommandData::get(b"k1".to_vec()), CommandData::get(b"k2".to_vec())];
client.batch(vec_batch_cmd, true).await?
内置多种持久化内核👍
- LsmStore: LSM存储,使用Leveled Compaction策略(默认内核)
- HashStore: 类Bitcask
- SledStore: 基于Sled数据库进行封装
操作示例⌨️
服务端
PS D:\Workspace\kould\KipDB\target\release> ./server -h
KipDB-Server 0.1.0
Kould <2435992353@qq.com>
A KV-Store server
USAGE:
server.exe [OPTIONS]
OPTIONS:
-h, --help Print help information
--ip <IP>
--port <PORT>
-V, --version Print version information
PS D:\Workspace\kould\KipDB\target\release> ./server
2022-10-13T06:50:06.528875Z INFO kip_db::kernel::lsm::ss_table: [SsTable: 6985961041465315323][restore_from_file][TableMetaInfo]: MetaInfo { level: 0, version: 0, data_len: 118, index_len: 97, part_size: 64, crc_code: 43553795 }, Size of Disk: 263
2022-10-13T06:50:06.529614Z INFO kip_db::net::server: [Listener][Inbound Connections]
2022-10-13T06:50:13.437586Z INFO kip_db::net::server: [Listener][Shutting Down]
客户端
PS D:\Workspace\kould\KipDB\target\release> ./cli --help
KipDB-Cli 0.1.0
Kould <2435992353@qq.com>
Issue KipDB Commands
USAGE:
cli.exe [OPTIONS] <SUBCOMMAND>
OPTIONS:
-h, --help Print help information
--hostname <hostname> [default: 127.0.0.1]
--port <PORT> [default: 6333]
-V, --version Print version information
SUBCOMMANDS:
batch-get
batch-remove
batch-set
flush
get
help Print this message or the help of the given subcommand(s)
len
remove
set
size-of-disk
PS D:\Workspace\kould\KipDB\target\release> ./cli batch-set kould kipdb welcome !
2022-09-27T09:50:11.768931Z INFO cli: ["Done!", "Done!"]
PS D:\Workspace\kould\KipDB\target\release> ./cli batch-get kould kipdb
2022-09-27T09:50:32.753919Z INFO cli: ["welcome", "!"]
Features🌠
- Marjor Compation
- 多级递增循环压缩 ✅
- SSTable压缩状态互斥
- 避免并行压缩时数据范围重复 ✅
- KVStore
- 参考Sled增加api
- size_of_disk ✅
- clear
- contains_key
- len ✅
- is_empty ✅
- ...
- 多进程锁 ✅
- 防止多进程对文件进行读写造成数据异常
- 参考Sled增加api
- SSTable
- 布隆过滤器 ✅
- 加快获取键值的速度
- MetaBlock ✅
- 用于存储统计数据布隆过滤器的存放
- 布隆过滤器 ✅
- Block
- DataBlock、IndexBlock复用实现并共享缓存 ✅
- 实现前缀压缩并使用varint编码以及LZ4减小空间占用 ✅
- 基于前缀进行二分查询 ✅
- Cache
- TableCache: SSTable Level 0缓存 ✅
- 读取频繁,因此使用Mmap进行只读映射
- BlockCache: 稀疏索引数据块缓存 ✅
- 类LevelDB的并行LruCache: ShardingLruCache ✅
- TableCache: SSTable Level 0缓存 ✅
- WAL 防灾日志
- 落盘时异常后重启数据回复 ✅
- 读取数据不存在时尝试读取 ✅
- MVCC单机事务 ✅
- Manifest多版本持久化 ✅
- SSTable多版本持久化 ✅
- 网络通信
- 使用ProtoBuf进行多语言序列化 ✅
- Ruby of KipDB
- Java of KipDB
- Rust of KipDB ✅
- 分布式
- 使用Raft复制协议保持状态一致
Perf火焰图监测
- 为了方便性能调优等监测,提供了两个Dockerfile作为支持
- Dockerfile: KipDB的Server与Cli
- Dockerfile-perf: 外部Perf监测
使用步骤
- 打包KipDB本体镜像
docker build -t kould/kip-db:v1 .
- 打包Perf监测镜像
docker build -f Dockerfile-perf -t kould/perf:v1 .
- 以任意形式执行kould/kip
- 例:
docker run kould/kip-db:v1
- 例:
- 执行
attach-win.sh <kip-db容器ID>
- 例:
./attach-win.sh 263ad21cc56169ebec79bbf614c6986a78ec89a6e0bdad5e364571d28bee2bfc
- 例:
- 在该bash内输入.
record.sh <kip-db的server进程pid>
- 若不清楚进程id是多少可以直接输入ps,通常为1
- 注意!: 不要关闭bash,否则会监听失败!
- 随后去对KipDB进行对应需要监测的操作
- 操作完毕后回到步骤5的bash内,以ctrl + c终止监听,得到perf.data
- 继续在该bash内输入
. plot.sh <图片名.svg>
, 即可生成火焰图- 导出图片一般可使用
docker cp
和docker exec
或挂载 volume,为方便预览和复制文件,容器内置了轻量网页服务,执行thttpd -p <端口号>
即可。由于脚本中没有设置端口转发,需要docker inspect <目标容器ID> | grep IPAdress
查看目标容器的 IP,然后在浏览器中访问即可。若需要更灵活的操作,可不用以上脚本手动添加参数运行容器。
- 导出图片一般可使用
参考自:https://chinggg.github.io/post/docker-perf/
如果你想参与我们的工作、提供更好的意见或抱着一起学习的心态,欢迎联系我以加入群聊
Thanks For
Dependencies
~12–18MB
~303K SLoC