Actions

The ballerinax/redis package exposes the following clients:

Client	Purpose
`Client`	Provides operations to interact with a Redis server or cluster for data storage and retrieval.

Client

Provides operations to interact with a Redis server or cluster for data storage and retrieval.

Configuration

The client is configured with a ConnectionConfig record.

Field	Type	Default	Description
`connection`	`ConnectionUri\|ConnectionParams`	`"redis://localhost:6379"`	Redis connection URI string or a `ConnectionParams` record with host, port, username, password, and options.
`connectionPooling`	`boolean`	`false`	Whether to enable connection pooling.
`isClusterConnection`	`boolean`	`false`	Whether this is a Redis cluster connection.
`secureSocket`	`SecureSocket?`	`()`	SSL/TLS configuration for encrypted connections.

Configuration types

`ConnectionUri`

A Redis connection URI string. Aliases string.

Format: redis://[username:password@]host[:port][/database] for unencrypted, or rediss://... for TLS.

`ConnectionParams`

Field-based connection configuration.

Field	Type	Default	Description
`host`	`string`	`"localhost"`	Host address of the Redis database.
`port`	`int`	`6379`	Port of the Redis database.
`username`	`string?`	`()`	Username for the Redis database (Redis 6.0+ ACL).
`password`	`string?`	`()`	Password for the Redis database.
`options`	`Options`	`{}`	Additional connection options.

`Options`

Connection options.

Field	Type	Default	Description
`clientName`	`string?`	`()`	Name of the client.
`database`	`int`	`0`	Database index the client should interact with. Not applicable for cluster connections.
`connectionTimeout`	`int`	`60`	Connection timeout in seconds.
`keepAlive`	`KeepAliveConfig?`	`()`	TCP keep-alive configuration for detecting stale connections. Set to `()` to disable.

`KeepAliveConfig`

TCP keep-alive parameters.

Field	Type	Default	Description
`idle`	`int`	`7200`	Time in seconds the connection must be idle before the first keep-alive probe is sent.
`interval`	`int`	`75`	Time in seconds between individual keep-alive probes.
`count`	`int`	`9`	Maximum number of keep-alive probes before the connection is considered dead.

`SecureSocket`

SSL/TLS configuration.

Field	Type	Default	Description
`cert`	`crypto:TrustStore\|string?`	`()`	A `crypto:TrustStore` record (`{path, password}`) or a path to a single certificate file the client trusts.
`key`	`crypto:KeyStore\|CertKey?`	`()`	A `crypto:KeyStore` record (`{path, password}`) or a `CertKey` value (used for mutual TLS).
`protocols`	`string[]?`	`()`	List of protocols used for the connection, such as `TLSv1.2`, `TLSv1.1`, `TLSv1`.
`ciphers`	`string[]?`	`()`	List of ciphers to be used for SSL connections.
`verifyMode`	`SslVerifyMode`	`FULL`	Server-certificate verification mode.
`startTls`	`boolean`	`false`	Whether StartTLS is enabled.

`CertKey`

Client certificate and private key (used for mutual TLS).

Field	Type	Default	Description
`certFile`	`string`	Required	Path to the certificate file.
`keyFile`	`string`	Required	Path to the private key file in PKCS8 format.
`keyPassword`	`string?`	`()`	Password of the private key, if encrypted.

`SslVerifyMode`

Enum of TLS verification modes:

NONE: No verification.
CA: Verify the server's certificate against the provided CA certificates.
FULL: Verify the server's certificate against the provided CA certificates and also verify the server's hostname.

Initializing the client

Using a connection URI:

import ballerinax/redis;

redis:Client redis = check new ({
    connection: "redis://localhost:6379"
});

Or using connection parameters with authentication:

import ballerinax/redis;

redis:Client redis = check new ({
    connection: {
        host: "localhost",
        port: 6379,
        password: "my_password"
    }
});

Operations

String operations

set

Set the string value of a key.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The key to set.
`value`	`string`	Yes	The value to set.

Returns: string|redis:Error

Sample code:

string result = check redis->set("name", "John");

Sample response:

"OK"

get

Get the value of a key.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The key to retrieve.

Returns: string|redis:Error?

Sample code:

string? value = check redis->get("name");

Sample response:

"John"

append

Append a value to a key.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The key to append to.
`value`	`string`	Yes	The value to append.

