https://github.com/patrickkoss/patrick-db

PatrickDB is a simplified Rust-based database designed to demonstrate distributed database principles. This distributed key-value store employs Zookeeper for replication and partitioning. Data is stored in a row-based format using a file-based system.
https://github.com/patrickkoss/patrick-db

database database-management-system key-value-store partitioning replication rust rust-lang

Last synced: 6 months ago
JSON representation

PatrickDB is a simplified Rust-based database designed to demonstrate distributed database principles. This distributed key-value store employs Zookeeper for replication and partitioning. Data is stored in a row-based format using a file-based system.

• Host: GitHub
• URL: https://github.com/patrickkoss/patrick-db
• Owner: PatrickKoss
• License: mit
• Created: 2023-12-21T18:56:51.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-13T20:50:27.000Z (over 2 years ago)
• Last Synced: 2024-01-29T21:28:30.141Z (over 2 years ago)
• Topics: database, database-management-system, key-value-store, partitioning, replication, rust, rust-lang
• Language: Rust
• Homepage:
• Size: 1.31 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


 	



# PatrickDB

![Build Status](https://github.com/patrickkoss/patrick-db/actions/workflows/main.yml/badge.svg)

![License](https://img.shields.io/github/license/patrickkoss/patrick-db)

![Issues](https://img.shields.io/github/issues-raw/patrickkoss/patrick-db)

![PRs](https://img.shields.io/github/issues-pr/patrickkoss/patrick-db)

![Forks](https://img.shields.io/github/forks/patrickkoss/patrick-db)

![Stars](https://img.shields.io/github/stars/patrickkoss/patrick-db)

PatrickDB is a simplified Rust-based database designed to demonstrate distributed database principles. This distributed

key-value store employs Zookeeper for replication and partitioning. Data is stored in a row-based format using a

file-based system.

The database is accessible through gRPC or REST, facilitated by Envoy for converting REST to gRPC. Additionally,

patrick-db's storage and index engines can be integrated into other projects.

# Architecture

![Architecture](./media/architecture.png)

Clients compatible with gRPC or REST can connect to patrick-db, such as the [cli](./server/src/client.rs) tool located

in

the [server](./server) directory.

Envoy, which serves multiple purposes, is used here to interchange REST and gRPC.

Zookeeper plays a role in service discovery and managing leader elections.

The [router](server/src/router.rs), a gRPC server akin to the database server, interacts with Zookeeper. It identifies

all partitions and their respective leaders and followers, directing traffic to the appropriate partition through

hash-based partitioning. For write or read operations, it selects the leader, and for read-only operations, a follower

is chosen.

The [database](server/src/server.rs) itself is a gRPC server that implements a file-based storage system. In its role as

a leader, it replicates data to followers using statement replication.

# Getting Started

Start all components (Zookeeper, Envoy, Router, and two Partitions with one Leader and Replica) inside docker

containers:

```bash

make run-all-docker

```

Lint all components:

```bash

make lint

```

Run all tests:

```bash

make test

```