Ballerina library

redis

Module redis

OverviewSetup guideQuickstartExamples

API

Client

Declarations

SslVerifyMode

Definitions

CertKey
ConnectionConfig
ConnectionParams
Options
SecureSocket

Error

ballerinax/redis Ballerina library

3.0.1

Overview

Redis is an open-source, in-memory data structure store that can be used as a database, cache, and message broker. It supports various data structures such as strings, hashes, lists, sets, and more.

The ballerinax/redis package offers APIs to connect to Redis servers and to manipulate key-value data, providing functionality to utilize Redis both as a database and cache. The current connector is compatible Redis server versions up to 7.2.x.

Setup guide

To use the Redis connector, you need to have a Redis server running and accessible. For that, you can either install Redis locally or use a cloud-based Redis service.

Setting up a Redis server locally

Step 1: Install Redis server

  1. Download and install Redis from the official website.

  2. Follow the installation instructions based on your operating system.

Step 2: Start Redis server

To start the Redis server, open a terminal and execute the following command.

Copy
redis-server

Step 3: Verify Redis connectivity

After starting the Redis server, you can verify the connectivity using the Redis CLI. Open a new terminal and execute the following command.

Copy
redis-cli ping

If the server is running, you will receive a response of "PONG".

Setting up a cloud-based Redis service

Several cloud providers offer managed Redis services. Some of the popular ones are:

  1. Redis Labs: Redis Labs offers Redis Enterprise Cloud, a fully-managed Redis service in the cloud.
  2. Amazon ElastiCache: Amazon Web Services provides ElastiCache, a managed Redis service for deploying, operating, and scaling Redis in the AWS Cloud.
  3. Google Cloud Memorystore: Google Cloud offers Memorystore for Redis, a fully-managed Redis service on Google Cloud Platform.
  4. Microsoft Azure Cache for Redis: Azure Cache for Redis is a fully-managed Redis service provided by Microsoft Azure.

Choose the hosting solution that best fits your requirements and proceed with its setup instructions.

Quickstart

To use the redis connector in your Ballerina application, follow the steps below:

Step 1: Import the module

Import the redis module.

Copy
import ballerinax/redis;

Step 2: Instantiate a new connector

Create a redis:ConnectionConfig instance by giving the Redis server configuration and initialize the Ballerina Redis client using it.

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

Step 3: Invoke the connector operation

Now, you can use the available connector operations to interact with Redis.

Set a key-value pair

Copy
check redis->set("key", "value");

Get value by key

Copy
string value = check redis->get("key");

Step 4: Run the Ballerina application

Save the changes and run the Ballerina application using the following command.

Copy
bal run

Examples

The Redis connector provides practical examples illustrating usage in various scenarios. Explore these examples covering common Redis operations.

  1. Cache management - Implement caching using Redis to improve application performance.

  2. Session management - Use Redis to manage user sessions efficiently.

  3. Rate limiting - Implement rate limiting for API endpoints using Redis.

Clients

redis: Client

Isolated

Ballerina Redis connector provides the capability to access Redis cache. This connector lets you to perform operations to access and manipulate key-value data stored in a Redis database.

Constructor

Initialize the Redis client.

init (*ConnectionConfig config)

append

Isolated FunctionRemote Function
function append(string key, string value) returns int|Error

Append a value to a key.

Parameters
  • key string - Key referring to a value
  • value string - String value to be appended
Return Type
  • int|Error - Length of the string after the operation

bitCount

Isolated FunctionRemote Function
function bitCount(string key) returns int|Error

Count set bits in a string.

Parameters
  • key string - Key referring to a value
Return Type
  • int|Error - Number of bits of the value

bitOpAnd

Isolated FunctionRemote Function
function bitOpAnd(string destination, string[] keys) returns int|Error

Perform bitwise AND between strings.

Parameters
  • destination string - Result key of the operation
  • keys string[] - Input keys to perform AND between
Return Type
  • int|Error - Size of the string stored in the destination key, that is equal to the size of the longest input string

bitOpOr

Isolated FunctionRemote Function
function bitOpOr(string destination, string[] keys) returns int|Error

Perform bitwise OR between strings.

Parameters
  • destination string - Result key of the operation
  • keys string[] - Input keys to perform OR between
Return Type
  • int|Error - Size of the string stored in the destination key, that is equal to the size of the longest input string or redis:Error if an error occurs

bitOpNot

Isolated FunctionRemote Function
function bitOpNot(string destination, string key) returns int|Error

Perform bitwise NOT on a string.

Parameters
  • destination string - Result key of the operation
  • key string - Input key to perform NOT
Return Type
  • int|Error - Size of the string stored in the destination key or redis:Error if an error occurs

bitOpXor

Isolated FunctionRemote Function
function bitOpXor(string destination, string[] keys) returns int|Error

