Zedis

Zedis is an innovative, Redis-compatible in-memory data store developed in Zig. Primarily crafted for educational purposes and experimentation, Zedis effectively implements the core Redis protocol and essential data structures, prioritizing simplicity, performance, and thread safety.

Key Features

• Redis Protocol Compatibility: Full support for the Redis Serialization Protocol (RESP) ensuring seamless integration.
• Multiple Data Types: Allows storage of strings and integers with automatic type conversion for easy data manipulation.
• Core Commands: Implements essential Redis commands including GET, SET, INCR, DECR, DEL, EXISTS, and TYPE, providing foundational functionality.
• High Performance: Leveraging the efficiency of Zig, Zedis ensures optimal performance and memory safety, making it suitable for various applications.
• Connection Management: Capable of handling multiple concurrent client connections, enhancing usability in multi-user scenarios.
• Disk Persistence (RDB): Features point-in-time snapshots of datasets, ensuring data safety and easy recovery.
• Pub/Sub Support: Offers decoupled communication between services, facilitating flexible application architecture. (Latest feature)

Project Roadmap

• Implemented RDB snapshots
• Added pub/sub functionality
• Introduce AOF (Append Only File) logging
• Extend with more Redis commands
• Support for lists and sets
• Add configuration file functionalities
• Implement key expiration features
• Introduce clustering capabilities
• Develop a performance benchmarking suite

Quick Start Guide

To get started with Zedis, ensure the following prerequisites are installed:

• Zig (minimum version 0.15.1)

Building and Running Zedis

To build and run Zedis:

# Clone the repository
git clone https://github.com/barddoo/zedis.git
cd zedis

# Build the project
zig build

# Run the server
zig build run

The server will be accessible at 127.0.0.1:6379 by default.

Testing with Redis CLI

Zedis can be tested using the standard redis-cli or any Redis client:

# Connect to Zedis
redis-cli -h 127.0.0.1 -p 6379

# Example commands
yzyzyzus-11056765
127.0.0.1:6379> SET mykey "Hello, Zedis!"
OK
127.0.0.1:6379> GET mykey
"Hello, Zedis!"
127.0.0.1:6379> INCR counter
(integer) 1
127.0.0.1:6379> TYPE mykey
string

Development Structure

The Zedis codebase adheres to Zig conventions, featuring:

• Type-safe operations and compile-time guarantees.
• Explicit error handling for robust applications.
• Memory safety using RAII patterns.
• Comprehensive logging for effective debugging.

Building for Development

To build for development purposes:

# Build in debug mode (default)
zig build -Doptimize=Debug

# Build optimized release version
zig build -Doptimize=ReleaseFast

# Run tests, if available
zig build test

Adding New Commands

New functionality can be added easily:

1. Implement the command handler in the appropriate file under src/commands/
2. Register the command in the command registry.
3. Add tests for the new feature.

Example:

pub fn myCommand(client: *Client, args: []const Value) !void {
    // Command implementation
    try client.writeSimpleString("OK");
}

Code Style Guidelines

• Follow Zig's standard formatting with zig fmt.
• Ensure comprehensive error handling.
• Include documentation comments for public APIs.
• Write tests for any new functionalities developed.

Contact Information

• GitHub: @barddoo
• Project Link: Zedis on GitHub

Zedis provides an excellent opportunity for learning the internals of Redis while utilizing the Zig programming language.