Database.Redis.Commands

Copies the value of a key to a new key (https://redis.io/commands/copy).

O(N) worst case for collections, where N is the number of nested items. O(1) for string values.

Since Redis 6.2.0

Copies the value of a key to a new key (https://redis.io/commands/copy).

O(N) worst case for collections, where N is the number of nested items. O(1) for string values.

Since Redis 6.2.0

Options for the copy command.

Redis default CopyOpts. Equivalent to omitting all optional parameters.

Delete a key (http://redis.io/commands/del). Returns a number of keys that were removed. Since Redis 1.0.0

Return a serialized version of the value stored at the specified key (http://redis.io/commands/dump). Since Redis 2.6.0

Determine if a key exists (http://redis.io/commands/exists). Since Redis 1.0.0

Set a key's time to live in seconds (http://redis.io/commands/expire). Since Redis 1.0.0

Set the expiration for a key as a UNIX timestamp (http://redis.io/commands/expireat). Since Redis 1.2.0

Set the expiration for a key as a UNIX timestamp (http://redis.io/commands/expireat). Since Redis 1.2.0

Find all keys matching the given pattern (http://redis.io/commands/keys). Since Redis 1.0.0

Options for the migrate command.

Redis default MigrateOpts. Equivalent to omitting all optional parameters.

MigrateOpts
    { migrateCopy    = False -- remove the key from the local instance
    , migrateReplace = False -- don't replace existing key on the remote instance
    , migrateAuth = Nothing
    }

Atomically transfer a key from a Redis instance to another one (http://redis.io/commands/migrate). The Redis command MIGRATE is split up into migrate, migrateMultiple. Since Redis 2.6.0

Atomically transfer a key from a Redis instance to another one (http://redis.io/commands/migrate). The Redis command MIGRATE is split up into migrate, migrateMultiple. Since Redis 2.6.0

Move a key to another database (http://redis.io/commands/move). Since Redis 1.0.0

Inspect the internals of Redis objects (http://redis.io/commands/object). The Redis command OBJECT is split up into objectRefcount, objectEncoding, objectIdletime. Since Redis 2.2.3

Inspect the internals of Redis objects (http://redis.io/commands/object). The Redis command OBJECT is split up into objectRefcount, objectEncoding, objectIdletime. Since Redis 2.2.3

Inspect the internals of Redis objects (http://redis.io/commands/object). The Redis command OBJECT is split up into objectRefcount, objectEncoding, objectIdletime. Since Redis 2.2.3

Remove the expiration from a key (http://redis.io/commands/persist). Since Redis 2.2.0

Returns the expiration time of a key as a Unix timestamp (https://redis.io/commands/expiretime).

Returns -2 if the key does not exist; -1 if the key exists but has no associated expiration.

O(1). Since Redis 7.0.0

Set a key's time to live in milliseconds (http://redis.io/commands/pexpire). Since Redis 2.6.0

Returns the expiration time of a key as a Unix timestamp in milliseconds (https://redis.io/commands/pexpiretime).

Returns -2 if the key does not exist; -1 if the key exists but has no associated expiration.

O(1). Since Redis 7.0.0

Set the expiration for a key as a UNIX timestamp specified in milliseconds (http://redis.io/commands/pexpireat). Since Redis 2.6.0

Set the expiration for a key as a UNIX timestamp specified in milliseconds (http://redis.io/commands/pexpireat). Since Redis 7.0

O(1) Get the time to live for a key in milliseconds (http://redis.io/commands/pttl). Since Redis 2.6.0

This command returns -2 if the key does not exist. This command returns -1 if the key exists but has no associated value

Return a random key from the keyspace (http://redis.io/commands/randomkey). Since Redis 1.0.0

Rename a key (http://redis.io/commands/rename). Since Redis 1.0.0

Does not return a error even if newkey existed.

Rename a key, only if the new key does not exist (http://redis.io/commands/renamenx). Since Redis 1.0.0

Create a key using the provided serialized value, previously obtained using DUMP (http://redis.io/commands/restore). The Redis command RESTORE is split up into restore, restoreReplace. Since Redis 2.6.0

Create a key using the provided serialized value, previously obtained using DUMP (http://redis.io/commands/restore). The Redis command RESTORE is split up into restore, restoreReplace. Since Redis 2.6.0

Redis default ScanOpts. Equivalent to omitting all optional parameters.

ScanOpts
    { scanMatch = Nothing -- don't match any pattern
    , scanCount = Nothing -- don't set any requirements on number elements returned (works like value COUNT 10)
    }

Incrementally iterate the keys space (http://redis.io/commands/scan). The Redis command SCAN is split up into scan, scanOpts. Since Redis 2.8.0

Incrementally iterate the keys space (http://redis.io/commands/scan). The Redis command SCAN is split up into scan, scanOpts. Since Redis 2.8.0

Options for the sort command.

Redis default SortOpts. Equivalent to omitting all optional parameters.

SortOpts
    { sortBy    = Nothing -- omit the BY option
    , sortLimit = (0,-1)  -- return entire collection
    , sortGet   = []      -- omit the GET option
    , sortOrder = Asc     -- sort in ascending order
    , sortAlpha = False   -- sort numerically, not lexicographically
    }

Sort the elements in a list, set or sorted set (http://redis.io/commands/sort). The Redis command SORT is split up into sort, sortStore. Since Redis 1.0.0

Sort the elements in a list, set or sorted set (http://redis.io/commands/sort). The Redis command SORT is split up into sort, sortStore. Since Redis 1.0.0

O(1) Get the time to live for a key (http://redis.io/commands/ttl). Since Redis 1.0.0

This command returns: * -2 if the key does not exist * -1 if the key exists but has no associated value

Determine the type stored at key (http://redis.io/commands/type). Since Redis 1.0.0

Delete one or more hash fields (http://redis.io/commands/hdel). Since Redis 2.0.0

Determine if a hash field exists (http://redis.io/commands/hexists). Since Redis 2.0.0

Sets expiration for hash fields using relative time to expire in seconds (https://redis.io/commands/hexpire).

O(N) where N is the number of specified fields.

Set an expiration (TTL or time to live) on one or more fields of a given hash key. You must specify at least one field. Field(s) will automatically be deleted from the hash key when their TTLs expire.

Field expirations will only be cleared by commands that delete or overwrite the contents of the hash fields, including HDEL and HSET commands. This means that all the operations that conceptually alter the value stored at a hash key's field without replacing it with a new one will leave the TTL untouched.

You can clear the TTL using the hpersist command, which turns the hash field back into a persistent field.

Note that calling hexpirehpexpire with a zero TTL or hexpireathpexpireat with a time in the past will result in the hash field being deleted.

Since Redis 7.4.0

Sets expiration for hash fields using relative time to expire in seconds (https://redis.io/commands/hexpire).

O(N) where N is the number of specified fields.

Since Redis 7.4.0

Sets expiration for hash fields using an absolute Unix timestamp in seconds (https://redis.io/commands/hexpireat).

O(N) where N is the number of specified fields.

Since Redis 7.4.0

Sets expiration for hash fields using an absolute Unix timestamp in seconds (https://redis.io/commands/hexpireat).

O(N) where N is the number of specified fields.

Since Redis 7.4.0

Returns the expiration time of hash fields as a Unix timestamp in seconds (https://redis.io/commands/hexpiretime).

O(N) where N is the number of specified fields.

Since Redis 7.4.0

Get the value of a hash field (http://redis.io/commands/hget). Since Redis 2.0.0

Returns the values associated with the specified fields in a hash and deletes those fields (https://redis.io/commands/hgetdel).

O(N) where N is the number of specified fields.

Since Redis 8.0.0

Returns the values associated with the specified fields in a hash and optionally updates the key expiration (https://redis.io/commands/hgetex).

O(N) where N is the number of specified fields.

Since Redis 8.0.0

Returns the values associated with the specified fields in a hash and optionally updates the key expiration (https://redis.io/commands/hgetex).

O(N) where N is the number of specified fields.

Since Redis 8.0.0

Get all the fields and values in a hash (http://redis.io/commands/hgetall).

Since Redis 2.0.0.

Increment the integer value of a hash field by the given number (http://redis.io/commands/hincrby). Since Redis 2.0.0

Increment the float value of a hash field by the given amount (http://redis.io/commands/hincrbyfloat). Since Redis 2.6.0

O(N) where N is size of the hash. Get all the fields in a hash (http://redis.io/commands/hkeys). Since Redis 2.0.0

O(1) Get the number of fields in a hash (http://redis.io/commands/hlen).

Since Redis 2.0.0

Get the values of all the given hash fields (http://redis.io/commands/hmget). Since Redis 2.0.0

Set multiple hash fields to multiple values (http://redis.io/commands/hmset).

Deprecated by Redis, consider using hset with multiple field-value pairs.

Since Redis 2.0.0

Returns a random field from a hash (https://redis.io/commands/hrandfield).

O(1)

Since Redis 6.2.0

Returns one or more random fields from a hash (https://redis.io/commands/hrandfield).

O(N) where N is the number of fields returned.

If the provided count argument is positive, return an array of distinct fields. The array's length is either count or the hash's number of fields (HLEN), whichever is lower.

If called with a negative count, the behavior changes and the command is allowed to return the same field multiple times. In this case, the number of returned fields is the absolute value of the specified count.

Since Redis 6.2.0

Returns one or more random fields and their values from a hash (https://redis.io/commands/hrandfield).

O(N) where N is the number of fields returned.

If the provided count argument is positive, return an array of distinct fields. The array's length is either count or the hash's number of fields (HLEN), whichever is lower.

If called with a negative count, the behavior changes and the command is allowed to return the same field multiple times. In this case, the number of returned fields is the absolute value of the specified count.

Since Redis 6.2.0

Incrementally iterate hash fields and associated values (http://redis.io/commands/hscan). The Redis command HSCAN is split up into hscan, hscanOpts. Since Redis 2.8.0

Incrementally iterate hash fields and associated values (http://redis.io/commands/hscan). The Redis command HSCAN is split up into hscan, hscanOpts. Since Redis 2.8.0

Sets expiration for hash fields using relative time to expire in milliseconds (https://redis.io/commands/hpexpire).

O(N) where N is the number of specified fields.

Since Redis 7.4.0

Sets expiration for hash fields using relative time to expire in milliseconds (https://redis.io/commands/hpexpire).

O(N) where N is the number of specified fields.

Since Redis 7.4.0

Sets expiration for hash fields using an absolute Unix timestamp in milliseconds (https://redis.io/commands/hpexpireat).

O(N) where N is the number of specified fields.

Since Redis 7.4.0

Sets expiration for hash fields using an absolute Unix timestamp in milliseconds (https://redis.io/commands/hpexpireat).

O(N) where N is the number of specified fields.

Since Redis 7.4.0

Returns the expiration time of hash fields as a Unix timestamp in milliseconds (https://redis.io/commands/hpexpiretime).

O(N) where N is the number of specified fields.

Since Redis 7.4.0

Returns the TTL in milliseconds of hash fields (https://redis.io/commands/hpttl).

O(N) where N is the number of specified fields.

Since Redis 7.4.0

Set the string value of a hash field (http://redis.io/commands/hset).

This command oveerides keys if they exist in the hash.

Since Redis 2.0.0

Sets fields in a hash and optionally updates the key expiration (https://redis.io/commands/hsetex).

O(N) where N is the number of fields set.

Since Redis 8.0.0

Sets fields in a hash and optionally updates the key expiration (https://redis.io/commands/hsetex).

O(N) where N is the number of fields set.

Since Redis 8.0.0

Set the value of a hash field, only if the field does not exist (http://redis.io/commands/hsetnx). Since Redis 2.0.0

Get the length of the value of a hash field (http://redis.io/commands/hstrlen). Since Redis 3.2.0

Returns the TTL in seconds of hash fields (https://redis.io/commands/httl).

O(N) where N is the number of specified fields.

Since Redis 7.4.0

Get all the values in a hash (http://redis.io/commands/hvals). Since Redis 2.0.0

O(1) Adds all the elements arguments to the HyperLogLog data structure stored at the variable name specified as first argument (http://redis.io/commands/pfadd). Since Redis 2.8.9

Return the approximated cardinality of the set(s) observed by the HyperLogLog at key(s) (http://redis.io/commands/pfcount). Since Redis 2.8.9

Merge N different HyperLogLogs into a single one (http://redis.io/commands/pfmerge). Since Redis 2.8.9

Remove and get the first element in a list, or block until one is available (http://redis.io/commands/blpop). Since Redis 2.0.0

Remove and get the first element in a list, or block until one is available (http://redis.io/commands/blpop). Since Redis 6.0.0

Pops one or more elements from the first non-empty list from a list of keys, or blocks until one is available (https://redis.io/commands/blmpop).

O(N+M) where N is the number of provided keys and M is the number of elements returned.

Since Redis 7.0.0

Pops one or more elements from the first non-empty list from a list of keys, or blocks until one is available (https://redis.io/commands/blmpop).

O(N+M) where N is the number of provided keys and M is the number of elements returned.

Since Redis 7.0.0

Move an element after taking it from one list and pushing it to another, or blocks until one is available (https://redis.io/commands/blmove).

In clustered environments source and destination keys must be in the same hash slot, which can be ensured by using hash tags (e.g. {tag}source and {tag}destination).

O(1)

Since Redis 6.2.0

O(N) Remove and get the last element in a list, or block until one is available (http://redis.io/commands/brpop).

Since Redis 2.0.0

O(N) Remove and get the last element in a list, or block until one is available (http://redis.io/commands/brpop).

Since Redis 2.0.0

Pop a value from a list, push it to another list and return it; or block until one is available (http://redis.io/commands/brpoplpush).

Since Redis 6.0 this command considered deprecated: it can be replaced by BLMOVE with the RIGHT and LEFT arguments when migrating or writing new code.

Since Redis 2.2.0

Get an element from a list by its index (http://redis.io/commands/lindex). Since Redis 1.0.0

Insert an element before or after another element in a list (http://redis.io/commands/linsert). The Redis command LINSERT is split up into linsertBefore, linsertAfter. Since Redis 2.2.0

Insert an element before or after another element in a list (http://redis.io/commands/linsert). The Redis command LINSERT is split up into linsertBefore, linsertAfter. Since Redis 2.2.0

Get the length of a list (http://redis.io/commands/llen). Since Redis 1.0.0

Pops one or more elements from the first non-empty list from a list of keys (https://redis.io/commands/lmpop).

O(N+M) where N is the number of provided keys and M is the number of elements returned.

Since Redis 7.0.0

Pops one or more elements from the first non-empty list from a list of keys (https://redis.io/commands/lmpop).

O(N+M) where N is the number of provided keys and M is the number of elements returned.

Since Redis 7.0.0

Returns the index of the first matching element in a list (https://redis.io/commands/lpos).

O(N) where N is the number of elements in the list, for the average case. When searching for elements near the head or the tail of the list, or when the MAXLEN option is provided, the command may run in constant time.

Since Redis 6.0.6

Returns the index of the first matching element in a list (https://redis.io/commands/lpos).

O(N) where N is the number of elements in the list, for the average case. When searching for elements near the head or the tail of the list, or when the MAXLEN option is provided, the command may run in constant time.

Since Redis 6.0.6

Returns the indexes of matching elements in a list (https://redis.io/commands/lpos).

O(N) where N is the number of elements in the list, for the average case. When searching for elements near the head or the tail of the list, or when the MAXLEN option is provided, the command may run in constant time.

Since Redis 6.0.6

Returns the indexes of matching elements in a list (https://redis.io/commands/lpos).

O(N) where N is the number of elements in the list, for the average case. When searching for elements near the head or the tail of the list, or when the MAXLEN option is provided, the command may run in constant time.

Since Redis 6.0.6

Remove and get the first element in a list (http://redis.io/commands/lpop). Since Redis 1.0.0

Remove and get the first element in a list (http://redis.io/commands/lpop). The reply will consist of up to count elements, depending on the list's length. Since Redis 1.0.0

Move an element after taking it from one list and pushing it to another (https://redis.io/commands/lmove).

In clustered environments source and destination keys must be in the same hash slot, which can be ensured by using hash tags (e.g. {tag}source and {tag}destination). O(1)

Since Redis 6.2.0

Prepend one or multiple values to a list (http://redis.io/commands/lpush). Since Redis 1.0.0

Prepend a value to a list, only if the list exists (http://redis.io/commands/lpushx). Since Redis 2.2.0

Get a range of elements from a list (http://redis.io/commands/lrange). Since Redis 1.0.0

Remove elements from a list (http://redis.io/commands/lrem). Since Redis 1.0.0

Set the value of an element in a list by its index (http://redis.io/commands/lset). Since Redis 1.0.0

Trim a list to the specified range (http://redis.io/commands/ltrim). Since Redis 1.0.0

Remove and get the last element in a list (http://redis.io/commands/rpop). Since Redis 1.0.0

Remove and get the last element in a list (http://redis.io/commands/rpop). The reply will consist of up to count elements, depending on the list's length. Result will have no more than N arguments.

Since Redis 1.0.0

Remove the last element in a list, prepend it to another list and return that element f it existed (http://redis.io/commands/rpoplpush). Since Redis 1.2.0

Append one or multiple values to a list (http://redis.io/commands/rpush). Since Redis 1.0.0

O(1) for each element added. Append a value to a list, only if the list exists (http://redis.io/commands/rpushx). Since Redis 2.2.0

Execute a Lua script server side (http://redis.io/commands/eval). Since Redis 2.6.0

Works like eval, but sends the SHA1 hash of the script instead of the script itself. Fails if the server does not recognise the hash, in which case, eval should be used instead.

Invokes a function (https://redis.io/commands/fcall).

Complexity depends on the function that is executed.

Since Redis 7.0.0

Invokes a read-only function (https://redis.io/commands/fcall_ro).

Complexity depends on the function that is executed.

Since Redis 7.0.0

Returns helpful text about FUNCTION subcommands (https://redis.io/commands/function-help).

O(1)

Since Redis 7.0.0

Returns information about all libraries (https://redis.io/commands/function-list).

O(N) where N is the number of functions.

Since Redis 7.0.0

Returns information about all libraries (https://redis.io/commands/function-list).

O(N) where N is the number of functions.

Since Redis 7.0.0

Set the debug mode for executed scripts (http://redis.io/commands/script-debug). Since Redis 3.2.0

Check existence of scripts in the script cache (http://redis.io/commands/script-exists). Since Redis 2.6.0

Remove all the scripts from the script cache (http://redis.io/commands/script-flush). Since Redis 2.6.0

Kill the script currently in execution (http://redis.io/commands/script-kill). Since Redis 2.6.0

Load the specified Lua script into the script cache (http://redis.io/commands/script-load). Since Redis 2.6.0

Asynchronously rewrite the append-only file (http://redis.io/commands/bgrewriteaof). Since Redis 1.0.0

Asynchronously save the dataset to disk (http://redis.io/commands/bgsave).

Since Redis 1.0.0

Asynchronously save the dataset to disk (http://redis.io/commands/bgsave).

Immediately returns OK when an AOF rewrite is in progress and schedule the background save to run at the next opportunity.

A client may bee able to check if the operation succeeded using the lastsave command

Since Redis 3.2.2

Get the current connection name (http://redis.io/commands/client-getname). Since Redis 2.6.9

Get the current connection ID (http://redis.io/commands/client-id). Since Redis 5.0.0

Get the list of client connections (http://redis.io/commands/client-list). Since Redis 2.4.0

Stop processing commands from clients for some time (http://redis.io/commands/client-pause). Since Redis 2.9.50

Instruct the server whether to reply to commands (http://redis.io/commands/client-reply). Since Redis 3.2

Resumes processing commands from paused clients (https://redis.io/commands/client-unpause).

O(N) where N is the number of paused clients.

Since Redis 6.2.0

Set the current connection name (http://redis.io/commands/client-setname). Since Redis 2.6.9

The CLIENT NO-TOUCH command controls whether commands sent by the client will alter the LRULFU of the keys they access (<https:redis.iocommands/client-notouch>).

When turned on, the current client will not change LFU/LRU stats, unless it sends the TOUCH command.

When turned off, the client touches LFU/LRU stats just as a normal client.

O(1)

Since Redis 7.2.0

The CLIENT SETINFO command assigns various info attributes to the current connection which are displayed in the output of CLIENT LIST and CLIENT INFO (https://redis.io/commands/client-setinfo).

O(1)

Since Redis 7.2.0

O(1) Get total number of Redis commands (http://redis.io/commands/command-count). Since Redis 2.8.13

Get array of specific Redis command details (http://redis.io/commands/command-info). Since Redis 2.8.13

Returns a list of command names (https://redis.io/commands/command-list).

O(N) where N is the total number of Redis commands.

Since Redis 7.0.0

Returns a list of command names (https://redis.io/commands/command-list).

O(N) where N is the total number of Redis commands.

Since Redis 7.0.0

Redis default HotkeysStartOpts. Equivalent to omitting all optional parameters.

Returns tracking results and metadata from the current or most recent hotkeys tracking session (https://redis.io/commands/hotkeys-get).

O(K) where K is the number of hotkeys returned.

Since Redis 8.6.0

Starts hotkeys tracking (https://redis.io/commands/hotkeys-start).

O(1)

Since Redis 8.6.0

Starts hotkeys tracking (https://redis.io/commands/hotkeys-start).

O(1)

Since Redis 8.6.0

Stops hotkeys tracking (https://redis.io/commands/hotkeys-stop).

O(1)

Since Redis 8.6.0

Release the resources used for hotkey tracking (https://redis.io/commands/hotkeys-reset).

O(1)

Since Redis 8.6.0

Get the value of a configuration parameter (http://redis.io/commands/config-get). Since Redis 2.0.0

Reset the stats returned by INFO (http://redis.io/commands/config-resetstat). Since Redis 2.0.0

Rewrite the configuration file with the in memory configuration (http://redis.io/commands/config-rewrite). Since Redis 2.8.0

Set a configuration parameter to the given value (http://redis.io/commands/config-set). Since Redis 2.0.0

Return the number of keys in the selected database (http://redis.io/commands/dbsize). Since Redis 1.0.0

Get debugging information about a key (http://redis.io/commands/debug-object). Since Redis 1.0.0

Remove all keys from all databases (http://redis.io/commands/flushall). Since Redis 1.0.0

Remove all keys from the current database (http://redis.io/commands/flushdb). Since Redis 6.2

Remove all keys from the current database (http://redis.io/commands/flushdb). Since Redis 1.0.0

Remove all keys from the current database (http://redis.io/commands/flushdb). Since Redis 6.2

Synchronously save the dataset to disk (http://redis.io/commands/save). Since Redis 1.0.0

Make the server a slave of another instance, or promote it as master (http://redis.io/commands/slaveof). Deprecated in Redis, can be replaced by replicaif since redis 5.0 Since Redis 1.0.0

A single entry from the slowlog.

Return the current server time (http://redis.io/commands/time). Since Redis 2.6.0

O(1) for each element added. Add one or more members to a set (http://redis.io/commands/sadd). Since Redis 1.0.0

Get the number of members in a set (http://redis.io/commands/scard). Since Redis 1.0.0

Subtract multiple sets (http://redis.io/commands/sdiff). Since Redis 1.0.0

Subtract multiple sets and store the resulting set in a key (http://redis.io/commands/sdiffstore). Since Redis 1.0.0

Intersect multiple sets (http://redis.io/commands/sinter). Since Redis 1.0.0

Returns the cardinality of the intersection of multiple sets (https://redis.io/commands/sintercard).

O(N*M) worst case where N is the cardinality of the smallest set and M is the number of sets.

In clustered environment, commands must operate on keys within the same hash slot.

Since Redis 7.0.0

Returns the cardinality of the intersection of multiple sets (https://redis.io/commands/sintercard).

O(N*M) worst case where N is the cardinality of the smallest set and M is the number of sets.

In clustered environment, commands must operate on keys within the same hash slot.

Since Redis 7.0.0

Intersect multiple sets and store the resulting set in a key (http://redis.io/commands/sinterstore). Since Redis 1.0.0

Determine if a given value is a member of a set (http://redis.io/commands/sismember). Since Redis 1.0.0

Get all the members in a set (http://redis.io/commands/smembers). Since Redis 1.0.0

Determines whether multiple members belong to a set (https://redis.io/commands/smismember).

O(N) where N is the number of elements being checked for membership.

Since Redis 6.2.0