Interface Command

public interface Command

Auto generated API Commands to interact with REDIS.

Version:

redis_version:8.6.2

Author:

Paulo Lopes

Field Summary

Fields

Modifier and Type	Field	Description
static final Command	ACL	A container for Access List Control commands.
static final Command	APPEND	Appends a string to the value of a key.
static final Command	ASKING	Signals that a cluster client is following an -ASK redirect.
static final Command	AUTH	Authenticates the connection.
static final Command	BF_ADD	Adds an item to a Bloom Filter.
static final Command	BF_CARD	Returns the cardinality of a Bloom filter.
static final Command	BF_DEBUG	This command only exists in Redis.
static final Command	BF_EXISTS	Checks whether an item exists in a Bloom Filter.
static final Command	BF_INFO	Returns information about a Bloom Filter.
static final Command	BF_INSERT	Adds one or more items to a Bloom Filter.
static final Command	BF_LOADCHUNK	Restores a filter previously saved using SCANDUMP.
static final Command	BF_MADD	Adds one or more items to a Bloom Filter.
static final Command	BF_MEXISTS	Checks whether one or more items exist in a Bloom Filter.
static final Command	BF_RESERVE	Creates a new Bloom Filter.
static final Command	BF_SCANDUMP	Begins an incremental save of the bloom filter.
static final Command	BGREWRITEAOF	Asynchronously rewrites the append-only file to disk.
static final Command	BGSAVE	Asynchronously saves the database(s) to disk.
static final Command	BITCOUNT	Counts the number of set bits (population counting) in a string.
static final Command	BITFIELD	Performs arbitrary bitfield integer operations on strings.
static final Command	BITFIELD_RO	Performs arbitrary read-only bitfield integer operations on strings.
static final Command	BITOP	Performs bitwise operations on multiple strings, and stores the result.
static final Command	BITPOS	Finds the first set (1) or clear (0) bit in a string.
static final Command	BLMOVE	Pops an element from a list, pushes it to another list and returns it.
static final Command	BLMPOP	Pops the first element from one of multiple lists.
static final Command	BLPOP	Removes and returns the first element in a list.
static final Command	BRPOP	Removes and returns the last element in a list.
static final Command	BRPOPLPUSH	Deprecated. since Redis 6.2.0, replaced by: BLMOVE with the RIGHT and LEFT arguments
static final Command	BZMPOP	Removes and returns a member by score from one or more sorted sets.
static final Command	BZPOPMAX	Removes and returns the member with the highest score from one or more sorted sets.
static final Command	BZPOPMIN	Removes and returns the member with the lowest score from one or more sorted sets.
static final Command	CF_ADD	Adds an item to a Cuckoo Filter.
static final Command	CF_ADDNX	Adds an item to a Cuckoo Filter if the item did not exist previously.
static final Command	CF_COMPACT	This command only exists in Redis.
static final Command	CF_COUNT	Return the number of times an item might be in a Cuckoo Filter.
static final Command	CF_DEBUG	This command only exists in Redis.
static final Command	CF_DEL	Deletes an item from a Cuckoo Filter.
static final Command	CF_EXISTS	Checks whether one or more items exist in a Cuckoo Filter.
static final Command	CF_INFO	Returns information about a Cuckoo Filter.
static final Command	CF_INSERT	Adds one or more items to a Cuckoo Filter.
static final Command	CF_INSERTNX	Adds one or more items to a Cuckoo Filter if the items did not exist previously.
static final Command	CF_LOADCHUNK	Restores a filter previously saved using SCANDUMP.
static final Command	CF_MEXISTS	Checks whether one or more items exist in a Cuckoo Filter.
static final Command	CF_RESERVE	Creates a new Cuckoo Filter.
static final Command	CF_SCANDUMP	Begins an incremental save of the bloom filter.
static final Command	CLIENT	A container for client connection commands.
static final Command	CLUSTER	A container for Redis Cluster commands.
static final Command	CMS_INCRBY	Increases the count of one or more items by increment.
static final Command	CMS_INFO	Returns information about a sketch.
static final Command	CMS_INITBYDIM	Initializes a Count-Min Sketch to dimensions specified by user.
static final Command	CMS_INITBYPROB	Initializes a Count-Min Sketch to accommodate requested tolerances.
static final Command	CMS_MERGE	Merges several sketches into one sketch.
static final Command	CMS_QUERY	Returns the count for one or more items in a sketch.
static final Command	COMMAND	Returns detailed information about all commands.
static final Command	COMMANDLOG	A container for command log commands.
static final Command	CONFIG	A container for server configuration commands.
static final Command	COPY	Copies the value of a key to a new key.
static final Command	DBSIZE	Returns the number of keys in the database.
static final Command	DEBUG	A container for debugging commands.
static final Command	DECR	Decrements the integer value of a key by one.
static final Command	DECRBY	Decrements a number from the integer value of a key.
static final Command	DEL	Deletes one or more keys.
static final Command	DELEX	Conditionally removes the specified key based on value or digest comparison.
static final Command	DELIFEQ	Delete key if value matches string.
static final Command	DIGEST	Returns the XXH3 hash of a string value.
static final Command	DISCARD	Discards a transaction.
static final Command	DUMP	Returns a serialized representation of the value stored at a key.
static final Command	ECHO	Returns the given string.
static final Command	EVAL	Executes a server-side Lua script.
static final Command	EVAL_RO	Executes a read-only server-side Lua script.
static final Command	EVALSHA	Executes a server-side Lua script by SHA1 digest.
static final Command	EVALSHA_RO	Executes a read-only server-side Lua script by SHA1 digest.
static final Command	EXEC	Executes all commands in a transaction.
static final Command	EXISTS	Determines whether one or more keys exist.
static final Command	EXPIRE	Sets the expiration time of a key in seconds.
static final Command	EXPIREAT	Sets the expiration time of a key to a Unix timestamp.
static final Command	EXPIRETIME	Returns the expiration time of a key as a Unix timestamp.
static final Command	FAILOVER	Starts a coordinated failover from a server to one of its replicas.
static final Command	FCALL	Invokes a function.
static final Command	FCALL_RO	Invokes a read-only function.
static final Command	FLUSHALL	Removes all keys from all databases.
static final Command	FLUSHDB	Remove all keys from the current database.
static final Command	FT__ALIASADDIFNX	Adds an alias to the index.
static final Command	FT__ALIASDELIFX	Deletes an alias from the index.
static final Command	FT__ALTERIFNX	Adds a new field to the index.
static final Command	FT__CREATEIFNX	Creates an index with the given spec.
static final Command	FT__DROPIFX	This command only exists in Redis.
static final Command	FT__DROPINDEXIFX	Deletes the index.
static final Command	FT__LIST	Returns a list of all existing indexes.
static final Command	FT_ADD	This command only exists in Redis.
static final Command	FT_AGGREGATE	Run a search query on an index and perform aggregate transformations on the results.
static final Command	FT_ALIASADD	Adds an alias to the index.
static final Command	FT_ALIASDEL	Deletes an alias from the index.
static final Command	FT_ALIASUPDATE	Adds or updates an alias to the index.
static final Command	FT_ALTER	Adds a new field to the index.
static final Command	FT_CONFIG	This command only exists in Redis.
static final Command	FT_CREATE	Creates an index with the given spec.
static final Command	FT_CURSOR	This command only exists in Redis.
static final Command	FT_DEBUG	Deprecated. this command no longer exists in the latest Redis release
static final Command	FT_DEL	This command only exists in Redis.
static final Command	FT_DICTADD	Adds terms to a dictionary.
static final Command	FT_DICTDEL	Deletes terms from a dictionary.
static final Command	FT_DICTDUMP	Dumps all terms in the given dictionary.
static final Command	FT_DROP	This command only exists in Redis.
static final Command	FT_DROPINDEX	Deletes the index.
static final Command	FT_EXPLAIN	Returns the execution plan for a complex query.
static final Command	FT_EXPLAINCLI	Returns the execution plan for a complex query.
static final Command	FT_GET	This command only exists in Redis.
static final Command	FT_HYBRID	Performs hybrid search combining text search and vector similarity search.
static final Command	FT_INFO	Returns information and statistics on the index.
static final Command	FT_MGET	This command only exists in Redis.
static final Command	FT_PROFILE	Performs a `FT.SEARCH` or `FT.AGGREGATE` command and collects performance information.
static final Command	FT_SAFEADD	This command only exists in Redis.
static final Command	FT_SEARCH	Searches the index with a textual query, returning either documents or just ids.
static final Command	FT_SPELLCHECK	Performs spelling correction on a query, returning suggestions for misspelled terms.
static final Command	FT_SUGADD	Adds a suggestion string to an auto-complete suggestion dictionary.
static final Command	FT_SUGDEL	Deletes a string from a suggestion index.
static final Command	FT_SUGGET	Gets completion suggestions for a prefix.
static final Command	FT_SUGLEN	Gets the size of an auto-complete suggestion dictionary.
static final Command	FT_SYNADD	This command only exists in Redis.
static final Command	FT_SYNDUMP	Dumps the contents of a synonym group.
static final Command	FT_SYNUPDATE	Creates or updates a synonym group with additional terms.
static final Command	FT_TAGVALS	Returns the distinct tags indexed in a Tag field.
static final Command	FUNCTION	A container for function commands.
static final Command	GEOADD	Adds one or more members to a geospatial index.
static final Command	GEODIST	Returns the distance between two members of a geospatial index.
static final Command	GEOHASH	Returns members from a geospatial index as geohash strings.
static final Command	GEOPOS	Returns the longitude and latitude of members from a geospatial index.
static final Command	GEORADIUS	Deprecated. since Redis 6.2.0, replaced by: GEOSEARCH and GEOSEARCHSTORE with the BYRADIUS argument
static final Command	GEORADIUS_RO	Deprecated. since Redis 6.2.0, replaced by: GEOSEARCH with the BYRADIUS argument
static final Command	GEORADIUSBYMEMBER	Deprecated. since Redis 6.2.0, replaced by: GEOSEARCH and GEOSEARCHSTORE with the BYRADIUS and FROMMEMBER arguments
static final Command	GEORADIUSBYMEMBER_RO	Deprecated. since Redis 6.2.0, replaced by: GEOSEARCH with the BYRADIUS and FROMMEMBER arguments
static final Command	GEOSEARCH	Queries a geospatial index for members inside an area of a box or a circle.
static final Command	GEOSEARCHSTORE	Queries a geospatial index for members inside an area of a box or a circle, optionally stores the result.
static final Command	GET	Returns the string value of a key.
static final Command	GETBIT	Returns a bit value by offset.
static final Command	GETDEL	Returns the string value of a key after deleting the key.
static final Command	GETEX	Returns the string value of a key after setting its expiration time.
static final Command	GETRANGE	Returns a substring of the string stored at a key.
static final Command	GETSET	Deprecated. since Redis 6.2.0, replaced by: SET with the !GET argument
static final Command	GRAPH_BULK	Deprecated. this command no longer exists in the latest Redis release
static final Command	GRAPH_CONFIG	Deprecated. this command no longer exists in the latest Redis release
static final Command	GRAPH_DEBUG	Deprecated. this command no longer exists in the latest Redis release
static final Command	GRAPH_DELETE	Deprecated. this command no longer exists in the latest Redis release
static final Command	GRAPH_EXPLAIN	Deprecated. this command no longer exists in the latest Redis release
static final Command	GRAPH_LIST	Deprecated. this command no longer exists in the latest Redis release
static final Command	GRAPH_PROFILE	Deprecated. this command no longer exists in the latest Redis release
static final Command	GRAPH_QUERY	Deprecated. this command no longer exists in the latest Redis release
static final Command	GRAPH_RO_QUERY	Deprecated. this command no longer exists in the latest Redis release
static final Command	GRAPH_SLOWLOG	Deprecated. this command no longer exists in the latest Redis release
static final Command	HDEL	Deletes one or more fields and their values from a hash.
static final Command	HELLO	Handshakes with the Redis server.
static final Command	HEXISTS	Determines whether a field exists in a hash.
static final Command	HEXPIRE	Set expiry for hash field using relative time to expire (seconds).
static final Command	HEXPIREAT	Set expiry for hash field using an absolute Unix timestamp (seconds).
static final Command	HEXPIRETIME	Returns the expiration time of a hash field as a Unix timestamp, in seconds.
static final Command	HGET	Returns the value of a field in a hash.
static final Command	HGETALL	Returns all fields and values in a hash.
static final Command	HGETDEL	Returns the value of a field and deletes it from the hash.
static final Command	HGETEX	Get the value of one or more fields of a given hash key, and optionally set their expiration.
static final Command	HINCRBY	Increments the integer value of a field in a hash by a number.
static final Command	HINCRBYFLOAT	Increments the floating point value of a field by a number.
static final Command	HKEYS	Returns all fields in a hash.
static final Command	HLEN	Returns the number of fields in a hash.
static final Command	HMGET	Returns the values of all fields in a hash.
static final Command	HMSET	Deprecated. since Redis 4.0.0, replaced by: HSET with multiple field-value pairs
static final Command	HOTKEYS	A container for hotkeys tracking commands.
static final Command	HPERSIST	Removes the expiration time for each specified field.
static final Command	HPEXPIRE	Set expiry for hash field using relative time to expire (milliseconds).
static final Command	HPEXPIREAT	Set expiry for hash field using an absolute Unix timestamp (milliseconds).
static final Command	HPEXPIRETIME	Returns the expiration time of a hash field as a Unix timestamp, in msec.
static final Command	HPTTL	Returns the TTL in milliseconds of a hash field.
static final Command	HRANDFIELD	Returns one or more random fields from a hash.
static final Command	HSCAN	Iterates over fields and values of a hash.
static final Command	HSET	Creates or modifies the value of a field in a hash.
static final Command	HSETEX	Set the value of one or more fields of a given hash key, and optionally set their expiration.
static final Command	HSETNX	Sets the value of a field in a hash only when the field doesn't exist.
static final Command	HSTRLEN	Returns the length of the value of a field.
static final Command	HTTL	Returns the TTL in seconds of a hash field.
static final Command	HVALS	Returns all values in a hash.
static final Command	INCR	Increments the integer value of a key by one.
static final Command	INCRBY	Increments the integer value of a key by a number.
static final Command	INCRBYFLOAT	Increment the floating point value of a key by a number.
static final Command	INFO	Returns information and statistics about the server.
static final Command	JSON_ARRAPPEND	Append the JSON values into the array at path after the last element in it.
static final Command	JSON_ARRINDEX	Search for the first occurrence of a JSON value in an array.
static final Command	JSON_ARRINSERT	Insert the json values into the array at path before the index (shifts to the right).
static final Command	JSON_ARRLEN	Report the length of the JSON array at path in key.
static final Command	JSON_ARRPOP	Remove and return the element at the specified index in the array at path.
static final Command	JSON_ARRTRIM	Trim an array so that it contains only the specified inclusive range of elements.
static final Command	JSON_CLEAR	Clear container values (arrays/objects) and set numeric values to 0.
static final Command	JSON_DEBUG	This is a container command for debugging related tasks.
static final Command	JSON_DEL	Delete a value.
static final Command	JSON_FORGET	Delete a value.
static final Command	JSON_GET	Get JSON value at path.
static final Command	JSON_MERGE	Merge a given JSON value into matching paths.
static final Command	JSON_MGET	Return the values at path from multiple key arguments.
static final Command	JSON_MSET	Set or update one or more JSON values according to the specified key-path-value triplets.
static final Command	JSON_NUMINCRBY	Increment the number value stored at path by number.
static final Command	JSON_NUMMULTBY	Multiply the number value stored at path by number.
static final Command	JSON_NUMPOWBY	Raise the number value stored at path to the power of number.
static final Command	JSON_OBJKEYS	Return the keys in the object that's referenced by path.
static final Command	JSON_OBJLEN	Report the number of keys in the JSON object at path in key.
static final Command	JSON_RESP	Return the JSON in key in Redis serialization protocol specification form.
static final Command	JSON_SET	Set the JSON value at path in key.
static final Command	JSON_STRAPPEND	Append the json-string values to the string at path.
static final Command	JSON_STRLEN	Report the length of the JSON String at path in key.
static final Command	JSON_TOGGLE	Toggle the boolean value stored at path.
static final Command	JSON_TYPE	Report the type of JSON value at path.
static final Command	KEYS	Returns all key names that match a pattern.
static final Command	LASTSAVE	Returns the Unix timestamp of the last successful save to disk.
static final Command	LATENCY	A container for latency diagnostics commands.
static final Command	LCS	Finds the longest common substring.
static final Command	LINDEX	Returns an element from a list by its index.
static final Command	LINSERT	Inserts an element before or after another element in a list.
static final Command	LLEN	Returns the length of a list.
static final Command	LMOVE	Returns an element after popping it from one list and pushing it to another.
static final Command	LMPOP	Returns multiple elements from a list after removing them.
static final Command	LOLWUT	Displays computer art and the Redis version.
static final Command	LPOP	Returns the first elements in a list after removing it.
static final Command	LPOS	Returns the index of matching elements in a list.
static final Command	LPUSH	Prepends one or more elements to a list.
static final Command	LPUSHX	Prepends one or more elements to a list only when the list exists.
static final Command	LRANGE	Returns a range of elements from a list.
static final Command	LREM	Removes elements from a list.
static final Command	LSET	Sets the value of an element in a list by its index.
static final Command	LTRIM	Removes elements from both ends a list.
static final Command	MEMORY	A container for memory diagnostics commands.
static final Command	MGET	Atomically returns the string values of one or more keys.
static final Command	MIGRATE	Atomically transfers a key from one Redis instance to another.
static final Command	MODULE	A container for module commands.
static final Command	MONITOR	Listens for all requests received by the server in real-time.
static final Command	MOVE	Moves a key to another database.
static final Command	MSET	Atomically creates or modifies the string values of one or more keys.
static final Command	MSETEX	Atomically sets multiple string keys with a shared expiration in a single operation.
static final Command	MSETNX	Atomically modifies the string values of one or more keys only when all keys don't exist.
static final Command	MULTI	Starts a transaction.
static final Command	OBJECT	A container for object introspection commands.
static final Command	PERSIST	Removes the expiration time of a key.
static final Command	PEXPIRE	Sets the expiration time of a key in milliseconds.
static final Command	PEXPIREAT	Sets the expiration time of a key to a Unix milliseconds timestamp.
static final Command	PEXPIRETIME	Returns the expiration time of a key as a Unix milliseconds timestamp.
static final Command	PFADD	Adds elements to a HyperLogLog key.
static final Command	PFCOUNT	Returns the approximated cardinality of the set(s) observed by the HyperLogLog key(s).
static final Command	PFDEBUG	Internal commands for debugging HyperLogLog values.
static final Command	PFMERGE	Merges one or more HyperLogLog values into a single key.
static final Command	PFSELFTEST	An internal command for testing HyperLogLog values.
static final Command	PING	Returns the server's liveliness response.
static final Command	PSETEX	Deprecated. since Redis 2.6.12, replaced by: SET with the PX argument
static final Command	PSUBSCRIBE	Listens for messages published to channels that match one or more patterns.
static final Command	PSYNC	An internal command used in replication.
static final Command	PTTL	Returns the expiration time in milliseconds of a key.
static final Command	PUBLISH	Posts a message to a channel.
static final Command	PUBSUB	A container for Pub/Sub commands.
static final Command	PUNSUBSCRIBE	Stops listening to messages published to channels that match one or more patterns.
static final Command	QUIT	Deprecated. since Redis 7.2.0, replaced by: just closing the connection
static final Command	RANDOMKEY	Returns a random key name from the database.
static final Command	READONLY	Enables read-only queries for a connection to a Redis Cluster replica node.
static final Command	READWRITE	Enables read-write queries for a connection to a Reids Cluster replica node.
static final Command	RENAME	Renames a key and overwrites the destination.
static final Command	RENAMENX	Renames a key only when the target key name doesn't exist.
static final Command	REPLCONF	An internal command for configuring the replication stream.
static final Command	REPLICAOF	Configures a server as replica of another, or promotes it to a master.
static final Command	RESET	Resets the connection.
static final Command	RESTORE	Creates a key from the serialized representation of a value.
static final Command	RESTORE_ASKING	An internal command for migrating keys in a cluster.
static final Command	ROLE	Returns the replication role.
static final Command	RPOP	Returns and removes the last elements of a list.
static final Command	RPOPLPUSH	Deprecated. since Redis 6.2.0, replaced by: LMOVE with the RIGHT and LEFT arguments
static final Command	RPUSH	Appends one or more elements to a list.
static final Command	RPUSHX	Appends an element to a list only when the list exists.
static final Command	SADD	Adds one or more members to a set.
static final Command	SAVE	Synchronously saves the database(s) to disk.
static final Command	SCAN	Iterates over the key names in the database.
static final Command	SCARD	Returns the number of members in a set.
static final Command	SCRIPT	A container for Lua scripts management commands.
static final Command	SDIFF	Returns the difference of multiple sets.
static final Command	SDIFFSTORE	Stores the difference of multiple sets in a key.
static final Command	SEARCH_CLUSTERINFO	This command only exists in Redis.
static final Command	SEARCH_CLUSTERREFRESH	This command only exists in Redis.
static final Command	SEARCH_CLUSTERSET	This command only exists in Redis.
static final Command	SELECT	Changes the selected database.
static final Command	SENTINEL
static final Command	SET	Sets the string value of a key, ignoring its type.
static final Command	SETBIT	Sets or clears the bit at offset of the string value.
static final Command	SETEX	Deprecated. since Redis 2.6.12, replaced by: SET with the EX argument
static final Command	SETNX	Deprecated. since Redis 2.6.12, replaced by: SET with the NX argument
static final Command	SETRANGE	Overwrites a part of a string value with another by an offset.
static final Command	SHUTDOWN	Synchronously saves the database(s) to disk and shuts down the Redis server.
static final Command	SINTER	Returns the intersect of multiple sets.
static final Command	SINTERCARD	Returns the number of members of the intersect of multiple sets.
static final Command	SINTERSTORE	Stores the intersect of multiple sets in a key.
static final Command	SISMEMBER	Determines whether a member belongs to a set.
static final Command	SLAVEOF	Deprecated. since Redis 5.0.0, replaced by: REPLICAOF
static final Command	SLOWLOG	A container for slow log commands.
static final Command	SMEMBERS	Returns all members of a set.
static final Command	SMISMEMBER	Determines whether multiple members belong to a set.
static final Command	SMOVE	Moves a member from one set to another.
static final Command	SORT	Sorts the elements in a list, a set, or a sorted set, optionally storing the result.
static final Command	SORT_RO	Returns the sorted elements of a list, a set, or a sorted set.
static final Command	SPOP	Returns one or more random members from a set after removing them.
static final Command	SPUBLISH	Post a message to a shard channel.
static final Command	SRANDMEMBER	Get one or multiple random members from a set.
static final Command	SREM	Removes one or more members from a set.
static final Command	SSCAN	Iterates over members of a set.
static final Command	SSUBSCRIBE	Listens for messages published to shard channels.
static final Command	STRLEN	Returns the length of a string value.
static final Command	SUBSCRIBE	Listens for messages published to channels.
static final Command	SUBSTR	Deprecated. since Redis 2.0.0, replaced by: GETRANGE
static final Command	SUNION	Returns the union of multiple sets.
static final Command	SUNIONSTORE	Stores the union of multiple sets in a key.
static final Command	SUNSUBSCRIBE	Stops listening to messages posted to shard channels.
static final Command	SWAPDB	Swaps two Redis databases.
static final Command	SYNC	An internal command used in replication.
static final Command	TDIGEST_ADD	Adds one or more observations to a t-digest sketch.
static final Command	TDIGEST_BYRANK	Returns, for each input rank, an estimation of the value (floating-point) with that rank.
static final Command	TDIGEST_BYREVRANK	Returns, for each input reverse rank, an estimation of the value (floating-point) with that reverse rank.
static final Command	TDIGEST_CDF	Returns, for each input value, an estimation of the floating-point fraction of (observations smaller than the given value + half the observations equal to the given value).
static final Command	TDIGEST_CREATE	Allocates memory and initializes a new t-digest sketch.
static final Command	TDIGEST_INFO	Returns information and statistics about a t-digest sketch.
static final Command	TDIGEST_MAX	Returns the maximum observation value from a t-digest sketch.
static final Command	TDIGEST_MERGE	Merges multiple t-digest sketches into a single sketch.
static final Command	TDIGEST_MIN	Returns the minimum observation value from a t-digest sketch.
static final Command	TDIGEST_QUANTILE	Returns, for each input fraction, an estimation of the value (floating point) that is smaller than the given fraction of observations.
static final Command	TDIGEST_RANK	Returns, for each input value (floating-point), the estimated rank of the value (the number of observations in the sketch that are smaller than the value + half the number of observations that are equal to the value).
static final Command	TDIGEST_RESET	Resets a t-digest sketch: empty the sketch and re-initializes it.
static final Command	TDIGEST_REVRANK	Returns, for each input value (floating-point), the estimated reverse rank of the value (the number of observations in the sketch that are larger than the value + half the number of observations that are equal to the value).
static final Command	TDIGEST_TRIMMED_MEAN	Returns an estimation of the mean value from the sketch, excluding observation values outside the low and high cutoff quantiles.
static final Command	TIME	Returns the server time.
static final Command	TIMESERIES_CLUSTERSET	This command only exists in Redis.
static final Command	TIMESERIES_CLUSTERSETFROMSHARD	Deprecated. this command no longer exists in the latest Redis release
static final Command	TIMESERIES_HELLO	Deprecated. this command no longer exists in the latest Redis release
static final Command	TIMESERIES_INFOCLUSTER	Deprecated. this command no longer exists in the latest Redis release
static final Command	TIMESERIES_INNERCOMMUNICATION	Deprecated. this command no longer exists in the latest Redis release
static final Command	TIMESERIES_NETWORKTEST	Deprecated. this command no longer exists in the latest Redis release
static final Command	TIMESERIES_REFRESHCLUSTER	This command only exists in Redis.
static final Command	TOPK_ADD	Adds an item to a Top-k sketch.
static final Command	TOPK_COUNT	Return the count for one or more items are in a sketch.
static final Command	TOPK_INCRBY	Increases the count of one or more items by increment.
static final Command	TOPK_INFO	Returns information about a sketch.
static final Command	TOPK_LIST	Return the full list of items in Top-K sketch.
static final Command	TOPK_QUERY	Checks whether one or more items are in a sketch.
static final Command	TOPK_RESERVE	Initializes a Top-K sketch with specified parameters.
static final Command	TOUCH	Returns the number of existing keys out of those specified after updating the time they were last accessed.
static final Command	TRIMSLOTS	Trim the keys that belong to specified slots.
static final Command	TS_ADD	Append a sample to a time series.
static final Command	TS_ALTER	Update the retention, chunk size, duplicate policy, and labels of an existing time series.
static final Command	TS_CREATE	Create a new time series.
static final Command	TS_CREATERULE	Create a compaction rule.
static final Command	TS_DECRBY	Decrease the value of the latest sample.
static final Command	TS_DEL	Delete all samples between two timestamps for a given time series.
static final Command	TS_DELETERULE	Delete a compaction rule.
static final Command	TS_GET	Get the sample with the highest timestamp from a given time series.
static final Command	TS_INCRBY	Increase the value of the latest sample.
static final Command	TS_INFO	Returns information and statistics for a time series.
static final Command	TS_MADD	Append new samples to one or more time series.
static final Command	TS_MGET	Get the sample with the highest timestamp from each time series matching a specific filter.
static final Command	TS_MRANGE	Query a range across multiple time series by filters in forward direction.
static final Command	TS_MREVRANGE	Query a range across multiple time series by filters in reverse direction.
static final Command	TS_QUERYINDEX	Get all time series keys matching a filter list.
static final Command	TS_RANGE	Query a range in forward direction.
static final Command	TS_REVRANGE	Query a range in reverse direction.
static final Command	TTL	Returns the expiration time in seconds of a key.
static final Command	TYPE	Determines the type of value stored at a key.
static final Command	UNLINK	Asynchronously deletes one or more keys.
static final Command	UNSUBSCRIBE	Stops listening to messages posted to channels.
static final Command	UNWATCH	Forgets about watched keys of a transaction.
static final Command	VADD	Add one or more elements to a vector set, or update its vector if it already exists.
static final Command	VCARD	Return the number of elements in a vector set.
static final Command	VDIM	Return the dimension of vectors in the vector set.
static final Command	VEMB	Return the vector associated with an element.
static final Command	VGETATTR	Retrieve the JSON attributes of elements.
static final Command	VINFO	Return information about a vector set.
static final Command	VISMEMBER	Check if an element exists in a vector set.
static final Command	VLINKS	Return the neighbors of an element at each layer in the HNSW graph.
static final Command	VRANDMEMBER	Return one or multiple random members from a vector set.
static final Command	VRANGE	Return vector set elements in a lex range.
static final Command	VREM	Remove an element from a vector set.
static final Command	VSETATTR	Associate or remove the JSON attributes of elements.
static final Command	VSIM	Return elements by vector similarity.
static final Command	WAIT	Blocks until the asynchronous replication of all preceding write commands sent by the connection is completed.
static final Command	WAITAOF	Blocks until all of the preceding write commands sent by the connection are written to the append-only file of the master and/or replicas.
static final Command	WATCH	Monitors changes to keys to determine the execution of a transaction.
static final Command	XACK	Returns the number of messages that were successfully acknowledged by the consumer group member of a stream.
static final Command	XACKDEL	Acknowledges and deletes one or multiple messages for a stream consumer group.
static final Command	XADD	Appends a new message to a stream.
static final Command	XAUTOCLAIM	Changes, or acquires, ownership of messages in a consumer group, as if the messages were delivered to as consumer group member.
static final Command	XCFGSET	Sets the IDMP configuration parameters for a stream.
static final Command	XCLAIM	Changes, or acquires, ownership of a message in a consumer group, as if the message was delivered a consumer group member.
static final Command	XDEL	Returns the number of messages after removing them from a stream.
static final Command	XDELEX	Deletes one or multiple entries from the stream.
static final Command	XGROUP	A container for consumer groups commands.
static final Command	XIDMPRECORD	An internal command for setting IDMP metadata on an existing stream message.
static final Command	XINFO	A container for stream introspection commands.
static final Command	XLEN	Return the number of messages in a stream.
static final Command	XPENDING	Returns the information and entries from a stream consumer group's pending entries list.
static final Command	XRANGE	Returns the messages from a stream within a range of IDs.
static final Command	XREAD	Returns messages from multiple streams with IDs greater than the ones requested.
static final Command	XREADGROUP	Returns new or historical messages from a stream for a consumer in a group.
static final Command	XREVRANGE	Returns the messages from a stream within a range of IDs in reverse order.
static final Command	XSETID	An internal command for replicating stream values.
static final Command	XTRIM	Deletes messages from the beginning of a stream.
static final Command	ZADD	Adds one or more members to a sorted set, or updates their scores.
static final Command	ZCARD	Returns the number of members in a sorted set.
static final Command	ZCOUNT	Returns the count of members in a sorted set that have scores within a range.
static final Command	ZDIFF	Returns the difference between multiple sorted sets.
static final Command	ZDIFFSTORE	Stores the difference of multiple sorted sets in a key.
static final Command	ZINCRBY	Increments the score of a member in a sorted set.
static final Command	ZINTER	Returns the intersect of multiple sorted sets.
static final Command	ZINTERCARD	Returns the number of members of the intersect of multiple sorted sets.
static final Command	ZINTERSTORE	Stores the intersect of multiple sorted sets in a key.
static final Command	ZLEXCOUNT	Returns the number of members in a sorted set within a lexicographical range.
static final Command	ZMPOP	Returns the highest- or lowest-scoring members from one or more sorted sets after removing them.
static final Command	ZMSCORE	Returns the score of one or more members in a sorted set.
static final Command	ZPOPMAX	Returns the highest-scoring members from a sorted set after removing them.
static final Command	ZPOPMIN	Returns the lowest-scoring members from a sorted set after removing them.
static final Command	ZRANDMEMBER	Returns one or more random members from a sorted set.
static final Command	ZRANGE	Returns members in a sorted set within a range of indexes.
static final Command	ZRANGEBYLEX	Deprecated. since Redis 6.2.0, replaced by: ZRANGE with the BYLEX argument
static final Command	ZRANGEBYSCORE	Deprecated. since Redis 6.2.0, replaced by: ZRANGE with the BYSCORE argument
static final Command	ZRANGESTORE	Stores a range of members from sorted set in a key.
static final Command	ZRANK	Returns the index of a member in a sorted set ordered by ascending scores.
static final Command	ZREM	Removes one or more members from a sorted set.
static final Command	ZREMRANGEBYLEX	Removes members in a sorted set within a lexicographical range.
static final Command	ZREMRANGEBYRANK	Removes members in a sorted set within a range of indexes.
static final Command	ZREMRANGEBYSCORE	Removes members in a sorted set within a range of scores.
static final Command	ZREVRANGE	Deprecated. since Redis 6.2.0, replaced by: ZRANGE with the REV argument
static final Command	ZREVRANGEBYLEX	Deprecated. since Redis 6.2.0, replaced by: ZRANGE with the REV and BYLEX arguments
static final Command	ZREVRANGEBYSCORE	Deprecated. since Redis 6.2.0, replaced by: ZRANGE with the REV and BYSCORE arguments
static final Command	ZREVRANK	Returns the index of a member in a sorted set ordered by descending scores.
static final Command	ZSCAN	Iterates over members and scores of a sorted set.
static final Command	ZSCORE	Returns the score of a member in a sorted set.
static final Command	ZUNION	Returns the union of multiple sorted sets.
static final Command	ZUNIONSTORE	Stores the union of multiple sorted sets in a key.

