Momento Lettuce Compatibility Client

What and why?

This project provides a Momento-backed implementation of lettuce The goal is to provide a drop-in replacement for lettuce so that you can use the same code with either a Redis server or with the Momento Cache service!

Installation

To use the compatiblity client, you will need three dependencies in your project: the Momento Lettuce compatibility client, the Momento Cache client, and the lettuce client.

The Momento Lettuce compatibility client is available on Maven Central. You can add it to your project via:

<dependency>
  <groupId>software.momento.java</groupId>
  <artifactId>momento-lettuce</artifactId>
  <version>0.1.0</version>
</dependency>

You will also need to add the Momento Cache client library to your project. You can find the latest version of the Momento Cache client library on Maven Central as well:

<dependency>
    <groupId>software.momento.java</groupId>
    <artifactId>sdk</artifactId>
    <version>1.15.0</version>
</dependency>

As well as the lettuce client also on Maven Central.

Usage

To switch your existing lettuce application to use Momento Cache, you only need to change the code where you construct your client object. Here is an example of constructing a Momento lettuce client:

package momento.lettuce.example.doc_examples;

import io.lettuce.core.api.reactive.RedisReactiveCommands;
import java.time.Duration;
import momento.lettuce.MomentoRedisReactiveClient;
import momento.sdk.CacheClient;
import momento.sdk.auth.CredentialProvider;
import momento.sdk.config.Configurations;

class ReadmeExample {
  public static void main(String[] args) {
    // Create a Momento cache client
    try (final CacheClient cacheClient =
        CacheClient.create(
            CredentialProvider.fromEnvVar("MOMENTO_API_KEY"),
            Configurations.Laptop.v1(),
            Duration.ofSeconds(60))) {
      final String cacheName = "cache";

      // Create a Redis client backed by the Momento cache client over the cache
      RedisReactiveCommands<String, String> redisClient =
          MomentoRedisReactiveClient.create(cacheClient, cacheName);

      // Perform operations vs Momento as if using a regular Redis client
      var setResult = redisClient.set("key", "value").block();
      System.out.println("Set result: " + setResult);

      var getResult = redisClient.get("key").block();
      System.out.println("Get result: " + getResult);
    }
  }
}

Additionally, to understand what APIs are supported, you can use the interface MomentoRedisReactiveCommands which contains only those APIs that are supported by this compatibility client:

package momento.lettuce.example.doc_examples;

import java.time.Duration;
import momento.lettuce.MomentoRedisReactiveClient;
import momento.lettuce.MomentoRedisReactiveCommands;
import momento.sdk.CacheClient;
import momento.sdk.auth.CredentialProvider;
import momento.sdk.config.Configurations;

class LimitedApiExample {
  public static void main(String[] args) {
    // Create a Momento cache client
    try (final CacheClient cacheClient =
        CacheClient.create(
            CredentialProvider.fromEnvVar("MOMENTO_API_KEY"),
            Configurations.Laptop.v1(),
            Duration.ofSeconds(60))) {
      final String cacheName = "cache";

      // This interface provides type safety as it only allows the user to interact with the
      // RedisReactiveCommands
      // commands that are supported by the MomentoRedisReactiveCommands class
      MomentoRedisReactiveCommands<String, String> redisClient =
          MomentoRedisReactiveClient.create(cacheClient, cacheName);
    }
  }
}

Current Redis API support

This library supports the most popular Redis APIs, but does not yet support all Redis APIs. We currently support the most common APIs related to string values (get, set, unlink), as well as list (lpush, lrange, ltrim). We will be adding support for additional APIs in the future. If there is a particular API that you need support for, please drop by our Discord or e-mail us at [email protected] and let us know!

---

For more info, visit our website at https://gomomento.com!