Skip to content

Ask the HotKV docs

Answers come only from these docs and can be wrong; check the linked pages before you rely on them.

Command reference

Last updated

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.

CategoryCountNotes
String24Includes MSETEX, LCS
List17Includes LMOVE, LMPOP
Set17Includes SMOVE, SINTERCARD
Hash28Includes HGETDEL, HGETEX, HSETEX, per-field TTLs (HEXPIRE family)
Sorted Set32Full ZRANGE* family, ZMPOP, ZINTERCARD
Bitmap7Includes BITFIELD, BITFIELD_RO
HyperLogLog5Redis’s format; PFDEBUG, PFSELFTEST
Stream15Full lifecycle including XCLAIM, XAUTOCLAIM
Geospatial10GEOSEARCH + legacy GEORADIUS family
Pub/Sub9Includes sharded pub/sub (7.0+)
Blocking8BLPOP through BZMPOP
Generic (Key)26DUMP/RESTORE, MOVE, nanosecond TTL
Transaction5
Server36MONITOR, ROLE, SORT_RO, WAITAOF, DEBUG, FAILOVER
Cluster6CLUSTER, ASKING, MIGRATE, RESTORE-ASKING
ACL110 subcommands
Tag7HotKV exclusive
Vector Similarity7HNSW-indexed, tag-filtered search
Bloom Filter10Probabilistic
Count-Min Sketch6Probabilistic
Top-K7Probabilistic
Scripting5EVAL, EVALSHA, SCRIPT
Function3FCALL, FUNCTION libraries
Module1Module management
Rate Limiting2GCRA (HotKV exclusive)
Total294

Features and command families that do not exist in Redis or Valkey, available on every plan with no license required:

FeatureCommandsDescription
Nanosecond TTLNEXPIRE, NTTL, NEXPIREATSet and read key TTLs in nanoseconds
Key TaggingTAG.SET/GET/REM/MEMBERS/INTER/COUNT/EXISTSAttach labels to keys and find keys by label
Vector Similarity SearchVSIM.CREATEINDEX/DROPINDEX/SET/GET/DEL/SEARCH/INFOBuilt-in HNSW-based approximate nearest neighbor search
Hot Key TrackingHOTKEYS TOP/RESETReal-time tracking of most frequently accessed keys
GCRA Rate LimitingGCRA.LIMIT, GCRA.RESETServer-side Generic Cell Rate Algorithm rate limiter

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.

Keys

CommandDescriptionAvailability
COPYCopy the value of a key to another key, optionally in another database.All plans
DELDelete one or more keys of any type.All plans
DUMPSerialize the value stored at a key so it can be restored with RESTORE.All plans
EXISTSCount how many of the given keys exist.All plans
EXPIRESet a key's time to live in seconds.All plans
EXPIREATMake a key expire at a Unix time given in seconds.All plans
EXPIRETIMEReturn the Unix time, in seconds, at which a key expires.All plans
KEYSReturn every key in the current database that matches a glob pattern.All plans
MOVEMove a key from the selected database to another database.All plans
NEXPIRESet a key's time to live in nanoseconds.All plans
NEXPIREATMake a key expire at a Unix time given in nanoseconds.All plans
NTTLReturn a key's remaining time to live in nanoseconds.All plans
OBJECTInspect how a key's value is stored and how it is accessed.All plans
OBJECT ENCODINGReturn the encoding name of the value stored at a key.All plans
OBJECT FREQReturn a key's access frequency counter under an LFU eviction policy.All plans
OBJECT IDLETIMEReturn how many seconds have passed since a key was last accessed.All plans
OBJECT REFCOUNTReturn the reference count of a key's value, which is always 1.All plans
PERSISTRemove a key's time to live so it no longer expires.All plans
PEXPIRESet a key's time to live in milliseconds.All plans
PEXPIREATMake a key expire at a Unix time given in milliseconds.All plans
PEXPIRETIMEReturn the Unix time, in milliseconds, at which a key expires.All plans
PTTLReturn a key's remaining time to live in milliseconds.All plans
RANDOMKEYReturn a random key from the current database.All plans
RENAMERename a key, overwriting the destination if it exists.All plans
RENAMENXRename a key only if the new name is not taken.All plans
RESTORECreate a key from a payload produced by DUMP.All plans
RESTORE-ASKINGRESTORE for a slot that is being imported during cluster resharding.All plans
SCANIterate over the keys of the current database with a cursor.All plans
TOUCHMark keys as accessed and count how many exist.All plans
TTLReturn a key's remaining time to live in seconds.All plans
TYPEReturn the type of the value stored at a key.All plans
UNLINKDelete one or more keys, with the same result as DEL.All plans

String

CommandDescriptionAvailability
APPENDAppend a value to the end of a string, creating the key if needed.All plans
DECRSubtract 1 from the integer stored at a key.All plans
DECRBYSubtract an integer from the integer stored at a key.All plans
DELEXDelete a key, or delete it only when its string value meets a condition.All plans
DIGESTReturn the digest of a string value, the fingerprint that the IFDEQ and IFDNE conditions compare.All plans
GETReturn the string value stored at a key.All plans
GETDELReturn the string value of a key and delete the key.All plans
GETEXReturn the string value of a key and optionally change its time to live.All plans
GETRANGEReturn a substring of the string stored at a key.All plans
GETSETSet a string value and return the value it replaced.All plans
INCRAdd 1 to the integer stored at a key.All plans
INCRBYAdd an integer to the integer stored at a key.All plans
INCRBYFLOATAdd a floating-point number to the number stored at a key.All plans
LCSFind the longest common subsequence of two strings.All plans
MGETReturn the string values of several keys in one call.All plans
MSETSet several keys to string values in one step.All plans
MSETEXSet several keys in one step with a shared condition and time to live.All plans
MSETNXSet several keys only if none of them exist.All plans
PSETEXSet a string value with a time to live in milliseconds.All plans
SETStore a string value at a key, with optional expiry and conditions.All plans
SETEXSet a string value with a time to live in seconds.All plans
SETNXSet a string value only if the key does not exist.All plans
SETRANGEOverwrite part of a string at a byte offset.All plans
STRLENReturn the length in bytes of the string stored at a key.All plans
SUBSTRReturn a substring of a string; an older name for GETRANGE.All plans

Bitmap

CommandDescriptionAvailability
BITCOUNTCount the set bits in a string, optionally within a byte or bit range.All plans
BITFIELDRead, write and increment integer fields of any width inside a string.All plans
BITFIELD_RORead integer fields inside a string; the read-only form of BITFIELD.All plans
BITOPCombine strings bit by bit with AND, OR, XOR, NOT, DIFF, DIFF1, ANDOR or ONE and store the result.All plans
BITPOSFind the position of the first bit set to 0 or 1 in a string.All plans
GETBITReturn the value of one bit of the string stored at a key.All plans
SETBITSet or clear one bit of the string stored at a key.All plans

Hash

