Command reference
HotKV implements 294 core commands across 25 categories, matching the Redis command set plus a handful of HotKV-exclusive additions. None of the core commands require a license or a specific plan. The Enterprise edition adds commands for AI and LLM workloads, rate limiting, time series, the feature store, audit, encryption, replication, multi-tenancy, observability, and licensing. Every command has its own page with syntax, options, RESP2 and RESP3 replies, examples, and notes on how it compares with Redis and Valkey; the full list is below.
Command counts by category
Section titled “Command counts by category”| Category | Count | Notes |
|---|---|---|
| String | 24 | Includes MSETEX, LCS |
| List | 17 | Includes LMOVE, LMPOP |
| Set | 17 | Includes SMOVE, SINTERCARD |
| Hash | 28 | Includes HGETDEL, HGETEX, HSETEX, per-field TTLs (HEXPIRE family) |
| Sorted Set | 32 | Full ZRANGE* family, ZMPOP, ZINTERCARD |
| Bitmap | 7 | Includes BITFIELD, BITFIELD_RO |
| HyperLogLog | 5 | Redis’s format; PFDEBUG, PFSELFTEST |
| Stream | 15 | Full lifecycle including XCLAIM, XAUTOCLAIM |
| Geospatial | 10 | GEOSEARCH + legacy GEORADIUS family |
| Pub/Sub | 9 | Includes sharded pub/sub (7.0+) |
| Blocking | 8 | BLPOP through BZMPOP |
| Generic (Key) | 26 | DUMP/RESTORE, MOVE, nanosecond TTL |
| Transaction | 5 | |
| Server | 36 | MONITOR, ROLE, SORT_RO, WAITAOF, DEBUG, FAILOVER |
| Cluster | 6 | CLUSTER, ASKING, MIGRATE, RESTORE-ASKING |
| ACL | 1 | 10 subcommands |
| Tag | 7 | HotKV exclusive |
| Vector Similarity | 7 | HNSW-indexed, tag-filtered search |
| Bloom Filter | 10 | Probabilistic |
| Count-Min Sketch | 6 | Probabilistic |
| Top-K | 7 | Probabilistic |
| Scripting | 5 | EVAL, EVALSHA, SCRIPT |
| Function | 3 | FCALL, FUNCTION libraries |
| Module | 1 | Module management |
| Rate Limiting | 2 | GCRA (HotKV exclusive) |
| Total | 294 |
HotKV-exclusive features
Section titled “HotKV-exclusive features”Features and command families that do not exist in Redis or Valkey, available on every plan with no license required:
| Feature | Commands | Description |
|---|---|---|
| Nanosecond TTL | NEXPIRE, NTTL, NEXPIREAT | Set and read key TTLs in nanoseconds |
| Key Tagging | TAG.SET/GET/REM/MEMBERS/INTER/COUNT/EXISTS | Attach labels to keys and find keys by label |
| Vector Similarity Search | VSIM.CREATEINDEX/DROPINDEX/SET/GET/DEL/SEARCH/INFO | Built-in HNSW-based approximate nearest neighbor search |
| Hot Key Tracking | HOTKEYS TOP/RESET | Real-time tracking of most frequently accessed keys |
| GCRA Rate Limiting | GCRA.LIMIT, GCRA.RESET | Server-side Generic Cell Rate Algorithm rate limiter |
Plans and licenses
Section titled “Plans and licenses”The enterprise commands, all except LICENSE.*, need a license feature:
on HotKV Cloud it comes with the plan, and On-Premise it comes with your
license. On HotKV Cloud:
- Performance and Scale include the AI and LLM commands, rate limiting, time series, the feature store, vector snapshots, and observability and alerting.
- Scale adds the audit log, encryption at rest, replication, and multi-tenancy.
- Starter includes none of them.
An unlicensed command replies
-NOLICENSE <feature> requires a HotKV license. Contact sales@hotkv.com.
Check what your server has with LICENSE.INFO.
Each command page shows what it needs under HotKV Cloud and
On-Premise.
All commands
Section titled “All commands”Keys
| Command | Description | Availability |
|---|---|---|
COPY | Copy the value of a key to another key, optionally in another database. | All plans |
DEL | Delete one or more keys of any type. | All plans |
DUMP | Serialize the value stored at a key so it can be restored with RESTORE. | All plans |
EXISTS | Count how many of the given keys exist. | All plans |
EXPIRE | Set a key's time to live in seconds. | All plans |
EXPIREAT | Make a key expire at a Unix time given in seconds. | All plans |
EXPIRETIME | Return the Unix time, in seconds, at which a key expires. | All plans |
KEYS | Return every key in the current database that matches a glob pattern. | All plans |
MOVE | Move a key from the selected database to another database. | All plans |
NEXPIRE | Set a key's time to live in nanoseconds. | All plans |
NEXPIREAT | Make a key expire at a Unix time given in nanoseconds. | All plans |
NTTL | Return a key's remaining time to live in nanoseconds. | All plans |
OBJECT | Inspect how a key's value is stored and how it is accessed. | All plans |
OBJECT ENCODING | Return the encoding name of the value stored at a key. | All plans |
OBJECT FREQ | Return a key's access frequency counter under an LFU eviction policy. | All plans |
OBJECT IDLETIME | Return how many seconds have passed since a key was last accessed. | All plans |
OBJECT REFCOUNT | Return the reference count of a key's value, which is always 1. | All plans |
PERSIST | Remove a key's time to live so it no longer expires. | All plans |
PEXPIRE | Set a key's time to live in milliseconds. | All plans |
PEXPIREAT | Make a key expire at a Unix time given in milliseconds. | All plans |
PEXPIRETIME | Return the Unix time, in milliseconds, at which a key expires. | All plans |
PTTL | Return a key's remaining time to live in milliseconds. | All plans |
RANDOMKEY | Return a random key from the current database. | All plans |
RENAME | Rename a key, overwriting the destination if it exists. | All plans |
RENAMENX | Rename a key only if the new name is not taken. | All plans |
RESTORE | Create a key from a payload produced by DUMP. | All plans |
RESTORE-ASKING | RESTORE for a slot that is being imported during cluster resharding. | All plans |
SCAN | Iterate over the keys of the current database with a cursor. | All plans |
TOUCH | Mark keys as accessed and count how many exist. | All plans |
TTL | Return a key's remaining time to live in seconds. | All plans |
TYPE | Return the type of the value stored at a key. | All plans |
UNLINK | Delete one or more keys, with the same result as DEL. | All plans |
String
| Command | Description | Availability |
|---|---|---|
APPEND | Append a value to the end of a string, creating the key if needed. | All plans |
DECR | Subtract 1 from the integer stored at a key. | All plans |
DECRBY | Subtract an integer from the integer stored at a key. | All plans |
DELEX | Delete a key, or delete it only when its string value meets a condition. | All plans |
DIGEST | Return the digest of a string value, the fingerprint that the IFDEQ and IFDNE conditions compare. | All plans |
GET | Return the string value stored at a key. | All plans |
GETDEL | Return the string value of a key and delete the key. | All plans |
GETEX | Return the string value of a key and optionally change its time to live. | All plans |
GETRANGE | Return a substring of the string stored at a key. | All plans |
GETSET | Set a string value and return the value it replaced. | All plans |
INCR | Add 1 to the integer stored at a key. | All plans |
INCRBY | Add an integer to the integer stored at a key. | All plans |
INCRBYFLOAT | Add a floating-point number to the number stored at a key. | All plans |
LCS | Find the longest common subsequence of two strings. | All plans |
MGET | Return the string values of several keys in one call. | All plans |
MSET | Set several keys to string values in one step. | All plans |
MSETEX | Set several keys in one step with a shared condition and time to live. | All plans |
MSETNX | Set several keys only if none of them exist. | All plans |
PSETEX | Set a string value with a time to live in milliseconds. | All plans |
SET | Store a string value at a key, with optional expiry and conditions. | All plans |
SETEX | Set a string value with a time to live in seconds. | All plans |
SETNX | Set a string value only if the key does not exist. | All plans |
SETRANGE | Overwrite part of a string at a byte offset. | All plans |
STRLEN | Return the length in bytes of the string stored at a key. | All plans |
SUBSTR | Return a substring of a string; an older name for GETRANGE. | All plans |
Bitmap
| Command | Description | Availability |
|---|---|---|
BITCOUNT | Count the set bits in a string, optionally within a byte or bit range. | All plans |
BITFIELD | Read, write and increment integer fields of any width inside a string. | All plans |
BITFIELD_RO | Read integer fields inside a string; the read-only form of BITFIELD. | All plans |
BITOP | Combine strings bit by bit with AND, OR, XOR, NOT, DIFF, DIFF1, ANDOR or ONE and store the result. | All plans |
BITPOS | Find the position of the first bit set to 0 or 1 in a string. | All plans |
GETBIT | Return the value of one bit of the string stored at a key. | All plans |
SETBIT | Set or clear one bit of the string stored at a key. | All plans |
Hash
| Command | Description | Availability |
|---|---|---|
HDEL | Remove one or more fields from a hash. | All plans |
HEXISTS | Check whether a field exists in a hash. | All plans |
HEXPIRE | Set a time to live in seconds on one or more hash fields. | All plans |
HEXPIREAT | Make one or more hash fields expire at a Unix time in seconds. | All plans |
HEXPIRETIME | Get the absolute expiry time of hash fields as a Unix time in seconds. | All plans |
HGET | Get the value of one field of a hash. | All plans |
HGETALL | Get all fields and values of a hash. | All plans |
HGETDEL | Get the values of hash fields and delete those fields in one step. | All plans |
HGETEX | Get the values of hash fields and optionally set or remove their time to live. | All plans |
HIMPORT | Load many hashes that share the same field names, by naming the fields once and then giving only the values. | All plans |
HIMPORT DISCARD | Forget one list of field names prepared on this connection. | All plans |
HIMPORT DISCARDALL | Forget every list of field names prepared on this connection. | All plans |
HIMPORT PREPARE | Give a name to a list of field names on this connection, for HIMPORT SET to use. | All plans |
HIMPORT SET | Make a hash from values, using a list of field names prepared on this connection. | All plans |
HINCRBY | Add an integer to the value of a hash field. | All plans |
HINCRBYFLOAT | Add a floating-point number to the value of a hash field. | All plans |
HKEYS | Get all field names of a hash. | All plans |
HLEN | Get the number of fields in a hash. | All plans |
HMGET | Get the values of several hash fields in one call. | All plans |
HMSET | Set several hash fields and reply OK (older form of HSET). | All plans |
HPERSIST | Remove the time to live from one or more hash fields. | All plans |
HPEXPIRE | Set a time to live in milliseconds on one or more hash fields. | All plans |
HPEXPIREAT | Make one or more hash fields expire at a Unix time in milliseconds. | All plans |
HPEXPIRETIME | Get the absolute expiry time of hash fields as a Unix time in milliseconds. | All plans |
HPTTL | Get the remaining time to live of hash fields, in milliseconds. | All plans |
HRANDFIELD | Return one or more random fields of a hash, optionally with their values. | All plans |
HSCAN | Iterate over the fields and values of a hash with a cursor. | All plans |
HSET | Set one or more fields of a hash, creating the hash if it does not exist. | All plans |
HSETEX | Set hash fields with an optional time to live and an all-or-nothing condition. | All plans |
HSETNX | Set a hash field only if it does not exist yet. | All plans |
HSTRLEN | Get the length in bytes of a hash field's value. | All plans |
HTTL | Get the remaining time to live of hash fields, in seconds. | All plans |
HVALS | Get all values of a hash. | All plans |
List
| Command | Description | Availability |
|---|---|---|
BLMOVE | Move an element from one list to another, waiting until the source has one. | All plans |
BLMPOP | Pop elements from the first non-empty list among several keys, waiting until one is available. | All plans |
BLPOP | Remove and return the first element of the first non-empty list, waiting until one is available. | All plans |
BRPOP | Remove and return the last element of the first non-empty list, waiting until one is available. | All plans |
BRPOPLPUSH | Move the last element of a list to the head of another, waiting until one is available (older form of BLMOVE). | All plans |
LINDEX | Get the element at an index of a list. | All plans |
LINSERT | Insert an element before or after another element in a list. | All plans |
LLEN | Get the length of a list. | All plans |
LMOVE | Pop an element from one list and push it onto another, atomically. | All plans |
LMPOP | Pop elements from the first non-empty list among several keys. | All plans |
LPOP | Remove and return elements from the head of a list. | All plans |
LPOS | Find the index of matching elements in a list. | All plans |
LPUSH | Insert one or more elements at the head of a list. | All plans |
LPUSHX | Insert elements at the head of a list, only if the list already exists. | All plans |
LRANGE | Get a range of elements from a list by index. | All plans |
LREM | Remove occurrences of an element from a list. | All plans |
LSET | Replace the element at an index of a list. | All plans |
LTRIM | Trim a list so it keeps only a range of elements. | All plans |
RPOP | Remove and return elements from the tail of a list. | All plans |
RPOPLPUSH | Pop the last element of one list and push it to the head of another (older form of LMOVE). | All plans |
RPUSH | Append one or more elements to the tail of a list. | All plans |
RPUSHX | Append elements to the tail of a list, only if the list already exists. | All plans |
Set
| Command | Description | Availability |
|---|---|---|
SADD | Add one or more members to a set. | All plans |
SCARD | Get the number of members in a set. | All plans |
SDIFF | Return the members of the first set that are not in any of the other sets. | All plans |
SDIFFSTORE | Store the difference between the first set and the others in a destination key. | All plans |
SINTER | Return the members present in every one of the given sets. | All plans |
SINTERCARD | Count the members of the intersection of sets, optionally stopping at a limit. | All plans |
SINTERSTORE | Store the intersection of sets in a destination key. | All plans |
SISMEMBER | Check whether a value is a member of a set. | All plans |
SMEMBERS | Get all members of a set. | All plans |
SMISMEMBER | Check several values for membership in a set in one call. | All plans |
SMOVE | Move a member from one set to another, atomically. | All plans |
SPOP | Remove and return one or more random members of a set. | All plans |
SRANDMEMBER | Return one or more random members of a set without removing them. | All plans |
SREM | Remove one or more members from a set. | All plans |
SSCAN | Iterate over the members of a set with a cursor. | All plans |
SUNION | Return the members present in any of the given sets. | All plans |
SUNIONSTORE | Store the union of sets in a destination key. | All plans |
Sorted set
| Command | Description | Availability |
|---|---|---|
BZMPOP | Pop the lowest or highest scored members from the first non-empty sorted set, waiting until one is available. | All plans |
BZPOPMAX | Remove and return the highest-scored member of the first non-empty sorted set, waiting until one is available. | All plans |
BZPOPMIN | Remove and return the lowest-scored member of the first non-empty sorted set, waiting until one is available. | All plans |
ZADD | Add members to a sorted set, or update their scores. | All plans |
ZCARD | Get the number of members in a sorted set. | All plans |
ZCOUNT | Count the members of a sorted set with scores in a range. | All plans |
ZDIFF | Return the members of the first sorted set that are not in any of the others. | All plans |
ZDIFFSTORE | Store the difference between the first sorted set and the others in a destination key. | All plans |
ZINCRBY | Add to the score of a member of a sorted set. | All plans |
ZINTER | Return the intersection of sorted sets, combining the scores of shared members. | All plans |
ZINTERCARD | Count the members of the intersection of sorted sets, optionally stopping at a limit. | All plans |
ZINTERSTORE | Store the intersection of sorted sets in a destination key. | All plans |
ZLEXCOUNT | Count the members of a sorted set in a lexicographic range. | All plans |
ZMPOP | Pop the lowest or highest scored members from the first non-empty sorted set among several keys. | All plans |
ZMSCORE | Get the scores of several members of a sorted set in one call. | All plans |
ZPOPMAX | Remove and return the members with the highest scores from a sorted set. | All plans |
ZPOPMIN | Remove and return the members with the lowest scores from a sorted set. | All plans |
ZRANDMEMBER | Return one or more random members of a sorted set, optionally with their scores. | All plans |
ZRANGE | Get a range of members from a sorted set by rank, score or lexicographic order. | All plans |
ZRANGEBYLEX | Get the members of a sorted set in a lexicographic range. | All plans |
ZRANGEBYSCORE | Get the members of a sorted set with scores in a range, lowest first. | All plans |
ZRANGESTORE | Store a range of a sorted set, by rank, score or lexicographic order, in another key. | All plans |
ZRANK | Get the rank of a member in a sorted set, lowest score first. | All plans |
ZREM | Remove one or more members from a sorted set. | All plans |
ZREMRANGEBYLEX | Remove the members of a sorted set in a lexicographic range. | All plans |
ZREMRANGEBYRANK | Remove the members of a sorted set in a range of ranks. | All plans |
ZREMRANGEBYSCORE | Remove the members of a sorted set with scores in a range. | All plans |
ZREVRANGE | Get a range of members from a sorted set by rank, highest score first. | All plans |
ZREVRANGEBYLEX | Get the members of a sorted set in a lexicographic range, in reverse order. | All plans |
ZREVRANGEBYSCORE | Get the members of a sorted set with scores in a range, highest first. | All plans |
ZREVRANK | Get the rank of a member in a sorted set, highest score first. | All plans |
ZSCAN | Iterate over the members and scores of a sorted set with a cursor. | All plans |
ZSCORE | Get the score of a member of a sorted set. | All plans |
ZUNION | Return the union of sorted sets, combining the scores of shared members. | All plans |
ZUNIONSTORE | Store the union of sorted sets in a destination key. | All plans |
Stream
| Command | Description | Availability |
|---|---|---|
XACK | Acknowledge stream entries, removing them from a consumer group's pending list. | All plans |
XADD | Append an entry to a stream, optionally trimming the stream in the same call. | All plans |
XAUTOCLAIM | Scan a consumer group's pending entries and claim the idle ones in one call. | All plans |
XCFGSET | Set how long a stream remembers the idempotent IDs of each producer, and how many. | All plans |
XCLAIM | Take ownership of pending stream entries that another consumer has left idle. | All plans |
XDEL | Delete entries from a stream by ID. | All plans |
XGROUP | Create, change and remove stream consumer groups and their consumers. | All plans |
XGROUP CREATE | Create a consumer group on a stream, starting after a given ID. | All plans |
XGROUP CREATECONSUMER | Add a consumer to a stream consumer group ahead of its first read. | All plans |
XGROUP DELCONSUMER | Remove a consumer from a stream consumer group, dropping its pending entries. | All plans |
XGROUP DESTROY | Delete a consumer group from a stream, with its consumers and pending entries. | All plans |
XGROUP SETID | Set the last delivered ID of a consumer group. | All plans |
XINFO | Inspect streams, their consumer groups and their consumers. | All plans |
XINFO CONSUMERS | List the consumers of a stream consumer group with their pending counts and idle times. | All plans |
XINFO GROUPS | List a stream's consumer groups with their progress and backlog. | All plans |
XINFO STREAM | Show a stream's length, ID bookkeeping, and first and last entries. | All plans |
XLEN | Return the number of entries in a stream. | All plans |
XPENDING | Inspect the entries a consumer group has delivered but not yet acknowledged. | All plans |
XRANGE | Return the stream entries with IDs in a range, oldest first. | All plans |
XREAD | Read new entries from one or more streams, optionally waiting for them. | All plans |
XREADGROUP | Read stream entries as a consumer of a consumer group, tracking them until acknowledged. | All plans |
XREVRANGE | Return the stream entries with IDs in a range, newest first. | All plans |
XSETID | Set a stream's last generated ID and its bookkeeping counters. | All plans |
XTRIM | Remove the oldest entries of a stream by length or by minimum ID. | All plans |
Geospatial
| Command | Description | Availability |
|---|---|---|
GEOADD | Add members with longitude and latitude to a geospatial index stored as a sorted set. | All plans |
GEODIST | Return the distance between two members of a geospatial index. | All plans |
GEOHASH | Return standard 11-character geohash strings for members of a geospatial index. | All plans |
GEOPOS | Return the longitude and latitude of members of a geospatial index. | All plans |
GEORADIUS | Find members of a geospatial index within a radius of a position (legacy form of GEOSEARCH). | All plans |
GEORADIUS_RO | Read-only form of GEORADIUS, without the STORE options. | All plans |
GEORADIUSBYMEMBER | Find members of a geospatial index within a radius of another member (legacy form of GEOSEARCH). | All plans |
GEORADIUSBYMEMBER_RO | Read-only form of GEORADIUSBYMEMBER, without the STORE options. | All plans |
GEOSEARCH | Find members of a geospatial index within a radius or a box around a point or a member. | All plans |
GEOSEARCHSTORE | Run a geospatial search and store the matching members in another sorted set. | All plans |
HyperLogLog
| Command | Description | Availability |
|---|---|---|
PFADD | Add elements to a HyperLogLog for approximate distinct counting. | All plans |
PFCOUNT | Return the approximate number of distinct elements in one or more HyperLogLogs. | All plans |
PFDEBUG | Inspect or convert the representation of a HyperLogLog. | All plans |
PFMERGE | Merge HyperLogLogs into a destination HyperLogLog. | All plans |
PFSELFTEST | Run the built-in HyperLogLog self-test. | All plans |
Bloom filter
| Command | Description | Availability |
|---|---|---|
BF.ADD | Add an item to a Bloom filter, creating the filter if needed. | All plans |
BF.CARD | Return the number of items added to a Bloom filter. | All plans |
BF.EXISTS | Check whether an item may have been added to a Bloom filter. | All plans |
BF.INFO | Show a Bloom filter's capacity, size, layers, item count and expansion rate. | All plans |
BF.INSERT | Add items to a Bloom filter, creating it with chosen settings or refusing to create it. | All plans |
BF.LOADCHUNK | Restore a Bloom filter from the chunks BF.SCANDUMP produced. | All plans |
BF.MADD | Add several items to a Bloom filter in one call, creating the filter if needed. | All plans |
BF.MEXISTS | Check several items against a Bloom filter in one call. | All plans |
BF.RESERVE | Create an empty Bloom filter with a chosen error rate and capacity. | All plans |
BF.SCANDUMP | Export a Bloom filter in chunks, to copy or back it up elsewhere. | All plans |
Count-min sketch
| Command | Description | Availability |
|---|---|---|
CMS.INCRBY | Increase the counts of one or more items in a Count-min sketch. | All plans |
CMS.INFO | Show a Count-min sketch's width, depth and total count. | All plans |
CMS.INITBYDIM | Create a Count-min sketch with an explicit width and depth. | All plans |
CMS.INITBYPROB | Create a Count-min sketch sized for a chosen error and probability. | All plans |
CMS.MERGE | Replace a Count-min sketch with the sum, optionally weighted, of other sketches. | All plans |
CMS.QUERY | Return the estimated counts of one or more items in a Count-min sketch. | All plans |
Top-K
| Command | Description | Availability |
|---|---|---|
TOPK.ADD | Count one occurrence of each item in a Top-K list, returning any items pushed out. | All plans |
TOPK.COUNT | Return the estimated counts of items in a Top-K structure, listed or not. | All plans |
TOPK.INCRBY | Count several occurrences of items in a Top-K list at once. | All plans |
TOPK.INFO | Show the settings of a Top-K structure. | All plans |
TOPK.LIST | Return the items in a Top-K list, most frequent first, optionally with their counts. | All plans |
TOPK.QUERY | Check whether items are currently in a Top-K list. | All plans |
TOPK.RESERVE | Create a Top-K list that tracks the most frequent items in a stream of events. | All plans |
Tags
| Command | Description | Availability |
|---|---|---|
TAG.COUNT | Return the number of tags attached to a key. | All plans |
TAG.EXISTS | Check whether a key carries a tag. | All plans |
TAG.GET | Return all tags attached to a key. | All plans |
TAG.INTER | Return the keys that carry all of the given tags. | All plans |
TAG.MEMBERS | Return all keys that carry a tag. | All plans |
TAG.REM | Remove one or more tags from a key. | All plans |
TAG.SET | Attach one or more tags to an existing key. | All plans |
Vector search
| Command | Description | Availability |
|---|---|---|
VSIM.CREATEINDEX | Create a named vector index for nearest-neighbor search. | All plans |
VSIM.DEL | Remove a key's vector from a vector index. | All plans |
VSIM.DROP | Delete a named blob saved with VSIM.SAVE. | Performance+ vsim-persist |
VSIM.DROPINDEX | Delete a vector index and all its vectors. | All plans |
VSIM.GET | Return the vector stored for a key in a vector index. | All plans |
VSIM.INFO | List vector indexes, or show one index's settings and size. | All plans |
VSIM.LIST | List the names of the blobs saved with VSIM.SAVE. | Performance+ vsim-persist |
VSIM.LOAD | Read back a named blob saved with VSIM.SAVE. | Performance+ vsim-persist |
VSIM.SAVE | Write a named blob of vector data to a file on the server. | Performance+ vsim-persist |
VSIM.SEARCH | Find the keys whose vectors are nearest to a query vector, optionally only among tagged keys. | All plans |
VSIM.SET | Store or replace the vector for a key in a vector index. | All plans |
Rate limiting
| Command | Description | Availability |
|---|---|---|
GCRA.LIMIT | Check and consume a rate limit in one atomic step, using the generic cell rate algorithm. | All plans |
GCRA.RESET | Clear the rate limit state of one or more keys. | All plans |
RATELIMIT.CHECK | Check a request against a rate limiter for one key, and consume units if it is allowed. | Performance+ rate-limiting |
RATELIMIT.CREATE | Create a named rate limiter with a limit, a window and an algorithm. | Performance+ rate-limiting |
RATELIMIT.DROP | Delete a rate limiter and the state of all its keys. | Performance+ rate-limiting |
RATELIMIT.LIST | List the names of all rate limiters. | Performance+ rate-limiting |
RATELIMIT.PEEK | See whether a key could make a request under a rate limiter, without consuming anything. | Performance+ rate-limiting |
RATELIMIT.RESET | Clear one key's state in a rate limiter so it starts fresh. | Performance+ rate-limiting |
RATELIMIT.STATS | Report a rate limiter's settings, tracked keys and allowed and denied totals. | Performance+ rate-limiting |
Time series
| Command | Description | Availability |
|---|---|---|
TS.ADD | Append a sample to a time series. | Performance+ time-series |
TS.AGG | Aggregate the samples of a time series into fixed-width time buckets. | Performance+ time-series |
TS.CREATE | Create a time series with an optional retention period and labels. | Performance+ time-series |
TS.DELETE | Delete a time series with all its samples, labels and rules. | Performance+ time-series |
TS.DOWNSAMPLE | Add a rule that feeds every new sample of one time series into another. | Performance+ time-series |
TS.INFO | Show a time series' sample count, first and last samples, retention, memory and labels. | Performance+ time-series |
TS.LIST | List time series names, optionally only those with a given label value. | Performance+ time-series |
TS.RANGE | Return the samples of a time series between two timestamps. | Performance+ time-series |
TS.RETENTION | Change how long a time series keeps its samples. | Performance+ time-series |
Pub/Sub
| Command | Description | Availability |
|---|---|---|
PSUBSCRIBE | Subscribe the connection to every channel matching a glob pattern. | All plans |
PUBLISH | Send a message to every subscriber of a Pub/Sub channel. | All plans |
PUBSUB | Inspect the state of Pub/Sub channels and subscriptions. | All plans |
PUBSUB CHANNELS | List the channels that currently have subscribers. | All plans |
PUBSUB NUMPAT | Return the number of pattern subscriptions on the node. | All plans |
PUBSUB NUMSUB | Return the number of subscribers of each given channel. | All plans |
PUBSUB SHARDCHANNELS | List the shard channels that currently have subscribers. | All plans |
PUBSUB SHARDNUMSUB | Return the number of subscribers of each given shard channel. | All plans |
PUNSUBSCRIBE | Remove pattern subscriptions from the connection. | All plans |
SPUBLISH | Send a message to the subscribers of a shard channel. | All plans |
SSUBSCRIBE | Subscribe the connection to one or more shard channels. | All plans |
SUBSCRIBE | Subscribe the connection to one or more Pub/Sub channels. | All plans |
SUNSUBSCRIBE | Unsubscribe the connection from shard channels. | All plans |
UNSUBSCRIBE | Unsubscribe the connection from Pub/Sub channels. | All plans |
Transactions
| Command | Description | Availability |
|---|---|---|
DISCARD | Drop the commands queued since MULTI and leave the transaction. | All plans |
EXEC | Run all commands queued since MULTI as one transaction. | All plans |
MULTI | Start a transaction that queues commands until EXEC. | All plans |
UNWATCH | Forget all keys watched by this connection. | All plans |
WATCH | Watch keys so the next transaction runs only if they did not change. | All plans |
Scripting and functions
| Command | Description | Availability |
|---|---|---|
EVAL | Run a Lua script on the server, atomically. | All plans |
EVAL_RO | Run a read-only Lua script. | All plans |
EVALSHA | Run a cached Lua script by its SHA1 digest. | All plans |
EVALSHA_RO | Run a cached read-only Lua script by its SHA1 digest. | All plans |
FCALL | Call a function from a loaded function library. | All plans |
FCALL_RO | Call a read-only function from a loaded function library. | All plans |
FUNCTION | Manage Lua function libraries. | All plans |
FUNCTION DELETE | Delete a function library and all of its functions. | All plans |
FUNCTION DUMP | Serialize all loaded function libraries into a payload for FUNCTION RESTORE. | All plans |
FUNCTION FLUSH | Delete all function libraries. | All plans |
FUNCTION KILL | Stop the function that is currently running, if it has not written yet. | All plans |
FUNCTION LIST | List the loaded function libraries and their functions. | All plans |
FUNCTION LOAD | Load a Lua function library, or replace an existing one. | All plans |
FUNCTION RESTORE | Load function libraries from a FUNCTION DUMP payload. | All plans |
FUNCTION STATS | Return the number of loaded function libraries and functions. | All plans |
SCRIPT | Manage the server's Lua script cache. | All plans |
SCRIPT DEBUG | Choose the debug mode for scripts; HotKV supports only NO. | All plans |
SCRIPT EXISTS | Check whether scripts are in the script cache. | All plans |
SCRIPT FLUSH | Remove every script from the script cache. | All plans |
SCRIPT KILL | Stop the script that is currently running, if it has not written yet. | All plans |
SCRIPT LOAD | Compile a Lua script and add it to the script cache without running it. | All plans |
Connection
| Command | Description | Availability |
|---|---|---|
AUTH | Authenticate the current connection with a password, or as a named ACL user. | All plans |
CLIENT | Inspect and manage client connections, including the current one. | All plans |
CLIENT CACHING | Choose whether the keys read by the next command are tracked, for connections in OPTIN or OPTOUT tracking mode. | All plans |
CLIENT GETNAME | Return the name of the current connection. | All plans |
CLIENT GETREDIR | Return the id of the connection that receives this connection's client-side caching invalidations. | All plans |
CLIENT ID | Return the unique id of the current connection. | All plans |
CLIENT INFO | Describe the current connection in one line of fields. | All plans |
CLIENT KILL | Close client connections by address, or every connection that matches a set of filters. | All plans |
CLIENT LIST | List client connections, one line of fields each, optionally filtered by type, flags or id. | All plans |
CLIENT NO-EVICT | Exempt the current connection from being closed when clients hold more than maxmemory-clients. | All plans |
CLIENT NO-TOUCH | Read keys on this connection without updating their last access time. | All plans |
CLIENT PAUSE | Hold every client's commands, or only writes, for a number of milliseconds. | All plans |
CLIENT REPLY | Turn off the server's replies to the current connection, turn them back on, or skip the next one. | All plans |
CLIENT SETINFO | Record the name or version of the client library using the connection. | All plans |
CLIENT SETNAME | Give the current connection a name that shows in CLIENT LIST and the slow log. | All plans |
CLIENT TRACKING | Turn server-assisted client-side caching on or off for the connection, so HotKV tells it when a key it read changes. | All plans |
CLIENT TRACKINGINFO | Report the client-side caching state of the connection, with its flags, where invalidations go and its prefixes. | All plans |
CLIENT UNBLOCK | End another connection's blocking command, as a timeout or with an error. | All plans |
CLIENT UNPAUSE | End a CLIENT PAUSE before its timeout. | All plans |
ECHO | Return the given message unchanged. | All plans |
HELLO | Choose RESP2 or RESP3 for the connection, optionally authenticate and name it, and get server details. | All plans |
PING | Check that the connection and server respond, optionally echoing a message. | All plans |
QUIT | Ask the server to close the connection once pending replies are sent. | All plans |
RESET | Return the connection to the state it had when it was opened. | All plans |
SELECT | Switch the connection to another numbered logical database. | All plans |
Server
| Command | Description | Availability |
|---|---|---|
BGREWRITEAOF | Rewrite the append-only file in the background so it holds the current data set compactly. | All plans |
BGSAVE | Start writing a snapshot of the data set to disk in the background. | All plans |
COMMAND | Describe the commands the server has, for client libraries and cluster routing. | All plans |
COMMAND COUNT | Return the number of commands the server has. | All plans |
COMMAND DOCS | Return a short documentation entry for each command. | All plans |
COMMAND GETKEYS | Return the key arguments of a full command line without running it. | All plans |
COMMAND GETKEYSANDFLAGS | Return the key arguments of a full command line, with whether each is read or written. | All plans |
COMMAND INFO | Return the arity, flags, key positions and ACL categories of commands. | All plans |
COMMAND LIST | List every command and subcommand name, optionally filtered by ACL category or pattern. | All plans |
CONFIG | Read and change server settings at runtime, save them to the config file, and reset statistics. | All plans |
CONFIG GET | Read server settings by exact name or glob-style pattern. | All plans |
CONFIG RESETSTAT | Reset the statistics counters reported by INFO. | All plans |
CONFIG REWRITE | Write the running configuration back to the config file the server was started with. | All plans |
CONFIG SET | Change one or more server settings at runtime, without a restart. | All plans |
DBSIZE | Return the number of keys in the selected database. | All plans |
DEBUG | Diagnostic and testing subcommands, disabled unless enable-debug-command allows them. | All plans |
FAILOVER | Accepted for compatibility only. Use REPLICATION.FAILOVER or CLUSTER FAILOVER to fail over. | All plans |
FLUSHALL | Delete every key in every database, along with the data of HotKV's AI features. | All plans |
FLUSHDB | Delete every key in the selected database. | All plans |
HOTKEYS | List the most frequently accessed keys, or clear the access counts. | All plans |
INFO | Server information and statistics in Redis-compatible sections, for monitoring and troubleshooting. | All plans |
LASTSAVE | Return the Unix time of the last successful snapshot save. | All plans |
LATENCY | Find latency spikes by event and see each command's latency distribution. | All plans |
LATENCY DOCTOR | Get a plain-English report on recorded latency spikes, with likely causes. | All plans |
LATENCY GRAPH | Draw one event's recorded latency spikes as a text bar chart. | All plans |
LATENCY HISTOGRAM | Return the latency distribution of each command as cumulative power-of-two buckets. | All plans |
LATENCY HISTORY | Return the recorded latency spikes of one event, oldest first. | All plans |
LATENCY LATEST | Return the latest and the worst latency spike of each monitored event. | All plans |
LATENCY RESET | Forget the recorded latency spikes of some or all events. | All plans |
LOLWUT | Print the HotKV banner and version. | All plans |
MEMORY | Inspect how much memory keys and the server use, and give unused memory back to the system. | All plans |
MEMORY DOCTOR | Get a short plain-English report on memory problems the server can see. | All plans |
MEMORY MALLOC-STATS | Return memory allocated, peak and resident figures as a short text report. | All plans |
MEMORY PURGE | Ask the server to give memory it has freed back to the operating system. | All plans |
MEMORY STATS | Report how the server's memory is used, split into data and overhead. | All plans |
MEMORY USAGE | Estimate how many bytes a key and its value take in memory. | All plans |
MODULE | Module management commands, kept for compatibility; HotKV does not load modules. | All plans |
MODULE LIST | List the loaded modules; always empty, because HotKV does not load modules. | All plans |
MODULE LOAD | Load a module; not supported in HotKV, the command always replies with an error. | All plans |
MODULE LOADEX | Load a module with configuration; not supported in HotKV, the command always replies with an error. | All plans |
MODULE UNLOAD | Unload a module; HotKV never has modules loaded, so the command always replies with an error. | All plans |
MONITOR | Stream every command the server runs to this connection, as it runs. | All plans |
REPLICAOF | Make this server a replica of another HotKV server, or stop replicating and become a primary again. | All plans |
ROLE | Return whether this server is a primary or a replica, with its replication state. | All plans |
SAVE | Write a snapshot of the data set to disk and reply once it is written. | All plans |
SHUTDOWN | Stop the server, saving a snapshot first when configured to, and, in a cluster, hand the shard to a replica. | All plans |
SLAVEOF | Deprecated alias of REPLICAOF. | All plans |
SLOWLOG | Read and manage the log of commands that took longer than a set time to run. | All plans |
SLOWLOG EXPORT | Return every slow log entry as a JSON array, including the user, tenant and database. | All plans |
SLOWLOG GET | Return the newest slow log entries. | All plans |
SLOWLOG LEN | Return the number of entries in the slow log. | All plans |
SLOWLOG RESET | Delete every entry in the slow log. | All plans |
SORT | Sort the elements of a list, set or sorted set, optionally by external keys, and return or store the result. | All plans |
SORT_RO | Read-only SORT, without the STORE option, safe to run on replicas. | All plans |
SWAPDB | Swap the contents of two logical databases in one step. | All plans |
TIME | Return the server's current time as seconds and microseconds. | All plans |
WAIT | Block until this connection's writes have reached a number of replicas, or a timeout passes. | All plans |
WAITAOF | Block until this connection's writes are in the append-only file on disk, locally and on replicas. | All plans |
Cluster
| Command | Description | Availability |
|---|---|---|
ASKING | Let the next command run on a slot this node is importing, after an ASK redirect. | All plans |
CLUSTER | Inspect and manage a HotKV cluster through the CLUSTER subcommands. | All plans |
CLUSTER ADDSLOTS | Assign one or more hash slots to the node that receives the command. | Not on Cloud |
CLUSTER ADDSLOTSRANGE | Assign one or more ranges of hash slots to the node that receives the command. | Not on Cloud |
CLUSTER BUMPEPOCH | Give the receiving node a new configuration epoch, greater than any the cluster knows. | Not on Cloud |
CLUSTER CANCELSLOTMIGRATIONS | Cancel every atomic slot migration the receiving node is moving out, leaving the slots where they are. | Not on Cloud |
CLUSTER COUNT-FAILURE-REPORTS | Count the current reports from other nodes that a given node is failing. | All plans |
CLUSTER COUNTKEYSINSLOT | Count the keys the receiving node holds in a hash slot. | All plans |
CLUSTER DELSLOTS | Unassign one or more hash slots in the receiving node's view of the cluster. | Not on Cloud |
CLUSTER DELSLOTSRANGE | Unassign one or more ranges of hash slots in the receiving node's view of the cluster. | Not on Cloud |
CLUSTER FAILOVER | Promote the receiving replica to primary of its shard, with or without its primary's help. | Not on Cloud |
CLUSTER FLUSHSLOT | Delete every key of one hash slot, in every database, on the node that receives the command and on its replicas. | Not on Cloud |
CLUSTER FLUSHSLOTS | Remove every hash slot the receiving node owns, and close its slot migrations. | Not on Cloud |
CLUSTER FORGET | Remove a node from the receiving node's table, and keep it out for 60 seconds. | Not on Cloud |
CLUSTER GETKEYSINSLOT | List up to a given number of the keys the receiving node holds in a hash slot. | All plans |
CLUSTER GETSLOTMIGRATIONS | List the atomic slot migrations the receiving node has run or is running, newest first. | Not on Cloud |
CLUSTER INFO | Return the cluster state, slot coverage, epochs and cluster bus counters as seen by the receiving node. | All plans |
CLUSTER KEYSLOT | Return the hash slot a key maps to. | All plans |
CLUSTER LINKS | List the receiving node's cluster bus connections to and from the other nodes. | All plans |
CLUSTER MEET | Connect the receiving node with another node so that both join one cluster. | Not on Cloud |
CLUSTER MIGRATESLOTS | Move slot ranges to other primaries in one step, with no ASK redirects and no half-moved slots. | Not on Cloud |
CLUSTER MIGRATION | Move slots to the receiving node in one atomic step, and list or cancel those migrations (the Redis 8 form). | Not on Cloud |
CLUSTER MYID | Return the receiving node's cluster node ID. | All plans |
CLUSTER MYSHARDID | Return the ID of the shard the receiving node belongs to. | Not on Cloud |
CLUSTER NODES | Return every node the receiving node knows, one line each, in the nodes.conf format. | All plans |
CLUSTER REPLICAS | List the replicas of a primary node, in the CLUSTER NODES line format. | Not on Cloud |
CLUSTER REPLICATE | Make the receiving node a replica of the given primary, or turn a replica back into an empty primary with NO ONE. | Not on Cloud |
CLUSTER RESET | Reset the receiving node's cluster state so that it can join a cluster again from scratch. | All plans |
CLUSTER SAVECONFIG | Write the receiving node's cluster configuration to nodes.conf now. | Not on Cloud |
CLUSTER SET-CONFIG-EPOCH | Set the configuration epoch of a new node that does not know any other node yet. | Not on Cloud |
CLUSTER SETNODENAME | Give the receiving node a human-readable name that every node uses for it in its logs. | Not on Cloud |
CLUSTER SETSLOT | Change a hash slot's migration state or owner, the building block of resharding. | Not on Cloud |
CLUSTER SHARDS | Return each shard of the cluster with its slot ranges and its nodes. | All plans |
CLUSTER SLAVES | Older name of CLUSTER REPLICAS, which lists the replicas of a primary node. | Not on Cloud |
CLUSTER SLOT-STATS | Report the key count and resource usage of each hash slot served by the receiving node's shard. | Not on Cloud |
CLUSTER SLOTS | Return the slot ranges of the cluster and the nodes that serve each of them. | All plans |
CLUSTERSCAN | Iterate over the keys of the whole cluster, slot by slot, with a cursor that goes from node to node. | Not on Cloud |
MIGRATE | Move one or more keys to another HotKV or Redis server, atomically per key. | All plans |
READONLY | Let a cluster client read keys from a replica instead of being redirected to the primary. | All plans |
READWRITE | Turn off READONLY for the connection, so that reads on a replica are redirected again. | All plans |
SFLUSH | Delete every key in ranges of hash slots that the node serves, and reply with the ranges it flushed. | Not on Cloud |
ACL
| Command | Description | Availability |
|---|---|---|
ACL | Manage users and their permissions through the ACL subcommands. | All plans |
ACL CAT | List the ACL command categories, or the commands and subcommands in one category. | All plans |
ACL DELUSER | Delete one or more ACL users and disconnect the clients logged in as them. | All plans |
ACL DRYRUN | Check whether a user may run a command with given arguments, without running it. | All plans |
ACL GENPASS | Generate a random password as hexadecimal digits from the system's cryptographic generator. | All plans |
ACL GETUSER | Show one ACL user's flags, password hashes, command rules, key and channel patterns, and selectors. | All plans |
ACL LIST | Return every ACL user as a line in the ACL file format. | All plans |
ACL LOAD | Replace the in-memory ACL users with the ones in the configured aclfile. | All plans |
ACL LOG | Show or clear the recent commands, keys and channels the ACL denied, and failed logins. | All plans |
ACL SAVE | Write the in-memory ACL users to the configured aclfile. | All plans |
ACL SETUSER | Create an ACL user, or change an existing user's passwords, state and permissions. | All plans |
ACL USERS | Return the names of all ACL users. | All plans |
ACL WHOAMI | Return the name of the ACL user the current connection is logged in as. | All plans |
Prompt cache
| Command | Description | Availability |
|---|---|---|
PCACHE.CONFIG | Change the entry limit, default TTL or per-hit cost of an existing prompt cache namespace. | Performance+ prompt-cache |
PCACHE.CREATE | Create a prompt cache namespace with an optional entry limit, default TTL and per-hit cost. | Performance+ prompt-cache |
PCACHE.DEL | Delete one cached prompt from a prompt cache namespace. | Performance+ prompt-cache |
PCACHE.DROP | Delete a prompt cache namespace and all of its entries. | Performance+ prompt-cache |
PCACHE.FLUSH | Remove every entry from a prompt cache namespace but keep the namespace. | Performance+ prompt-cache |
PCACHE.GET | Look up the cached response for an exact prompt in a prompt cache namespace. | Performance+ prompt-cache |
PCACHE.GETEX | Look up a cached prompt response together with its metadata and hit count. | Performance+ prompt-cache |
PCACHE.LIST | List the names of all prompt cache namespaces. | Performance+ prompt-cache |
PCACHE.SET | Store or replace a cached LLM response for an exact prompt, with optional TTL, metadata and token usage. | Performance+ prompt-cache |
PCACHE.STATS | Report entries, hits, misses, evictions, memory, lookup latency and savings for a prompt cache namespace. | Performance+ prompt-cache |
Semantic cache
| Command | Description | Availability |
|---|---|---|
SCACHE.CREATE | Create a semantic cache namespace with a vector dimension, distance metric and similarity threshold. | Performance+ semantic-cache |
SCACHE.DROP | Delete a semantic cache namespace and all of its entries. | Performance+ semantic-cache |
SCACHE.FLUSH | Remove every entry from a semantic cache namespace but keep the namespace and its settings. | Performance+ semantic-cache |
SCACHE.GET | Find the cached response whose query embedding is most similar to yours, if it clears the threshold. | Performance+ semantic-cache |
SCACHE.LIST | List the names of all semantic cache namespaces. | Performance+ semantic-cache |
SCACHE.SET | Store an LLM response in a semantic cache together with the embedding of its query. | Performance+ semantic-cache |
SCACHE.STATS | Report entries, hits, misses, hit rate, search latency and savings for a semantic cache namespace. | Performance+ semantic-cache |
SCACHE.THRESHOLD | Change the similarity threshold of a semantic cache namespace. | Performance+ semantic-cache |
Keyed caches
| Command | Description | Availability |
|---|---|---|
GUARD.CREATE | Create a guard cache namespace with an optional entry limit and default TTL. | Performance+ guard-cache |
GUARD.DEL | Delete one entry from a guard cache namespace. | Performance+ guard-cache |
GUARD.DROP | Delete a guard cache namespace and all of its entries. | Performance+ guard-cache |
GUARD.FLUSH | Remove every entry from a guard cache namespace but keep the namespace. | Performance+ guard-cache |
GUARD.GET | Look up an entry in a guard cache namespace by its exact key. | Performance+ guard-cache |
GUARD.LIST | List the names of all guard cache namespaces. | Performance+ guard-cache |
GUARD.SET | Store or replace an entry in a guard cache namespace, with optional TTL and token usage. | Performance+ guard-cache |
GUARD.STATS | Report entries, hits, misses, evictions, memory and savings for a guard cache namespace. | Performance+ guard-cache |
NCACHE.CREATE | Create a negative cache namespace with an optional entry limit and default TTL. | Performance+ negative-cache |
NCACHE.DEL | Delete one entry from a negative cache namespace. | Performance+ negative-cache |
NCACHE.DROP | Delete a negative cache namespace and all of its entries. | Performance+ negative-cache |
NCACHE.FLUSH | Remove every entry from a negative cache namespace but keep the namespace. | Performance+ negative-cache |
NCACHE.GET | Look up an entry in a negative cache namespace by its exact key. | Performance+ negative-cache |
NCACHE.LIST | List the names of all negative cache namespaces. | Performance+ negative-cache |
NCACHE.SET | Store or replace an entry in a negative cache namespace, with optional TTL and token usage. | Performance+ negative-cache |
NCACHE.STATS | Report entries, hits, misses, evictions, memory and savings for a negative cache namespace. | Performance+ negative-cache |
RERANK.CREATE | Create a rerank cache namespace with an optional entry limit and default TTL. | Performance+ rerank-cache |
RERANK.DEL | Delete one entry from a rerank cache namespace. | Performance+ rerank-cache |
RERANK.DROP | Delete a rerank cache namespace and all of its entries. | Performance+ rerank-cache |
RERANK.FLUSH | Remove every entry from a rerank cache namespace but keep the namespace. | Performance+ rerank-cache |
RERANK.GET | Look up an entry in a rerank cache namespace by its exact key. | Performance+ rerank-cache |
RERANK.LIST | List the names of all rerank cache namespaces. | Performance+ rerank-cache |
RERANK.SET | Store or replace an entry in a rerank cache namespace, with optional TTL and token usage. | Performance+ rerank-cache |
RERANK.STATS | Report entries, hits, misses, evictions, memory and savings for a rerank cache namespace. | Performance+ rerank-cache |
TOOL.CACHE.CREATE | Create a tool cache namespace with an optional entry limit and default TTL. | Performance+ tool-cache |
TOOL.CACHE.DEL | Delete one entry from a tool cache namespace. | Performance+ tool-cache |
TOOL.CACHE.DROP | Delete a tool cache namespace and all of its entries. | Performance+ tool-cache |
TOOL.CACHE.FLUSH | Remove every entry from a tool cache namespace but keep the namespace. | Performance+ tool-cache |
TOOL.CACHE.GET | Look up an entry in a tool cache namespace by its exact key. | Performance+ tool-cache |
TOOL.CACHE.LIST | List the names of all tool cache namespaces. | Performance+ tool-cache |
TOOL.CACHE.SET | Store or replace an entry in a tool cache namespace, with optional TTL and token usage. | Performance+ tool-cache |
TOOL.CACHE.STATS | Report entries, hits, misses, evictions, memory and savings for a tool cache namespace. | Performance+ tool-cache |
LLM usage and budgets
| Command | Description | Availability |
|---|---|---|
LLMBUDGET.CONSUME | Charge tokens and cost to an LLM budget, and find out whether the request is allowed. | Performance+ llm-budget |
LLMBUDGET.DROP | Delete an LLM budget. | Performance+ llm-budget |
LLMBUDGET.LIST | List the names of all LLM budgets. | Performance+ llm-budget |
LLMBUDGET.RESET | Clear an LLM budget's usage and counters and start a new window. | Performance+ llm-budget |
LLMBUDGET.SET | Create or update an LLM budget with a token cap, a cost cap and a window length. | Performance+ llm-budget |
LLMBUDGET.STATUS | Show an LLM budget's usage against its limits, its window and its allowed and rejected counts. | Performance+ llm-budget |
LLMSTATS.BUCKET | Create an LLM usage stats bucket, or confirm that it exists. | Performance+ llm-stats |
LLMSTATS.DROP | Delete an LLM usage stats bucket. | Performance+ llm-stats |
LLMSTATS.GET | Read the running totals and the last-minute window of an LLM usage stats bucket. | Performance+ llm-stats |
LLMSTATS.LIST | List the names of all LLM usage stats buckets. | Performance+ llm-stats |
LLMSTATS.PRICE | Set, read, list or remove model prices in the price table shared by usage stats, budgets and cache savings. | Performance+ llm-stats |
LLMSTATS.RECORD | Record the tokens, cost and latency of one LLM request in a usage stats bucket. | Performance+ llm-stats |
LLMSTATS.RESET | Zero every counter of an LLM usage stats bucket but keep the bucket. | Performance+ llm-stats |
Agent memory
| Command | Description | Availability |
|---|---|---|
AMEM.CONV.APPEND | Append one turn, with its role and content, to a conversation memory session. | Performance+ agent-memory |
AMEM.CONV.CLEAR | Remove every turn from a conversation memory session but keep the session. | Performance+ agent-memory |
AMEM.CONV.CREATE | Create a conversation memory session with an optional window size. | Performance+ agent-memory |
AMEM.CONV.DROP | Delete a conversation memory session and its turns. | Performance+ agent-memory |
AMEM.CONV.GET | Return every turn currently held in a conversation memory session. | Performance+ agent-memory |
AMEM.CONV.WINDOW | Return the most recent turns of a conversation memory session. | Performance+ agent-memory |
AMEM.EPIS.CLEAR | Remove every event from an agent's episodic memory. | Performance+ agent-memory |
AMEM.EPIS.LOG | Append a timestamped event to an agent's episodic memory. | Performance+ agent-memory |
AMEM.EPIS.QUERY | Query an agent's episodic memory by event type and time range. | Performance+ agent-memory |
AMEM.EPIS.STATS | Report the number of events and the oldest and newest timestamps in an agent's episodic memory. | Performance+ agent-memory |
AMEM.SEARCH | Search an agent's memory by embedding and return the closest entries with their source. | Performance+ agent-memory |
AMEM.SEM.CREATE | Create an agent's semantic memory store for embeddings of a fixed dimension. | Performance+ agent-memory |
AMEM.SEM.FORGET | Remove one fact from an agent's semantic memory. | Performance+ agent-memory |
AMEM.SEM.LIST | List the keys of the facts in an agent's semantic memory. | Performance+ agent-memory |
AMEM.SEM.RECALL | Recall the facts in an agent's semantic memory closest to a query embedding. | Performance+ agent-memory |
AMEM.SEM.STORE | Store a fact with its embedding in an agent's semantic memory. | Performance+ agent-memory |
AMEM.SUMMARY.APPEND | Append text to an agent's rolling summary and return its new version number. | Performance+ amem-summary |
AMEM.SUMMARY.DROP | Delete an agent's rolling summary. | Performance+ amem-summary |
AMEM.SUMMARY.GET | Read an agent's rolling summary with its version and last update time. | Performance+ amem-summary |
AMEM.SUMMARY.LIST | List the agent ids that have a rolling summary. | Performance+ amem-summary |
AMEM.SUMMARY.SET | Replace an agent's rolling summary and return its new version number. | Performance+ amem-summary |
AMEM.WORK.CLEAR | Remove every key from an agent session's working memory. | Performance+ agent-memory |
AMEM.WORK.DEL | Delete a key from an agent session's working memory. | Performance+ agent-memory |
AMEM.WORK.GET | Read a key from an agent session's working memory. | Performance+ agent-memory |
AMEM.WORK.LIST | List the keys in an agent session's working memory. | Performance+ agent-memory |
AMEM.WORK.SET | Set a key in an agent session's working memory, creating the session if needed. | Performance+ agent-memory |
RAG
| Command | Description | Availability |
|---|---|---|
RAG.CREATE | Create a RAG pipeline with a vector dimension and a chunking strategy. | Performance+ rag-pipeline |
RAG.DROP | Delete a RAG pipeline with all of its chunks and embeddings. | Performance+ rag-pipeline |
RAG.INGEST | Chunk a document into a RAG pipeline, with optional metadata and one embedding per chunk. | Performance+ rag-pipeline |
RAG.LIST | List the names of all RAG pipelines. | Performance+ rag-pipeline |
RAG.SEARCH | Search a RAG pipeline by query text and embedding, with optional metadata filters. | Performance+ rag-pipeline |
RAG.STATS | Report the documents, chunks, queries and chunking settings of a RAG pipeline. | Performance+ rag-pipeline |
Embeddings
| Command | Description | Availability |
|---|---|---|
EMBED.DEDUP.DROP | Delete an embedding de-duplication namespace and all of its entries. | Performance+ embed-dedup |
EMBED.DEDUP.GET | Fetch the stored embedding for a content hash. | Performance+ embed-dedup |
EMBED.DEDUP.LIST | List the names of all embedding de-duplication namespaces. | Performance+ embed-dedup |
EMBED.DEDUP.PURGE | Remove every embedding from a de-duplication namespace but keep the namespace. | Performance+ embed-dedup |
EMBED.DEDUP.PUT | Store an embedding under its content hash, or add a reference if it is already stored. | Performance+ embed-dedup |
EMBED.DEDUP.RELEASE | Drop one reference to a stored embedding, removing it when no references remain. | Performance+ embed-dedup |
EMBED.DEDUP.STATS | Report hits, misses and entries for an embedding de-duplication namespace. | Performance+ embed-dedup |
Prompt registry
| Command | Description | Availability |
|---|---|---|
PROMPT.DROP | Delete a prompt template and all of its versions. | Performance+ prompt-registry |
PROMPT.GET | Read the active version of a prompt template, or a specific version. | Performance+ prompt-registry |
PROMPT.LATEST | Read the active version of a prompt template. | Performance+ prompt-registry |
PROMPT.LIST | List the names of all prompt templates. | Performance+ prompt-registry |
PROMPT.PUT | Add a new version of a prompt template and make it the active version. | Performance+ prompt-registry |
PROMPT.SETACTIVE | Choose which stored version of a prompt template is active. | Performance+ prompt-registry |
PROMPT.VERSIONS | List the version numbers stored for a prompt template. | Performance+ prompt-registry |
Feature store
| Command | Description | Availability |
|---|---|---|
FEATURE.BATCH | Read feature values for many entities of a feature group in one call. | Performance+ feature-store |
FEATURE.CREATE | Create a feature group with a description and a typed schema. | Performance+ feature-store |
FEATURE.DROP | Delete a feature group with all of its entities. | Performance+ feature-store |
FEATURE.GET | Read an entity's feature values from a feature group, with their update time and age. | Performance+ feature-store |
FEATURE.LIST | List the names of all feature groups. | Performance+ feature-store |
FEATURE.SCHEMA | Show the feature names and types of a feature group. | Performance+ feature-store |
FEATURE.SET | Write one or more feature values for an entity in a feature group. | Performance+ feature-store |
FEATURE.SETAT | Write feature values for an entity and stamp the entity with a time you give, in Unix milliseconds. | Performance+ feature-store |
FEATURE.STATS | Report entities, reads, writes and memory for a feature group. | Performance+ feature-store |
Replication
| Command | Description | Availability |
|---|---|---|
REPLICATION.FAILOVER | Promote this replica to primary, outside cluster mode. | Scale replication |
REPLICATION.INFO | Return this node's replication role, state, offset and number of replicas. | Scale replication |
REPLICATION.PAUSE | Pause the replication stream on this node until REPLICATION.RESUME. | Scale replication |
REPLICATION.RESUME | Resume replication after REPLICATION.PAUSE. | Scale replication |
Encryption
| Command | Description | Availability |
|---|---|---|
ENCRYPTION.INFO | Report whether encryption at rest is on, its algorithm and its key provider. | Scale encryption-at-rest |
ENCRYPTION.ROTATE | Switch encryption at rest to a new key file for every snapshot written from now on. | Scale encryption-at-rest |
ENCRYPTION.VERIFY | Check that an encrypted file on the server decrypts completely and has not been altered. | Scale encryption-at-rest |
Audit
| Command | Description | Availability |
|---|---|---|
AUDIT.EXPORT | Export the audit log to a file on the server as JSON Lines, CSV or CEF. | Scale audit-log |
AUDIT.INFO | Report the audit log's entry count, file size, integrity status and last sequence number. | Scale audit-log |
AUDIT.ROTATE | Close the current audit log file, keep it under a timestamped name, and start a new one. | Scale audit-log |
AUDIT.VERIFY | Check every entry of the audit log for tampering. | Scale audit-log |
IAM
| Command | Description | Availability |
|---|---|---|
IAM.AUTH | Log the connection in through an LDAP directory, an OpenID Connect token, or an ACL user. | Not on Cloud enterprise-iam |
IAM.ROLE.CREATE | Create a role: a set of commands and keys that logins can be given. | Not on Cloud enterprise-iam |
IAM.ROLE.DELETE | Delete a role. Logins that had it lose what it gave at once. | Not on Cloud enterprise-iam |
IAM.ROLE.INFO | Show what a role allows, the keys it reaches, and how many users have it. | Not on Cloud enterprise-iam |
IAM.ROLE.LIST | List the names of all roles. | Not on Cloud enterprise-iam |
IAM.SESSION.KILL | End a login and close its connection. | Not on Cloud enterprise-iam |
IAM.SESSION.LIST | List the logins that are open on this node. | Not on Cloud enterprise-iam |
IAM.USER.ASSIGN | Give a role to a user name, to the users of one source, or to a group. | Not on Cloud enterprise-iam |
IAM.USER.LIST | List who has roles, and which. | Not on Cloud enterprise-iam |
IAM.USER.UNASSIGN | Take a role from a user name, a source or a group. | Not on Cloud enterprise-iam |
Tenancy
| Command | Description | Availability |
|---|---|---|
TENANT.BIND | Record that an ACL user belongs to a tenant. | Scale multi-tenancy |
TENANT.CREATE | Register a tenant with an ID, a display name and optional quota values. | Scale multi-tenancy |
TENANT.DROP | Remove a tenant from the tenant registry; the data stays. | Scale multi-tenancy |
TENANT.INFO | Show a tenant's ID, name, state and usage figures. | Scale multi-tenancy |
TENANT.LIST | List the IDs of all tenants. | Scale multi-tenancy |
TENANT.RESUME | Set a suspended tenant back to active. | Scale multi-tenancy |
TENANT.STATS | Show a tenant's usage figures alongside its memory and key quota values. | Scale multi-tenancy |
TENANT.SUSPEND | Mark a tenant as suspended in the tenant registry. | Scale multi-tenancy |
TENANT.UNBIND | Remove an ACL user from a tenant's list of users. | Scale multi-tenancy |
Observability
| Command | Description | Availability |
|---|---|---|
ALERTS | Inspect and configure webhook alerting, and send test alerts. | Performance+ enterprise-observability |
OBSERVE | Return a summary of the server's state, or its key operational metrics, as RESP. | Performance+ enterprise-observability |
License
| Command | Description | Availability |
|---|---|---|
LICENSE.CHECK | Check whether one feature is enabled by this server's license. | All plans |
LICENSE.HWID | Return this machine's hardware ID, which you send to HotKV when you request a license. | All plans |
LICENSE.INFO | Show the state of this server's HotKV license, its expiry and the features it enables. | All plans |
LICENSE.RELOAD | Load the license file again, from the configured path or from a new one. | All plans |
LICENSE.SET | Install a license and save it to the license file. | All plans |
No commands match.
Was this page helpful?
Thanks for the feedback.