Returns: int|redis:Error

Sample code:

int length = check redis->append("greeting", " World");

Sample response:

incr

Increment the integer value of a key by one.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The key to increment.

Returns: int|redis:Error

Sample code:

int newValue = check redis->incr("counter");

Sample response:

incrBy

Increment the integer value of a key by the given amount.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The key to increment.
`value`	`int`	Yes	The increment amount.

Returns: int|redis:Error

Sample code:

int newValue = check redis->incrBy("counter", 5);

Sample response:

incrByFloat

Increment the float value of a key by the given amount.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The key to increment.
`value`	`float`	Yes	The float increment amount.

Returns: float|redis:Error

Sample code:

float newValue = check redis->incrByFloat("price", 2.5);

Sample response:

12.5

decr

Decrement the integer value of a key by one.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The key to decrement.

Returns: int|redis:Error

Sample code:

int newValue = check redis->decr("counter");

Sample response:

decrBy

Decrement the integer value of a key by the given number.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The key to decrement.
`value`	`int`	Yes	The decrement amount.

Returns: int|redis:Error

Sample code:

int newValue = check redis->decrBy("counter", 3);

Sample response:

mSet

Set multiple keys to multiple values.

Parameters:

Name	Type	Required	Description
`keyValueMap`	`map<any>`	Yes	A map of key-value pairs to set.

Returns: string|redis:Error

Sample code:

string result = check redis->mSet({
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
});

Sample response:

"OK"

mGet

Get the values of all the given keys.

Parameters:

Name	Type	Required	Description
`keys`	`string[]`	Yes	Array of keys to retrieve.

Returns: string[]|redis:Error

Sample code:

string[] values = check redis->mGet(["key1", "key2", "key3"]);

Sample response:

["value1", "value2", "value3"]

mSetNx

Set multiple keys to multiple values, only if none of the keys exist.

Parameters:

Name	Type	Required	Description
`keyValueMap`	`map<any>`	Yes	A map of key-value pairs to set.

Returns: boolean|redis:Error

Sample code:

boolean result = check redis->mSetNx({"nx1": "val1", "nx2": "val2"});

Sample response:

true

setEx

Set the value and expiration (in seconds) of a key.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The key to set.
`value`	`string`	Yes	The value to set.
`expirationTime`	`int`	Yes	Expiration time in seconds.

Returns: string|redis:Error

Sample code:

string result = check redis->setEx("session:abc123", "user_data", 3600);

Sample response:

"OK"

pSetEx

Set value and expiration in milliseconds of a key.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The key to set.
`value`	`string`	Yes	The value to set.
`expirationTime`	`int`	Yes	Expiration time in milliseconds.

Returns: string|redis:Error

Sample code:

string result = check redis->pSetEx("temp:data", "ephemeral", 5000);

Sample response:

"OK"

setNx

Set the value of a key, only if the key does not exist.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The key to set.
`value`	`string`	Yes	The value to set.

Returns: boolean|redis:Error

Sample code:

boolean wasSet = check redis->setNx("lock:resource1", "locked");

Sample response:

true

getSet

Set the string value of a key and return its old value.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The key to set.
`value`	`string`	Yes	The new value.

Returns: string|redis:Error?

Sample code:

string? oldValue = check redis->getSet("status", "active");

Sample response:

"inactive"

getRange

Get a substring of the string stored at a key.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The key.
`startPos`	`int`	Yes	Start offset (inclusive).
`end`	`int`	Yes	End offset (inclusive).

Returns: string|redis:Error

Sample code:

string substring = check redis->getRange("greeting", 0, 4);

Sample response:

"Hello"

setRange

Overwrite part of a string at key starting at the specified offset.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The key.
`offset`	`int`	Yes	The byte offset to start overwriting at.
`value`	`string`	Yes	The value to write.

Returns: int|redis:Error

Sample code:

int newLen = check redis->setRange("greeting", 6, "Redis");

Sample response:

strLen

Get the length of the value stored in a key.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The key.

Returns: int|redis:Error

Sample code:

int length = check redis->strLen("name");

Sample response:

bitCount

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

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The key.

Returns: int|redis:Error

Sample code:

int bits = check redis->bitCount("mybitfield");

Sample response:

setBit