CommandDescriptionAvailability
HDELRemove one or more fields from a hash.All plans
HEXISTSCheck whether a field exists in a hash.All plans
HEXPIRESet a time to live in seconds on one or more hash fields.All plans
HEXPIREATMake one or more hash fields expire at a Unix time in seconds.All plans
HEXPIRETIMEGet the absolute expiry time of hash fields as a Unix time in seconds.All plans
HGETGet the value of one field of a hash.All plans
HGETALLGet all fields and values of a hash.All plans
HGETDELGet the values of hash fields and delete those fields in one step.All plans
HGETEXGet the values of hash fields and optionally set or remove their time to live.All plans
HIMPORTLoad many hashes that share the same field names, by naming the fields once and then giving only the values.All plans
HIMPORT DISCARDForget one list of field names prepared on this connection.All plans
HIMPORT DISCARDALLForget every list of field names prepared on this connection.All plans
HIMPORT PREPAREGive a name to a list of field names on this connection, for HIMPORT SET to use.All plans
HIMPORT SETMake a hash from values, using a list of field names prepared on this connection.All plans
HINCRBYAdd an integer to the value of a hash field.All plans
HINCRBYFLOATAdd a floating-point number to the value of a hash field.All plans
HKEYSGet all field names of a hash.All plans
HLENGet the number of fields in a hash.All plans
HMGETGet the values of several hash fields in one call.All plans
HMSETSet several hash fields and reply OK (older form of HSET).All plans
HPERSISTRemove the time to live from one or more hash fields.All plans
HPEXPIRESet a time to live in milliseconds on one or more hash fields.All plans
HPEXPIREATMake one or more hash fields expire at a Unix time in milliseconds.All plans
HPEXPIRETIMEGet the absolute expiry time of hash fields as a Unix time in milliseconds.All plans
HPTTLGet the remaining time to live of hash fields, in milliseconds.All plans
HRANDFIELDReturn one or more random fields of a hash, optionally with their values.All plans
HSCANIterate over the fields and values of a hash with a cursor.All plans
HSETSet one or more fields of a hash, creating the hash if it does not exist.All plans
HSETEXSet hash fields with an optional time to live and an all-or-nothing condition.All plans
HSETNXSet a hash field only if it does not exist yet.All plans
HSTRLENGet the length in bytes of a hash field's value.All plans
HTTLGet the remaining time to live of hash fields, in seconds.All plans
HVALSGet all values of a hash.All plans

List

CommandDescriptionAvailability
BLMOVEMove an element from one list to another, waiting until the source has one.All plans
BLMPOPPop elements from the first non-empty list among several keys, waiting until one is available.All plans
BLPOPRemove and return the first element of the first non-empty list, waiting until one is available.All plans
BRPOPRemove and return the last element of the first non-empty list, waiting until one is available.All plans
BRPOPLPUSHMove the last element of a list to the head of another, waiting until one is available (older form of BLMOVE).All plans
LINDEXGet the element at an index of a list.All plans
LINSERTInsert an element before or after another element in a list.All plans
LLENGet the length of a list.All plans
LMOVEPop an element from one list and push it onto another, atomically.All plans
LMPOPPop elements from the first non-empty list among several keys.All plans
LPOPRemove and return elements from the head of a list.All plans
LPOSFind the index of matching elements in a list.All plans
LPUSHInsert one or more elements at the head of a list.All plans
LPUSHXInsert elements at the head of a list, only if the list already exists.All plans
LRANGEGet a range of elements from a list by index.All plans
LREMRemove occurrences of an element from a list.All plans
LSETReplace the element at an index of a list.All plans
LTRIMTrim a list so it keeps only a range of elements.All plans
RPOPRemove and return elements from the tail of a list.All plans
RPOPLPUSHPop the last element of one list and push it to the head of another (older form of LMOVE).All plans
RPUSHAppend one or more elements to the tail of a list.All plans
RPUSHXAppend elements to the tail of a list, only if the list already exists.All plans

Set

CommandDescriptionAvailability
SADDAdd one or more members to a set.All plans
SCARDGet the number of members in a set.All plans
SDIFFReturn the members of the first set that are not in any of the other sets.All plans
SDIFFSTOREStore the difference between the first set and the others in a destination key.All plans
SINTERReturn the members present in every one of the given sets.All plans
SINTERCARDCount the members of the intersection of sets, optionally stopping at a limit.All plans
SINTERSTOREStore the intersection of sets in a destination key.All plans
SISMEMBERCheck whether a value is a member of a set.All plans
SMEMBERSGet all members of a set.All plans
SMISMEMBERCheck several values for membership in a set in one call.All plans
SMOVEMove a member from one set to another, atomically.All plans
SPOPRemove and return one or more random members of a set.All plans
SRANDMEMBERReturn one or more random members of a set without removing them.All plans
SREMRemove one or more members from a set.All plans
SSCANIterate over the members of a set with a cursor.All plans
SUNIONReturn the members present in any of the given sets.All plans
SUNIONSTOREStore the union of sets in a destination key.All plans

Sorted set

CommandDescriptionAvailability
BZMPOPPop the lowest or highest scored members from the first non-empty sorted set, waiting until one is available.All plans
BZPOPMAXRemove and return the highest-scored member of the first non-empty sorted set, waiting until one is available.All plans
BZPOPMINRemove and return the lowest-scored member of the first non-empty sorted set, waiting until one is available.All plans
ZADDAdd members to a sorted set, or update their scores.All plans
ZCARDGet the number of members in a sorted set.All plans
ZCOUNTCount the members of a sorted set with scores in a range.All plans
ZDIFFReturn the members of the first sorted set that are not in any of the others.All plans
ZDIFFSTOREStore the difference between the first sorted set and the others in a destination key.All plans
ZINCRBYAdd to the score of a member of a sorted set.All plans
ZINTERReturn the intersection of sorted sets, combining the scores of shared members.All plans
ZINTERCARDCount the members of the intersection of sorted sets, optionally stopping at a limit.All plans
ZINTERSTOREStore the intersection of sorted sets in a destination key.All plans
ZLEXCOUNTCount the members of a sorted set in a lexicographic range.All plans
ZMPOPPop the lowest or highest scored members from the first non-empty sorted set among several keys.All plans
ZMSCOREGet the scores of several members of a sorted set in one call.All plans
ZPOPMAXRemove and return the members with the highest scores from a sorted set.All plans
ZPOPMINRemove and return the members with the lowest scores from a sorted set.All plans
ZRANDMEMBERReturn one or more random members of a sorted set, optionally with their scores.All plans
ZRANGEGet a range of members from a sorted set by rank, score or lexicographic order.All plans
ZRANGEBYLEXGet the members of a sorted set in a lexicographic range.All plans
ZRANGEBYSCOREGet the members of a sorted set with scores in a range, lowest first.All plans
ZRANGESTOREStore a range of a sorted set, by rank, score or lexicographic order, in another key.All plans
ZRANKGet the rank of a member in a sorted set, lowest score first.All plans
ZREMRemove one or more members from a sorted set.All plans
ZREMRANGEBYLEXRemove the members of a sorted set in a lexicographic range.All plans
ZREMRANGEBYRANKRemove the members of a sorted set in a range of ranks.All plans
ZREMRANGEBYSCORERemove the members of a sorted set with scores in a range.All plans
ZREVRANGEGet a range of members from a sorted set by rank, highest score first.All plans
ZREVRANGEBYLEXGet the members of a sorted set in a lexicographic range, in reverse order.All plans
ZREVRANGEBYSCOREGet the members of a sorted set with scores in a range, highest first.All plans
ZREVRANKGet the rank of a member in a sorted set, highest score first.All plans
ZSCANIterate over the members and scores of a sorted set with a cursor.All plans
ZSCOREGet the score of a member of a sorted set.All plans
ZUNIONReturn the union of sorted sets, combining the scores of shared members.All plans
ZUNIONSTOREStore the union of sorted sets in a destination key.All plans

