{"id":24797250,"url":"https://github.com/aallali/safinadb","last_synced_at":"2025-04-11T00:04:15.810Z","repository":{"id":240974527,"uuid":"803264342","full_name":"aallali/SafinaDB","owner":"aallali","description":"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\".","archived":false,"fork":false,"pushed_at":"2024-06-11T07:53:45.000Z","size":2884,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"v1","last_synced_at":"2025-04-11T00:04:07.842Z","etag":null,"topics":["database","key-value-store","learning-by-doing","rust","storage-engine"],"latest_commit_sha":null,"homepage":"https://aallali.github.io/SafinaDB/","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/aallali.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":"roadmaps/version1.md","authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-20T11:50:56.000Z","updated_at":"2024-10-04T02:12:00.000Z","dependencies_parsed_at":"2024-06-09T17:13:01.893Z","dependency_job_id":"1d2d4059-703d-4cf2-b338-415b06be6c86","html_url":"https://github.com/aallali/SafinaDB","commit_stats":null,"previous_names":["aallali/safinadb"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aallali%2FSafinaDB","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aallali%2FSafinaDB/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aallali%2FSafinaDB/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aallali%2FSafinaDB/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aallali","download_url":"https://codeload.github.com/aallali/SafinaDB/tar.gz/refs/heads/v1","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248317705,"owners_count":21083528,"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":["database","key-value-store","learning-by-doing","rust","storage-engine"],"created_at":"2025-01-30T01:19:01.777Z","updated_at":"2025-04-11T00:04:15.784Z","avatar_url":"https://github.com/aallali.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n   \u003cimg src=\"https://i.imgur.com/09pNQV4.png\" alt=\"safinaDbLogo\" width=\"250\"/\u003e\u003e\n\u003c/p\u003e\n\n# SafinaDB\n\nSafinaDB (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\".\nThis project is developed incrementally, starting from a basic key-value store to an advanced distributed database system.\n\n\n## 📋 Table of contents\n- [Project Roadmap](#️-project-roadmap)\n- [Getting Started](#-getting-started)\n\n---\n\n## 🗺️ Project Roadmap\n\n### [Version 1: Basic Key-Value Store](https://github.com/aallali/SafinaDB/blob/v1/roadmaps/version1.md) ⏳\n- Data Storage: File-based storage for key-value pairs.\n- Basic CRUD Operations: Create, Read, Update, Delete functionality.\n- Simple CLI: Command-line interface for interacting with the database.\n\n### Version 2: In-Memory Cache\n- In-Memory Data Structure: Add an in-memory hash map for faster access.\n- Write-Through Cache: Implement caching with write-through to disk.\n- Basic Indexing: Simple in-memory indexing for fast lookups.\n\n### Version 3: Persistence and Recovery\n- Log-based Storage: Implement write-ahead logging for durability.\n- Recovery Mechanism: Add crash recovery to replay logs.\n- Data Serialization: Efficient serialization and deserialization of data.\n\n### Version 4: Advanced Indexing\n- B-Tree Indexes: Implement B-tree indexing for efficient range queries.\n- Secondary Indexes: Add support for secondary indexes.\n- Query Optimization: Basic query optimization techniques.\n\n### Version 5: Concurrency Control\n- Locking Mechanism: Implement basic locking for concurrent access.\n- Transactions: Support for transactions with ACID properties.\n- Isolation Levels: Implement different transaction isolation levels.\n\n### Version 6: Replication\n- Master-Slave Replication: Basic replication for high availability.\n- Data Synchronization: Mechanism to sync data between nodes.\n- Fault Tolerance: Basic fault tolerance and failover.\n\n### Version 7: Advanced Features\n- Query Language: Implement a simple query language (e.g., SQL-like syntax).\n- Stored Procedures: Support for stored procedures and functions.\n- User Authentication: Basic user authentication and access control.\n\n## [future goals] Will keep them here for motivation.\n### *Version 8: Performance Optimization*\n- Caching Strategies: Implement advanced caching strategies.\n- Compression: Data compression for efficient storage.\n- Performance Tuning: Optimize data structures and algorithms for performance.\n\n### *Version 9: Distributed Database*\n- Sharding: Implement data sharding across multiple nodes.\n- Consistency Protocols: Implement consistency protocols like Quorum or Paxos.\n- Distributed Transactions: Support for distributed transactions and two-phase commit.\n\n### *Version 10: Final Refinements*\n- Comprehensive Testing: Extensive testing for stability and performance.\n- Documentation: Detailed documentation and user guides.\n- Release: Finalize the release and publish as an open-source project.\n\n## 🏁 Getting Started\n\nTo get started with SafinaDB, follow these steps:\n\n1. **Clone the repository**:\n   ```bash\n   git clone https://github.com/aallali/SafinaDB.git\n   cd SafinaDB/safina_db\n   ```\n\n1. **Build the project**:\n   ```bash\n   make build\n   ```\n\n1. **Use the CLI**:\n   ```bash\n   make run\n   ```\n1. **Run tests**:\n   ```bash\n   make test\n   ```\n1. **Run benchmarks**:\n   ```bash\n   make bench\n   ```\n\n1. **Generate documentation**:\n   ```bash\n   make doc\n   ```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faallali%2Fsafinadb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faallali%2Fsafinadb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faallali%2Fsafinadb/lists"}