Method Summary

Static Methods

Modifier and Type	Method	Description
static Command	create(String command)	Generic command generator for extensions.

Field Details

ACL

static final Command ACL

A container for Access List Control commands.

Since:

Redis 6.0.0

APPEND

static final Command APPEND

Appends a string to the value of a key. Creates the key if it doesn't exist.

Since:

Redis 2.0.0

ASKING

static final Command ASKING

Signals that a cluster client is following an -ASK redirect.

Since:

Redis 3.0.0

AUTH

static final Command AUTH

Authenticates the connection.

Since:

Redis 1.0.0

BF_ADD

static final Command BF_ADD

Adds an item to a Bloom Filter.

This command only exists in Redis.

Since:

Redis Bloom 1.0.0

BF_CARD

static final Command BF_CARD

Returns the cardinality of a Bloom filter.

This command only exists in Redis.

Since:

Redis Bloom 2.4.4

BF_DEBUG

static final Command BF_DEBUG

This command only exists in Redis.

BF_EXISTS

static final Command BF_EXISTS

Checks whether an item exists in a Bloom Filter.

This command only exists in Redis.

Since:

Redis Bloom 1.0.0

BF_INFO

static final Command BF_INFO

Returns information about a Bloom Filter.

This command only exists in Redis.

Since:

Redis Bloom 1.0.0

BF_INSERT

static final Command BF_INSERT

Adds one or more items to a Bloom Filter. A filter will be created if it does not exist.

This command only exists in Redis.

Since:

Redis Bloom 1.0.0

BF_LOADCHUNK

static final Command BF_LOADCHUNK

Restores a filter previously saved using SCANDUMP.

This command only exists in Redis.

Since:

Redis Bloom 1.0.0

BF_MADD

static final Command BF_MADD

Adds one or more items to a Bloom Filter. A filter will be created if it does not exist.

This command only exists in Redis.

Since:

Redis Bloom 1.0.0

BF_MEXISTS

static final Command BF_MEXISTS

Checks whether one or more items exist in a Bloom Filter.

This command only exists in Redis.

Since:

Redis Bloom 1.0.0

BF_RESERVE

static final Command BF_RESERVE

Creates a new Bloom Filter.

This command only exists in Redis.

Since:

Redis Bloom 1.0.0

BF_SCANDUMP

static final Command BF_SCANDUMP

Begins an incremental save of the bloom filter.

This command only exists in Redis.

Since:

Redis Bloom 1.0.0

BGREWRITEAOF

static final Command BGREWRITEAOF

Asynchronously rewrites the append-only file to disk.

Since:

Redis 1.0.0

BGSAVE

static final Command BGSAVE

Asynchronously saves the database(s) to disk.

Since:

Redis 1.0.0

BITCOUNT

static final Command BITCOUNT

Counts the number of set bits (population counting) in a string.

Since:

Redis 2.6.0

BITFIELD

static final Command BITFIELD

Performs arbitrary bitfield integer operations on strings.

Since:

Redis 3.2.0

BITFIELD_RO

static final Command BITFIELD_RO