Perform bitwise XOR between strings.

Parameters
  • destination string - Result key of the operation
  • keys string[] - Input keys to perform XOR between
Return Type
  • int|Error - Size of the string stored in the destination key, that is equal to the size of the longest input string or redis:Error if an error occurs

decr

Isolated FunctionRemote Function
function decr(string key) returns int|Error

Decrement integer value of a key by one.

Parameters
  • key string - Key referring to a value
Return Type
  • int|Error - Value of key after the decrement

decrBy

Isolated FunctionRemote Function
function decrBy(string key, int value) returns int|Error

Decrement integer value of a key by the given number.

Parameters
  • key string - Key referring to a value
  • value int - Value to be decremented
Return Type
  • int|Error - Value of key after decrement or redis:Error if an error occurs

getBit

Isolated FunctionRemote Function
function getBit(string key, int offset) returns int|Error

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

Parameters
  • key string - Key referring to a value
  • offset int - Offset in string value
Return Type
  • int|Error - Bit value stored at offset or redis:Error if an error occurs

getRange

Isolated FunctionRemote Function
function getRange(string key, int startPos, int end) returns string|Error

Get substring of string stored at a key.

Parameters
  • key string - Key referring to a value
  • startPos int - Starting point of substring
  • end int - End point of substring
Return Type
  • string|Error - Substring or redis:Error if an error occurs

getSet

Isolated FunctionRemote Function
function getSet(string key, string value) returns string|Error?

Set string value of key and return its existing value.

Parameters
  • key string - Key referring to a value
  • value string - Value to be set
Return Type
  • string|Error? - Existing value stored at key, or nil when key does not exist or redis:Error if an error occurs

get

Isolated FunctionRemote Function
function get(string key) returns string|Error?

Get value of key.

Parameters
  • key string - Key referring to a value
Return Type
  • string|Error? - Value of key, or nil when key does not exist or redis:Error if an error occurs

incr

Isolated FunctionRemote Function
function incr(string key) returns int|Error

Increment integer value of a key by one.

Parameters
  • key string - Key referring to a value
Return Type
  • int|Error - Value of key after increment

incrBy

Isolated FunctionRemote Function
function incrBy(string key, int value) returns int|Error

Increment integer value of key by the given amount.

Parameters
  • key string - Key referring to a value
  • value int - Amount to increment
Return Type
  • int|Error - Value of key after increment

incrByFloat

Isolated FunctionRemote Function
function incrByFloat(string key, float value) returns float|Error

Increment integer value of key by the given float.

Parameters
  • key string - Key referring to a value
  • value float - Amount to increment
Return Type

mGet

Isolated FunctionRemote Function
function mGet(string[] keys) returns string[]|Error

Get values of all given keys.

Parameters
  • keys string[] - Keys of which values need to be retrieved
Return Type

mSet

Isolated FunctionRemote Function
function mSet(map<any> keyValueMap) returns string|Error

Set multiple keys to multiple values.

Parameters
  • keyValueMap map<any> - Map of key-value pairs to be set
Return Type
  • string|Error - String with value OK if the operation was successful

mSetNx

Isolated FunctionRemote Function
function mSetNx(map<any> keyValueMap) returns boolean|Error

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

Parameters
  • keyValueMap map<any> - Map of key-value pairs to be set
Return Type
  • boolean|Error - True if the operation was successful, false if it failed

pSetEx

Isolated FunctionRemote Function
function pSetEx(string key, string value, int expirationTime) returns string|Error

Set value and expiration in milliseconds of a key.

Parameters
  • key string - Key referring to a value
  • value string - Value to be set
  • expirationTime int - Expiration time in milli seconds
Return Type
  • string|Error - OK if successful or redis:Error if an error occurs

set

Isolated FunctionRemote Function
function set(string key, string value) returns string|Error

Set the value of a key.

Parameters
  • key string - Key referring to a value
Return Type

setBit

Isolated FunctionRemote Function
function setBit(string key, int value, int offset) returns int|Error

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

Parameters
  • key string - Key referring to a value
  • value int - Value to be set
  • offset int - Offset at which the value should be set
Return Type
  • int|Error - Original bit value stored at offset or redis:Error if an error occurs

setEx

Isolated FunctionRemote Function
function setEx(string key, string value, int expirationTime) returns string|Error

Set the value and expiration of a key.

Parameters
  • key string - Key referring to a value
  • value string - Value to be set
  • expirationTime int - Expiration time to be set, in seconds
Return Type
  • string|Error - On success OK or redis:Error if an error occurs

setNx

Isolated FunctionRemote Function
function setNx(string key, string value) returns boolean|Error

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

Parameters
  • key string - Key referring to a value
  • value string - Value to be set
Return Type
  • boolean|Error - True if exist False if not or redis:Error if an error occurs

setRange

