🥕 Carade

"Storing your bits, forgetting your bytes... but now remembering them better!"

Carade is a high-performance, in-memory key-value store & message broker built with pure Java. Now runs on Netty, supports RESP (Redis Serialization Protocol), extensive Data Structures, and robust Security.

A CodeTease project.

Features

• RESP Support: Fully compatible with standard Redis clients (redis-cli, redis-py, etc.).
• Advanced Data Structures:
  • String: Standard Key-Value with INCR/DECR support, SETBIT/GETBIT, BITOP, BITCOUNT, BITFIELD.
  • List: LPUSH, RPUSH, LPOP, RPOP, LRANGE, LTRIM, RPOPLPUSH, and blocking BLPOP/BRPOP.
  • Hash: HSET, HGET, HGETALL, HDEL, HINCRBY.
  • Set: SADD, SMEMBERS, SREM, SINTER, SUNION, SDIFF.
  • Sorted Set: ZADD, ZRANGE, ZREVRANGE, ZREM, ZRANK, ZSCORE, ZCARD, ZCOUNT.
  • Geospatial: GEOADD, GEODIST, GEORADIUS (Store and query coordinates).
  • JSON: JSON.SET, JSON.GET, JSON.DEL (Native JSON manipulation).
  • Probabilistic: PFADD/PFCOUNT (HyperLogLog), BF.ADD (Bloom Filters), T-Digest.
• Scripting:
  • Lua: Full support for EVAL and EVALSHA.
• Persistence:
  • RDB Snapshots: Periodic binary dumps (carade.dump) compatible with Redis format.
  • AOF (Append-Only File): Logs every write operation (carade.aof) for maximum durability and replay on startup.
• Replication:
  • Master-Slave: Supports REPLICAOF/SLAVEOF for real-time data replication.
  • Psync: Partial resynchronization support.
• Transactions:
  • Atomic Execution: MULTI, EXEC, DISCARD.
  • Optimistic Locking: WATCH, UNWATCH.
• Pub/Sub System:
  • SUBSCRIBE / PUBLISH.
  • Pattern Matching: PSUBSCRIBE news.*.
  • UNSUBSCRIBE support.
• Memory Management:
  • Max Memory Limit: Configurable RAM usage.
  • LRU Eviction: Automatically removes least recently used keys when full.
• Security & Config:
  • ACLs: User-based permissions (Admin, Read/Write, Read-Only) via AUTH.
  • Configuration File: Load settings from carade.conf.

Roadmap & Missing Features

While Carade aims for high compatibility, the following features are currently missing in v0.3.0+ compared to standard Redis:

• Redis Cluster: No native clustering or sharding support.
• Streams: No support for Stream data type (XADD, XREAD, etc.).
• Modules: No module system support.
• ACL Command: Full ACL command management is not implemented (use carade.conf for user management).

Installation & Usage

Prerequisites: JDK 21+ and Maven.

1. Build

mvn clean package

2. Run

# Run the jar
java -jar target/carade-0.3.4.jar

The server listens on port 63790 (default).

Docker Support 🐳

You can also run Carade using Docker:

# Pull lastest version from GHCR
docker pull ghcr.io/codetease/carade:latest

# Run container (Persist data to ./data directory)
docker run -d \
  -p 63790:63790 \
  -v $(pwd)/data:/data \
  --name carade-server \
  ghcr.io/codetease/carade:latest

Configuration (carade.conf)

Create a carade.conf file to configure the server:

port 63790
requirepass teasertopsecret
maxmemory 100MB

# Users: user <name> <password> <admin|readwrite|readonly>
user default teasertopsecret admin
user viewer viewpass readonly
user writer writepass readwrite

Usage & Commands

Connect via redis-cli -p 63790 or telnet.

Storage Commands

• String: SET, GET, DEL, INCR, DECR, MSET, MGET, SETNX, SETBIT, GETBIT.
• Key Mgmt: TTL, EXPIRE, PERSIST, KEYS, SCAN, RENAME.
• List: LPUSH, RPUSH, LPOP, RPOP, BLPOP, BRPOP, RPOPLPUSH, LTRIM, LRANGE.
• Hash: HSET, HGET, HGETALL, HDEL, HINCRBY, HSCAN.
• Set: SADD, SMEMBERS, SREM, SINTER, SUNION, SDIFF, SSCAN.
• Sorted Set: ZADD, ZRANGE, ZREVRANGE, ZSCORE, ZRANK, ZREM, ZINCRBY, ZSCAN.
• Geospatial: GEOADD key longitude latitude member, GEODIST, GEORADIUS.
• JSON: JSON.SET, JSON.GET, JSON.DEL.
• Probabilistic: PFADD, PFCOUNT, BF.ADD, TD.ADD.

Transactions

• MULTI - Start transaction.
• EXEC - Execute transaction.
• DISCARD - Discard transaction.
• WATCH key - Watch key for changes.
• UNWATCH - Unwatch all keys.

Pub/Sub

• SUBSCRIBE channel
• PSUBSCRIBE pattern.*
• PUBLISH channel message

Replication & Connection

• REPLICAOF host port / SLAVEOF host port - Make server a replica.
• SELECT index - Switch database (0-15).
• PING / ECHO.

System

• AUTH [user] password
• FLUSHALL / FLUSHDB
• DBSIZE
• INFO
• BGREWRITEAOF

Included Tools

• benchmark.py: Stress tester. (Legacy script)
• chat.py: Demo chat app.
• ping.py: Send a test PING command.

License

Distributed under the MIT License.