Performs arbitrary read-only bitfield integer operations on strings.

Since:

Redis 6.0.0

BITOP

static final Command BITOP

Performs bitwise operations on multiple strings, and stores the result.

Since:

Redis 2.6.0

BITPOS

static final Command BITPOS

Finds the first set (1) or clear (0) bit in a string.

Since:

Redis 2.8.7

BLMOVE

static final Command BLMOVE

Pops an element from a list, pushes it to another list and returns it. Blocks until an element is available otherwise. Deletes the list if the last element was moved.

Since:

Redis 6.2.0

BLMPOP

static final Command BLMPOP

Pops the first element from one of multiple lists. Blocks until an element is available otherwise. Deletes the list if the last element was popped.

Since:

Redis 7.0.0

BLPOP

static final Command BLPOP

Removes and returns the first element in a list. Blocks until an element is available otherwise. Deletes the list if the last element was popped.

Since:

Redis 2.0.0

BRPOP

static final Command BRPOP

Removes and returns the last element in a list. Blocks until an element is available otherwise. Deletes the list if the last element was popped.

Since:

Redis 2.0.0

BRPOPLPUSH

static final Command BRPOPLPUSH

Deprecated.

since Redis 6.2.0, replaced by: BLMOVE with the RIGHT and LEFT arguments

Pops an element from a list, pushes it to another list and returns it. Block until an element is available otherwise. Deletes the list if the last element was popped.

Since:

Redis 2.2.0

BZMPOP

static final Command BZMPOP

Removes and returns a member by score from one or more sorted sets. Blocks until a member is available otherwise. Deletes the sorted set if the last element was popped.

Since:

Redis 7.0.0

BZPOPMAX

static final Command BZPOPMAX

Removes and returns the member with the highest score from one or more sorted sets. Blocks until a member available otherwise. Deletes the sorted set if the last element was popped.

Since:

Redis 5.0.0

BZPOPMIN

static final Command BZPOPMIN

Removes and returns the member with the lowest score from one or more sorted sets. Blocks until a member is available otherwise. Deletes the sorted set if the last element was popped.

Since:

Redis 5.0.0

CF_ADD

static final Command CF_ADD

Adds an item to a Cuckoo Filter.

This command only exists in Redis.

Since:

Redis Bloom 1.0.0

CF_ADDNX

static final Command CF_ADDNX

Adds an item to a Cuckoo Filter if the item did not exist previously.

This command only exists in Redis.

Since:

Redis Bloom 1.0.0

CF_COMPACT

static final Command CF_COMPACT

This command only exists in Redis.

CF_COUNT

static final Command CF_COUNT

Return the number of times an item might be in a Cuckoo Filter.

This command only exists in Redis.

Since:

Redis Bloom 1.0.0

CF_DEBUG

static final Command CF_DEBUG

This command only exists in Redis.

CF_DEL

static final Command CF_DEL

Deletes an item from a Cuckoo Filter.

This command only exists in Redis.

Since:

Redis Bloom 1.0.0

CF_EXISTS

static final Command CF_EXISTS

Checks whether one or more items exist in a Cuckoo Filter.

This command only exists in Redis.

Since:

Redis Bloom 1.0.0

CF_INFO

static final Command CF_INFO

Returns information about a Cuckoo Filter.

This command only exists in Redis.

Since:

Redis Bloom 1.0.0

CF_INSERT

static final Command CF_INSERT

Adds one or more items to a Cuckoo Filter. A filter will be created if it does not exist.

This command only exists in Redis.

Since:

Redis Bloom 1.0.0

CF_INSERTNX

static final Command CF_INSERTNX

Adds one or more items to a Cuckoo Filter if the items did not exist previously. A filter will be created if it does not exist.

This command only exists in Redis.

Since:

Redis Bloom 1.0.0

CF_LOADCHUNK

static final Command CF_LOADCHUNK

Restores a filter previously saved using SCANDUMP.

This command only exists in Redis.

Since:

Redis Bloom 1.0.0

CF_MEXISTS

static final Command CF_MEXISTS

Checks whether one or more items exist in a Cuckoo Filter.

This command only exists in Redis.

Since:

Redis Bloom 1.0.0

CF_RESERVE

static final Command CF_RESERVE

Creates a new Cuckoo Filter.

This command only exists in Redis.

Since:

Redis Bloom 1.0.0

CF_SCANDUMP

static final Command CF_SCANDUMP

Begins an incremental save of the bloom filter.

This command only exists in Redis.

Since:

Redis Bloom 1.0.0

CLIENT

static final Command CLIENT

A container for client connection commands.

Since:

Redis 2.4.0

CLUSTER

static final Command CLUSTER

A container for Redis Cluster commands.

Since:

Redis 3.0.0

CMS_INCRBY

static final Command CMS_INCRBY

Increases the count of one or more items by increment.

This command only exists in Redis.

Since:

Redis Bloom 2.0.0

CMS_INFO

static final Command CMS_INFO

Returns information about a sketch.

This command only exists in Redis.

Since:

Redis Bloom 2.0.0

CMS_INITBYDIM

static final Command CMS_INITBYDIM

Initializes a Count-Min Sketch to dimensions specified by user.

This command only exists in Redis.

Since:

Redis Bloom 2.0.0

CMS_INITBYPROB

static final Command CMS_INITBYPROB

Initializes a Count-Min Sketch to accommodate requested tolerances.

This command only exists in Redis.

Since:

Redis Bloom 2.0.0

CMS_MERGE

static final Command CMS_MERGE

Merges several sketches into one sketch.

This command only exists in Redis.

Since:

Redis Bloom 2.0.0

CMS_QUERY

static final Command CMS_QUERY

Returns the count for one or more items in a sketch.

This command only exists in Redis.

Since:

Redis Bloom 2.0.0

COMMAND

static final Command COMMAND

Returns detailed information about all commands.

Since:

Redis 2.8.13

COMMANDLOG

static final Command COMMANDLOG

A container for command log commands.

This command only exists in Valkey.

Since:

Valkey 8.1.0

CONFIG

static final Command CONFIG

A container for server configuration commands.

Since:

Redis 2.0.0

COPY

static final Command COPY

Copies the value of a key to a new key.

Since:

Redis 6.2.0

DBSIZE

static final Command DBSIZE

Returns the number of keys in the database.

Since:

Redis 1.0.0

DEBUG

static final Command DEBUG

A container for debugging commands.

Since:

Redis 1.0.0

DECR

static final Command DECR

Decrements the integer value of a key by one. Uses 0 as initial value if the key doesn't exist.

Since:

Redis 1.0.0

DECRBY

static final Command DECRBY

Decrements a number from the integer value of a key. Uses 0 as initial value if the key doesn't exist.

Since:

Redis 1.0.0

DEL

static final Command DEL

Deletes one or more keys.

Since:

Redis 1.0.0

DELEX

static final Command DELEX

Conditionally removes the specified key based on value or digest comparison.

This command only exists in Redis.

Since:

Redis 8.4.0

DELIFEQ

static final Command DELIFEQ

Delete key if value matches string.

This command only exists in Valkey.

Since:

Valkey 9.0.0

DIGEST

static final Command DIGEST

Returns the XXH3 hash of a string value.

This command only exists in Redis.

Since:

Redis 8.4.0

DISCARD

static final Command DISCARD

Discards a transaction.

Since:

Redis 2.0.0

DUMP

static final Command DUMP

Returns a serialized representation of the value stored at a key.

Since:

Redis 2.6.0

ECHO

static final Command ECHO

Returns the given string.

Since:

Redis 1.0.0

EVAL

static final Command EVAL

Executes a server-side Lua script.

Since:

Redis 2.6.0

EVALSHA

static final Command EVALSHA

Executes a server-side Lua script by SHA1 digest.

Since:

Redis 2.6.0

EVALSHA_RO

static final Command EVALSHA_RO

Executes a read-only server-side Lua script by SHA1 digest.

Since:

Redis 7.0.0

EVAL_RO

static final Command EVAL_RO

Executes a read-only server-side Lua script.

Since:

Redis 7.0.0

EXEC

static final Command EXEC

Executes all commands in a transaction.

Since:

Redis 1.2.0

EXISTS

static final Command EXISTS

Determines whether one or more keys exist.

Since:

Redis 1.0.0

EXPIRE

static final Command EXPIRE

Sets the expiration time of a key in seconds.

Since:

Redis 1.0.0

EXPIREAT

static final Command EXPIREAT

Sets the expiration time of a key to a Unix timestamp.

Since:

Redis 1.2.0

EXPIRETIME

static final Command EXPIRETIME

Returns the expiration time of a key as a Unix timestamp.

Since:

Redis 7.0.0

FAILOVER

static final Command FAILOVER

Starts a coordinated failover from a server to one of its replicas.

Since:

Redis 6.2.0

FCALL

static final Command FCALL

Invokes a function.

Since:

Redis 7.0.0

FCALL_RO

static final Command FCALL_RO

Invokes a read-only function.

Since:

Redis 7.0.0

FLUSHALL

static final Command FLUSHALL

Removes all keys from all databases.

Since:

Redis 1.0.0

FLUSHDB

static final Command FLUSHDB

Remove all keys from the current database.

Since:

Redis 1.0.0

FT_ADD

static final Command FT_ADD

This command only exists in Redis.

FT_AGGREGATE

static final Command FT_AGGREGATE

Run a search query on an index and perform aggregate transformations on the results.

This command only exists in Redis.

Since:

Redis Search 1.1.0

FT_ALIASADD

static final Command FT_ALIASADD

Adds an alias to the index.

This command only exists in Redis.

Since:

Redis Search 1.0.0

FT_ALIASDEL

static final Command FT_ALIASDEL

Deletes an alias from the index.

This command only exists in Redis.

Since:

Redis Search 1.0.0

FT_ALIASUPDATE

static final Command FT_ALIASUPDATE

Adds or updates an alias to the index.

This command only exists in Redis.

Since:

Redis Search 1.0.0

FT_ALTER

static final Command FT_ALTER

Adds a new field to the index.

This command only exists in Redis.

Since:

Redis Search 1.0.0

FT_CONFIG

static final Command FT_CONFIG

This command only exists in Redis.

FT_CREATE

static final Command FT_CREATE

Creates an index with the given spec.

This command only exists in Redis.

Since:

Redis Search 1.0.0

FT_CURSOR

static final Command FT_CURSOR

This command only exists in Redis.

FT_DEBUG

static final Command FT_DEBUG

Deprecated.

this command no longer exists in the latest Redis release

This command only exists in Redis.

FT_DEL

static final Command FT_DEL

This command only exists in Redis.

FT_DICTADD

static final Command FT_DICTADD

Adds terms to a dictionary.

This command only exists in Redis.

Since:

Redis Search 1.4.0

FT_DICTDEL

static final Command FT_DICTDEL

Deletes terms from a dictionary.

This command only exists in Redis.

Since:

Redis Search 1.4.0

FT_DICTDUMP

static final Command FT_DICTDUMP

Dumps all terms in the given dictionary.

This command only exists in Redis.

Since:

Redis Search 1.4.0

FT_DROP

static final Command FT_DROP

This command only exists in Redis.

FT_DROPINDEX

static final Command FT_DROPINDEX

Deletes the index.

This command only exists in Redis.

Since:

Redis Search 2.0.0

FT_EXPLAIN

static final Command FT_EXPLAIN

Returns the execution plan for a complex query.

This command only exists in Redis.

Since:

Redis Search 1.0.0

FT_EXPLAINCLI

static final Command FT_EXPLAINCLI

Returns the execution plan for a complex query.

This command only exists in Redis.

Since:

Redis Search 1.0.0

FT_GET

static final Command FT_GET

This command only exists in Redis.

FT_HYBRID

static final Command FT_HYBRID

Performs hybrid search combining text search and vector similarity search.

This command only exists in Redis.

Since:

Redis Search 8.4.4

FT_INFO

static final Command FT_INFO

Returns information and statistics on the index.

This command only exists in Redis.

Since:

Redis Search 1.0.0

FT_MGET

static final Command FT_MGET

This command only exists in Redis.

FT_PROFILE

static final Command FT_PROFILE

Performs a `FT.SEARCH` or `FT.AGGREGATE` command and collects performance information.

This command only exists in Redis.

Since:

Redis Search 2.2.0

FT_SAFEADD

static final Command FT_SAFEADD

This command only exists in Redis.

FT_SEARCH

static final Command FT_SEARCH

