Skip to content

commands.md

Latest commit

 

History

History
130 lines (94 loc) · 3.35 KB

commands.md

File metadata and controls

130 lines (94 loc) · 3.35 KB

Commands

This document summarizes the command framework and the currently implemented Redis-compatible commands.

Command Framework

Command implementation lives in nimbis/src/cmd/.

Core types in nimbis/src/cmd/mod.rs:

  • CmdMeta { name, arity }
  • CmdContext { client_id }
  • Cmd trait (meta, do_cmd, execute)
  • ParsedCmd
  • CmdTable

Cmd::execute performs arity validation first, then calls do_cmd.

Arity Rules

Nimbis follows Redis-style arity conventions:

  • arity > 0: exact number of tokens required (including command name)
  • arity < 0: minimum number of tokens required (including command name)
  • validation uses args.len() + 1

Examples:

  • GET key => arity 2
  • PING [message] => arity -1
  • EXISTS key [key ...] => arity -2

Supported Commands (Current)

Source of truth: nimbis/src/cmd/table.rs.

Generic

  • PING (-1)
  • HELLO (-1) — supports protocol 2 and 3
  • DEL (-2)
  • EXISTS (-2)
  • EXPIRE (3)
  • TTL (2)
  • INCR (2)
  • DECR (2)
  • FLUSHDB (1)

String

  • SET (3)
  • GET (2)
  • APPEND (3)

Hash

  • HSET (-4)
  • HDEL (-3)
  • HGET (3)
  • HLEN (2)
  • HMGET (-3)
  • HGETALL (2)

List

  • LPUSH (-3)
  • RPUSH (-3)
  • LPOP (-2)
  • RPOP (-2)
  • LLEN (2)
  • LRANGE (4)

Set

  • SADD (-3)
  • SMEMBERS (2)
  • SISMEMBER (3)
  • SREM (-3)
  • SCARD (2)

Sorted Set

  • ZADD (-4)
  • ZRANGE (-4) — by rank range (start stop [WITHSCORES])
  • ZSCORE (3)
  • ZREM (-3)
  • ZCARD (2)

Configuration / Client

  • CONFIG (-3)
    • CONFIG GET <pattern>
    • CONFIG SET <field> <value>
  • CLIENT (-2)
    • CLIENT ID
    • CLIENT SETNAME <name>
    • CLIENT GETNAME
    • CLIENT LIST

Benchmark Alignment

The full redis-benchmark profile in xtask/src/redis_benchmark.rs should cover this implemented command table. FLUSHDB is the exception: it is used for benchmark setup and cleanup, not throughput comparison.

The comparison redis-benchmark profile is intentionally smaller so CI can compare PR and main branch performance across a stable command subset. It must still contain only commands listed in this document.

Add a New Command

  1. Add cmd_xxx.rs under nimbis/src/cmd/.
  2. Implement Cmd for the command struct.
  3. Export the module in nimbis/src/cmd/mod.rs.
  4. Register it in nimbis/src/cmd/table.rs.
  5. Update this document, docs/redis-benchmark.md, and the benchmark profiles in xtask/src/redis_benchmark.rs together.

Redis Compatibility Notes (Known Gaps)

Nimbis is Redis-compatible for the implemented subset, but does not yet implement full Redis semantics.

  • SET currently documents/implements the basic SET key value form only (no NX|XX|EX|PX|KEEPTTL|GET options).
  • ZRANGE supports start stop [WITHSCORES] rank mode only; flags such as BYSCORE, BYLEX, REV, and LIMIT are not part of this interface.
  • CONFIG is limited to GET and SET subcommands.
  • CLIENT is limited to ID, SETNAME, GETNAME, and LIST.
  • Multi-key string helpers like MGET/MSET, transactions (MULTI/EXEC), pub/sub, scripting, streams, cluster commands, and ACL are not documented as implemented in this command table.

When adding new commands or options, update nimbis/src/cmd/table.rs, this document, and the benchmark documentation/profile lists together.