Sets or clears the bit at offset in the string value stored at key.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The key.
`value`	`int`	Yes	The bit value (0 or 1).
`offset`	`int`	Yes	The bit offset.

Returns: int|redis:Error

Sample code:

int originalBit = check redis->setBit("mybitfield", 1, 7);

Sample response:

getBit

Returns the bit value at offset in the string value stored at key.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The key.
`offset`	`int`	Yes	The bit offset.

Returns: int|redis:Error

Sample code:

int bit = check redis->getBit("mybitfield", 7);

Sample response:

bitOpAnd

Perform a bitwise AND operation between multiple strings and store the result.

Parameters:

Name	Type	Required	Description
`destination`	`string`	Yes	The destination key.
`keys`	`string[]`	Yes	The source keys.

Returns: int|redis:Error

Sample code:

int resultLen = check redis->bitOpAnd("result", ["key1", "key2"]);

Sample response:

bitOpOr

Perform a bitwise OR operation between multiple strings and store the result.

Parameters:

Name	Type	Required	Description
`destination`	`string`	Yes	The destination key.
`keys`	`string[]`	Yes	The source keys.

Returns: int|redis:Error

Sample code:

int resultLen = check redis->bitOpOr("result", ["key1", "key2"]);

Sample response:

bitOpNot

Perform a bitwise NOT operation on a string and store the result.

Parameters:

Name	Type	Required	Description
`destination`	`string`	Yes	The destination key.
`key`	`string`	Yes	The source key.

Returns: int|redis:Error

Sample code:

int resultLen = check redis->bitOpNot("result", "source");

Sample response:

bitOpXor

Perform a bitwise XOR operation between multiple strings and store the result.

Parameters:

Name	Type	Required	Description
`destination`	`string`	Yes	The destination key.
`keys`	`string[]`	Yes	The source keys.

Returns: int|redis:Error

Sample code:

int resultLen = check redis->bitOpXor("result", ["key1", "key2"]);

Sample response:

List operations

lPush

Prepend one or multiple values to a list.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The list key.
`values`	`string[]`	Yes	The values to prepend.

Returns: int|redis:Error

Sample code:

int listLen = check redis->lPush("tasks", ["task1", "task2", "task3"]);

Sample response:

rPush

Append one or multiple values to a list.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The list key.
`values`	`string[]`	Yes	The values to append.

Returns: int|redis:Error

Sample code:

int listLen = check redis->rPush("queue", ["item1", "item2"]);

Sample response:

lPop

Remove and get the first element in a list.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The list key.

Returns: string|redis:Error?

Sample code:

string? first = check redis->lPop("tasks");

Sample response:

"task3"

rPop

Remove and get the last element in a list.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The list key.

Returns: string|redis:Error?

Sample code:

string? last = check redis->rPop("tasks");

Sample response:

"task1"

lPushX

Prepend values to a list, only if the list exists.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The list key.
`values`	`string[]`	Yes	The values to prepend.

Returns: int|redis:Error

Sample code:

int listLen = check redis->lPushX("tasks", ["urgent_task"]);

Sample response:

rPushX

Append values to a list, only if the list exists.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The list key.
`values`	`string[]`	Yes	The values to append.

Returns: int|redis:Error

Sample code:

int listLen = check redis->rPushX("queue", ["late_item"]);

Sample response:

bLPop

Remove and get the first element in a list, or block until one is available.

Parameters:

Name	Type	Required	Description
`timeOut`	`int`	Yes	Timeout in seconds (0 to block indefinitely).
`keys`	`string[]`	Yes	The list keys to pop from.

Returns: map<any>|redis:Error

Sample code:

map<any> result = check redis->bLPop(30, ["queue"]);

Sample response:

{"queue": "item1"}

bRPop

Remove and get the last element in a list, or block until one is available.

Parameters:

Name	Type	Required	Description
`timeout`	`int`	Yes	Timeout in seconds (0 to block indefinitely).
`keys`	`string[]`	Yes	The list keys to pop from.

Returns: map<any>|redis:Error

Sample code:

map<any> result = check redis->bRPop(30, ["queue"]);

Sample response:

{"queue": "item2"}

lIndex

Get an element from a list by its index.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The list key.
`index`	`int`	Yes	Zero-based index (negative indices count from the end).

Returns: string|redis:Error?

Sample code:

string? element = check redis->lIndex("tasks", 0);