Searches the index with a textual query, returning either documents or just ids.

This command only exists in Redis.

Since:

Redis Search 1.0.0

FT_SPELLCHECK

static final Command FT_SPELLCHECK

Performs spelling correction on a query, returning suggestions for misspelled terms.

This command only exists in Redis.

Since:

Redis Search 1.4.0

FT_SUGADD

static final Command FT_SUGADD

Adds a suggestion string to an auto-complete suggestion dictionary.

This command only exists in Redis.

Since:

Redis Search 1.0.0

FT_SUGDEL

static final Command FT_SUGDEL

Deletes a string from a suggestion index.

This command only exists in Redis.

Since:

Redis Search 1.0.0

FT_SUGGET

static final Command FT_SUGGET

Gets completion suggestions for a prefix.

This command only exists in Redis.

Since:

Redis Search 1.0.0

FT_SUGLEN

static final Command FT_SUGLEN

Gets the size of an auto-complete suggestion dictionary.

This command only exists in Redis.

Since:

Redis Search 1.0.0

FT_SYNADD

static final Command FT_SYNADD

This command only exists in Redis.

FT_SYNDUMP

static final Command FT_SYNDUMP

Dumps the contents of a synonym group.

This command only exists in Redis.

Since:

Redis Search 1.2.0

FT_SYNUPDATE

static final Command FT_SYNUPDATE

Creates or updates a synonym group with additional terms.

This command only exists in Redis.

Since:

Redis Search 1.2.0

FT_TAGVALS

static final Command FT_TAGVALS

Returns the distinct tags indexed in a Tag field.

This command only exists in Redis.

Since:

Redis Search 1.0.0

FT__ALIASADDIFNX

static final Command FT__ALIASADDIFNX

Adds an alias to the index.

This command only exists in Redis.

Since:

Redis Search 1.0.0

FT__ALIASDELIFX

static final Command FT__ALIASDELIFX

Deletes an alias from the index.

This command only exists in Redis.

Since:

Redis Search 1.0.0

FT__ALTERIFNX

static final Command FT__ALTERIFNX

Adds a new field to the index.

This command only exists in Redis.

Since:

Redis Search 1.0.0

FT__CREATEIFNX

static final Command FT__CREATEIFNX

Creates an index with the given spec.

This command only exists in Redis.

Since:

Redis Search 1.0.0

FT__DROPIFX

static final Command FT__DROPIFX

This command only exists in Redis.

FT__DROPINDEXIFX

static final Command FT__DROPINDEXIFX

Deletes the index.

This command only exists in Redis.

Since:

Redis Search 2.0.0

FT__LIST

static final Command FT__LIST

Returns a list of all existing indexes.

This command only exists in Redis.

Since:

Redis Search 2.0.0

FUNCTION

static final Command FUNCTION

A container for function commands.

Since:

Redis 7.0.0

GEOADD

static final Command GEOADD

Adds one or more members to a geospatial index. The key is created if it doesn't exist.

Since:

Redis 3.2.0

GEODIST

static final Command GEODIST

Returns the distance between two members of a geospatial index.

Since:

Redis 3.2.0

GEOHASH

static final Command GEOHASH

Returns members from a geospatial index as geohash strings.

Since:

Redis 3.2.0

GEOPOS

static final Command GEOPOS

Returns the longitude and latitude of members from a geospatial index.

Since:

Redis 3.2.0

GEORADIUS

static final Command GEORADIUS

Deprecated.

since Redis 6.2.0, replaced by: GEOSEARCH and GEOSEARCHSTORE with the BYRADIUS argument

Queries a geospatial index for members within a distance from a coordinate, optionally stores the result.

Since:

Redis 3.2.0

GEORADIUSBYMEMBER

static final Command GEORADIUSBYMEMBER

Deprecated.

since Redis 6.2.0, replaced by: GEOSEARCH and GEOSEARCHSTORE with the BYRADIUS and FROMMEMBER arguments

Queries a geospatial index for members within a distance from a member, optionally stores the result.

Since:

Redis 3.2.0

GEORADIUSBYMEMBER_RO

static final Command GEORADIUSBYMEMBER_RO

Deprecated.

since Redis 6.2.0, replaced by: GEOSEARCH with the BYRADIUS and FROMMEMBER arguments

Returns members from a geospatial index that are within a distance from a member.

Since:

Redis 3.2.10

GEORADIUS_RO

static final Command GEORADIUS_RO

Deprecated.

since Redis 6.2.0, replaced by: GEOSEARCH with the BYRADIUS argument

Returns members from a geospatial index that are within a distance from a coordinate.

Since:

Redis 3.2.10

GEOSEARCH

static final Command GEOSEARCH

Queries a geospatial index for members inside an area of a box or a circle.

Since:

Redis 6.2.0

GEOSEARCHSTORE

static final Command GEOSEARCHSTORE

Queries a geospatial index for members inside an area of a box or a circle, optionally stores the result.

Since:

Redis 6.2.0

GET

static final Command GET

Returns the string value of a key.

Since:

Redis 1.0.0

GETBIT

static final Command GETBIT

Returns a bit value by offset.

Since:

Redis 2.2.0

GETDEL

static final Command GETDEL

Returns the string value of a key after deleting the key.

Since:

Redis 6.2.0

GETEX

static final Command GETEX

Returns the string value of a key after setting its expiration time.

Since:

Redis 6.2.0

GETRANGE

static final Command GETRANGE

Returns a substring of the string stored at a key.

Since:

Redis 2.4.0

GETSET

static final Command GETSET

Deprecated.

since Redis 6.2.0, replaced by: SET with the !GET argument

Returns the previous string value of a key after setting it to a new value.

Since:

Redis 1.0.0

GRAPH_BULK

static final Command GRAPH_BULK

Deprecated.

this command no longer exists in the latest Redis release

This command only exists in Redis.

GRAPH_CONFIG

static final Command GRAPH_CONFIG

Deprecated.

this command no longer exists in the latest Redis release

This command only exists in Redis.

GRAPH_DEBUG

static final Command GRAPH_DEBUG

Deprecated.

this command no longer exists in the latest Redis release

This command only exists in Redis.

GRAPH_DELETE

static final Command GRAPH_DELETE

Deprecated.

this command no longer exists in the latest Redis release

This command only exists in Redis.

GRAPH_EXPLAIN

static final Command GRAPH_EXPLAIN

Deprecated.

this command no longer exists in the latest Redis release

This command only exists in Redis.

GRAPH_LIST

static final Command GRAPH_LIST

Deprecated.

this command no longer exists in the latest Redis release

This command only exists in Redis.

GRAPH_PROFILE

static final Command GRAPH_PROFILE

Deprecated.

this command no longer exists in the latest Redis release

This command only exists in Redis.

GRAPH_QUERY

static final Command GRAPH_QUERY

Deprecated.

this command no longer exists in the latest Redis release

This command only exists in Redis.

GRAPH_RO_QUERY

static final Command GRAPH_RO_QUERY

Deprecated.

this command no longer exists in the latest Redis release

This command only exists in Redis.

GRAPH_SLOWLOG

static final Command GRAPH_SLOWLOG

Deprecated.

this command no longer exists in the latest Redis release

This command only exists in Redis.

HDEL

static final Command HDEL

Deletes one or more fields and their values from a hash. Deletes the hash if no fields remain.

Since:

Redis 2.0.0

HELLO

static final Command HELLO

Handshakes with the Redis server.

Since:

Redis 6.0.0

HEXISTS

static final Command HEXISTS

Determines whether a field exists in a hash.

Since:

Redis 2.0.0

HEXPIRE

static final Command HEXPIRE

Set expiry for hash field using relative time to expire (seconds).

Since:

Redis 7.4.0

HEXPIREAT

static final Command HEXPIREAT

Set expiry for hash field using an absolute Unix timestamp (seconds).

Since:

Redis 7.4.0

HEXPIRETIME

static final Command HEXPIRETIME

Returns the expiration time of a hash field as a Unix timestamp, in seconds.

Since:

Redis 7.4.0

HGET

static final Command HGET

Returns the value of a field in a hash.

Since:

Redis 2.0.0

HGETALL

static final Command HGETALL

Returns all fields and values in a hash.

Since:

Redis 2.0.0

HGETDEL

static final Command HGETDEL

Returns the value of a field and deletes it from the hash.

This command only exists in Redis.

Since:

Redis 8.0.0

HGETEX

static final Command HGETEX

Get the value of one or more fields of a given hash key, and optionally set their expiration.

Since:

Redis 8.0.0

HINCRBY

static final Command HINCRBY

Increments the integer value of a field in a hash by a number. Uses 0 as initial value if the field doesn't exist.

Since:

Redis 2.0.0

HINCRBYFLOAT

static final Command HINCRBYFLOAT

Increments the floating point value of a field by a number. Uses 0 as initial value if the field doesn't exist.

Since:

Redis 2.6.0

HKEYS

static final Command HKEYS

Returns all fields in a hash.

Since:

Redis 2.0.0

HLEN

static final Command HLEN

Returns the number of fields in a hash.

Since:

Redis 2.0.0

HMGET

static final Command HMGET

Returns the values of all fields in a hash.

Since:

Redis 2.0.0

HMSET

static final Command HMSET

Deprecated.

since Redis 4.0.0, replaced by: HSET with multiple field-value pairs

Sets the values of multiple fields.

Since:

Redis 2.0.0

HOTKEYS

static final Command HOTKEYS

A container for hotkeys tracking commands.

This command only exists in Redis.

Since:

Redis 8.6.0

HPERSIST

static final Command HPERSIST

Removes the expiration time for each specified field.

Since:

Redis 7.4.0

HPEXPIRE

static final Command HPEXPIRE

Set expiry for hash field using relative time to expire (milliseconds).

Since:

Redis 7.4.0

HPEXPIREAT

static final Command HPEXPIREAT

Set expiry for hash field using an absolute Unix timestamp (milliseconds).

Since:

Redis 7.4.0

HPEXPIRETIME

static final Command HPEXPIRETIME

Returns the expiration time of a hash field as a Unix timestamp, in msec.

Since:

Redis 7.4.0

HPTTL

static final Command HPTTL

Returns the TTL in milliseconds of a hash field.

Since:

Redis 7.4.0

HRANDFIELD

static final Command HRANDFIELD

Returns one or more random fields from a hash.

Since:

Redis 6.2.0

HSCAN

static final Command HSCAN

Iterates over fields and values of a hash.

Since:

Redis 2.8.0

HSET

static final Command HSET

Creates or modifies the value of a field in a hash.

Since:

Redis 2.0.0

HSETEX

static final Command HSETEX

Set the value of one or more fields of a given hash key, and optionally set their expiration.

Since:

Redis 8.0.0

HSETNX

static final Command HSETNX

Sets the value of a field in a hash only when the field doesn't exist.

Since:

Redis 2.0.0

HSTRLEN

static final Command HSTRLEN

Returns the length of the value of a field.

Since:

Redis 3.2.0

HTTL

static final Command HTTL

Returns the TTL in seconds of a hash field.

Since:

Redis 7.4.0

HVALS

static final Command HVALS

Returns all values in a hash.

Since:

Redis 2.0.0

INCR

static final Command INCR

Increments the integer value of a key by one. Uses 0 as initial value if the key doesn't exist.

Since:

Redis 1.0.0

INCRBY

static final Command INCRBY

Increments the integer value of a key by a number. Uses 0 as initial value if the key doesn't exist.

Since:

Redis 1.0.0

INCRBYFLOAT

static final Command INCRBYFLOAT

Increment the floating point value of a key by a number. Uses 0 as initial value if the key doesn't exist.

Since:

Redis 2.6.0

INFO

static final Command INFO

Returns information and statistics about the server.

Since:

Redis 1.0.0

JSON_ARRAPPEND

static final Command JSON_ARRAPPEND

Append the JSON values into the array at path after the last element in it.

This command only exists in Redis.

Since:

Redis ReJSON 1.0.0

JSON_ARRINDEX

static final Command JSON_ARRINDEX

Search for the first occurrence of a JSON value in an array.

This command only exists in Redis.

Since:

Redis ReJSON 1.0.0

JSON_ARRINSERT

static final Command JSON_ARRINSERT

Insert the json values into the array at path before the index (shifts to the right).

This command only exists in Redis.

Since:

Redis ReJSON 1.0.0

JSON_ARRLEN

static final Command JSON_ARRLEN

Report the length of the JSON array at path in key.

