CoreDB

A Redis-compatible distributed KV database with strong consistency, built on Raft consensus and RocksDB.

Features

Redis Protocol Compatible: Use any Redis client to connect
Distributed Consensus: Built on Raft for strong consistency
Persistent Storage: RocksDB backend for durability
Cluster Mode: Multi-node cluster with automatic failover

Quick Start

Build

cargo build --release

Configuration

CoreDB uses TOML configuration files. Example:

node_id = 1
server_addr = "0.0.0.0:6379"

[raft]
address = "127.0.0.1:7001"
advertise_host = "localhost"
single = true  # Set to false for cluster mode
join = []      # Addresses to join for cluster mode

[rocksdb]
data_path = "/tmp/coredb/node1"
max_open_files = 10000

[log]
level = "info"

Configuration Fields

| Field | Description | |-------|-------------| | node_id | Unique node ID in the cluster | | server_addr | Redis protocol listening address | | raft.address | Raft consensus listening address | | raft.advertise_host | Host advertised to other nodes | | raft.single | Run as single node (no cluster) | | raft.join | List of nodes to join for cluster mode | | rocksdb.data_path | RocksDB data directory | | rocksdb.max_open_files | Max open files for RocksDB | | log.level | Log level (debug, info, warn, error) |

Usage

Using redis-cli

# Connect to node
redis-cli -p 6379

# Set a key
SET mykey "myvalue"

# Get a key
GET mykey

# Set with expiration (in seconds)
SET mykey "myvalue" EX 60

# Delete a key
DEL mykey

Using any Redis client

import redis

r = redis.Redis(host='localhost', port=6379)
r.set('key', 'value')
print(r.get('key'))

Architecture

┌─────────────────┐
│   Redis Client  │
└────────┬────────┘
         │ RESP Protocol
         ▼
┌─────────────────┐     ┌─────────────────┐
│   CoreDB Server │────▶│   Raft Node     │
│   (Redis API)   │     │   (Consensus)   │
└────────┬────────┘     └────────┬────────┘
         │                       │
         ▼                       ▼
┌─────────────────┐     ┌─────────────────┐
│   State Machine │     │   Raft Log      │
└────────┬────────┘     └────────┬────────┘
         │                       │
         └──────────┬────────────┘
                    ▼
            ┌───────────────┐
            │   RocksDB     │
            └───────────────┘

Commands

The command list below is sourced from the Redis official data types documentation.

String Commands

| Command | Description | Status | |---------|-------------|--------| | GET key | Get value by key | ✅ | | SET key value | Set key-value | ✅ | | SET key value [NX\|XX] [GET] [EX seconds\|PX milliseconds\|EXAT timestamp\|PXAT timestamp\|KEEPTTL] | Set with options | ✅ | | DEL key [key ...] | Delete key(s) | ✅ | | MGET key [key ...] | Get multiple keys | ✅ | | MSET key value [key value ...] | Set multiple key-value pairs | ✅ | | INCR key | Increment key by 1 | ✅ | | INCRBY key increment | Increment key by value | ✅ | | DECR key | Decrement key by 1 | ✅ | | DECRBY key decrement | Decrement key by value | ✅ | | APPEND key value | Append value to key | ✅ | | STRLEN key | Get string length | ✅ | | GETSET key value | Get old value and set new value | ❌ | | SETEX key seconds value | Set with expiration (seconds) | ✅ | | PSETEX key milliseconds value | Set with expiration (ms) | ✅ | | SETNX key value | Set if key not exists | ✅ |

Bitmap Commands

| Command | Description | Status | |---------|-------------|--------| | GETBIT key offset | Get bit at offset | ✅ | | SETBIT key offset value | Set bit at offset | ✅ | | BITCOUNT key [start end] | Count set bits | ❌ | | BITPOS key bit [start end] | Find first bit with given value | ❌ | | BITOP operation destkey key [key ...] | Perform bitwise operations | ❌ | | BITFIELD key [GET type offset] [SET type offset value] [INCRBY type offset increment] [OVERFLOW wrap|sat|fail] | Perform bit field operations | ❌ |

JSON Commands

| Command | Description | Status | |---------|-------------|--------| | JSON.GET key [path [path ...]] | Get JSON value at path | ❌ | | JSON.SET key path value [NX\|XX] | Set JSON value at path | ❌ | | JSON.DEL key [path [path ...]] | Delete JSON value at path | ❌ | | JSON.TYPE key [path] | Get type of JSON value | ❌ | | JSON.NUMINCRBY key path value | Increment JSON number | ❌ | | JSON.STRAPPEND key path value | Append string to JSON string | ❌ | | JSON.ARRAPPEND key path value [value ...] | Append to JSON array | ❌ | | JSON.ARRLEN key [path] | Get JSON array length | ❌ | | JSON.OBJLEN key [path] | Get JSON object length | ❌ | | JSON.OBJKEYS key [path] | Get JSON object keys | ❌ | | JSON.MGET key [key ...] path | Get values from multiple keys | ❌ |

Hash Commands