Stream

CommandDescriptionAvailability
XACKAcknowledge stream entries, removing them from a consumer group's pending list.All plans
XADDAppend an entry to a stream, optionally trimming the stream in the same call.All plans
XAUTOCLAIMScan a consumer group's pending entries and claim the idle ones in one call.All plans
XCFGSETSet how long a stream remembers the idempotent IDs of each producer, and how many.All plans
XCLAIMTake ownership of pending stream entries that another consumer has left idle.All plans
XDELDelete entries from a stream by ID.All plans
XGROUPCreate, change and remove stream consumer groups and their consumers.All plans
XGROUP CREATECreate a consumer group on a stream, starting after a given ID.All plans
XGROUP CREATECONSUMERAdd a consumer to a stream consumer group ahead of its first read.All plans
XGROUP DELCONSUMERRemove a consumer from a stream consumer group, dropping its pending entries.All plans
XGROUP DESTROYDelete a consumer group from a stream, with its consumers and pending entries.All plans
XGROUP SETIDSet the last delivered ID of a consumer group.All plans
XINFOInspect streams, their consumer groups and their consumers.All plans
XINFO CONSUMERSList the consumers of a stream consumer group with their pending counts and idle times.All plans
XINFO GROUPSList a stream's consumer groups with their progress and backlog.All plans
XINFO STREAMShow a stream's length, ID bookkeeping, and first and last entries.All plans
XLENReturn the number of entries in a stream.All plans
XPENDINGInspect the entries a consumer group has delivered but not yet acknowledged.All plans
XRANGEReturn the stream entries with IDs in a range, oldest first.All plans
XREADRead new entries from one or more streams, optionally waiting for them.All plans
XREADGROUPRead stream entries as a consumer of a consumer group, tracking them until acknowledged.All plans
XREVRANGEReturn the stream entries with IDs in a range, newest first.All plans
XSETIDSet a stream's last generated ID and its bookkeeping counters.All plans
XTRIMRemove the oldest entries of a stream by length or by minimum ID.All plans

Geospatial

CommandDescriptionAvailability
GEOADDAdd members with longitude and latitude to a geospatial index stored as a sorted set.All plans
GEODISTReturn the distance between two members of a geospatial index.All plans
GEOHASHReturn standard 11-character geohash strings for members of a geospatial index.All plans
GEOPOSReturn the longitude and latitude of members of a geospatial index.All plans
GEORADIUSFind members of a geospatial index within a radius of a position (legacy form of GEOSEARCH).All plans
GEORADIUS_RORead-only form of GEORADIUS, without the STORE options.All plans
GEORADIUSBYMEMBERFind members of a geospatial index within a radius of another member (legacy form of GEOSEARCH).All plans
GEORADIUSBYMEMBER_RORead-only form of GEORADIUSBYMEMBER, without the STORE options.All plans
GEOSEARCHFind members of a geospatial index within a radius or a box around a point or a member.All plans
GEOSEARCHSTORERun a geospatial search and store the matching members in another sorted set.All plans

HyperLogLog

CommandDescriptionAvailability
PFADDAdd elements to a HyperLogLog for approximate distinct counting.All plans
PFCOUNTReturn the approximate number of distinct elements in one or more HyperLogLogs.All plans
PFDEBUGInspect or convert the representation of a HyperLogLog.All plans
PFMERGEMerge HyperLogLogs into a destination HyperLogLog.All plans
PFSELFTESTRun the built-in HyperLogLog self-test.All plans

Bloom filter

CommandDescriptionAvailability
BF.ADDAdd an item to a Bloom filter, creating the filter if needed.All plans
BF.CARDReturn the number of items added to a Bloom filter.All plans
BF.EXISTSCheck whether an item may have been added to a Bloom filter.All plans
BF.INFOShow a Bloom filter's capacity, size, layers, item count and expansion rate.All plans
BF.INSERTAdd items to a Bloom filter, creating it with chosen settings or refusing to create it.All plans
BF.LOADCHUNKRestore a Bloom filter from the chunks BF.SCANDUMP produced.All plans
BF.MADDAdd several items to a Bloom filter in one call, creating the filter if needed.All plans
BF.MEXISTSCheck several items against a Bloom filter in one call.All plans
BF.RESERVECreate an empty Bloom filter with a chosen error rate and capacity.All plans
BF.SCANDUMPExport a Bloom filter in chunks, to copy or back it up elsewhere.All plans

Count-min sketch

CommandDescriptionAvailability
CMS.INCRBYIncrease the counts of one or more items in a Count-min sketch.All plans
CMS.INFOShow a Count-min sketch's width, depth and total count.All plans
CMS.INITBYDIMCreate a Count-min sketch with an explicit width and depth.All plans
CMS.INITBYPROBCreate a Count-min sketch sized for a chosen error and probability.All plans
CMS.MERGEReplace a Count-min sketch with the sum, optionally weighted, of other sketches.All plans
CMS.QUERYReturn the estimated counts of one or more items in a Count-min sketch.All plans

Top-K

CommandDescriptionAvailability
TOPK.ADDCount one occurrence of each item in a Top-K list, returning any items pushed out.All plans
TOPK.COUNTReturn the estimated counts of items in a Top-K structure, listed or not.All plans
TOPK.INCRBYCount several occurrences of items in a Top-K list at once.All plans
TOPK.INFOShow the settings of a Top-K structure.All plans
TOPK.LISTReturn the items in a Top-K list, most frequent first, optionally with their counts.All plans
TOPK.QUERYCheck whether items are currently in a Top-K list.All plans
TOPK.RESERVECreate a Top-K list that tracks the most frequent items in a stream of events.All plans

Tags

CommandDescriptionAvailability
TAG.COUNTReturn the number of tags attached to a key.All plans
TAG.EXISTSCheck whether a key carries a tag.All plans
TAG.GETReturn all tags attached to a key.All plans
TAG.INTERReturn the keys that carry all of the given tags.All plans
TAG.MEMBERSReturn all keys that carry a tag.All plans
TAG.REMRemove one or more tags from a key.All plans
TAG.SETAttach one or more tags to an existing key.All plans
CommandDescriptionAvailability
VSIM.CREATEINDEXCreate a named vector index for nearest-neighbor search.All plans
VSIM.DELRemove a key's vector from a vector index.All plans
VSIM.DROPDelete a named blob saved with VSIM.SAVE.Performance+
vsim-persist
VSIM.DROPINDEXDelete a vector index and all its vectors.All plans
VSIM.GETReturn the vector stored for a key in a vector index.All plans
VSIM.INFOList vector indexes, or show one index's settings and size.All plans
VSIM.LISTList the names of the blobs saved with VSIM.SAVE.Performance+
vsim-persist
VSIM.LOADRead back a named blob saved with VSIM.SAVE.Performance+
vsim-persist
VSIM.SAVEWrite a named blob of vector data to a file on the server.Performance+
vsim-persist
VSIM.SEARCHFind the keys whose vectors are nearest to a query vector, optionally only among tagged keys.All plans
VSIM.SETStore or replace the vector for a key in a vector index.All plans