Sample response:

"task1"

lInsert

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

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The list key.
`before`	`boolean`	Yes	`true` to insert before the pivot, `false` to insert after.
`pivot`	`string`	Yes	The reference element.
`value`	`string`	Yes	The value to insert.

Returns: int|redis:Error

Sample code:

int listLen = check redis->lInsert("tasks", true, "task2", "task1.5");

Sample response:

lLen

Get the length of a list.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The list key.

Returns: int|redis:Error

Sample code:

int length = check redis->lLen("tasks");

Sample response:

lRange

Get a range of elements from a list.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The list key.
`startPos`	`int`	Yes	Start index (inclusive).
`stopPos`	`int`	Yes	Stop index (inclusive).

Returns: string[]|redis:Error

Sample code:

string[] elements = check redis->lRange("tasks", 0, -1);

Sample response:

["task1", "task2", "task3"]

lRem

Remove elements from a list.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The list key.
`count`	`int`	Yes	Number of occurrences to remove (0 = all, positive = from head, negative = from tail).
`value`	`string`	Yes	The value to remove.

Returns: int|redis:Error

Sample code:

int removed = check redis->lRem("tasks", 1, "task2");

Sample response:

lSet

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

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The list key.
`index`	`int`	Yes	The index of the element.
`value`	`string`	Yes	The new value.

Returns: string|redis:Error

Sample code:

string result = check redis->lSet("tasks", 0, "updated_task");

Sample response:

"OK"

lTrim

Trim a list to the specified range.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The list key.
`startPos`	`int`	Yes	Start index (inclusive).
`stopPos`	`int`	Yes	Stop index (inclusive).

Returns: string|redis:Error

Sample code:

string result = check redis->lTrim("tasks", 0, 9);

Sample response:

"OK"

rPopLPush

Remove the last element in a list, prepend it to another list, and return it.

Parameters:

Name	Type	Required	Description
`src`	`string`	Yes	The source list key.
`destination`	`string`	Yes	The destination list key.

Returns: string|redis:Error

Sample code:

string moved = check redis->rPopLPush("processing", "completed");

Sample response:

"task1"

Set operations

sAdd

Add one or more members to a set.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The set key.
`values`	`string[]`	Yes	The members to add.

Returns: int|redis:Error

Sample code:

int added = check redis->sAdd("tags", ["ballerina", "redis", "integration"]);

Sample response:

sMembers

Get all the members in a set.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The set key.

Returns: string[]|redis:Error

Sample code:

string[] members = check redis->sMembers("tags");

Sample response:

["ballerina", "redis", "integration"]

sCard

Get the number of members in a set.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The set key.

Returns: int|redis:Error

Sample code:

int count = check redis->sCard("tags");

Sample response:

sIsMember

Determine if a given value is a member of a set.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The set key.
`value`	`string`	Yes	The value to check.

Returns: boolean|redis:Error

Sample code:

boolean isMember = check redis->sIsMember("tags", "redis");

Sample response:

true

sRem

Remove one or more members from a set.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The set key.
`members`	`string[]`	Yes	The members to remove.

Returns: int|redis:Error

Sample code:

int removed = check redis->sRem("tags", ["integration"]);

Sample response:

sPop

Remove and return one or more random members from a set.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The set key.
`count`	`int`	Yes	Number of members to pop.

Returns: string[]|redis:Error?

Sample code:

string[]? popped = check redis->sPop("tags", 1);

Sample response:

["redis"]

sRandMember

Get one or multiple random members from a set without removing them.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The set key.
`count`	`int`	Yes	Number of random members to return.

Returns: string[]|redis:Error

Sample code:

string[] randomMembers = check redis->sRandMember("tags", 2);

Sample response:

["ballerina", "redis"]

sMove

Move a member from one set to another.

Parameters:

Name	Type	Required	Description
`src`	`string`	Yes	The source set key.
`destination`	`string`	Yes	The destination set key.
`member`	`string`	Yes	The member to move.

Returns: boolean|redis:Error

Sample code:

boolean moved = check redis->sMove("active_tags", "archived_tags", "old_tag");

Sample response:

true

sDiff

Return the set resulting from the difference between the first set and all successive sets.

Parameters:

Name	Type	Required	Description
`keys`	`string[]`	Yes	The set keys.

Returns: string[]|redis:Error