Isolated FunctionRemote Function
function setRange(string key, int offset, string value) returns int|Error

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

Parameters
  • key string - Key referring to a value
  • offset int - Offset at which the value should be set
  • value string - Value to be set
Return Type
  • int|Error - Length of the string after it was modified or redis:Error if an error occurs

strLen

Isolated FunctionRemote Function
function strLen(string key) returns int|Error

Get length of value stored in a key.

Parameters
  • key string - Key referring to a value
Return Type
  • int|Error - Length of string at key, or 0 when key does not exist or redis:Error if an error occurs

lPush

Isolated FunctionRemote Function
function lPush(string key, string[] values) returns int|Error

Prepend one or multiple values to list.

Parameters
  • key string - Key referring to a value
  • values string[] - Values to be prepended
Return Type
  • int|Error - Length of list after the push operation(s) or redis:Error if an error occurs

lPop

Isolated FunctionRemote Function
function lPop(string key) returns string|Error?

Remove and get the first element in a list.

Parameters
  • key string - Key referring to a value
Return Type
  • string|Error? - Value of the first element, or nil when key does not exist or redis:Error if an error occurs

lPushX

Isolated FunctionRemote Function
function lPushX(string key, string[] values) returns int|Error

Prepend one or multiple values to a list, only if the list exists.

Parameters
  • key string - Key referring to a value
  • values string[] - Values to be prepended
Return Type
  • int|Error - Length of the list after the push operation(s)

bLPop

Isolated FunctionRemote Function
function bLPop(int timeOut, string[] keys) returns map<any>|Error

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

Parameters
  • timeOut int - Timeout in seconds
  • keys string[] - Keys referring to values
Return Type
  • map<any>|Error - Nil when no element could be popped and the timeout expired. A map containing one item, with the key being the name of the key where an element was popped and the second element being the value of the popped element, or redis:Error if an error occurs

bRPop

Isolated FunctionRemote Function
function bRPop(int timeout, string[] keys) returns map<any>|Error

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

Parameters
  • timeout int - Timeout in seconds
  • keys string[] - Keys referring to values
Return Type
  • map<any>|Error - nil when no element could be popped and the timeout expired. A map containing one item, with the key being the name of the key where an element was popped and the second element being the value of the popped element, or redis:Error if an error occurs

lIndex

Isolated FunctionRemote Function
function lIndex(string key, int index) returns string|Error?

Get an element from list by its index.

Parameters
  • key string - Key referring to a value
  • index int - Index from which the element should be retrieved
Return Type

lInsert

Isolated FunctionRemote Function
function lInsert(string key, boolean before, string pivot, string value) returns int|Error

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

Parameters
  • key string - Key referring to a value
  • before boolean - Boolean value representing Whether element should be inserted before or after the pivot
  • pivot string - Pivot position
  • value string - Value to insert
Return Type
  • int|Error - Length of the list after the insert operation, or -1 when the value pivot not found, or redis:Error if an error occurs

lLen

Isolated FunctionRemote Function
function lLen(string key) returns int|Error

Get length of a list.

Parameters
  • key string - Key referring to a value
Return Type
  • int|Error - Length of list at key or redis:Error if an error occurs

lRange

Isolated FunctionRemote Function
function lRange(string key, int startPos, int stopPos) returns string[]|Error

Get a range of elements from a list.

Parameters
  • key string - Key referring to a value
  • startPos int - Begining index of the range
  • stopPos int - Last index of the range
Return Type
  • string[]|Error - Array of elements in the specified range or redis:Error if an error occurs

lRem

Isolated FunctionRemote Function
function lRem(string key, int count, string value) returns int|Error

Remove elements from list.

Parameters
  • key string - Key referring to a value
  • count int - Number of elements to be removed
  • value string - Value which the elements to be removed should be equal to
Return Type
  • int|Error - Number of elements removed or redis:Error if an error occurs

lSet

Isolated FunctionRemote Function
function lSet(string key, int index, string value) returns string|Error

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

Parameters
  • index int - Index of the element of which the value needs to be set
  • value string - Value to be set
Return Type
  • string|Error - String with the value OK if the operation was successful or redis:Error if an error occurs

lTrim

Isolated FunctionRemote Function
function lTrim(string key, int startPos, int stopPos) returns string|Error

Trim list to the specified range.

Parameters
  • startPos int - Starting index of the range
  • stopPos int - End index of the range
Return Type
  • string|Error - String with the value OK if the operation was successful

rPop

Isolated FunctionRemote Function
function rPop(string key) returns string|Error?

Remove and get the last element in a list.

Parameters
Return Type
  • string|Error? - Value of the last element, or nil when key does not exist or redis:Error if an error occurs

rPopLPush

Isolated FunctionRemote Function
function rPopLPush(string src, string destination) returns string|Error

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

Parameters
  • destination string - Destination key