Rate limiting

CommandDescriptionAvailability
GCRA.LIMITCheck and consume a rate limit in one atomic step, using the generic cell rate algorithm.All plans
GCRA.RESETClear the rate limit state of one or more keys.All plans
RATELIMIT.CHECKCheck a request against a rate limiter for one key, and consume units if it is allowed.Performance+
rate-limiting
RATELIMIT.CREATECreate a named rate limiter with a limit, a window and an algorithm.Performance+
rate-limiting
RATELIMIT.DROPDelete a rate limiter and the state of all its keys.Performance+
rate-limiting
RATELIMIT.LISTList the names of all rate limiters.Performance+
rate-limiting
RATELIMIT.PEEKSee whether a key could make a request under a rate limiter, without consuming anything.Performance+
rate-limiting
RATELIMIT.RESETClear one key's state in a rate limiter so it starts fresh.Performance+
rate-limiting
RATELIMIT.STATSReport a rate limiter's settings, tracked keys and allowed and denied totals.Performance+
rate-limiting

Time series

CommandDescriptionAvailability
TS.ADDAppend a sample to a time series.Performance+
time-series
TS.AGGAggregate the samples of a time series into fixed-width time buckets.Performance+
time-series
TS.CREATECreate a time series with an optional retention period and labels.Performance+
time-series
TS.DELETEDelete a time series with all its samples, labels and rules.Performance+
time-series
TS.DOWNSAMPLEAdd a rule that feeds every new sample of one time series into another.Performance+
time-series
TS.INFOShow a time series' sample count, first and last samples, retention, memory and labels.Performance+
time-series
TS.LISTList time series names, optionally only those with a given label value.Performance+
time-series
TS.RANGEReturn the samples of a time series between two timestamps.Performance+
time-series
TS.RETENTIONChange how long a time series keeps its samples.Performance+
time-series

Pub/Sub

CommandDescriptionAvailability
PSUBSCRIBESubscribe the connection to every channel matching a glob pattern.All plans
PUBLISHSend a message to every subscriber of a Pub/Sub channel.All plans
PUBSUBInspect the state of Pub/Sub channels and subscriptions.All plans
PUBSUB CHANNELSList the channels that currently have subscribers.All plans
PUBSUB NUMPATReturn the number of pattern subscriptions on the node.All plans
PUBSUB NUMSUBReturn the number of subscribers of each given channel.All plans
PUBSUB SHARDCHANNELSList the shard channels that currently have subscribers.All plans
PUBSUB SHARDNUMSUBReturn the number of subscribers of each given shard channel.All plans
PUNSUBSCRIBERemove pattern subscriptions from the connection.All plans
SPUBLISHSend a message to the subscribers of a shard channel.All plans
SSUBSCRIBESubscribe the connection to one or more shard channels.All plans
SUBSCRIBESubscribe the connection to one or more Pub/Sub channels.All plans
SUNSUBSCRIBEUnsubscribe the connection from shard channels.All plans
UNSUBSCRIBEUnsubscribe the connection from Pub/Sub channels.All plans

Transactions

CommandDescriptionAvailability
DISCARDDrop the commands queued since MULTI and leave the transaction.All plans
EXECRun all commands queued since MULTI as one transaction.All plans
MULTIStart a transaction that queues commands until EXEC.All plans
UNWATCHForget all keys watched by this connection.All plans
WATCHWatch keys so the next transaction runs only if they did not change.All plans

Scripting and functions

CommandDescriptionAvailability
EVALRun a Lua script on the server, atomically.All plans
EVAL_RORun a read-only Lua script.All plans
EVALSHARun a cached Lua script by its SHA1 digest.All plans
EVALSHA_RORun a cached read-only Lua script by its SHA1 digest.All plans
FCALLCall a function from a loaded function library.All plans
FCALL_ROCall a read-only function from a loaded function library.All plans
FUNCTIONManage Lua function libraries.All plans
FUNCTION DELETEDelete a function library and all of its functions.All plans
FUNCTION DUMPSerialize all loaded function libraries into a payload for FUNCTION RESTORE.All plans
FUNCTION FLUSHDelete all function libraries.All plans
FUNCTION KILLStop the function that is currently running, if it has not written yet.All plans
FUNCTION LISTList the loaded function libraries and their functions.All plans
FUNCTION LOADLoad a Lua function library, or replace an existing one.All plans
FUNCTION RESTORELoad function libraries from a FUNCTION DUMP payload.All plans
FUNCTION STATSReturn the number of loaded function libraries and functions.All plans
SCRIPTManage the server's Lua script cache.All plans
SCRIPT DEBUGChoose the debug mode for scripts; HotKV supports only NO.All plans
SCRIPT EXISTSCheck whether scripts are in the script cache.All plans
SCRIPT FLUSHRemove every script from the script cache.All plans
SCRIPT KILLStop the script that is currently running, if it has not written yet.All plans
SCRIPT LOADCompile a Lua script and add it to the script cache without running it.All plans

Connection

CommandDescriptionAvailability
AUTHAuthenticate the current connection with a password, or as a named ACL user.All plans
CLIENTInspect and manage client connections, including the current one.All plans
CLIENT CACHINGChoose whether the keys read by the next command are tracked, for connections in OPTIN or OPTOUT tracking mode.All plans
CLIENT GETNAMEReturn the name of the current connection.All plans
CLIENT GETREDIRReturn the id of the connection that receives this connection's client-side caching invalidations.All plans
CLIENT IDReturn the unique id of the current connection.All plans
CLIENT INFODescribe the current connection in one line of fields.All plans
CLIENT KILLClose client connections by address, or every connection that matches a set of filters.All plans
CLIENT LISTList client connections, one line of fields each, optionally filtered by type, flags or id.All plans
CLIENT NO-EVICTExempt the current connection from being closed when clients hold more than maxmemory-clients.All plans
CLIENT NO-TOUCHRead keys on this connection without updating their last access time.All plans
CLIENT PAUSEHold every client's commands, or only writes, for a number of milliseconds.All plans
CLIENT REPLYTurn off the server's replies to the current connection, turn them back on, or skip the next one.All plans
CLIENT SETINFORecord the name or version of the client library using the connection.All plans
CLIENT SETNAMEGive the current connection a name that shows in CLIENT LIST and the slow log.All plans
CLIENT TRACKINGTurn server-assisted client-side caching on or off for the connection, so HotKV tells it when a key it read changes.All plans
CLIENT TRACKINGINFOReport the client-side caching state of the connection, with its flags, where invalidations go and its prefixes.All plans
CLIENT UNBLOCKEnd another connection's blocking command, as a timeout or with an error.All plans
CLIENT UNPAUSEEnd a CLIENT PAUSE before its timeout.All plans
ECHOReturn the given message unchanged.All plans
HELLOChoose RESP2 or RESP3 for the connection, optionally authenticate and name it, and get server details.All plans
PINGCheck that the connection and server respond, optionally echoing a message.All plans
QUITAsk the server to close the connection once pending replies are sent.All plans
RESETReturn the connection to the state it had when it was opened.All plans
SELECTSwitch the connection to another numbered logical database.All plans