| Command | Description | Status | |---------|-------------|--------| | HGET key field | Get hash field value | ✅ | | HSET key field value [field value ...] | Set hash field(s) | ✅ | | HDEL key field [field ...] | Delete hash field(s) | ✅ | | HEXISTS key field | Check if field exists | ✅ | | HGETALL key | Get all fields and values | ✅ | | HKEYS key | Get all field names | ✅ | | HLEN key | Get number of fields | ✅ | | HMGET key field [field ...] | Get multiple field values | ✅ | | HSETNX key field value | Set field if not exists | ✅ | | HVALS key | Get all field values | ✅ | | HINCRBY key field increment | Increment field value | ✅ |

Connection Commands

| Command | Description | Status | |---------|-------------|--------| | PING [message] | Ping server | ✅ | | ECHO message | Echo message | ❌ | | SELECT index | Select database | ❌ | | QUIT | Close connection | ❌ |

Key Commands

| Command | Description | Status | |---------|-------------|--------| | EXISTS key [key ...] | Check if key(s) exist | ✅ | | EXPIRE key seconds [NX|XX|GT|LT] | Set expiration in seconds | ✅ | | PEXPIRE key milliseconds [NX|XX|GT|LT] | Set expiration in ms | ✅ | | TTL key | Get remaining TTL | ❌ | | PTTL key | Get remaining TTL in ms | ❌ | | PERSIST key | Remove expiration | ❌ | | KEYS pattern | Find keys matching pattern | ❌ | | RENAME key newkey | Rename key | ❌ | | RENAMENX key newkey | Rename if newkey not exists | ❌ | | TYPE key | Get value type | ✅ | | UNLINK key [key ...] | Delete key(s) asynchronously | ❌ | | FLUSHDB | Delete all keys in current DB | ❌ | | FLUSHALL | Delete all keys in all DBs | ❌ |

List Commands

| Command | Description | Status | |---------|-------------|--------| | LPUSH key value [value ...] | Push to left | ✅ | | RPUSH key value [value ...] | Push to right | ✅ | | LPOP key [count] | Pop from left | ✅ | | RPOP key [count] | Pop from right | ✅ | | LLEN key | Get list length | ✅ | | LRANGE key start stop | Get range of elements | ✅ | | LINDEX key index | Get element at index | ❌ | | LSET key index value | Set element at index | ❌ | | LREM key count value | Remove elements | ❌ | | LTRIM key start stop | Trim list | ❌ |

Set Commands

| Command | Description | Status | |---------|-------------|--------| | SADD key member [member ...] | Add member(s) to set | ✅ | | SREM key member [member ...] | Remove member(s) from set | ✅ | | SMEMBERS key | Get all members | ✅ | | SISMEMBER key member | Check if member exists | ✅ | | SCARD key | Get set cardinality | ❌ | | SPOP key [count] | Remove and return random member(s) | ❌ | | SRANDMEMBER key [count] | Get random member(s) | ❌ | | SINTER key [key ...] | Intersection of sets | ❌ | | SUNION key [key ...] | Union of sets | ❌ | | SDIFF key [key ...] | Difference of sets | ❌ |

Sorted Set Commands

| Command | Description | Status | |---------|-------------|--------| | ZADD key [NX\|XX] [GT\|LT] [CH] [INCR] score member [score member ...] | Add member(s) with score | ✅ | | ZREM key member [member ...] | Remove member(s) | ✅ | | ZRANGE key start stop [WITHSCORES] | Get range by rank | ✅ | | ZREVRANGE key start stop [WITHSCORES] | Get range by rank (reverse) | ✅ | | ZRANGEBYSCORE key min max [WITHSCORES] [LIMIT offset count] | Get range by score | ❌ | | ZSCORE key member | Get member score | ❌ | | ZCARD key | Get sorted set cardinality | ❌ | | ZCOUNT key min max | Count members in score range | ❌ | | ZRANK key member | Get member rank | ❌ | | ZREVRANK key member | Get member rank (reverse) | ❌ | | ZINCRBY key increment member | Increment member score | ❌ | | ZREMKEY key | Remove key | ❌ |

HyperLogLog Commands

| Command | Description | Status | |---------|-------------|--------| | PFADD key element [element ...] | Add element(s) to HyperLogLog | ❌ | | PFCOUNT key [key ...] | Get approximate cardinality | ❌ | | PFMERGE destkey sourcekey [sourcekey ...] | Merge HyperLogLogs | ❌ |

GEO Commands

| Command | Description | Status | |---------|-------------|--------| | GEOADD key [NX\|XX] [CH] longitude latitude member [longitude latitude member ...] | Add geo member(s) | ❌ | | GEOHASH key member [member ...] | Get GeoHash string(s) | ❌ | | GEOPOS key member [member ...] | Get member position(s) | ❌ | | GEODIST key member1 member2 [M\|KM\|FT\|MI] | Get distance between members | ❌ | | GEORADIUS key longitude latitude radius M\|KM\|FT\|MI [WITHCOORD] [WITHDIST] [WITHHASH] [COUNT count] | Query by radius | ❌ | | GEORADIUSBYMEMBER key member radius M\|KM\|FT\|MI [WITHCOORD] [WITHDIST] [WITHHASH] [COUNT count] | Query by member radius | ❌ |

Transaction Commands

| Command | Description | Status | |---------|-------------|--------| | MULTI | Start transaction | ❌ | | EXEC | Execute transaction | ❌ | | DISCARD | Discard transaction | ❌ | | WATCH key [key ...] | Watch key(s) for changes | ❌ | | UNWATCH | Unwatch all keys | ❌ |

Server Commands

| Command | Description | S

Coredb

Install / Use

README