Sample code:

string[] diff = check redis->sDiff(["set1", "set2"]);

Sample response:

["unique_to_set1"]

sDiffStore

Store the difference between the first set and all successive sets at a destination key.

Parameters:

Name	Type	Required	Description
`destination`	`string`	Yes	The destination key.
`keys`	`string[]`	Yes	The set keys.

Returns: int|redis:Error

Sample code:

int count = check redis->sDiffStore("diff_result", ["set1", "set2"]);

Sample response:

sInter

Return the set resulting from the intersection of all provided sets.

Parameters:

Name	Type	Required	Description
`keys`	`string[]`	Yes	The set keys.

Returns: string[]|redis:Error

Sample code:

string[] common = check redis->sInter(["set1", "set2"]);

Sample response:

["common_member"]

sInterStore

Store the intersection of all provided sets at a destination key.

Parameters:

Name	Type	Required	Description
`destination`	`string`	Yes	The destination key.
`keys`	`string[]`	Yes	The set keys.

Returns: int|redis:Error

Sample code:

int count = check redis->sInterStore("inter_result", ["set1", "set2"]);

Sample response:

sUnion

Return the set resulting from the union of all provided sets.

Parameters:

Name	Type	Required	Description
`keys`	`string[]`	Yes	The set keys.

Returns: string[]|redis:Error

Sample code:

string[] all = check redis->sUnion(["set1", "set2"]);

Sample response:

["member1", "member2", "member3"]

sUnionStore

Store the union of all provided sets at a destination key.

Parameters:

Name	Type	Required	Description
`destination`	`string`	Yes	The destination key.
`keys`	`string[]`	Yes	The set keys.

Returns: int|redis:Error

Sample code:

int count = check redis->sUnionStore("union_result", ["set1", "set2"]);

Sample response:

Sorted set operations

zAdd

Add one or more members to a sorted set, or update the score of an existing member.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The sorted set key.
`memberScoreMap`	`map<any>`	Yes	A map of member names to their scores.

Returns: int|redis:Error

Sample code:

int added = check redis->zAdd("leaderboard", {
    "alice": 100.0,
    "bob": 85.0,
    "charlie": 92.0
});

Sample response:

zRange

Return a range of members in a sorted set by index (low to high).

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The sorted set key.
`min`	`int`	Yes	Start index (inclusive).
`max`	`int`	Yes	Stop index (inclusive).

Returns: string[]|redis:Error

Sample code:

string[] members = check redis->zRange("leaderboard", 0, -1);

Sample response:

["bob", "charlie", "alice"]

zRevRange

Return a range of members in a sorted set by index (high to low).

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The sorted set key.
`min`	`int`	Yes	Start index (inclusive).
`max`	`int`	Yes	Stop index (inclusive).

Returns: string[]|redis:Error

Sample code:

string[] topPlayers = check redis->zRevRange("leaderboard", 0, 2);

Sample response:

["alice", "charlie", "bob"]

zRangeByScore

Return members in a sorted set with scores within the given range (low to high).

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The sorted set key.
`min`	`float`	Yes	Minimum score (inclusive).
`max`	`float`	Yes	Maximum score (inclusive).

Returns: string[]|redis:Error

Sample code:

string[] members = check redis->zRangeByScore("leaderboard", 90.0, 100.0);

Sample response:

["charlie", "alice"]

zRevRangeByScore

Return members in a sorted set with scores within the given range (high to low).

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The sorted set key.
`min`	`float`	Yes	Minimum score (inclusive).
`max`	`float`	Yes	Maximum score (inclusive).

Returns: string[]|redis:Error

Sample code:

string[] members = check redis->zRevRangeByScore("leaderboard", 80.0, 100.0);

Sample response:

["alice", "charlie", "bob"]

zRangeByLex

Return a range of members in a sorted set by lexicographical range (lowest to highest).

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The sorted set key.
`min`	`string`	Yes	Minimum lex bound (e.g., `[a` or `-`).
`max`	`string`	Yes	Maximum lex bound (e.g., `[z` or `+`).

Returns: string[]|redis:Error

Sample code:

string[] members = check redis->zRangeByLex("names", "-", "+");

Sample response:

["alice", "bob", "charlie"]

zRevRangeByLex