This command only exists in Redis.

Since:

Redis ReJSON 1.0.0

JSON_ARRPOP

static final Command JSON_ARRPOP

Remove and return the element at the specified index in the array at path.

This command only exists in Redis.

Since:

Redis ReJSON 1.0.0

JSON_ARRTRIM

static final Command JSON_ARRTRIM

Trim an array so that it contains only the specified inclusive range of elements.

This command only exists in Redis.

Since:

Redis ReJSON 1.0.0

JSON_CLEAR

static final Command JSON_CLEAR

Clear container values (arrays/objects) and set numeric values to 0.

This command only exists in Redis.

Since:

Redis ReJSON 2.0.0

JSON_DEBUG

static final Command JSON_DEBUG

This is a container command for debugging related tasks.

This command only exists in Redis.

Since:

Redis ReJSON 1.0.0

JSON_DEL

static final Command JSON_DEL

Delete a value.

This command only exists in Redis.

Since:

Redis ReJSON 1.0.0

JSON_FORGET

static final Command JSON_FORGET

Delete a value.

This command only exists in Redis.

Since:

Redis ReJSON 1.0.0

JSON_GET

static final Command JSON_GET

Get JSON value at path.

This command only exists in Redis.

Since:

Redis ReJSON 1.0.0

JSON_MERGE

static final Command JSON_MERGE

Merge a given JSON value into matching paths. Consequently, JSON values at matching paths are updated, deleted, or expanded with new children.

This command only exists in Redis.

Since:

Redis ReJSON 2.6.0

JSON_MGET

static final Command JSON_MGET

Return the values at path from multiple key arguments.

This command only exists in Redis.

Since:

Redis ReJSON 1.0.0

JSON_MSET

static final Command JSON_MSET

Set or update one or more JSON values according to the specified key-path-value triplets.

This command only exists in Redis.

Since:

Redis ReJSON 2.6.0

JSON_NUMINCRBY

static final Command JSON_NUMINCRBY

Increment the number value stored at path by number.

This command only exists in Redis.

Since:

Redis ReJSON 1.0.0

JSON_NUMMULTBY

static final Command JSON_NUMMULTBY

Multiply the number value stored at path by number.

This command only exists in Redis.

Since:

Redis ReJSON 1.0.0

JSON_NUMPOWBY

static final Command JSON_NUMPOWBY

Raise the number value stored at path to the power of number.

This command only exists in Redis.

Since:

Redis ReJSON 1.0.0

JSON_OBJKEYS

static final Command JSON_OBJKEYS

Return the keys in the object that's referenced by path.

This command only exists in Redis.

Since:

Redis ReJSON 1.0.0

JSON_OBJLEN

static final Command JSON_OBJLEN

Report the number of keys in the JSON object at path in key.

This command only exists in Redis.

Since:

Redis ReJSON 1.0.0

JSON_RESP

static final Command JSON_RESP

Return the JSON in key in Redis serialization protocol specification form.

This command only exists in Redis.

Since:

Redis ReJSON 1.0.0

JSON_SET

static final Command JSON_SET

Set the JSON value at path in key.

This command only exists in Redis.

Since:

Redis ReJSON 1.0.0

JSON_STRAPPEND

static final Command JSON_STRAPPEND

Append the json-string values to the string at path.

This command only exists in Redis.

Since:

Redis ReJSON 1.0.0

JSON_STRLEN

static final Command JSON_STRLEN

Report the length of the JSON String at path in key.

This command only exists in Redis.

Since:

Redis ReJSON 1.0.0

JSON_TOGGLE

static final Command JSON_TOGGLE

Toggle the boolean value stored at path.

This command only exists in Redis.

Since:

Redis ReJSON 2.0.0

JSON_TYPE

static final Command JSON_TYPE

Report the type of JSON value at path.

This command only exists in Redis.

Since:

Redis ReJSON 1.0.0

KEYS

static final Command KEYS

Returns all key names that match a pattern.

Since:

Redis 1.0.0

LASTSAVE

static final Command LASTSAVE

Returns the Unix timestamp of the last successful save to disk.

Since:

Redis 1.0.0

LATENCY

static final Command LATENCY

A container for latency diagnostics commands.

Since:

Redis 2.8.13

LCS

static final Command LCS

Finds the longest common substring.

Since:

Redis 7.0.0

LINDEX

static final Command LINDEX

Returns an element from a list by its index.

Since:

Redis 1.0.0

LINSERT

static final Command LINSERT

Inserts an element before or after another element in a list.

Since:

Redis 2.2.0

LLEN

static final Command LLEN

Returns the length of a list.

Since:

Redis 1.0.0

LMOVE

static final Command LMOVE

Returns an element after popping it from one list and pushing it to another. Deletes the list if the last element was moved.

Since:

Redis 6.2.0

LMPOP

static final Command LMPOP

Returns multiple elements from a list after removing them. Deletes the list if the last element was popped.

Since:

Redis 7.0.0

LOLWUT

static final Command LOLWUT

Displays computer art and the Redis version.

Since:

Redis 5.0.0

LPOP

static final Command LPOP

Returns the first elements in a list after removing it. Deletes the list if the last element was popped.

Since:

Redis 1.0.0

LPOS

static final Command LPOS

Returns the index of matching elements in a list.

Since:

Redis 6.0.6

LPUSH

static final Command LPUSH

Prepends one or more elements to a list. Creates the key if it doesn't exist.

Since:

Redis 1.0.0

LPUSHX

static final Command LPUSHX

Prepends one or more elements to a list only when the list exists.

Since:

Redis 2.2.0

LRANGE

static final Command LRANGE

Returns a range of elements from a list.

Since:

Redis 1.0.0

LREM

static final Command LREM

Removes elements from a list. Deletes the list if the last element was removed.

Since:

Redis 1.0.0

LSET

static final Command LSET

Sets the value of an element in a list by its index.

Since:

Redis 1.0.0

LTRIM

static final Command LTRIM

Removes elements from both ends a list. Deletes the list if all elements were trimmed.

Since:

Redis 1.0.0

MEMORY

static final Command MEMORY

A container for memory diagnostics commands.

Since:

Redis 4.0.0

MGET

static final Command MGET

Atomically returns the string values of one or more keys.

Since:

Redis 1.0.0

MIGRATE

static final Command MIGRATE

Atomically transfers a key from one Redis instance to another.

Since:

Redis 2.6.0

MODULE

static final Command MODULE

A container for module commands.

Since:

Redis 4.0.0

MONITOR

static final Command MONITOR

Listens for all requests received by the server in real-time.

Since:

Redis 1.0.0

MOVE

static final Command MOVE

Moves a key to another database.

Since:

Redis 1.0.0

MSET

static final Command MSET

Atomically creates or modifies the string values of one or more keys.

Since:

Redis 1.0.1

MSETEX

static final Command MSETEX

Atomically sets multiple string keys with a shared expiration in a single operation. Supports flexible argument parsing where condition and expiration flags can appear in any order.

This command only exists in Redis.

Since:

Redis 8.4.0

MSETNX

static final Command MSETNX

Atomically modifies the string values of one or more keys only when all keys don't exist.

Since:

Redis 1.0.1

MULTI

static final Command MULTI

Starts a transaction.

Since:

Redis 1.2.0

OBJECT

static final Command OBJECT

A container for object introspection commands.

Since:

Redis 2.2.3

PERSIST

static final Command PERSIST

Removes the expiration time of a key.

Since:

Redis 2.2.0

PEXPIRE

static final Command PEXPIRE

Sets the expiration time of a key in milliseconds.

Since:

Redis 2.6.0

PEXPIREAT

static final Command PEXPIREAT

Sets the expiration time of a key to a Unix milliseconds timestamp.

Since:

Redis 2.6.0

PEXPIRETIME

static final Command PEXPIRETIME

Returns the expiration time of a key as a Unix milliseconds timestamp.

Since:

Redis 7.0.0

PFADD

static final Command PFADD

Adds elements to a HyperLogLog key. Creates the key if it doesn't exist.

Since:

Redis 2.8.9

PFCOUNT

static final Command PFCOUNT

Returns the approximated cardinality of the set(s) observed by the HyperLogLog key(s).

Since:

Redis 2.8.9

PFDEBUG

static final Command PFDEBUG

Internal commands for debugging HyperLogLog values.

Since:

Redis 2.8.9

PFMERGE

static final Command PFMERGE

Merges one or more HyperLogLog values into a single key.

Since:

Redis 2.8.9

PFSELFTEST

static final Command PFSELFTEST

An internal command for testing HyperLogLog values.

Since:

Redis 2.8.9

PING

static final Command PING

Returns the server's liveliness response.

Since:

Redis 1.0.0

PSETEX

static final Command PSETEX

Deprecated.

since Redis 2.6.12, replaced by: SET with the PX argument

Sets both string value and expiration time in milliseconds of a key. The key is created if it doesn't exist.

Since:

Redis 2.6.0

PSUBSCRIBE

static final Command PSUBSCRIBE

Listens for messages published to channels that match one or more patterns.

Since:

Redis 2.0.0

PSYNC

static final Command PSYNC

An internal command used in replication.

Since:

Redis 2.8.0

PTTL

static final Command PTTL

Returns the expiration time in milliseconds of a key.

Since:

Redis 2.6.0

PUBLISH

static final Command PUBLISH

Posts a message to a channel.

Since:

Redis 2.0.0

PUBSUB

static final Command PUBSUB

A container for Pub/Sub commands.

Since:

Redis 2.8.0

PUNSUBSCRIBE

static final Command PUNSUBSCRIBE

Stops listening to messages published to channels that match one or more patterns.

Since:

Redis 2.0.0

QUIT

static final Command QUIT

Deprecated.

since Redis 7.2.0, replaced by: just closing the connection

Closes the connection.

Since:

Redis 1.0.0

RANDOMKEY

static final Command RANDOMKEY

Returns a random key name from the database.

Since:

Redis 1.0.0

READONLY

static final Command READONLY

Enables read-only queries for a connection to a Redis Cluster replica node.

Since:

Redis 3.0.0

READWRITE

static final Command READWRITE

Enables read-write queries for a connection to a Reids Cluster replica node.

Since:

Redis 3.0.0

RENAME

static final Command RENAME

Renames a key and overwrites the destination.

Since:

Redis 1.0.0

RENAMENX

static final Command RENAMENX

Renames a key only when the target key name doesn't exist.

Since:

Redis 1.0.0

REPLCONF

static final Command REPLCONF

An internal command for configuring the replication stream.

Since:

Redis 3.0.0

REPLICAOF

static final Command REPLICAOF

Configures a server as replica of another, or promotes it to a master.

Since:

Redis 5.0.0

RESET

static final Command RESET

Resets the connection.

Since:

Redis 6.2.0

RESTORE

static final Command RESTORE

Creates a key from the serialized representation of a value.

Since:

Redis 2.6.0

RESTORE_ASKING

static final Command RESTORE_ASKING

An internal command for migrating keys in a cluster.

Since:

Redis 3.0.0

ROLE

static final Command ROLE

Returns the replication role.

Since:

Redis 2.8.12

RPOP

static final Command RPOP

Returns and removes the last elements of a list. Deletes the list if the last element was popped.

Since:

Redis 1.0.0

RPOPLPUSH

static final Command RPOPLPUSH

Deprecated.

since Redis 6.2.0, replaced by: LMOVE with the RIGHT and LEFT arguments

Returns the last element of a list after removing and pushing it to another list. Deletes the list if the last element was popped.

Since:

Redis 1.2.0

RPUSH

static final Command RPUSH

Appends one or more elements to a list. Creates the key if it doesn't exist.

Since:

Redis 1.0.0

RPUSHX

static final Command RPUSHX

Appends an element to a list only when the list exists.

Since:

Redis 2.2.0

SADD

static final Command SADD

Adds one or more members to a set. Creates the key if it doesn't exist.

Since:

Redis 1.0.0

SAVE

static final Command SAVE

Synchronously saves the database(s) to disk.

Since:

Redis 1.0.0

SCAN

static final Command SCAN

Iterates over the key names in the database.

Since:

Redis 2.8.0

SCARD

static final Command SCARD

Returns the number of members in a set.

Since:

Redis 1.0.0

SCRIPT

static final Command SCRIPT

A container for Lua scripts management commands.

Since:

Redis 2.6.0

SDIFF

static final Command SDIFF

Returns the difference of multiple sets.

Since:

Redis 1.0.0

SDIFFSTORE

static final Command SDIFFSTORE

Stores the difference of multiple sets in a key.

Since:

Redis 1.0.0

SEARCH_CLUSTERINFO

static final Command SEARCH_CLUSTERINFO

This command only exists in Redis.

SEARCH_CLUSTERREFRESH

static final Command SEARCH_CLUSTERREFRESH

This command only exists in Redis.

SEARCH_CLUSTERSET

static final Command SEARCH_CLUSTERSET

This command only exists in Redis.

SELECT

static final Command SELECT

Changes the selected database.

Since:

Redis 1.0.0

SET

static final Command SET

Sets the string value of a key, ignoring its type. The key is created if it doesn't exist.

Since:

Redis 1.0.0

SETBIT

static final Command SETBIT

Sets or clears the bit at offset of the string value. Creates the key if it doesn't exist.

Since:

Redis 2.2.0

SETEX

static final Command SETEX

Deprecated.

since Redis 2.6.12, replaced by: SET with the EX argument

Sets the string value and expiration time of a key. Creates the key if it doesn't exist.

Since:

Redis 2.0.0

SETNX

static final Command SETNX

Deprecated.

since Redis 2.6.12, replaced by: SET with the NX argument

Set the string value of a key only when the key doesn't exist.

Since:

Redis 1.0.0

SETRANGE

static final Command SETRANGE

Overwrites a part of a string value with another by an offset. Creates the key if it doesn't exist.

Since:

Redis 2.2.0

SHUTDOWN

static final Command SHUTDOWN

Synchronously saves the database(s) to disk and shuts down the Redis server.

Since:

Redis 1.0.0

SINTER

static final Command SINTER

Returns the intersect of multiple sets.

Since:

Redis 1.0.0

SINTERCARD

static final Command SINTERCARD

Returns the number of members of the intersect of multiple sets.

Since:

Redis 7.0.0

SINTERSTORE

static final Command SINTERSTORE

Stores the intersect of multiple sets in a key.

Since:

Redis 1.0.0

SISMEMBER

static final Command SISMEMBER

Determines whether a member belongs to a set.

Since:

Redis 1.0.0

SLAVEOF

static final Command SLAVEOF

Deprecated.

since Redis 5.0.0, replaced by: REPLICAOF

Sets a Redis server as a replica of another, or promotes it to being a master.

Since:

Redis 1.0.0

SLOWLOG

static final Command SLOWLOG

A container for slow log commands.

Since:

Redis 2.2.12

SMEMBERS

static final Command SMEMBERS

Returns all members of a set.

Since:

Redis 1.0.0

SMISMEMBER

static final Command SMISMEMBER

Determines whether multiple members belong to a set.

Since:

Redis 6.2.0

SMOVE

static final Command SMOVE

Moves a member from one set to another.

Since:

Redis 1.0.0

SORT

static final Command SORT

Sorts the elements in a list, a set, or a sorted set, optionally storing the result.

Since:

Redis 1.0.0

SORT_RO

static final Command SORT_RO

Returns the sorted elements of a list, a set, or a sorted set.

Since:

Redis 7.0.0

SPOP

static final Command SPOP

Returns one or more random members from a set after removing them. Deletes the set if the last member was popped.

Since:

Redis 1.0.0

SPUBLISH

static final Command SPUBLISH

Post a message to a shard channel.

Since:

Redis 7.0.0

SRANDMEMBER

static final Command SRANDMEMBER

Get one or multiple random members from a set.

Since:

Redis 1.0.0

SREM

static final Command SREM

Removes one or more members from a set. Deletes the set if the last member was removed.

Since:

Redis 1.0.0

SSCAN

static final Command SSCAN

Iterates over members of a set.

Since:

Redis 2.8.0

SSUBSCRIBE

static final Command SSUBSCRIBE

Listens for messages published to shard channels.

Since:

Redis 7.0.0

STRLEN

static final Command STRLEN

Returns the length of a string value.

Since:

Redis 2.2.0

SUBSCRIBE

static final Command SUBSCRIBE

Listens for messages published to channels.

Since:

Redis 2.0.0

SUBSTR

static final Command SUBSTR

Deprecated.

since Redis 2.0.0, replaced by: GETRANGE

Returns a substring from a string value.

Since:

Redis 1.0.0

SUNION

static final Command SUNION

Returns the union of multiple sets.

Since:

Redis 1.0.0

SUNIONSTORE

static final Command SUNIONSTORE

Stores the union of multiple sets in a key.

Since:

Redis 1.0.0

SUNSUBSCRIBE

static final Command SUNSUBSCRIBE

Stops listening to messages posted to shard channels.

Since:

Redis 7.0.0

SWAPDB

static final Command SWAPDB

Swaps two Redis databases.

Since:

Redis 4.0.0

SYNC

static final Command SYNC

An internal command used in replication.

Since:

Redis 1.0.0

TDIGEST_ADD

static final Command TDIGEST_ADD

Adds one or more observations to a t-digest sketch.

This command only exists in Redis.

Since:

Redis Bloom 2.4.0

TDIGEST_BYRANK

static final Command TDIGEST_BYRANK

Returns, for each input rank, an estimation of the value (floating-point) with that rank.

This command only exists in Redis.

Since:

Redis Bloom 2.4.0

TDIGEST_BYREVRANK

static final Command TDIGEST_BYREVRANK

Returns, for each input reverse rank, an estimation of the value (floating-point) with that reverse rank.

This command only exists in Redis.

Since:

Redis Bloom 2.4.0

TDIGEST_CDF

static final Command TDIGEST_CDF

Returns, for each input value, an estimation of the floating-point fraction of (observations smaller than the given value + half the observations equal to the given value). Multiple fractions can be retrieved in a single call.

This command only exists in Redis.

Since:

Redis Bloom 2.4.0

TDIGEST_CREATE

static final Command TDIGEST_CREATE

Allocates memory and initializes a new t-digest sketch.

This command only exists in Redis.

Since:

Redis Bloom 2.4.0

TDIGEST_INFO

static final Command TDIGEST_INFO

Returns information and statistics about a t-digest sketch.

This command only exists in Redis.

Since:

Redis Bloom 2.4.0

TDIGEST_MAX

static final Command TDIGEST_MAX

Returns the maximum observation value from a t-digest sketch.

This command only exists in Redis.

Since:

Redis Bloom 2.4.0

TDIGEST_MERGE

static final Command TDIGEST_MERGE

Merges multiple t-digest sketches into a single sketch.

This command only exists in Redis.

Since:

Redis Bloom 2.4.0

TDIGEST_MIN

static final Command TDIGEST_MIN

Returns the minimum observation value from a t-digest sketch.

This command only exists in Redis.

Since:

Redis Bloom 2.4.0

TDIGEST_QUANTILE

static final Command TDIGEST_QUANTILE

Returns, for each input fraction, an estimation of the value (floating point) that is smaller than the given fraction of observations.

This command only exists in Redis.

Since:

Redis Bloom 2.4.0

TDIGEST_RANK

static final Command TDIGEST_RANK

Returns, for each input value (floating-point), the estimated rank of the value (the number of observations in the sketch that are smaller than the value + half the number of observations that are equal to the value).

This command only exists in Redis.

Since:

Redis Bloom 2.4.0

TDIGEST_RESET

static final Command TDIGEST_RESET

Resets a t-digest sketch: empty the sketch and re-initializes it.

This command only exists in Redis.

Since:

Redis Bloom 2.4.0

TDIGEST_REVRANK

static final Command TDIGEST_REVRANK

Returns, for each input value (floating-point), the estimated reverse rank of the value (the number of observations in the sketch that are larger than the value + half the number of observations that are equal to the value).

This command only exists in Redis.

Since:

Redis Bloom 2.4.0

TDIGEST_TRIMMED_MEAN

static final Command TDIGEST_TRIMMED_MEAN

Returns an estimation of the mean value from the sketch, excluding observation values outside the low and high cutoff quantiles.

This command only exists in Redis.

Since:

Redis Bloom 2.4.0

TIME

static final Command TIME

Returns the server time.

Since:

Redis 2.6.0

TIMESERIES_CLUSTERSET

static final Command TIMESERIES_CLUSTERSET

This command only exists in Redis.

TIMESERIES_CLUSTERSETFROMSHARD

static final Command TIMESERIES_CLUSTERSETFROMSHARD

Deprecated.

this command no longer exists in the latest Redis release

This command only exists in Redis.

TIMESERIES_HELLO

static final Command TIMESERIES_HELLO

Deprecated.

this command no longer exists in the latest Redis release

This command only exists in Redis.

TIMESERIES_INFOCLUSTER

static final Command TIMESERIES_INFOCLUSTER

Deprecated.

this command no longer exists in the latest Redis release

This command only exists in Redis.

TIMESERIES_INNERCOMMUNICATION

static final Command TIMESERIES_INNERCOMMUNICATION

Deprecated.

this command no longer exists in the latest Redis release

This command only exists in Redis.

TIMESERIES_NETWORKTEST

static final Command TIMESERIES_NETWORKTEST

Deprecated.

this command no longer exists in the latest Redis release

This command only exists in Redis.

TIMESERIES_REFRESHCLUSTER

static final Command TIMESERIES_REFRESHCLUSTER

This command only exists in Redis.

TOPK_ADD

static final Command TOPK_ADD

Adds an item to a Top-k sketch. Multiple items can be added at the same time.

This command only exists in Redis.

Since:

Redis Bloom 2.0.0

TOPK_COUNT

static final Command TOPK_COUNT

Return the count for one or more items are in a sketch.

This command only exists in Redis.

Since:

Redis Bloom 2.0.0

TOPK_INCRBY

static final Command TOPK_INCRBY

Increases the count of one or more items by increment.

This command only exists in Redis.

Since:

Redis Bloom 2.0.0

TOPK_INFO

static final Command TOPK_INFO

Returns information about a sketch.

This command only exists in Redis.

Since:

Redis Bloom 2.0.0

TOPK_LIST

static final Command TOPK_LIST

Return the full list of items in Top-K sketch.

This command only exists in Redis.

Since:

Redis Bloom 2.0.0

TOPK_QUERY

static final Command TOPK_QUERY

Checks whether one or more items are in a sketch.

This command only exists in Redis.

Since:

Redis Bloom 2.0.0

TOPK_RESERVE

static final Command TOPK_RESERVE

Initializes a Top-K sketch with specified parameters.

This command only exists in Redis.

Since:

Redis Bloom 2.0.0

TOUCH

static final Command TOUCH

Returns the number of existing keys out of those specified after updating the time they were last accessed.

Since:

Redis 3.2.1

TRIMSLOTS

static final Command TRIMSLOTS

Trim the keys that belong to specified slots.

This command only exists in Redis.

Since:

Redis 8.4.0

TS_ADD

static final Command TS_ADD

Append a sample to a time series.

This command only exists in Redis.

Since:

Redis TimeSeries 1.0.0

TS_ALTER

static final Command TS_ALTER

Update the retention, chunk size, duplicate policy, and labels of an existing time series.

This command only exists in Redis.

Since:

Redis TimeSeries 1.0.0

TS_CREATE

static final Command TS_CREATE

Create a new time series.

This command only exists in Redis.

Since:

Redis TimeSeries 1.0.0

TS_CREATERULE

static final Command TS_CREATERULE

Create a compaction rule.

This command only exists in Redis.

Since:

Redis TimeSeries 1.0.0

TS_DECRBY

static final Command TS_DECRBY

Decrease the value of the latest sample.

This command only exists in Redis.

Since:

Redis TimeSeries 1.0.0

TS_DEL

static final Command TS_DEL

Delete all samples between two timestamps for a given time series.

This command only exists in Redis.

Since:

Redis TimeSeries 1.6.0

TS_DELETERULE

static final Command TS_DELETERULE

Delete a compaction rule.

This command only exists in Redis.

Since:

Redis TimeSeries 1.0.0

TS_GET

static final Command TS_GET

Get the sample with the highest timestamp from a given time series.

This command only exists in Redis.

Since:

Redis TimeSeries 1.0.0

TS_INCRBY

static final Command TS_INCRBY

Increase the value of the latest sample.

This command only exists in Redis.

Since:

Redis TimeSeries 1.0.0

TS_INFO

static final Command TS_INFO

Returns information and statistics for a time series.

This command only exists in Redis.

Since:

Redis TimeSeries 1.0.0

TS_MADD

