diff --git a/README.md b/README.md index c65a299f3407dd53bc12b1b21429a99b5aa98c41..7dd1bcf9de46c96251287e9b9c5264c3a674e6e4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # LevelDB_Rust #### 介绍 + LevelDB for rust. LevelDB是一款写性能十分优秀的可持久化的KV存储引擎，其实现原理是依据LSM-Tree（Log Structed-Merge Tree）. @@ -12,85 +13,92 @@ LevelDB是一款写性能十分优秀的可持久化的KV存储引擎，其实 LSM tree (log-structured merge-tree) 是一种对写操作非常友好的存储方案。 -LSM tree 是许多 KV型或日志型数据库所依赖的核心实现，例如BigTable、HBase、Cassandra、LevelDB、SQLite、RocksDB 等 - +LSM tree 是许多 KV型或日志型数据库所依赖的核心实现，例如BigTable、HBase、Cassandra、LevelDB、SQLite、RocksDB 等 #### 安装教程 -1. xxxx +1. xxxx #### 使用说明 -1. xxxx +1. xxxx #### 参与贡献 -1. Fork 本仓库 -2. 新建 feat/1.0.0_util_xxx 分支 -3. 提交代码 -4. 新建 Pull Request - +1. Fork 本仓库 +2. 新建 feat/1.0.0_util_xxx 分支 +3. 提交代码 +4. 新建 Pull Request ## TODO + [TODO和分工](doc/TODOList.md) ## 编码和git规范 + [编码和git规范](doc/CodeStyle.md) ## RoadMap -1. 1.0.0 版本, 完成 util 相关的内容 -| 功能模块 | 完成人 | 进度 | -|-------------------------------|-----------------|------| -| Arena (Memory Management) | wangboo | 100% | -| bloom | fengyang | 10% | -| Cache | colagy | 10% | -| Coding (Primitive Type SerDe) | colagy | 100% | -| Comparator | fengyang | 90% | -| CRC | wangboo、lxd5866 | 100% | -| Env | lxd5866 | | -| filter_policy | fengyang | 10% | -| Hash | fengyang | 100% | -| Histgram | kazeseiriou | 100% | -| loging | | | -| MutexLock | kazeseiriou | 100% | -| Random | colagy | | -| Status | fengyang | 100% | -| Slice | wangboo | 100% | +1. 1.0.0 版本, 完成 util 相关的内容 +| 功能模块 | 完成人 | 进度 | +|----------------------------------------|-----------------|------| +| Arena (Memory Management) | wangboo | 100% | +| bloom | fengyang | 10% | +| Cache | colagy | 10% | +| Coding (Primitive Type SerDe) | colagy | 100% | +| Comparator | fengyang | 90% | +| CRC | wangboo、lxd5866 | 100% | +| Env | lxd5866 | | +| filter_policy | fengyang | 10% | +| Hash | fengyang | 100% | +| Histgram | kazeseiriou | 100% | +| loging | | | +| MutexLock | kazeseiriou | 100% | +| Random | colagy | | +| Status | fengyang | 100% | +| Slice | wangboo | 100% | 2. 1.1.0 版本, 完成基础零部件 - -| 功能模块 | 完成人 | 进度 | -|-------------------------------------------------------------------------------|----------|---| -| util.Options(ReadOptions、WriteOptions) | 未认领 | | -| util.ENV(WritableFile、SequentialFile、RandomAccessFile、FileLock) | 未认领 | | -| util.Logger | 未认领 | | -| table.Block、BlockBuilder、FilterBlockBuilder | 未认领 | | -| FilterBlock、FilterBlockReader | 未认领 | | -| table.format(Footer、BlockHandle) | 未认领 | | -| db.dbformat(InternalKeyComparator、InternalFilterPolicy、LookupKey、InternalKey) | 未认领 | | -| db.SkipList | 未认领 | | -| table.Iterator(DBIter、MergingIterator、TwoLevelIterator...) | 未认领 | | -| IteratorWrapper | 未认领 | | -| db.MemTable(MemTable、MemTableIterator) | 未认领 | | -| table.Table | 未认领 | | -| db.leveldb_util | 未认领 | | -| db.log_format | 未认领 | | -| db.LogReader | wangboo | 90% | -| db.LogWriter | wangboo | 90% | -| db.TableCache | colagy | | -| db.VersionEdit(Tag、VersionEdit、FileMetaData) | fengyang | | -| db.VersionSet(Version、LevelFileNumIterator、SaverState) | fengyang | | -| WriteBatch | 未认领 | | +| 功能模块 | 完成人 | 进度 | +|----------------------------------------------------------------------------------|-------------|-----| +| util.Options(ReadOptions, WriteOptions) | kazeseiriou | | +| util.ENV(WritableFile, SequentialFile, RandomAccessFile, FileLock) | lxd5866 | | +| util.Logger | peach | | +| table.Block, BlockBuilder, FilterBlockBuilder | colagy | | +| FilterBlock, FilterBlockReader | colagy | | +| table.format(Footer, BlockHandle) | fengyang | | +| db.dbformat(InternalKeyComparator, InternalFilterPolicy, LookupKey, InternalKey) | fengyang | | +| db.SkipList | wangboo | | +| table.Iterator(DBIter, MergingIterator, TwoLevelIterator...) | kazeseiriou | | +| IteratorWrapper | kazeseiriou | | +| db.MemTable(MemTable, MemTableIterator) | wangboo | | +| SSTable | fengyang | | +| table.Table | peach | | +| db.leveldb_util | hui | | +| db.log_format | hui | | +| db.LogReader | wangboo | 90% | +| db.LogWriter | wangboo | 90% | +| db.TableCache | colagy | | +| db.VersionEdit(Tag, VersionEdit, FileMetaData) | fengyang | | +| db.VersionSet(Version, LevelFileNumIterator, SaverState) | fengyang | | +| WriteBatch | peach | | 3. 1.2.0 版本, 完成核心组件 -| 功能模块 | 完成人 | 进度 | -|--------------------|---------|-----| -| DB(DBImpl、ModelDB) | 未认领 | | -| Repairer | 未认领 | | -| Snapshot | 未认领 | | -| DumpFile | 未认领 | | -| | 未认领 | | \ No newline at end of file +| module | contributor | process | +|---------------------|-------------|---------| +| DB(DBImpl, ModelDB) | none | | +| Repairer | none | | +| Snapshot | none | | +| DumpFile | none | | +| | none | | + +4. todo + gitee -> github (同步) 主仓库gitee, github用于申请JetBrains账号 + 官网交给辉哥, 展示一些要做的内容和产品信息 + 接口先确定对齐, 先不要写实现, 时间: 1月17号晚, 1月18号下午 + 注释 使用rust标准, 使用中文注释 +