Ballerina Redis Connector

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

Download and install Redis from the official website.
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.

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.

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:

Redis Labs: Redis Labs offers Redis Enterprise Cloud, a fully-managed Redis service in the cloud.
Amazon ElastiCache: Amazon Web Services provides ElastiCache, a managed Redis service for deploying, operating, and scaling Redis in the AWS Cloud.
Google Cloud Memorystore: Google Cloud offers Memorystore for Redis, a fully-managed Redis service on Google Cloud Platform.
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.

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.

redis:Client redis = check 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

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

Get value by key

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

Step 4: Run the Ballerina application

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

bal run

Examples

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

Cache management - Implement caching using Redis to improve application performance.
Session management - Use Redis to manage user sessions efficiently.
Rate limiting - Implement rate limiting for API endpoints using Redis.

Issues and projects

The Issues and Projects tabs are disabled for this repository as this is part of the Ballerina library. To report bugs, request new features, start new discussions, view project boards, etc., visit the Ballerina library parent repository.

This repository only contains the source code for the package.

Building from the source

Prerequisites

Download and install Java SE Development Kit (JDK) version 17. You can download it from either of the following sources:
- Oracle JDK
- OpenJDK
Note: After installation, remember to set the JAVA_HOME environment variable to the directory where JDK was installed.
Download and install Ballerina Swan Lake.
Download and install Docker.

Note: Ensure that the Docker daemon is running before executing any tests.

Build options

Execute the commands below to build from the source.

To build the package:
```
./gradlew clean build
```
To run the tests:
```
./gradlew clean test
```
To build the without the tests:
```
./gradlew clean build -x test
```

To run tests against different environment:

./gradlew clean test -Pgroups=<Comma separated groups/test cases>

To debug package with a remote debugger:
```
./gradlew clean build -Pdebug=<port>
```

To debug with the Ballerina language:

./gradlew clean build -PbalJavaDebug=<port>

Publish the generated artifacts to the local Ballerina Central repository:
```
./gradlew clean build -PpublishToLocalCentral=true
```
Publish the generated artifacts to the Ballerina Central repository:
```
./gradlew clean build -PpublishToCentral=true
```

Contribute to Ballerina

As an open-source project, Ballerina welcomes contributions from the community.

For more information, go to the contribution guidelines.

Code of conduct

All the contributors are encouraged to read the Ballerina Code of Conduct.

Useful links

For more information go to the redis package.
For example demonstrations of the usage, go to Ballerina By Examples.
Chat live with us via our Discord server.
Post all technical questions on Stack Overflow with the #ballerina tag.

ballerina-platform/module-ballerinax-redis