Redis RESP3 Protocol Documentation
This directory contains consolidated documentation for HeliosDB's Redis RESP3 protocol support.
Quick Start
Connect to HeliosDB using any Redis client:
import redis
# Connect to HeliosDB (Redis-compatible)
client = redis.Redis(
host='localhost',
port=6379,
protocol=3, # RESP3
decode_responses=True
)
# Test connection
print(client.ping()) # True
# Basic operations
client.set('user:1:name', 'Alice')
name = client.get('user:1:name')
Contents
| File |
Description |
| README.md |
Overview and quick start (this file) |
| CONFIGURATION.md |
Connection and protocol configuration |
| COMPATIBILITY.md |
RESP3 feature compatibility |
| EXAMPLES.md |
Redis command examples |
Feature Overview
RESP3 Protocol Support
| Feature |
Status |
Notes |
| Protocol Version |
RESP3 |
Full v3 implementation |
| HELLO Command |
Supported |
Protocol negotiation |
| Push Types |
Supported |
Server-initiated messages |
| Streaming |
Supported |
Large value handling |
| Boolean Type |
Supported |
Native true/false |
Data Structures
| Structure |
Coverage |
Key Commands |
| Strings |
100% |
GET, SET, INCR, APPEND |
| Lists |
100% |
LPUSH, RPOP, LRANGE |
| Sets |
100% |
SADD, SMEMBERS, SINTER |
| Sorted Sets |
100% |
ZADD, ZRANGE, ZINCRBY |
| Hashes |
100% |
HSET, HGET, HGETALL |
| Streams |
100% |
XADD, XREAD, XGROUP |
| HyperLogLog |
100% |
PFADD, PFCOUNT |
| Bitmaps |
100% |
SETBIT, GETBIT, BITCOUNT |
| Geospatial |
100% |
GEOADD, GEORADIUS |
Advanced Features
| Feature |
Status |
Notes |
| Pub/Sub |
Supported |
SUBSCRIBE, PUBLISH, PSUBSCRIBE |
| Transactions |
Supported |
MULTI, EXEC, WATCH |
| Lua Scripting |
80% |
EVAL, EVALSHA |
| Pipelining |
Supported |
Batch operations |
| ACL |
Supported |
User-based access control |
Connection Parameters
| Parameter |
Default |
Description |
host |
localhost |
Server hostname |
port |
6379 |
Redis protocol port |
protocol |
3 |
RESP version (2 or 3) |
password |
- |
Authentication password |
username |
default |
ACL username |
database |
0 |
Database number |
Driver Compatibility
| Driver |
Version |
Status |
| redis-py (Python) |
4.5+ |
Full |
| node-redis (Node.js) |
4.x |
Full |
| Jedis (Java) |
4.x |
Full |
| go-redis (Go) |
9.x |
Full |
| StackExchange.Redis (C#) |
2.x |
Full |
Use Cases
- Caching: High-speed key-value caching
- Session Storage: User session management
- Rate Limiting: Request throttling
- Leaderboards: Real-time rankings
- Pub/Sub: Real-time messaging
- Job Queues: Background task processing
Last Updated: December 2025
Consolidation Status: Complete