Return a range of members in a sorted set by lexicographical range (highest to lowest).

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The sorted set key.
`min`	`string`	Yes	Minimum lex bound.
`max`	`string`	Yes	Maximum lex bound.

Returns: string[]|redis:Error

Sample code:

string[] members = check redis->zRevRangeByLex("names", "+", "-");

Sample response:

["charlie", "bob", "alice"]

zScore

Get the score associated with the given member in a sorted set.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The sorted set key.
`member`	`string`	Yes	The member name.

Returns: float|redis:Error

Sample code:

float score = check redis->zScore("leaderboard", "alice");

Sample response:

100.0

zRank

Determine the index of a member in a sorted set (lowest score = rank 0).

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The sorted set key.
`member`	`string`	Yes	The member name.

Returns: int|redis:Error

Sample code:

int rank = check redis->zRank("leaderboard", "alice");

Sample response:

zRevRank

Determine the index of a member in a sorted set, with scores ordered from high to low.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The sorted set key.
`member`	`string`	Yes	The member name.

Returns: int|redis:Error

Sample code:

int rank = check redis->zRevRank("leaderboard", "alice");

Sample response:

zCard

Get the number of members in a sorted set.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The sorted set key.

Returns: int|redis:Error

Sample code:

int count = check redis->zCard("leaderboard");

Sample response:

zCount

Count the members in a sorted set with scores within the given range.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The sorted set key.
`min`	`float`	Yes	Minimum score (inclusive).
`max`	`float`	Yes	Maximum score (inclusive).

Returns: int|redis:Error

Sample code:

int count = check redis->zCount("leaderboard", 90.0, 100.0);

Sample response:

zLexCount

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

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The sorted set key.
`min`	`string`	Yes	Minimum lex bound.
`max`	`string`	Yes	Maximum lex bound.

Returns: int|redis:Error

Sample code:

int count = check redis->zLexCount("names", "-", "+");

Sample response:

zIncrBy

Increment the score of a member in a sorted set.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The sorted set key.
`amount`	`float`	Yes	The increment amount.
`member`	`string`	Yes	The member name.

Returns: float|redis:Error

Sample code:

float newScore = check redis->zIncrBy("leaderboard", 10.0, "bob");

Sample response:

95.0

zRem

Remove one or more members from a sorted set.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The sorted set key.
`members`	`string[]`	Yes	The members to remove.

Returns: int|redis:Error

Sample code:

int removed = check redis->zRem("leaderboard", ["bob"]);

Sample response:

zRemRangeByRank

Remove all members in a sorted set within the given indices.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The sorted set key.
`min`	`int`	Yes	Start index.
`max`	`int`	Yes	Stop index.

Returns: int|redis:Error

Sample code:

int removed = check redis->zRemRangeByRank("leaderboard", 0, 1);

Sample response:

zRemRangeByScore

Remove all members in a sorted set within the given scores.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The sorted set key.
`min`	`float`	Yes	Minimum score.
`max`	`float`	Yes	Maximum score.

Returns: int|redis:Error

Sample code:

int removed = check redis->zRemRangeByScore("leaderboard", 0.0, 50.0);

Sample response:

zRemRangeByLex

Remove all members in a sorted set within the given lexicographical range.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The sorted set key.
`min`	`string`	Yes	Minimum lex bound.
`max`	`string`	Yes	Maximum lex bound.

Returns: int|redis:Error

Sample code:

int removed = check redis->zRemRangeByLex("names", "[a", "[b");

Sample response:

zInterStore

Intersect multiple sorted sets and store the resulting sorted set in a new key.

Parameters:

Name	Type	Required	Description
`destination`	`string`	Yes	The destination key.
`keys`	`string[]`	Yes	The sorted set keys to intersect.

Returns: int|redis:Error

Sample code:

int count = check redis->zInterStore("common_scores", ["set1", "set2"]);

Sample response:

zUnionStore

Compute the union of multiple sorted sets and store the result in a new key.

Parameters:

Name	Type	Required	Description
`destination`	`string`	Yes	The destination key.
`keys`	`string[]`	Yes	The sorted set keys to union.

Returns: int|redis:Error

Sample code:

int count = check redis->zUnionStore("all_scores", ["set1", "set2"]);

Sample response:

Hash operations

hSet

Set the string value of a hash field.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The hash key.
`field`	`string`	Yes	The field name.
`value`	`string`	Yes	The field value.