Return Type
  • string|Error - Element being popped and pushed or redis:Error if an error occurs

rPush

Isolated FunctionRemote Function
function rPush(string key, string[] values) returns int|Error

Append one or multiple values to a list.

Parameters
  • values string[] - Array of values to be appended
Return Type
  • int|Error - Length of the list after the push operation or redis:Error if an error occurs

rPushX

Isolated FunctionRemote Function
function rPushX(string key, string[] values) returns int|Error

Append one or multiple values to a list, only if the list exists.

Parameters
  • values string[] - Array of values to be appended
Return Type
  • int|Error - Length of the list after the push operation or redis:Error if an error occurs

sAdd

Isolated FunctionRemote Function
function sAdd(string key, string[] values) returns int|Error

Add one or more members to a set.

Parameters
  • values string[] - Array of values to be added
Return Type
  • int|Error - Number of elements that were added to the set, not including all the elements which were already present in the set, or redis:Error if an error occurs

sCard

Isolated FunctionRemote Function
function sCard(string key) returns int|Error

Get the number of members in a set

Parameters
Return Type
  • int|Error - Cardinality (number of elements) of the set or redis:Error if an error occurs

sDiff

Isolated FunctionRemote Function
function sDiff(string[] keys) returns string[]|Error

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

Parameters
  • keys string[] - The keys of the sets
Return Type
  • string[]|Error - An array of members of the resulting set or redis:Error if an error occurs

sDiffStore

Isolated FunctionRemote Function
function sDiffStore(string destination, string[] keys) returns int|Error

Obtain the set resulting from the difference between the first set and all the successive. sets and store at the provided destination.

Parameters
  • destination string - Destination key of the resulting set
  • keys string[] - Keys of the sets to find the difference of
Return Type
  • int|Error - Number of members in the resulting set or redis:Error if an error occurs

sInter

Isolated FunctionRemote Function
function sInter(string[] keys) returns string[]|Error

Return the intersection of the provided sets.

Parameters
  • keys string[] - Keys of the sets to be intersected
Return Type
  • string[]|Error - Array of members of the resulting set or redis:Error if an error occurs

sInterStore

Isolated FunctionRemote Function
function sInterStore(string destination, string[] keys) returns int|Error

Obtain the intersection of the provided sets and store at the provided destination.

Parameters
  • destination string - Destination key of the resulting set
  • keys string[] - Keys of the sets to be intersected
Return Type
  • int|Error - Number of members of the resulting set or redis:Error if an error occurs

sIsMember

Isolated FunctionRemote Function
function sIsMember(string key, string value) returns boolean|Error

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

Parameters
  • value string - Value of a key
Return Type
  • boolean|Error - boolean true/false depending on whether the value is a member of the set or not, or redis:Error if an error occurs

sMembers

Isolated FunctionRemote Function
function sMembers(string key) returns string[]|Error

Get all members in a set.

Parameters
Return Type
  • string[]|Error - Array of all members in the set or redis:Error if an error occurs

sMove

Isolated FunctionRemote Function
function sMove(string src, string destination, string member) returns boolean|Error

Move a member from one set to another.

Parameters
  • destination string - Destination key
  • member string - Member to be moved
Return Type
  • boolean|Error - True if the element is moved. false if the element is not a member of source and no operation was performed or redis:Error if an error occurs

sPop

Isolated FunctionRemote Function
function sPop(string key, int count) returns string[]|Error?

Remove and return a random member from a set.

Parameters
  • count int - Number of members to pop
Return Type
  • string[]|Error? - Array of removed elements or nil if key does not exist or redis:Error if an error occurs

sRandMember

Isolated FunctionRemote Function
function sRandMember(string key, int count) returns string[]|Error

Get one or multiple random members from a set.

Parameters
  • count int - Number of members to obtain
Return Type
  • string[]|Error - Array of the randomly selected elements, or nil when key does not exist or redis:Error if an error occurs

sRem

Isolated FunctionRemote Function
function sRem(string key, string[] members) returns int|Error

Remove one or more members from a set.

Parameters
  • members string[] - Array of members to remove
Return Type
  • int|Error - Number of members that were removed from the set, not including non existing members or redis:Error if an error occurs

sUnion

Isolated FunctionRemote Function
function sUnion(string[] keys) returns string[]|Error

Return the union of multiple sets.

Parameters
  • keys string[] - Array of keys of sets
Return Type
  • string[]|Error - Array of members of the resulting set or redis:Error if an error occurs

sUnionStore

Isolated FunctionRemote Function
function sUnionStore(string destination, string[] keys) returns int|Error

Return the union of multiple sets.

Parameters
  • destination string - Destination key of the resulting set
  • keys string[] - Array of keys of sets
Return Type
  • int|Error - Number of members of the resulting set or redis:Error if an error occurs

zAdd