Server

CommandDescriptionAvailability
BGREWRITEAOFRewrite the append-only file in the background so it holds the current data set compactly.All plans
BGSAVEStart writing a snapshot of the data set to disk in the background.All plans
COMMANDDescribe the commands the server has, for client libraries and cluster routing.All plans
COMMAND COUNTReturn the number of commands the server has.All plans
COMMAND DOCSReturn a short documentation entry for each command.All plans
COMMAND GETKEYSReturn the key arguments of a full command line without running it.All plans
COMMAND GETKEYSANDFLAGSReturn the key arguments of a full command line, with whether each is read or written.All plans
COMMAND INFOReturn the arity, flags, key positions and ACL categories of commands.All plans
COMMAND LISTList every command and subcommand name, optionally filtered by ACL category or pattern.All plans
CONFIGRead and change server settings at runtime, save them to the config file, and reset statistics.All plans
CONFIG GETRead server settings by exact name or glob-style pattern.All plans
CONFIG RESETSTATReset the statistics counters reported by INFO.All plans
CONFIG REWRITEWrite the running configuration back to the config file the server was started with.All plans
CONFIG SETChange one or more server settings at runtime, without a restart.All plans
DBSIZEReturn the number of keys in the selected database.All plans
DEBUGDiagnostic and testing subcommands, disabled unless enable-debug-command allows them.All plans
FAILOVERAccepted for compatibility only. Use REPLICATION.FAILOVER or CLUSTER FAILOVER to fail over.All plans
FLUSHALLDelete every key in every database, along with the data of HotKV's AI features.All plans
FLUSHDBDelete every key in the selected database.All plans
HOTKEYSList the most frequently accessed keys, or clear the access counts.All plans
INFOServer information and statistics in Redis-compatible sections, for monitoring and troubleshooting.All plans
LASTSAVEReturn the Unix time of the last successful snapshot save.All plans
LATENCYFind latency spikes by event and see each command's latency distribution.All plans
LATENCY DOCTORGet a plain-English report on recorded latency spikes, with likely causes.All plans
LATENCY GRAPHDraw one event's recorded latency spikes as a text bar chart.All plans
LATENCY HISTOGRAMReturn the latency distribution of each command as cumulative power-of-two buckets.All plans
LATENCY HISTORYReturn the recorded latency spikes of one event, oldest first.All plans
LATENCY LATESTReturn the latest and the worst latency spike of each monitored event.All plans
LATENCY RESETForget the recorded latency spikes of some or all events.All plans
LOLWUTPrint the HotKV banner and version.All plans
MEMORYInspect how much memory keys and the server use, and give unused memory back to the system.All plans
MEMORY DOCTORGet a short plain-English report on memory problems the server can see.All plans
MEMORY MALLOC-STATSReturn memory allocated, peak and resident figures as a short text report.All plans
MEMORY PURGEAsk the server to give memory it has freed back to the operating system.All plans
MEMORY STATSReport how the server's memory is used, split into data and overhead.All plans
MEMORY USAGEEstimate how many bytes a key and its value take in memory.All plans
MODULEModule management commands, kept for compatibility; HotKV does not load modules.All plans
MODULE LISTList the loaded modules; always empty, because HotKV does not load modules.All plans
MODULE LOADLoad a module; not supported in HotKV, the command always replies with an error.All plans
MODULE LOADEXLoad a module with configuration; not supported in HotKV, the command always replies with an error.All plans
MODULE UNLOADUnload a module; HotKV never has modules loaded, so the command always replies with an error.All plans
MONITORStream every command the server runs to this connection, as it runs.All plans
REPLICAOFMake this server a replica of another HotKV server, or stop replicating and become a primary again.All plans
ROLEReturn whether this server is a primary or a replica, with its replication state.All plans
SAVEWrite a snapshot of the data set to disk and reply once it is written.All plans
SHUTDOWNStop the server, saving a snapshot first when configured to, and, in a cluster, hand the shard to a replica.All plans
SLAVEOFDeprecated alias of REPLICAOF.All plans
SLOWLOGRead and manage the log of commands that took longer than a set time to run.All plans
SLOWLOG EXPORTReturn every slow log entry as a JSON array, including the user, tenant and database.All plans
SLOWLOG GETReturn the newest slow log entries.All plans
SLOWLOG LENReturn the number of entries in the slow log.All plans
SLOWLOG RESETDelete every entry in the slow log.All plans
SORTSort the elements of a list, set or sorted set, optionally by external keys, and return or store the result.All plans
SORT_RORead-only SORT, without the STORE option, safe to run on replicas.All plans
SWAPDBSwap the contents of two logical databases in one step.All plans
TIMEReturn the server's current time as seconds and microseconds.All plans
WAITBlock until this connection's writes have reached a number of replicas, or a timeout passes.All plans
WAITAOFBlock until this connection's writes are in the append-only file on disk, locally and on replicas.All plans

Cluster