Returns: boolean|redis:Error

Sample code:

boolean isNew = check redis->hSet("user:1001", "name", "John Doe");

Sample response:

true

hGet

Get the value of a hash field.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The hash key.
`field`	`string`	Yes	The field name.

Returns: string|redis:Error

Sample code:

string name = check redis->hGet("user:1001", "name");

Sample response:

"John Doe"

hGetAll

Get all the fields and values in a hash.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The hash key.

Returns: map<any>|redis:Error

Sample code:

map<any> user = check redis->hGetAll("user:1001");

Sample response:

{"name": "John Doe", "email": "[email protected]", "age": "30"}

hMSet

Set multiple hash fields to multiple values.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The hash key.
`fieldValueMap`	`map<any>`	Yes	A map of field names to values.

Returns: string|redis:Error

Sample code:

string result = check redis->hMSet("user:1001", {
    "name": "John Doe",
    "email": "[email protected]",
    "age": "30"
});

Sample response:

"OK"

hMGet

Get the values of all the given hash fields.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The hash key.
`fields`	`string[]`	Yes	The field names to retrieve.

Returns: map<any>|redis:Error

Sample code:

map<any> values = check redis->hMGet("user:1001", ["name", "email"]);

Sample response:

{"name": "John Doe", "email": "[email protected]"}

hDel

Delete one or more hash fields.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The hash key.
`fields`	`string[]`	Yes	The field names to delete.

Returns: int|redis:Error

Sample code:

int deleted = check redis->hDel("user:1001", ["age"]);

Sample response:

hExists

Determine if a hash field exists.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The hash key.
`field`	`string`	Yes	The field name.

Returns: boolean|redis:Error

Sample code:

boolean exists = check redis->hExists("user:1001", "email");

Sample response:

true

hSetNx

Set the value of a hash field, only if the field does not exist.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The hash key.
`field`	`string`	Yes	The field name.
`value`	`string`	Yes	The field value.

Returns: boolean|redis:Error

Sample code:

boolean wasSet = check redis->hSetNx("user:1001", "role", "admin");

Sample response:

true

hKeys

Get all the fields in a hash.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The hash key.

Returns: string[]|redis:Error

Sample code:

string[] fields = check redis->hKeys("user:1001");

Sample response:

["name", "email", "age"]

hVals

Get all the values in a hash.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The hash key.

Returns: string[]|redis:Error

Sample code:

string[] values = check redis->hVals("user:1001");

Sample response:

["John Doe", "[email protected]", "30"]

hLen

Get the number of fields in a hash.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The hash key.

Returns: int|redis:Error

Sample code:

int fieldCount = check redis->hLen("user:1001");

Sample response:

hIncrBy

Increment the integer value of a hash field by the given number.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The hash key.
`field`	`string`	Yes	The field name.
`amount`	`int`	Yes	The increment amount.

Returns: int|redis:Error

Sample code:

int newAge = check redis->hIncrBy("user:1001", "age", 1);

Sample response:

hIncrByFloat

Increment the float value of a hash field by the given amount.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The hash key.
`field`	`string`	Yes	The field name.
`amount`	`float`	Yes	The float increment amount.

Returns: float|redis:Error

Sample code:

float newBalance = check redis->hIncrByFloat("account:1001", "balance", 25.50);

Sample response:

125.50

hStrLen

Get the string length of the value associated with a field in a hash.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The hash key.
`field`	`string`	Yes	The field name.

Returns: int|redis:Error

Sample code:

int length = check redis->hStrLen("user:1001", "name");

Sample response:

Key operations

del

Delete one or more keys.

Parameters:

Name	Type	Required	Description
`keys`	`string[]`	Yes	The keys to delete.

Returns: int|redis:Error

Sample code:

int deleted = check redis->del(["key1", "key2", "key3"]);

Sample response:

exists

Determine how many of the specified keys exist.

Parameters:

Name	Type	Required	Description
`keys`	`string[]`	Yes	The keys to check.

Returns: int|redis:Error

Sample code:

int count = check redis->exists(["name", "counter", "nonexistent"]);

Sample response:

expire

Set a key's time to live in seconds.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The key.
`seconds`	`int`	Yes	Expiration time in seconds.

Returns: boolean|redis:Error

Sample code:

boolean result = check redis->expire("session:abc", 3600);

