https://github.com/aallali/safinadb
SafinaDB (safina;سفينة;ship;saa-fee-na) is a custom-built database engine designed to be efficient, stable and fast (for learning purposes). Inspired by the Arabic word for "ship".
https://github.com/aallali/safinadb
database key-value-store learning-by-doing rust storage-engine
Last synced: about 2 months ago
JSON representation
SafinaDB (safina;سفينة;ship;saa-fee-na) is a custom-built database engine designed to be efficient, stable and fast (for learning purposes). Inspired by the Arabic word for "ship".
- Host: GitHub
- URL: https://github.com/aallali/safinadb
- Owner: aallali
- License: mit
- Created: 2024-05-20T11:50:56.000Z (about 1 year ago)
- Default Branch: v1
- Last Pushed: 2024-06-11T07:53:45.000Z (12 months ago)
- Last Synced: 2025-04-11T00:04:07.842Z (about 2 months ago)
- Topics: database, key-value-store, learning-by-doing, rust, storage-engine
- Language: Rust
- Homepage: https://aallali.github.io/SafinaDB/
- Size: 2.75 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Roadmap: roadmaps/version1.md
Awesome Lists containing this project
README
>
# SafinaDB
SafinaDB (safina;سفينة;ship;saa-fee-na) is a custom-built database engine designed to be efficient, stable and fast **(for learning purposes)**. Inspired by the Arabic word for "ship".
This project is developed incrementally, starting from a basic key-value store to an advanced distributed database system.
## 📋 Table of contents
- [Project Roadmap](#️-project-roadmap)
- [Getting Started](#-getting-started)
---
## 🗺️ Project Roadmap
### [Version 1: Basic Key-Value Store](https://github.com/aallali/SafinaDB/blob/v1/roadmaps/version1.md) ⏳
- Data Storage: File-based storage for key-value pairs.
- Basic CRUD Operations: Create, Read, Update, Delete functionality.
- Simple CLI: Command-line interface for interacting with the database.
### Version 2: In-Memory Cache
- In-Memory Data Structure: Add an in-memory hash map for faster access.
- Write-Through Cache: Implement caching with write-through to disk.
- Basic Indexing: Simple in-memory indexing for fast lookups.
### Version 3: Persistence and Recovery
- Log-based Storage: Implement write-ahead logging for durability.
- Recovery Mechanism: Add crash recovery to replay logs.
- Data Serialization: Efficient serialization and deserialization of data.
### Version 4: Advanced Indexing
- B-Tree Indexes: Implement B-tree indexing for efficient range queries.
- Secondary Indexes: Add support for secondary indexes.
- Query Optimization: Basic query optimization techniques.
### Version 5: Concurrency Control
- Locking Mechanism: Implement basic locking for concurrent access.
- Transactions: Support for transactions with ACID properties.
- Isolation Levels: Implement different transaction isolation levels.
### Version 6: Replication
- Master-Slave Replication: Basic replication for high availability.
- Data Synchronization: Mechanism to sync data between nodes.
- Fault Tolerance: Basic fault tolerance and failover.
### Version 7: Advanced Features
- Query Language: Implement a simple query language (e.g., SQL-like syntax).
- Stored Procedures: Support for stored procedures and functions.
- User Authentication: Basic user authentication and access control.
## [future goals] Will keep them here for motivation.
### *Version 8: Performance Optimization*
- Caching Strategies: Implement advanced caching strategies.
- Compression: Data compression for efficient storage.
- Performance Tuning: Optimize data structures and algorithms for performance.
### *Version 9: Distributed Database*
- Sharding: Implement data sharding across multiple nodes.
- Consistency Protocols: Implement consistency protocols like Quorum or Paxos.
- Distributed Transactions: Support for distributed transactions and two-phase commit.
### *Version 10: Final Refinements*
- Comprehensive Testing: Extensive testing for stability and performance.
- Documentation: Detailed documentation and user guides.
- Release: Finalize the release and publish as an open-source project.
## 🏁 Getting Started
To get started with SafinaDB, follow these steps:
1. **Clone the repository**:
```bash
git clone https://github.com/aallali/SafinaDB.git
cd SafinaDB/safina_db
```
1. **Build the project**:
```bash
make build
```
1. **Use the CLI**:
```bash
make run
```
1. **Run tests**:
```bash
make test
```
1. **Run benchmarks**:
```bash
make bench
```
1. **Generate documentation**:
```bash
make doc
```