CommandDescriptionAvailability
ASKINGLet the next command run on a slot this node is importing, after an ASK redirect.All plans
CLUSTERInspect and manage a HotKV cluster through the CLUSTER subcommands.All plans
CLUSTER ADDSLOTSAssign one or more hash slots to the node that receives the command.Not on Cloud
CLUSTER ADDSLOTSRANGEAssign one or more ranges of hash slots to the node that receives the command.Not on Cloud
CLUSTER BUMPEPOCHGive the receiving node a new configuration epoch, greater than any the cluster knows.Not on Cloud
CLUSTER CANCELSLOTMIGRATIONSCancel every atomic slot migration the receiving node is moving out, leaving the slots where they are.Not on Cloud
CLUSTER COUNT-FAILURE-REPORTSCount the current reports from other nodes that a given node is failing.All plans
CLUSTER COUNTKEYSINSLOTCount the keys the receiving node holds in a hash slot.All plans
CLUSTER DELSLOTSUnassign one or more hash slots in the receiving node's view of the cluster.Not on Cloud
CLUSTER DELSLOTSRANGEUnassign one or more ranges of hash slots in the receiving node's view of the cluster.Not on Cloud
CLUSTER FAILOVERPromote the receiving replica to primary of its shard, with or without its primary's help.Not on Cloud
CLUSTER FLUSHSLOTDelete every key of one hash slot, in every database, on the node that receives the command and on its replicas.Not on Cloud
CLUSTER FLUSHSLOTSRemove every hash slot the receiving node owns, and close its slot migrations.Not on Cloud
CLUSTER FORGETRemove a node from the receiving node's table, and keep it out for 60 seconds.Not on Cloud
CLUSTER GETKEYSINSLOTList up to a given number of the keys the receiving node holds in a hash slot.All plans
CLUSTER GETSLOTMIGRATIONSList the atomic slot migrations the receiving node has run or is running, newest first.Not on Cloud
CLUSTER INFOReturn the cluster state, slot coverage, epochs and cluster bus counters as seen by the receiving node.All plans
CLUSTER KEYSLOTReturn the hash slot a key maps to.All plans
CLUSTER LINKSList the receiving node's cluster bus connections to and from the other nodes.All plans
CLUSTER MEETConnect the receiving node with another node so that both join one cluster.Not on Cloud
CLUSTER MIGRATESLOTSMove slot ranges to other primaries in one step, with no ASK redirects and no half-moved slots.Not on Cloud
CLUSTER MIGRATIONMove slots to the receiving node in one atomic step, and list or cancel those migrations (the Redis 8 form).Not on Cloud
CLUSTER MYIDReturn the receiving node's cluster node ID.All plans
CLUSTER MYSHARDIDReturn the ID of the shard the receiving node belongs to.Not on Cloud
CLUSTER NODESReturn every node the receiving node knows, one line each, in the nodes.conf format.All plans
CLUSTER REPLICASList the replicas of a primary node, in the CLUSTER NODES line format.Not on Cloud
CLUSTER REPLICATEMake 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 RESETReset the receiving node's cluster state so that it can join a cluster again from scratch.All plans
CLUSTER SAVECONFIGWrite the receiving node's cluster configuration to nodes.conf now.Not on Cloud
CLUSTER SET-CONFIG-EPOCHSet the configuration epoch of a new node that does not know any other node yet.Not on Cloud
CLUSTER SETNODENAMEGive the receiving node a human-readable name that every node uses for it in its logs.Not on Cloud
CLUSTER SETSLOTChange a hash slot's migration state or owner, the building block of resharding.Not on Cloud
CLUSTER SHARDSReturn each shard of the cluster with its slot ranges and its nodes.All plans
CLUSTER SLAVESOlder name of CLUSTER REPLICAS, which lists the replicas of a primary node.Not on Cloud
CLUSTER SLOT-STATSReport the key count and resource usage of each hash slot served by the receiving node's shard.Not on Cloud
CLUSTER SLOTSReturn the slot ranges of the cluster and the nodes that serve each of them.All plans
CLUSTERSCANIterate over the keys of the whole cluster, slot by slot, with a cursor that goes from node to node.Not on Cloud
MIGRATEMove one or more keys to another HotKV or Redis server, atomically per key.All plans
READONLYLet a cluster client read keys from a replica instead of being redirected to the primary.All plans
READWRITETurn off READONLY for the connection, so that reads on a replica are redirected again.All plans
SFLUSHDelete every key in ranges of hash slots that the node serves, and reply with the ranges it flushed.Not on Cloud

ACL

CommandDescriptionAvailability
ACLManage users and their permissions through the ACL subcommands.All plans
ACL CATList the ACL command categories, or the commands and subcommands in one category.All plans
ACL DELUSERDelete one or more ACL users and disconnect the clients logged in as them.All plans
ACL DRYRUNCheck whether a user may run a command with given arguments, without running it.All plans
ACL GENPASSGenerate a random password as hexadecimal digits from the system's cryptographic generator.All plans
ACL GETUSERShow one ACL user's flags, password hashes, command rules, key and channel patterns, and selectors.All plans
ACL LISTReturn every ACL user as a line in the ACL file format.All plans
ACL LOADReplace the in-memory ACL users with the ones in the configured aclfile.All plans
ACL LOGShow or clear the recent commands, keys and channels the ACL denied, and failed logins.All plans
ACL SAVEWrite the in-memory ACL users to the configured aclfile.All plans
ACL SETUSERCreate an ACL user, or change an existing user's passwords, state and permissions.All plans
ACL USERSReturn the names of all ACL users.All plans
ACL WHOAMIReturn the name of the ACL user the current connection is logged in as.All plans

Prompt cache

CommandDescriptionAvailability
PCACHE.CONFIGChange the entry limit, default TTL or per-hit cost of an existing prompt cache namespace.Performance+
prompt-cache
PCACHE.CREATECreate a prompt cache namespace with an optional entry limit, default TTL and per-hit cost.Performance+
prompt-cache
PCACHE.DELDelete one cached prompt from a prompt cache namespace.Performance+
prompt-cache
PCACHE.DROPDelete a prompt cache namespace and all of its entries.Performance+
prompt-cache
PCACHE.FLUSHRemove every entry from a prompt cache namespace but keep the namespace.Performance+
prompt-cache
PCACHE.GETLook up the cached response for an exact prompt in a prompt cache namespace.Performance+
prompt-cache
PCACHE.GETEXLook up a cached prompt response together with its metadata and hit count.Performance+
prompt-cache
PCACHE.LISTList the names of all prompt cache namespaces.Performance+
prompt-cache
PCACHE.SETStore or replace a cached LLM response for an exact prompt, with optional TTL, metadata and token usage.Performance+
prompt-cache
PCACHE.STATSReport entries, hits, misses, evictions, memory, lookup latency and savings for a prompt cache namespace.Performance+
prompt-cache

Semantic cache

CommandDescriptionAvailability
SCACHE.CREATECreate a semantic cache namespace with a vector dimension, distance metric and similarity threshold.Performance+
semantic-cache
SCACHE.DROPDelete a semantic cache namespace and all of its entries.Performance+
semantic-cache
SCACHE.FLUSHRemove every entry from a semantic cache namespace but keep the namespace and its settings.Performance+
semantic-cache
SCACHE.GETFind the cached response whose query embedding is most similar to yours, if it clears the threshold.Performance+
semantic-cache
SCACHE.LISTList the names of all semantic cache namespaces.Performance+
semantic-cache
SCACHE.SETStore an LLM response in a semantic cache together with the embedding of its query.Performance+
semantic-cache
SCACHE.STATSReport entries, hits, misses, hit rate, search latency and savings for a semantic cache namespace.Performance+
semantic-cache
SCACHE.THRESHOLDChange the similarity threshold of a semantic cache namespace.Performance+
semantic-cache

Keyed caches