Sample response:

true

pExpire

Set a key's time to live in milliseconds.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The key.
`expirationTime`	`int`	Yes	Expiration time in milliseconds.

Returns: boolean|redis:Error

Sample code:

boolean result = check redis->pExpire("temp:data", 5000);

Sample response:

true

ttl

Get the time to live for a key in seconds.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The key.

Returns: int|redis:Error

Sample code:

int remainingSeconds = check redis->ttl("session:abc");

Sample response:

pTtl

Get the time to live for a key in milliseconds.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The key.

Returns: int|redis:Error

Sample code:

int remainingMs = check redis->pTtl("temp:data");

Sample response:

persist

Remove the expiration from a key.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The key.

Returns: boolean|redis:Error

Sample code:

boolean result = check redis->persist("session:abc");

Sample response:

true

keys

Find all keys matching the given pattern.

Parameters:

Name	Type	Required	Description
`pattern`	`string`	Yes	The glob-style pattern to match (e.g., `user:*`).

Returns: string[]|redis:Error

Sample code:

string[] matchingKeys = check redis->keys("user:*");

Sample response:

["user:1001", "user:1002", "user:1003"]

rename

Rename a key.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The current key name.
`newName`	`string`	Yes	The new key name.

Returns: string|redis:Error

Sample code:

string result = check redis->rename("old_key", "new_key");

Sample response:

"OK"

renameNx

Rename a key, only if the new key does not exist.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The current key name.
`newName`	`string`	Yes	The new key name.

Returns: boolean|redis:Error

Sample code:

boolean renamed = check redis->renameNx("old_key", "new_key");

Sample response:

true

move

Move a key to another database.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The key to move.
`database`	`int`	Yes	The target database index.

Returns: boolean|redis:Error

Sample code:

boolean moved = check redis->move("temp_key", 1);

Sample response:

true

sort

Sort the elements in a list, set, or sorted set.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The key to sort.

Returns: string[]|redis:Error

Sample code:

string[] sorted = check redis->sort("numbers");

Sample response:

["1", "2", "3", "5", "8"]

randomKey

Return a random key from the keyspace.

Returns: string|redis:Error?

Sample code:

string? key = check redis->randomKey();

Sample response:

"user:1002"

redisType

Determine the type stored at a key.

Parameters:

Name	Type	Required	Description
`key`	`string`	Yes	The key to inspect.

Returns: string|redis:Error

Sample code:

string keyType = check redis->redisType("user:1001");

Sample response:

"hash"

Connection operations

ping

Ping the server to test connectivity.

Returns: string|redis:Error

Sample code:

string response = check redis->ping();

Sample response:

"PONG"

auth

Authenticate to the server.

Parameters:

Name	Type	Required	Description
`password`	`string`	Yes	The authentication password.

Returns: string|redis:Error

Sample code:

string result = check redis->auth("my_password");

Sample response:

"OK"

echo

Echo the given string back from the server.

Parameters:

Name	Type	Required	Description
`message`	`string`	Yes	The message to echo.

Returns: string|redis:Error

Sample code:

string response = check redis->echo("Hello Redis");

Sample response:

"Hello Redis"

Close the connection to the Redis server.

Returns: redis:Error?

Sample code:

check redis.close();

Cluster operations

clusterInfo

Retrieve information and statistics about the Redis cluster.

Returns: string[]|redis:Error

Sample code:

string[] info = check redis->clusterInfo();

Sample response:

["cluster_enabled:1", "cluster_state:ok", "cluster_slots_assigned:16384", "cluster_slots_ok:16384", "cluster_known_nodes:6", "cluster_size:3"]

Client​

Configuration​

Configuration types​

ConnectionUri​

ConnectionParams​

Options​

KeepAliveConfig​

SecureSocket​

CertKey​

SslVerifyMode​

Initializing the client​

Operations​

String operations​

List operations​

Set operations​

Sorted set operations​

Hash operations​

Key operations​

Connection operations​

Cluster operations​

Client

Configuration

Configuration types

`ConnectionUri`

`ConnectionParams`

`Options`

`KeepAliveConfig`

`SecureSocket`

`CertKey`

`SslVerifyMode`

Initializing the client

Operations

String operations

List operations

Set operations

Sorted set operations

Hash operations

Key operations

Connection operations

Cluster operations