{"id":17718439,"url":"https://github.com/kevinzh0a/bitkv-rs","last_synced_at":"2025-09-02T18:47:50.569Z","repository":{"id":229808283,"uuid":"762958097","full_name":"KevinZh0A/bitkv-rs","owner":"KevinZh0A","description":"A k/v storage engine inspired by bitcask written in Rust","archived":false,"fork":false,"pushed_at":"2024-06-13T16:12:33.000Z","size":194,"stargazers_count":9,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-06T05:29:19.187Z","etag":null,"topics":["bitcask","database","kv"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KevinZh0A.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-02-25T06:59:34.000Z","updated_at":"2024-09-27T14:49:17.000Z","dependencies_parsed_at":"2024-04-27T12:23:33.802Z","dependency_job_id":"cc1acc11-9824-4475-b583-84a5d1f82edb","html_url":"https://github.com/KevinZh0A/bitkv-rs","commit_stats":null,"previous_names":["kevinzh0a/bitkv-rs"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KevinZh0A%2Fbitkv-rs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KevinZh0A%2Fbitkv-rs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KevinZh0A%2Fbitkv-rs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KevinZh0A%2Fbitkv-rs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KevinZh0A","download_url":"https://codeload.github.com/KevinZh0A/bitkv-rs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251342720,"owners_count":21574244,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bitcask","database","kv"],"created_at":"2024-10-25T14:49:52.667Z","updated_at":"2025-04-28T16:02:16.335Z","avatar_url":"https://github.com/KevinZh0A.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\u003ch1\u003eBitkv\u003c/h1\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n[\u003cimg alt=\"github\" src=\"https://img.shields.io/badge/github-KevinZh0A%2Fbitkv-8da0cb?style=for-the-badge\u0026logo=GitHub\u0026label=github\u0026color=8da0cb\" height=\"22\"\u003e][Github-url]\n[\u003cimg alt=\"Build\" src=\"https://img.shields.io/github/actions/workflow/status/KevinZh0A/bitkv-rs/rust.yml?branch=main\u0026style=for-the-badge\u0026logo=Github-Actions\u0026cacheSeconds= d\" height=\"22\"\u003e][CI-url]\n[\u003cimg alt=\"Codecov\" src=\"https://img.shields.io/codecov/c/gh/KevinZh0A/bitkv-rs?token=6DNS3IF3MO\u0026style=for-the-badge\u0026logo=codecov\" height=\"22\"\u003e][codecov-url]\n\u003cimg alt=\"GitHub License\" src=\"https://img.shields.io/github/license/KevinZh0A/bitkv-rs?style=for-the-badge\u0026logo=license\u0026label=license\" height=\"22\"\u003e\n\nAn efficient key-value storage engine, designed for fast reading and writing, which is inspired by [Bitcask][bitcask_url].\n\nSee [Introduction](#introduction), [Installation](#installation) and [Usages](#usages) for more details.\n\n\u003c/div\u003e\n\n## Introduction\n\nBitkv is a high-performance key-value storage system written in Rust. It leverages a log-structured design with an append-only write approach to deliver exceptional speed, reliability, and scalability.\n\n### Features\n\n- **Efficient Key-Value Storage:** Optimized for fast read and write operations with minimal overhead.\n- **Diverse Index:** Support BTree, Skiplist, BPlusTree index for multiple index strategies.\n- **MemMap files for efficient I/O:**  To achieve rapid index reconstruction and enhance startup speeds\n- **Low latency per item read or written:** Benchmarks run on a Macintosh with Apple M1 Core:\n    - Write latency:  `~ 3.3 µs`\n    - Read latency:  `~ 370 ns` \n- **Concurrency Support:**   fine-grained locking minimizes contentions.\n- **WriteBatch transaction:**   commit a batch of writes to ensure atomicity.\n\n\n## Installation\n\nTo use bitkv in your project, add it as a dependency in your Cargo.toml file:\n\n  ```toml\n  [dependencies]\n  bitkv-rs = \"0.2.1\"\n  ```\nThen, run cargo build to download and compile bitkv-rs and its dependencies.\n\nFor more detailed setup and compilation instructions, visit the Bitkv-rs GitHub repository.\n\n## Usages\nPlease see [`examples`].\n\nFor detailed usage and API documentation, refer to the [bitkv-rs Documentation](https://docs.rs/bitkv-rs).\n\n## TODO\n\n- [X] Basic error handling\n- [X] Merge files during compaction\n- [X] Configurable compaction triggers and thresholds\n- [X] WriteBactch transaction\n- [X] Use mmap to read data file that on disk.\n- [X] Optimize hintfile storage structure to support the memtable build faster \n- [X] Http api server\n- [X] Tests\n- [X] Benchmark\n- [ ] Documentation \n- [ ] Increased use of flatbuffers option to support faster reading speed\n- [ ] Extend support for Redis Data Types\n\n## Contribution\n\nContributions to this project are welcome! If you find any issues or have suggestions for improvements, please raise an issue or submit a pull request.\n\n\n#### License\n\n\u003csup\u003e\nBitkv-rs is licensed under the [MIT license](https://github.com/example/bitkv-rs/blob/main/LICENSE-MIT), permitting use in both open source and private projects.\n\u003c/sup\u003e\n\u003cbr\u003e\n\u003csub\u003e\nThis license grants you the freedom to use bitkv-rs in your own projects, under the condition that the original license and copyright notice are included with any substantial portions of the Bitkv-rs software.\n\u003c/sub\u003e\n\n\n[Github-url]: https://github.com/KevinZh0A/bitkv-rs\n[CI-url]: https://github.com/KevinZh0A/bitkv-rs/actions/workflows/rust.yml\n[doc-url]: https://docs.rs/bitkv\n\n[crates-url]: https://crates.io/crates/bitkv\n[codecov-url]: https://app.codecov.io/gh/KevinZh0A/bitkv-rs\n[bitcask_url]: https://riak.com/assets/bitcask-intro.pdf\n[`examples`]: https://github.com/KevinZh0A/bitkv-rs/tree/main/examples","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkevinzh0a%2Fbitkv-rs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkevinzh0a%2Fbitkv-rs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkevinzh0a%2Fbitkv-rs/lists"}