Isolated FunctionRemote Function
function zAdd(string key, map<any> memberScoreMap) returns int|Error

Add one or more members to a sorted set, or update its score if it already exist.

Parameters
  • key string - Key of the sorted set
  • memberScoreMap map<any> - Map of members and corresponding scores
Return Type
  • int|Error - Number of elements that were added to the sorted set, not including all the elements which were already present in the set for which the score was updated, or redis:Error if an error occurs

zCard

Isolated FunctionRemote Function
function zCard(string key) returns int|Error

Get the number of members in a sorted set.

Parameters
  • key string - Key of the sorted set
Return Type
  • int|Error - Cardinality (number of elements) of the sorted set or redis:Error if an error occurs

zCount

Isolated FunctionRemote Function
function zCount(string key, float min, float max) returns int|Error

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

Parameters
  • key string - Key of the sorted set
  • min float - Minimum score of the range
  • max float - Maximum score of the range
Return Type
  • int|Error - Number of elements in the specified score range or redis:Error if an error occurs

zIncrBy

Isolated FunctionRemote Function
function zIncrBy(string key, float amount, string member) returns float|Error

Increment the score of a member in a sorted set.

Parameters
  • key string - Key of the sorted set
  • amount float - Amount to increment
  • member string - Member whose score to be incremented
Return Type
  • float|Error - New score of the member or redis:Error if an error occurs

zInterStore

Isolated FunctionRemote Function
function zInterStore(string destination, string[] keys) returns int|Error

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

Parameters
  • destination string - Destination key of the resulting sorted set
  • keys string[] - Keys of the sorted sets to be intersected
Return Type
  • int|Error - Number of elements in the resulting sorted set or redis:Error if an error occurs

zLexCount

Isolated FunctionRemote Function
function zLexCount(string key, string min, string max) returns int|Error

Count the members in a sorted set within the given lexicographical range.

Parameters
  • key string - Key of the sorted set
  • min string - Minimum lexicographical value of the range
  • max string - Maximum lexicographical value of the range
Return Type
  • int|Error - Number of elements in the specified lexicographical value range or redis:Error if an error occurs

zRange

Isolated FunctionRemote Function
function zRange(string key, int min, int max) returns string[]|Error

Return a range of members in a sorted set, by index.

Parameters
  • key string - Key of the sorted set
  • min int - Minimum index of the range
  • max int - Maximum index of the range
Return Type
  • string[]|Error - Range of members in a sorted set, by index, or redis:Error if an error occurs

zRangeByLex

Isolated FunctionRemote Function
function zRangeByLex(string key, string min, string max) returns string[]|Error

Return a range of members in a sorted set, by lexicographical range from lowest to highest.

Parameters
  • key string - Key of the sorted set
  • min string - Minimum lexicographical value of the range
  • max string - Maximum lexicographical value of the range
Return Type
  • string[]|Error - Array of members in the specified lexicographical value range ordered from lowest to highest or redis:Error if an error occurs

zRevRangeByLex

Isolated FunctionRemote Function
function zRevRangeByLex(string key, string min, string max) returns string[]|Error

Return a range of members in a sorted set, by lexicographical range ordered from highest to lowest.

Parameters
  • key string - Key of the sorted set
  • min string - Lexicographical value of the range
  • max string - Maximum lexicographical value of the range
Return Type
  • string[]|Error - Array of members in the specified lexicographical value range ordered from highest to lowest or redis:Error if an error occurs

zRangeByScore

Isolated FunctionRemote Function
function zRangeByScore(string key, float min, float max) returns string[]|Error

Return a range of members in a sorted set, by score from lowest to highest.

Parameters
  • key string - Key of sorted set
  • min float - Minimum score of range
  • max float - Maximum score of range
Return Type
  • string[]|Error - Array of members in the specified score range ordered from lowest to highest or redis:Error if an error occurs

zRank

Isolated FunctionRemote Function
function zRank(string key, string member) returns int|Error

Determine index of a member in a sorted set.

Parameters
  • key string - Key of the sorted set
  • member string - Member of which the index needs to be obtained
Return Type
  • int|Error - Index of the member or redis:Error if an error occurs

zRem

Isolated FunctionRemote Function
function zRem(string key, string[] members) returns int|Error

Remove one or more members from a sorted set

Parameters
  • key string - Key of the sorted set
  • members string[] - Members to be removed
Return Type
  • int|Error - Number of members removed from the sorted set, not including non existing members or redis:Error if an error occurs

zRemRangeByLex

Isolated FunctionRemote Function
function zRemRangeByLex(string key, string min, string max) returns int|Error

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

Parameters
  • key string - Key of the sorted set
  • min string - Minimum lexicographical value of the range
  • max string - Maximum lexicographical value of the range
Return Type
  • int|Error - Number of members removed from the sorted set or redis:Error if an error occurs