CommandDescriptionAvailability
GUARD.CREATECreate a guard cache namespace with an optional entry limit and default TTL.Performance+
guard-cache
GUARD.DELDelete one entry from a guard cache namespace.Performance+
guard-cache
GUARD.DROPDelete a guard cache namespace and all of its entries.Performance+
guard-cache
GUARD.FLUSHRemove every entry from a guard cache namespace but keep the namespace.Performance+
guard-cache
GUARD.GETLook up an entry in a guard cache namespace by its exact key.Performance+
guard-cache
GUARD.LISTList the names of all guard cache namespaces.Performance+
guard-cache
GUARD.SETStore or replace an entry in a guard cache namespace, with optional TTL and token usage.Performance+
guard-cache
GUARD.STATSReport entries, hits, misses, evictions, memory and savings for a guard cache namespace.Performance+
guard-cache
NCACHE.CREATECreate a negative cache namespace with an optional entry limit and default TTL.Performance+
negative-cache
NCACHE.DELDelete one entry from a negative cache namespace.Performance+
negative-cache
NCACHE.DROPDelete a negative cache namespace and all of its entries.Performance+
negative-cache
NCACHE.FLUSHRemove every entry from a negative cache namespace but keep the namespace.Performance+
negative-cache
NCACHE.GETLook up an entry in a negative cache namespace by its exact key.Performance+
negative-cache
NCACHE.LISTList the names of all negative cache namespaces.Performance+
negative-cache
NCACHE.SETStore or replace an entry in a negative cache namespace, with optional TTL and token usage.Performance+
negative-cache
NCACHE.STATSReport entries, hits, misses, evictions, memory and savings for a negative cache namespace.Performance+
negative-cache
RERANK.CREATECreate a rerank cache namespace with an optional entry limit and default TTL.Performance+
rerank-cache
RERANK.DELDelete one entry from a rerank cache namespace.Performance+
rerank-cache
RERANK.DROPDelete a rerank cache namespace and all of its entries.Performance+
rerank-cache
RERANK.FLUSHRemove every entry from a rerank cache namespace but keep the namespace.Performance+
rerank-cache
RERANK.GETLook up an entry in a rerank cache namespace by its exact key.Performance+
rerank-cache
RERANK.LISTList the names of all rerank cache namespaces.Performance+
rerank-cache
RERANK.SETStore or replace an entry in a rerank cache namespace, with optional TTL and token usage.Performance+
rerank-cache
RERANK.STATSReport entries, hits, misses, evictions, memory and savings for a rerank cache namespace.Performance+
rerank-cache
TOOL.CACHE.CREATECreate a tool cache namespace with an optional entry limit and default TTL.Performance+
tool-cache
TOOL.CACHE.DELDelete one entry from a tool cache namespace.Performance+
tool-cache
TOOL.CACHE.DROPDelete a tool cache namespace and all of its entries.Performance+
tool-cache
TOOL.CACHE.FLUSHRemove every entry from a tool cache namespace but keep the namespace.Performance+
tool-cache
TOOL.CACHE.GETLook up an entry in a tool cache namespace by its exact key.Performance+
tool-cache
TOOL.CACHE.LISTList the names of all tool cache namespaces.Performance+
tool-cache
TOOL.CACHE.SETStore or replace an entry in a tool cache namespace, with optional TTL and token usage.Performance+
tool-cache
TOOL.CACHE.STATSReport entries, hits, misses, evictions, memory and savings for a tool cache namespace.Performance+
tool-cache

LLM usage and budgets

CommandDescriptionAvailability
LLMBUDGET.CONSUMECharge tokens and cost to an LLM budget, and find out whether the request is allowed.Performance+
llm-budget
LLMBUDGET.DROPDelete an LLM budget.Performance+
llm-budget
LLMBUDGET.LISTList the names of all LLM budgets.Performance+
llm-budget
LLMBUDGET.RESETClear an LLM budget's usage and counters and start a new window.Performance+
llm-budget
LLMBUDGET.SETCreate or update an LLM budget with a token cap, a cost cap and a window length.Performance+
llm-budget
LLMBUDGET.STATUSShow an LLM budget's usage against its limits, its window and its allowed and rejected counts.Performance+
llm-budget
LLMSTATS.BUCKETCreate an LLM usage stats bucket, or confirm that it exists.Performance+
llm-stats
LLMSTATS.DROPDelete an LLM usage stats bucket.Performance+
llm-stats
LLMSTATS.GETRead the running totals and the last-minute window of an LLM usage stats bucket.Performance+
llm-stats
LLMSTATS.LISTList the names of all LLM usage stats buckets.Performance+
llm-stats
LLMSTATS.PRICESet, read, list or remove model prices in the price table shared by usage stats, budgets and cache savings.Performance+
llm-stats
LLMSTATS.RECORDRecord the tokens, cost and latency of one LLM request in a usage stats bucket.Performance+
llm-stats
LLMSTATS.RESETZero every counter of an LLM usage stats bucket but keep the bucket.Performance+
llm-stats

Agent memory

CommandDescriptionAvailability
AMEM.CONV.APPENDAppend one turn, with its role and content, to a conversation memory session.Performance+
agent-memory
AMEM.CONV.CLEARRemove every turn from a conversation memory session but keep the session.Performance+
agent-memory
AMEM.CONV.CREATECreate a conversation memory session with an optional window size.Performance+
agent-memory
AMEM.CONV.DROPDelete a conversation memory session and its turns.Performance+
agent-memory
AMEM.CONV.GETReturn every turn currently held in a conversation memory session.Performance+
agent-memory
AMEM.CONV.WINDOWReturn the most recent turns of a conversation memory session.Performance+
agent-memory
AMEM.EPIS.CLEARRemove every event from an agent's episodic memory.Performance+
agent-memory
AMEM.EPIS.LOGAppend a timestamped event to an agent's episodic memory.Performance+
agent-memory
AMEM.EPIS.QUERYQuery an agent's episodic memory by event type and time range.Performance+
agent-memory
AMEM.EPIS.STATSReport the number of events and the oldest and newest timestamps in an agent's episodic memory.Performance+
agent-memory
AMEM.SEARCHSearch an agent's memory by embedding and return the closest entries with their source.Performance+
agent-memory
AMEM.SEM.CREATECreate an agent's semantic memory store for embeddings of a fixed dimension.Performance+
agent-memory
AMEM.SEM.FORGETRemove one fact from an agent's semantic memory.Performance+
agent-memory
AMEM.SEM.LISTList the keys of the facts in an agent's semantic memory.Performance+
agent-memory
AMEM.SEM.RECALLRecall the facts in an agent's semantic memory closest to a query embedding.Performance+
agent-memory
AMEM.SEM.STOREStore a fact with its embedding in an agent's semantic memory.Performance+
agent-memory
AMEM.SUMMARY.APPENDAppend text to an agent's rolling summary and return its new version number.Performance+
amem-summary
AMEM.SUMMARY.DROPDelete an agent's rolling summary.Performance+
amem-summary
AMEM.SUMMARY.GETRead an agent's rolling summary with its version and last update time.Performance+
amem-summary
AMEM.SUMMARY.LISTList the agent ids that have a rolling summary.Performance+
amem-summary
AMEM.SUMMARY.SETReplace an agent's rolling summary and return its new version number.Performance+
amem-summary
AMEM.WORK.CLEARRemove every key from an agent session's working memory.Performance+
agent-memory
AMEM.WORK.DELDelete a key from an agent session's working memory.Performance+
agent-memory
AMEM.WORK.GETRead a key from an agent session's working memory.Performance+
agent-memory
AMEM.WORK.LISTList the keys in an agent session's working memory.Performance+
agent-memory
AMEM.WORK.SETSet a key in an agent session's working memory, creating the session if needed.Performance+
agent-memory

RAG