static final Command TS_MADD

Append new samples to one or more time series.

This command only exists in Redis.

Since:

Redis TimeSeries 1.0.0

TS_MGET

static final Command TS_MGET

Get the sample with the highest timestamp from each time series matching a specific filter.

This command only exists in Redis.

Since:

Redis TimeSeries 1.0.0

TS_MRANGE

static final Command TS_MRANGE

Query a range across multiple time series by filters in forward direction.

This command only exists in Redis.

Since:

Redis TimeSeries 1.0.0

TS_MREVRANGE

static final Command TS_MREVRANGE

Query a range across multiple time series by filters in reverse direction.

This command only exists in Redis.

Since:

Redis TimeSeries 1.4.0

TS_QUERYINDEX

static final Command TS_QUERYINDEX

Get all time series keys matching a filter list.

This command only exists in Redis.

Since:

Redis TimeSeries 1.0.0

TS_RANGE

static final Command TS_RANGE

Query a range in forward direction.

This command only exists in Redis.

Since:

Redis TimeSeries 1.0.0

TS_REVRANGE

static final Command TS_REVRANGE

Query a range in reverse direction.

This command only exists in Redis.

Since:

Redis TimeSeries 1.4.0

TTL

static final Command TTL

Returns the expiration time in seconds of a key.

Since:

Redis 1.0.0

TYPE

static final Command TYPE

Determines the type of value stored at a key.

Since:

Redis 1.0.0

UNLINK

static final Command UNLINK

Asynchronously deletes one or more keys.

Since:

Redis 4.0.0

UNSUBSCRIBE

static final Command UNSUBSCRIBE

Stops listening to messages posted to channels.

Since:

Redis 2.0.0

UNWATCH

static final Command UNWATCH

Forgets about watched keys of a transaction.

Since:

Redis 2.2.0

VADD

static final Command VADD

Add one or more elements to a vector set, or update its vector if it already exists.

This command only exists in Redis.

Since:

Redis VectorSet 8.0.0

VCARD

static final Command VCARD

Return the number of elements in a vector set.

This command only exists in Redis.

Since:

Redis VectorSet 8.0.0

VDIM

static final Command VDIM

Return the dimension of vectors in the vector set.

This command only exists in Redis.

Since:

Redis VectorSet 8.0.0

VEMB

static final Command VEMB

Return the vector associated with an element.

This command only exists in Redis.

Since:

Redis VectorSet 8.0.0

VGETATTR

static final Command VGETATTR

Retrieve the JSON attributes of elements.

This command only exists in Redis.

Since:

Redis VectorSet 8.0.0

VINFO

static final Command VINFO

Return information about a vector set.

This command only exists in Redis.

Since:

Redis VectorSet 8.0.0

VISMEMBER

static final Command VISMEMBER

Check if an element exists in a vector set.

This command only exists in Redis.

Since:

Redis VectorSet 8.2.0

VLINKS

static final Command VLINKS

Return the neighbors of an element at each layer in the HNSW graph.

This command only exists in Redis.

Since:

Redis VectorSet 8.0.0

VRANDMEMBER

static final Command VRANDMEMBER

Return one or multiple random members from a vector set.

This command only exists in Redis.

Since:

Redis VectorSet 8.0.0

VRANGE

static final Command VRANGE

Return vector set elements in a lex range.

This command only exists in Redis.

Since:

Redis VectorSet 8.4.0

VREM

static final Command VREM

Remove an element from a vector set.

This command only exists in Redis.

Since:

Redis VectorSet 8.0.0

VSETATTR

static final Command VSETATTR

Associate or remove the JSON attributes of elements.

This command only exists in Redis.

Since:

Redis VectorSet 8.0.0

VSIM

static final Command VSIM

Return elements by vector similarity.

This command only exists in Redis.

Since:

Redis VectorSet 8.0.0

WAIT

static final Command WAIT

Blocks until the asynchronous replication of all preceding write commands sent by the connection is completed.

Since:

Redis 3.0.0

WAITAOF

static final Command WAITAOF

Blocks until all of the preceding write commands sent by the connection are written to the append-only file of the master and/or replicas.

Since:

Redis 7.2.0

WATCH

static final Command WATCH

Monitors changes to keys to determine the execution of a transaction.

Since:

Redis 2.2.0

XACK

static final Command XACK

Returns the number of messages that were successfully acknowledged by the consumer group member of a stream.

Since:

Redis 5.0.0

XACKDEL

static final Command XACKDEL

Acknowledges and deletes one or multiple messages for a stream consumer group.

This command only exists in Redis.

Since:

Redis 8.2.0

XADD

static final Command XADD

Appends a new message to a stream. Creates the key if it doesn't exist.

Since:

Redis 5.0.0

XAUTOCLAIM

static final Command XAUTOCLAIM

Changes, or acquires, ownership of messages in a consumer group, as if the messages were delivered to as consumer group member.

Since:

Redis 6.2.0

XCFGSET

static final Command XCFGSET

Sets the IDMP configuration parameters for a stream.

This command only exists in Redis.

Since:

Redis 8.6.0

XCLAIM

static final Command XCLAIM

Changes, or acquires, ownership of a message in a consumer group, as if the message was delivered a consumer group member.

Since:

Redis 5.0.0

XDEL

static final Command XDEL

Returns the number of messages after removing them from a stream.

Since:

Redis 5.0.0

XDELEX

static final Command XDELEX

Deletes one or multiple entries from the stream.

This command only exists in Redis.

Since:

Redis 8.2.0

XGROUP

static final Command XGROUP

A container for consumer groups commands.

Since:

Redis 5.0.0

XIDMPRECORD

static final Command XIDMPRECORD

An internal command for setting IDMP metadata on an existing stream message.

This command only exists in Redis.

Since:

Redis 8.6.2

XINFO

static final Command XINFO

A container for stream introspection commands.

Since:

Redis 5.0.0

XLEN

static final Command XLEN

Return the number of messages in a stream.

Since:

Redis 5.0.0

XPENDING

static final Command XPENDING

Returns the information and entries from a stream consumer group's pending entries list.

Since:

Redis 5.0.0

XRANGE

static final Command XRANGE

Returns the messages from a stream within a range of IDs.

Since:

Redis 5.0.0

XREAD

static final Command XREAD

Returns messages from multiple streams with IDs greater than the ones requested. Blocks until a message is available otherwise.

Since:

Redis 5.0.0

XREADGROUP

static final Command XREADGROUP

Returns new or historical messages from a stream for a consumer in a group. Blocks until a message is available otherwise.

Since:

Redis 5.0.0

XREVRANGE

static final Command XREVRANGE

Returns the messages from a stream within a range of IDs in reverse order.

Since:

Redis 5.0.0

XSETID

static final Command XSETID

An internal command for replicating stream values.

Since:

Redis 5.0.0

XTRIM

static final Command XTRIM

Deletes messages from the beginning of a stream.

Since:

Redis 5.0.0

ZADD

static final Command ZADD

Adds one or more members to a sorted set, or updates their scores. Creates the key if it doesn't exist.

Since:

Redis 1.2.0

ZCARD

static final Command ZCARD

Returns the number of members in a sorted set.

Since:

Redis 1.2.0

ZCOUNT

static final Command ZCOUNT

Returns the count of members in a sorted set that have scores within a range.

Since:

Redis 2.0.0

ZDIFF

static final Command ZDIFF

Returns the difference between multiple sorted sets.

Since:

Redis 6.2.0

ZDIFFSTORE

static final Command ZDIFFSTORE

Stores the difference of multiple sorted sets in a key.

Since:

Redis 6.2.0

ZINCRBY

static final Command ZINCRBY

Increments the score of a member in a sorted set.

Since:

Redis 1.2.0

ZINTER

static final Command ZINTER

Returns the intersect of multiple sorted sets.

Since:

Redis 6.2.0

ZINTERCARD

static final Command ZINTERCARD

Returns the number of members of the intersect of multiple sorted sets.

Since:

Redis 7.0.0

ZINTERSTORE

static final Command ZINTERSTORE

Stores the intersect of multiple sorted sets in a key.

Since:

Redis 2.0.0

ZLEXCOUNT

static final Command ZLEXCOUNT

Returns the number of members in a sorted set within a lexicographical range.

Since:

Redis 2.8.9

ZMPOP

static final Command ZMPOP

Returns the highest- or lowest-scoring members from one or more sorted sets after removing them. Deletes the sorted set if the last member was popped.

Since:

Redis 7.0.0

ZMSCORE

static final Command ZMSCORE

Returns the score of one or more members in a sorted set.

Since:

Redis 6.2.0

ZPOPMAX

static final Command ZPOPMAX

Returns the highest-scoring members from a sorted set after removing them. Deletes the sorted set if the last member was popped.

Since:

Redis 5.0.0

ZPOPMIN

static final Command ZPOPMIN

Returns the lowest-scoring members from a sorted set after removing them. Deletes the sorted set if the last member was popped.

Since:

Redis 5.0.0

ZRANDMEMBER

static final Command ZRANDMEMBER

Returns one or more random members from a sorted set.

Since:

Redis 6.2.0

ZRANGE

static final Command ZRANGE

Returns members in a sorted set within a range of indexes.

Since:

Redis 1.2.0

ZRANGEBYLEX

static final Command ZRANGEBYLEX

Deprecated.

since Redis 6.2.0, replaced by: ZRANGE with the BYLEX argument

Returns members in a sorted set within a lexicographical range.

Since:

Redis 2.8.9

ZRANGEBYSCORE

static final Command ZRANGEBYSCORE

Deprecated.

since Redis 6.2.0, replaced by: ZRANGE with the BYSCORE argument

Returns members in a sorted set within a range of scores.

Since:

Redis 1.0.5

ZRANGESTORE

static final Command ZRANGESTORE

Stores a range of members from sorted set in a key.

Since:

Redis 6.2.0

ZRANK

static final Command ZRANK

Returns the index of a member in a sorted set ordered by ascending scores.

Since:

Redis 2.0.0

ZREM

static final Command ZREM

Removes one or more members from a sorted set. Deletes the sorted set if all members were removed.

Since:

Redis 1.2.0

ZREMRANGEBYLEX

static final Command ZREMRANGEBYLEX

Removes members in a sorted set within a lexicographical range. Deletes the sorted set if all members were removed.

Since:

Redis 2.8.9

ZREMRANGEBYRANK

static final Command ZREMRANGEBYRANK

Removes members in a sorted set within a range of indexes. Deletes the sorted set if all members were removed.

Since:

Redis 2.0.0

ZREMRANGEBYSCORE

static final Command ZREMRANGEBYSCORE

Removes members in a sorted set within a range of scores. Deletes the sorted set if all members were removed.

Since:

Redis 1.2.0

ZREVRANGE

static final Command ZREVRANGE

Deprecated.

since Redis 6.2.0, replaced by: ZRANGE with the REV argument

Returns members in a sorted set within a range of indexes in reverse order.

Since:

Redis 1.2.0

ZREVRANGEBYLEX

static final Command ZREVRANGEBYLEX

Deprecated.

since Redis 6.2.0, replaced by: ZRANGE with the REV and BYLEX arguments

Returns members in a sorted set within a lexicographical range in reverse order.

Since:

Redis 2.8.9

ZREVRANGEBYSCORE

static final Command ZREVRANGEBYSCORE

Deprecated.

since Redis 6.2.0, replaced by: ZRANGE with the REV and BYSCORE arguments

Returns members in a sorted set within a range of scores in reverse order.

Since:

Redis 2.2.0

ZREVRANK

static final Command ZREVRANK

Returns the index of a member in a sorted set ordered by descending scores.

Since:

Redis 2.0.0

ZSCAN

static final Command ZSCAN

Iterates over members and scores of a sorted set.

Since:

Redis 2.8.0

ZSCORE

static final Command ZSCORE

Returns the score of a member in a sorted set.

Since:

Redis 1.2.0

ZUNION

static final Command ZUNION

Returns the union of multiple sorted sets.

Since:

Redis 6.2.0

ZUNIONSTORE

static final Command ZUNIONSTORE

Stores the union of multiple sorted sets in a key.

Since:

Redis 2.0.0

SENTINEL

static final Command SENTINEL

Method Details

create

static Command create(String command)

Generic command generator for extensions.

To avoid inconsistent behavior, when command is one of the known commands for which a static instance exists, the static instance is returned.

Parameters:

command - command name

Returns:

the cacheable immutable command instance