zRemRangeByRank

Isolated FunctionRemote Function
function zRemRangeByRank(string key, int min, int max) returns int|Error

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

Parameters
  • key string - Key of the sorted set
  • min int - Minimum index of the range
  • max int - Maximum index of the range
Return Type
  • int|Error - Number of members removed from the sorted set or redis:Error if an error occurs

zRemRangeByScore

Isolated FunctionRemote Function
function zRemRangeByScore(string key, float min, float max) returns int|Error

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

Parameters
  • key string - Key of the sorted set
  • min float - Minimum score of the range
  • max float - Maximum score of the range
Return Type
  • int|Error - Number of members removed from the sorted set or redis:Error if an error occurs

zRevRange

Isolated FunctionRemote Function
function zRevRange(string key, int min, int max) returns string[]|Error

Return a range of members in a sorted set, by index, ordered highest to lowest.

Parameters
  • key string - Key of the sorted set
  • min int - Minimum index of the range
  • max int - Maximum index of the range
Return Type
  • string[]|Error - Number of elements in the specified index range or redis:Error if an error occurs

zRevRangeByScore

Isolated FunctionRemote Function
function zRevRangeByScore(string key, float min, float max) returns string[]|Error

Return a range of members in a sorted set, by score from highest to lowest.

Parameters
  • key string - Key of the sorted set
  • min float - Minimum score of the range
  • max float - Maximum score of the range
Return Type
  • string[]|Error - Array of members in the specified score range ordered from highest to lowest or redis:Error if an error occurs

zRevRank

Isolated FunctionRemote Function
function zRevRank(string key, string member) returns int|Error

Determine the index of a member in a sorted set

Parameters
  • key string - Key of the sorted set
  • member string - Member of which the index needs to be obtained
Return Type
  • int|Error - Index of the member or redis:Error if an error occurs

zScore

Isolated FunctionRemote Function
function zScore(string key, string member) returns float|Error

Determine the score of a member in a sorted set

Parameters
  • key string - Key of the sorted set
  • member string - Member of which the score needs to be obtained
Return Type
  • float|Error - Score of the member or redis:Error if an error occurs

zUnionStore

Isolated FunctionRemote Function
function zUnionStore(string destination, string[] keys) returns int|Error

Return the union of multiple sorted sets

Parameters
  • destination string - Destination key of the resulting set
  • keys string[] - Array of keys of sorted sets
Return Type
  • int|Error - Number of members of the resulting sorted set or redis:Error if an error occurs

hDel

Isolated FunctionRemote Function
function hDel(string key, string[] fields) returns int|Error

Delete one or more hash fields.

Parameters
  • fields string[] - Array of fields to be deleted
Return Type
  • int|Error - Number of fields that were removed from the hash, not including specified but non existing fields or redis:Error if an error occurs

hExists