CommandDescriptionAvailability
RAG.CREATECreate a RAG pipeline with a vector dimension and a chunking strategy.Performance+
rag-pipeline
RAG.DROPDelete a RAG pipeline with all of its chunks and embeddings.Performance+
rag-pipeline
RAG.INGESTChunk a document into a RAG pipeline, with optional metadata and one embedding per chunk.Performance+
rag-pipeline
RAG.LISTList the names of all RAG pipelines.Performance+
rag-pipeline
RAG.SEARCHSearch a RAG pipeline by query text and embedding, with optional metadata filters.Performance+
rag-pipeline
RAG.STATSReport the documents, chunks, queries and chunking settings of a RAG pipeline.Performance+
rag-pipeline

Embeddings

CommandDescriptionAvailability
EMBED.DEDUP.DROPDelete an embedding de-duplication namespace and all of its entries.Performance+
embed-dedup
EMBED.DEDUP.GETFetch the stored embedding for a content hash.Performance+
embed-dedup
EMBED.DEDUP.LISTList the names of all embedding de-duplication namespaces.Performance+
embed-dedup
EMBED.DEDUP.PURGERemove every embedding from a de-duplication namespace but keep the namespace.Performance+
embed-dedup
EMBED.DEDUP.PUTStore an embedding under its content hash, or add a reference if it is already stored.Performance+
embed-dedup
EMBED.DEDUP.RELEASEDrop one reference to a stored embedding, removing it when no references remain.Performance+
embed-dedup
EMBED.DEDUP.STATSReport hits, misses and entries for an embedding de-duplication namespace.Performance+
embed-dedup

Prompt registry

CommandDescriptionAvailability
PROMPT.DROPDelete a prompt template and all of its versions.Performance+
prompt-registry
PROMPT.GETRead the active version of a prompt template, or a specific version.Performance+
prompt-registry
PROMPT.LATESTRead the active version of a prompt template.Performance+
prompt-registry
PROMPT.LISTList the names of all prompt templates.Performance+
prompt-registry
PROMPT.PUTAdd a new version of a prompt template and make it the active version.Performance+
prompt-registry
PROMPT.SETACTIVEChoose which stored version of a prompt template is active.Performance+
prompt-registry
PROMPT.VERSIONSList the version numbers stored for a prompt template.Performance+
prompt-registry

Feature store

CommandDescriptionAvailability
FEATURE.BATCHRead feature values for many entities of a feature group in one call.Performance+
feature-store
FEATURE.CREATECreate a feature group with a description and a typed schema.Performance+
feature-store
FEATURE.DROPDelete a feature group with all of its entities.Performance+
feature-store
FEATURE.GETRead an entity's feature values from a feature group, with their update time and age.Performance+
feature-store
FEATURE.LISTList the names of all feature groups.Performance+
feature-store
FEATURE.SCHEMAShow the feature names and types of a feature group.Performance+
feature-store
FEATURE.SETWrite one or more feature values for an entity in a feature group.Performance+
feature-store
FEATURE.SETATWrite feature values for an entity and stamp the entity with a time you give, in Unix milliseconds.Performance+
feature-store
FEATURE.STATSReport entities, reads, writes and memory for a feature group.Performance+
feature-store

Replication

CommandDescriptionAvailability
REPLICATION.FAILOVERPromote this replica to primary, outside cluster mode.Scale
replication
REPLICATION.INFOReturn this node's replication role, state, offset and number of replicas.Scale
replication
REPLICATION.PAUSEPause the replication stream on this node until REPLICATION.RESUME.Scale
replication
REPLICATION.RESUMEResume replication after REPLICATION.PAUSE.Scale
replication

Encryption

CommandDescriptionAvailability
ENCRYPTION.INFOReport whether encryption at rest is on, its algorithm and its key provider.Scale
encryption-at-rest
ENCRYPTION.ROTATESwitch encryption at rest to a new key file for every snapshot written from now on.Scale
encryption-at-rest
ENCRYPTION.VERIFYCheck that an encrypted file on the server decrypts completely and has not been altered.Scale
encryption-at-rest

Audit

CommandDescriptionAvailability
AUDIT.EXPORTExport the audit log to a file on the server as JSON Lines, CSV or CEF.Scale
audit-log
AUDIT.INFOReport the audit log's entry count, file size, integrity status and last sequence number.Scale
audit-log
AUDIT.ROTATEClose the current audit log file, keep it under a timestamped name, and start a new one.Scale
audit-log
AUDIT.VERIFYCheck every entry of the audit log for tampering.Scale
audit-log

IAM

CommandDescriptionAvailability
IAM.AUTHLog the connection in through an LDAP directory, an OpenID Connect token, or an ACL user.Not on Cloud
enterprise-iam
IAM.ROLE.CREATECreate a role: a set of commands and keys that logins can be given.Not on Cloud
enterprise-iam
IAM.ROLE.DELETEDelete a role. Logins that had it lose what it gave at once.Not on Cloud
enterprise-iam
IAM.ROLE.INFOShow what a role allows, the keys it reaches, and how many users have it.Not on Cloud
enterprise-iam
IAM.ROLE.LISTList the names of all roles.Not on Cloud
enterprise-iam
IAM.SESSION.KILLEnd a login and close its connection.Not on Cloud
enterprise-iam
IAM.SESSION.LISTList the logins that are open on this node.Not on Cloud
enterprise-iam
IAM.USER.ASSIGNGive a role to a user name, to the users of one source, or to a group.Not on Cloud
enterprise-iam
IAM.USER.LISTList who has roles, and which.Not on Cloud
enterprise-iam
IAM.USER.UNASSIGNTake a role from a user name, a source or a group.Not on Cloud
enterprise-iam

Tenancy

CommandDescriptionAvailability
TENANT.BINDRecord that an ACL user belongs to a tenant.Scale
multi-tenancy
TENANT.CREATERegister a tenant with an ID, a display name and optional quota values.Scale
multi-tenancy
TENANT.DROPRemove a tenant from the tenant registry; the data stays.Scale
multi-tenancy
TENANT.INFOShow a tenant's ID, name, state and usage figures.Scale
multi-tenancy
TENANT.LISTList the IDs of all tenants.Scale
multi-tenancy
TENANT.RESUMESet a suspended tenant back to active.Scale
multi-tenancy
TENANT.STATSShow a tenant's usage figures alongside its memory and key quota values.Scale
multi-tenancy
TENANT.SUSPENDMark a tenant as suspended in the tenant registry.Scale
multi-tenancy
TENANT.UNBINDRemove an ACL user from a tenant's list of users.Scale
multi-tenancy

Observability

CommandDescriptionAvailability
ALERTSInspect and configure webhook alerting, and send test alerts.Performance+
enterprise-observability
OBSERVEReturn a summary of the server's state, or its key operational metrics, as RESP.Performance+
enterprise-observability

License

CommandDescriptionAvailability
LICENSE.CHECKCheck whether one feature is enabled by this server's license.All plans
LICENSE.HWIDReturn this machine's hardware ID, which you send to HotKV when you request a license.All plans
LICENSE.INFOShow the state of this server's HotKV license, its expiry and the features it enables.All plans
LICENSE.RELOADLoad the license file again, from the configured path or from a new one.All plans
LICENSE.SETInstall a license and save it to the license file.All plans