Isolated FunctionRemote Function
function hExists(string key, string 'field) returns boolean|Error

Determine if a hash field exists.

Parameters
Return Type
  • boolean|Error - Boolean true if the hash contains the field. boolean false if the hash does not contain field or key does not exist or redis:Error if an error occurs

hGet

Isolated FunctionRemote Function
function hGet(string key, string 'field) returns string|Error

Get the value of a hash field.

Parameters
Return Type
  • string|Error - Value of the field or redis:Error if an error occurs

hGetAll

Isolated FunctionRemote Function
function hGetAll(string key) returns map<any>|Error

Get the all values of a hash.

Parameters
Return Type
  • map<any>|Error - Map of field-value pairs or redis:Error if an error occurs

hIncrBy

Isolated FunctionRemote Function
function hIncrBy(string key, string 'field, int amount) returns int|Error

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

Parameters
  • amount int - Amount to increment
Return Type
  • int|Error - Value of the field or redis:Error if an error occurs

hIncrByFloat

Isolated FunctionRemote Function
function hIncrByFloat(string key, string 'field, float amount) returns float|Error

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

Parameters
  • amount float - Amount to increment
Return Type
  • float|Error - Value of the field or redis:Error if an error occurs

hKeys

Isolated FunctionRemote Function
function hKeys(string key) returns string[]|Error

Get all the fields in a hash.

Parameters
Return Type
  • string[]|Error - Array of hash fields or redis:Error if an error occurs

hLen

Isolated FunctionRemote Function
function hLen(string key) returns int|Error

Get the number of fields in a hash.

Parameters
Return Type
  • int|Error - Number of fields or redis:Error if an error occurs

hMGet

Isolated FunctionRemote Function
function hMGet(string key, string[] fields) returns map<any>|Error

Get the values of all the given hash fields.

Parameters
  • fields string[] - Array of hash fields
Return Type
  • map<any>|Error - Map of field-value pairs or redis:Error if an error occurs

hMSet

Isolated FunctionRemote Function
function hMSet(string key, map<any> fieldValueMap) returns string|Error

Set multiple hash fields to multiple values.

Parameters
  • fieldValueMap map<any> - Map of field-value pairs
Return Type
  • string|Error - String with the value OK if the operation was successful, or redis:Error if an error occurs

hSet

Isolated FunctionRemote Function
function hSet(string key, string 'field, string value) returns boolean|Error

Set the string value of a hash field.

Parameters
  • value string - Value to be set to the field
Return Type
  • boolean|Error - Boolean true if field is a new field in the hash and value was set. boolean false if field already exists in the hash and the value was updated, or redis:Error if an error occurs

hSetNx

Isolated FunctionRemote Function
function hSetNx(string key, string 'field, string value) returns boolean|Error

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

Parameters
  • value string - Value to be set to the field
Return Type
  • boolean|Error - Boolean true if field is a new field in the hash and value was set. boolean false if field already exists in the hash and no operation was performed, or redis:Error if an error occurs

hStrLen

Isolated FunctionRemote Function
function hStrLen(string key, string 'field) returns int|Error

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

Parameters
Return Type
  • int|Error - Length of the field value, or 0 when field is not present in the hash or key does not exist at all, or redis:Error if an error occurs

hVals

Isolated FunctionRemote Function
function hVals(string key) returns string[]|Error

Get all the values in a hash.

Parameters
Return Type
  • string[]|Error - Array of values in the hash, or an empty array when key does not exist or redis:Error if an error occurs

del

Isolated FunctionRemote Function
function del(string[] keys) returns int|Error

Delete one or more keys.

Parameters
  • keys string[] - Key to be deleted
Return Type
  • int|Error - Number of keys that were removed

exists

Isolated FunctionRemote Function
function exists(string[] keys) returns int|Error

Determine how many keys exist.

Parameters
  • keys string[] - Keys of which existence to be found out
Return Type
  • int|Error - Number of existing keys or redis:Error if an error occurs

expire

Isolated FunctionRemote Function
function expire(string key, int seconds) returns boolean|Error

Set a key's time to live in seconds.

Parameters
  • key string - Keys of which expiry time to be set
  • seconds int - Expiry in seconds
Return Type
  • boolean|Error - Boolean true if the timeout was set. false if key does not exist or the timeout could not be set or redis:Error if an error occurs

keys

Isolated FunctionRemote Function
function keys(string pattern) returns string[]|Error

Find all keys matching the given pattern.

Parameters
  • pattern string - Pattern to match
Return Type
  • string[]|Error - Array of keys matching the given pattern or redis:Error if an error occurs

move

Isolated FunctionRemote Function
function move(string key, int database) returns boolean|Error

Move a key to another database.

Parameters
  • database int - Database to which the key needs to be moved
Return Type
  • boolean|Error - Boolean true if key was succesfully moved, boolean false otherwise or redis:Error if an error occurs

persist

Isolated FunctionRemote Function
function persist(string key) returns boolean|Error

Remove the expiration from a key.

Parameters
  • key string - Key of which expiry time should be removed
Return Type
  • boolean|Error - Boolean true if the timeout was removed. boolean false if key does not exist or does not have an associated timeout, or redis:Error if an error occurs

pExpire

Isolated FunctionRemote Function
function pExpire(string key, int expirationTime) returns boolean|Error

Set a key's time to live in milliseconds.

Parameters
  • key string - Key of which expiry time should be removed
  • expirationTime int - Expiry time in milli seconds
Return Type
  • boolean|Error - Boolean true if the timeout was set. boolean false if key does not exist or the timeout could not be set, or redis:Error if an error occurs

pTtl

Isolated FunctionRemote Function
function pTtl(string key) returns int|Error

Get the time to live for a key in milliseconds.

Parameters
  • key string - Key of which time-to-live should be obtained
Return Type
  • int|Error - TTL of the key, in milli seconds or redis:Error if an error occurs

randomKey

Isolated FunctionRemote Function
function randomKey() returns string|Error?

Return a random key from the keyspace.

Return Type
  • string|Error? - Random key, or nil when the database is empty or redis:Error if an error occurs

rename

Isolated FunctionRemote Function
function rename(string key, string newName) returns string|Error

Rename a key.

Parameters
  • key string - Key to be renamed
  • newName string - New name of the key
Return Type
  • string|Error - String with the value OK if the operation was successful or redis:Error if an error occurs

renameNx

Isolated FunctionRemote Function
function renameNx(string key, string newName) returns boolean|Error

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

Parameters
  • key string - Key to be renamed
  • newName string - New name of the key
Return Type
  • boolean|Error - Boolean true if key was renamed to newkey. boolean false if newkey already exists. Or redis:Error if an error occurs

sort

Isolated FunctionRemote Function
function sort(string key) returns string[]|Error

Sort elements in a list, set or sorted set.

Parameters
  • key string - Key of the data type to be sorted
Return Type
  • string[]|Error - Sorted array containing the members of the sorted data type or redis:Error if an error occurs

ttl

Isolated FunctionRemote Function
function ttl(string key) returns int|Error

Get the time to live for a key.

Parameters
  • key string - Key of which the time to live needs to be obtained
Return Type
  • int|Error - Time to live in seconds or a negative value/redis:Error in order to signal an error in evaluating ttl. Whether it is a negative value of an redis:Error would differ depending on whether the error occurs at DB level or the driver level

redisType

Isolated FunctionRemote Function
function redisType(string key) returns string|Error

Determine the type stored at key.

Parameters
  • key string - Key of which the type needs to be obtained
Return Type

clusterInfo

Isolated FunctionRemote Function
function clusterInfo() returns string[]|Error

Retrieve information and statistics about the cluster observed by the current node. This command is exclusively available in cluster mode. If the connection is in a non-clustered mode, the API will return a redis:Error. Other errors will also be appropriately handled.

Return Type
  • string[]|Error - a bulk-string-reply as a string array or, a redis:Error if the connection is non-clustered or encounters any other errors.

ping

Isolated FunctionRemote Function
function ping() returns string|Error

Ping the server.

Return Type
  • string|Error - String with the value PONG if the operation was successful

auth

Isolated FunctionRemote Function
function auth(string password) returns string|Error

Authenticate to the server.

Parameters
  • password string - Password to authenticate
Return Type
  • string|Error - String with the value OK if the operation was successful or redis:Error if an error occurs

echo

Isolated FunctionRemote Function
function echo(string message) returns string|Error

Echo the given string.

Parameters
  • message string - Message to be echo-ed
Return Type
  • string|Error - Message itself if the operation was successful or redis:Error if an error occurs

close

Isolated Function
function close() returns Error?

Close the connection.

Return Type
  • Error? - nil if the operation was successful or an redis:Error if an error occurs

Enums

redis: SslVerifyMode

Represents the SSL/TLS verification mode.

Members

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

Records

redis: CertKey

Closed record

Represents a combination of certificate, private key, and private key password if encrypted.

Fields
  • certFile string - File containing the certificate
  • keyFile string - File containing the private key in PKCS8 format
  • keyPassword string? - Password of the private key if it is encrypted

redis: ConnectionConfig

Closed record

The client endpoint configuration for Redis.

Fields
  • connection ConnectionUri|ConnectionParams(default "redis://localhost:6379") - Connection configurations of the Redis server. This can be either a single URI or a set of parameters
  • connectionPooling boolean(default false) - Flag to indicate whether connection pooling is enabled
  • isClusterConnection boolean(default false) - Flag to indicate whether the connection is a cluster connection
  • secureSocket SecureSocket? - Configurations related to SSL/TLS encryption

redis: ConnectionParams

Closed record

The connection parameters based configurations.

Fields
  • host string(default "localhost") - Host address of the Redis database
  • port int(default 6379) - Port of the Redis database
  • username string? - The username for the Redis database
  • password string? - The password for the Redis database
  • options Options(default {}) - Other connection options of the connection configuration

redis: Options

Closed record

Connection options for Redis client endpoint.

Fields
  • clientName string? - Name of the client
  • database int(default 0) - Database index which the client should interact with. Not applicable for cluster connections
  • connectionTimeout int(default 60) - Connection timeout in seconds

redis: SecureSocket

Closed record

Configurations for secure communication with the Redis server.

Fields
  • cert TrustStore|string? - Configurations associated with crypto:TrustStore or single certificate file that the client trusts
  • key KeyStore|CertKey? - Configurations associated with crypto:KeyStore or combination of certificate and private key of the client
  • protocols string[]? - List of protocols used for the connection established to Redis Server, such as TLSv1.2, TLSv1.1, TLSv1.
  • ciphers string[]? - List of ciphers to be used for SSL connections
  • verifyMode SslVerifyMode(default FULL) - The SSL/TLS verification mode. This can be either NONE, CA, or FULL.
  • startTls boolean(default false) - Whether StartTLS is enabled

Errors

redis: Error

Distinct

Represents a redis generic error

Import

import ballerinax/redis;Copy

Metadata

Released date: about 2 months ago

Version: 3.0.1

License: Apache-2.0

Compatibility

Platform: java17

Ballerina version: 2201.8.0

GraalVM compatible: Yes

Pull count

Total: 11332

Current verison: 1483

Weekly downloads

Source repository

Keywords

IT Operations/Databases

Cost/Freemium

Contributors

Other versions

3.0.1

3.0.02.6.02.5.12.5.0
See more...

Dependencies

ballerina/crypto/2.6.2

Dependents

ballerinax/persist.redis/0.1.0

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2024 WSO2 LLC