Java: README.md

CHANGELOG.md

@@ -49,6 +49,9 @@
 * Python: Added ZREVRANK command ([#1614](https://github.com/aws/glide-for-redis/pull/1614))
 * Python: Added XDEL command ([#1619](https://github.com/aws/glide-for-redis/pull/1619))
 * Python: Added XRANGE command ([#1624](https://github.com/aws/glide-for-redis/pull/1624))
+* Python: Added COPY command ([#1626](https://github.com/aws/glide-for-redis/pull/1626))
+* Python: Added XREVRANGE command ([#1625](https://github.com/aws/glide-for-redis/pull/1625))
+* Python: Added XREAD command ([#1644](https://github.com/aws/glide-for-redis/pull/1644))
 
 ### Breaking Changes
 * Node: Update XREAD to return a Map of Map ([#1494](https://github.com/aws/glide-for-redis/pull/1494))

glide-core/src/protobuf/redis_request.proto

@@ -233,6 +233,9 @@ enum RequestType {
     GetEx = 192;
     Dump = 193;
     Restore = 194;
+    SortReadOnly = 195;
+    FunctionDump = 196;
+    FunctionRestore = 197;
 }
 
 message Command {

glide-core/src/request_type.rs

@@ -203,6 +203,9 @@ pub enum RequestType {
     GetEx = 192,
     Dump = 193,
     Restore = 194,
+    SortReadOnly = 195,
+    FunctionDump = 196,
+    FunctionRestore = 197,
 }
 
 fn get_two_word_command(first: &str, second: &str) -> Cmd {
@@ -409,6 +412,9 @@ impl From<::protobuf::EnumOrUnknown<ProtobufRequestType>> for RequestType {
             ProtobufRequestType::GetEx => RequestType::GetEx,
             ProtobufRequestType::Dump => RequestType::Dump,
             ProtobufRequestType::Restore => RequestType::Restore,
+            ProtobufRequestType::SortReadOnly => RequestType::SortReadOnly,
+            ProtobufRequestType::FunctionDump => RequestType::FunctionDump,
+            ProtobufRequestType::FunctionRestore => RequestType::FunctionRestore,
         }
     }
 }
@@ -613,6 +619,9 @@ impl RequestType {
             RequestType::GetEx => Some(cmd("GETEX")),
             RequestType::Dump => Some(cmd("DUMP")),
             RequestType::Restore => Some(cmd("RESTORE")),
+            RequestType::SortReadOnly => Some(cmd("SORT_RO")),
+            RequestType::FunctionDump => Some(get_two_word_command("FUNCTION", "DUMP")),
+            RequestType::FunctionRestore => Some(get_two_word_command("FUNCTION", "RESTORE")),
         }
     }
 }

java/README.md

@@ -1,18 +1,41 @@
+# GLIDE for Valkey
+
+General Language Independent Driver for the Enterprise (GLIDE) for Valkey, is an AWS-sponsored, open-source Valkey client. GLIDE for Valkey works with any Valkey distribution that adheres to the Valkey Serialization
+Protocol (RESP) specification, including open-source Valkey, Amazon ElastiCache for Valkey, and Amazon MemoryDB for Valkey.
+Strategic, mission-critical Valkey-based applications have requirements for security, optimized performance, minimal downtime, and observability. GLIDE for Valkey is designed to provide a client experience that helps meet these objectives.
+It is sponsored and supported by AWS, and comes pre-configured with best practices learned from over a decade of operating Valkey-compatible services used by hundreds of thousands of customers.
+To help ensure consistency in development and operations, GLIDE for Valkey is implemented using a core driver framework, written in Rust, with extensions made available for each supported programming language. This design ensures that updates easily propagate to each language and reduces overall complexity.
+In this release, GLIDE for Valkey is available for Python, Javascript (Node.js), and Java.
+
+## Supported Valkey Versions
+
+GLIDE for Valkey is API-compatible with open source Valkey version 6 and 7.
+
+## Current Status
+
+We've made GLIDE for Valkey an open-source project, and are releasing it in Preview to the community to gather feedback, and actively collaborate on the project roadmap. We welcome questions and contributions from all Valkey stakeholders.
+This preview release is recommended for testing purposes only.
+
 # Getting Started - Java Wrapper
 
-## Notice: Java Wrapper - Work in Progress
+## System Requirements
+
+The beta release of GLIDE for Valkey was tested on Intel x86_64 using Ubuntu 22.04.1, Amazon Linux 2023 (AL2023), and macOS 12.7.
+
+## Supported Operating Systems
 
-We're excited to share that the Java client is currently in development! However, it's important to note that this client
-is a work in progress and is not yet complete or fully tested. Your contributions and feedback are highly encouraged as
-we work towards refining and improving this implementation. Thank you for your interest and understanding as we continue
-to develop this Java wrapper.
+GLIDE for Valkey is supported in Ubuntu, CentOS, and MacOS.
+
+## Java supported version
+JDK 11+.
 
 The Java client contains the following parts:
 
-1. `client`: A Java-wrapper around the rust-core client.
-2. `examples`: An examples app to test the client against a Redis localhost
-3. `benchmark`: A dedicated benchmarking tool designed to evaluate and compare the performance of GLIDE for Redis and other Java clients.
-4. `integTest`: An integration test sub-project for API and E2E testing
+1. `src`: Rust dynamic library FFI to integrate with [GLIDE core library](https://github.com/aws/glide-for-redis/blob/main/glide-core/README.md).
+2. `client`: A Java-wrapper around the [GLIDE core rust library](../glide-core/README.md) and unit tests for it.
+3. `examples`: An examples app to test the client against a Valkey localhost.
+4. `benchmark`: A dedicated benchmarking tool designed to evaluate and compare the performance of GLIDE for Valkey and other Java clients.
+5. `integTest`: An integration test sub-project for API and E2E testing.
 
 ## Installation and Setup
 
@@ -25,61 +48,48 @@ At the moment, the Java client must be built from source.
 Software Dependencies:
 
 - JDK 11+
-- git
-- protoc (protobuf compiler)
-- Rust
+
+Please also consider installing the following packages to build [GLIDE core rust library](../glide-core/README.md):
+
+- openssl
+- openssl-dev
 
 #### Prerequisites
 
+**Protoc installation**
+
+Download a binary matching your system from the [official release page](https://github.com/protocolbuffers/protobuf/releases) and make it accessible in your $PATH by moving it or creating a symlink.
+For example, on Linux you can copy it to `/usr/bin`:
+
+```bash
+sudo cp protoc /usr/bin/
+```
+
 **Dependencies installation for Ubuntu**
+
 ```bash
 sudo apt update -y
-sudo apt install -y protobuf-compiler openjdk-11-jdk openssl gcc
+sudo apt install -y openjdk-11-jdk openssl gcc
 curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
 source "$HOME/.cargo/env"
 ```
 
-**Dependencies for MacOS**
+**Dependencies installation for MacOS**
 
-Ensure that you have a minimum Java version of JDK 11 installed on your system:
 ```bash
- $ echo $JAVA_HOME
-/Library/Java/JavaVirtualMachines/adoptopenjdk-11.jdk/Contents/Home
-
-$ java -version
- openjdk version "11.0.1" 2018-10-16
- OpenJDK Runtime Environment 18.9 (build 11.0.1+13)
- OpenJDK 64-Bit Server VM 18.9 (build 11.0.1+13, mixed mode)
+brew update
+brew install git gcc pkgconfig openssl openjdk@11
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+source "$HOME/.cargo/env"
 ```
 
-#### Building and installation steps
-The Java client is currently a work in progress and offers no guarantees. Users should build at their own risk.
+**Java version check**
+
+Ensure that you have a minimum Java version of JDK 11 installed on your system:
 
-Before starting this step, make sure you've installed all software requirements.
-1. Clone the repository:
-```bash
-VERSION=0.1.0 # You can modify this to other released version or set it to "main" to get the unstable branch
-git clone --branch ${VERSION} https://github.com/aws/glide-for-redis.git
-cd glide-for-redis
-```
-2. Initialize git submodule:
-```bash
-git submodule update --init --recursive
-```
-3. Generate protobuf files:
-```bash
-cd java/
-./gradlew :client:protobuf
-```
-4. Build the client library:
-```bash
-cd java/
-./gradlew :client:build
-```
-5. Run tests:
 ```bash
-cd java/
-$ ./gradlew :client:test
+echo $JAVA_HOME
+java -version
 ```
 
 Other useful gradle developer commands:
@@ -90,20 +100,105 @@ Other useful gradle developer commands:
 * `./gradlew :examples:run` to run client examples (make sure you have a running redis on port `6379`)
 * `./gradlew :benchmarks:run` to run performance benchmarks
 
+
+### Setting up the Driver
+
+Refer to https://central.sonatype.com/search?q=glide&namespace=software.amazon.glide for your specific system.
+Once set up, you can run the basic examples.
+
+Gradle:
+- Copy the snippet and paste it in the `build.gradle` dependencies section.
+Example shown below is for `glide-osx-aarch_64`.
+```bash
+dependencies {
+    testImplementation platform('org.junit:junit-bom:5.10.0')
+    testImplementation 'org.junit.jupiter:junit-jupiter'
+    implementation group: 'software.amazon.glide', name: 'glide-osx-aarch_64', version: '0.4.2'
+}
+```
+
+Maven (AARCH_64) specific.
+- **IMPORTANT** must include a `classifier` block. Please use this dependency block instead and add it to the pom.xml file.
+```bash
+<dependency>
+    <groupId>software.amazon.glide</groupId>
+    <artifactId>glide-osx-aarch_64</artifactId>
+    <classifier>osx-aarch_64</classifier>
+    <version>0.4.2</version>
+</dependency>
+```
+
 ## Basic Examples
 
-### Standalone Redis:
+### Standalone Valkey:
 
 ```java
 import glide.api.RedisClient;
+import glide.api.models.configuration.NodeAddress;
+import glide.api.models.configuration.RedisClientConfiguration;
+
+import java.util.concurrent.ExecutionException;
+import static glide.api.models.GlideString.gs;
+
+# Run this code in the Main file. Include InterruptedException and ExecutionException handling.
+
+public static void main(String[] args) throws InterruptedException, ExecutionException {
+
+String host = "localhost";
+Integer port = 6379;
+boolean useSsl = false;
+
+RedisClientConfiguration config =
+        RedisClientConfiguration.builder()
+                .address(NodeAddress.builder().host(host).port(port).build())
+                .useTLS(useSsl)
+                .build();
+
+RedisClient client = RedisClient.CreateClient(config).get();
+
+System.out.println("PING: " + client.ping().get());
+System.out.println("PING(found you): " + client.ping("found you").get());
+
+System.out.println("SET(apples, oranges): " + client.set("apples", "oranges").get());
+System.out.println("GET(apples): " + client.get("apples").get());
+
+System.out.println("GLIDESTRINGSET(cats, meow): " + client.set(gs("cats"), gs("meow")).get());
+System.out.println("GET(cats): " + client.get("cats").get());
+}
+```
+
+### Cluster Valkey:
+```java
+
+import glide.api.RedisClusterClient;
+import glide.api.models.configuration.NodeAddress;
+import glide.api.models.configuration.RedisClusterClientConfiguration;
+
+import java.util.concurrent.ExecutionException;
+import static glide.api.models.GlideString.gs;
+
+# Run this code in the Main file. Include InterruptedException and ExecutionException handling.
+
+String host = "localhost";
+Integer port = 6379;
+boolean useSsl = false;
+
+RedisClusterClientConfiguration config =
+        RedisClusterClientConfiguration.builder()
+                .address(NodeAddress.builder().host(host).port(port).build())
+                .useTLS(useSsl)
+                .build();
+
+RedisClusterClient client = RedisClusterClient.CreateClient(config).get();
 
-RedisClient client = RedisClient.CreateClient().get();
+System.out.println("PING: " + client.ping().get());
+System.out.println("PING(found you): " + client.ping("found you").get());
 
-CompletableFuture<String> setResponse = client.set("key", "foobar");
-assert setResponse.get() == "OK" : "Failed on client.set("key", "foobar") request";
+System.out.println("SET(apples, oranges): " + client.set("apples", "oranges").get());
+System.out.println("GET(apples): " + client.get("apples").get());
 
-CompletableFuture<String> getResponse = client.get("key");
-assert getResponse.get() == "foobar" : "Failed on client.get("key") request";
+System.out.println("GLIDESTRINGSET(cats, meow): " + client.set(gs("cats"), gs("meow")).get());
+System.out.println("GET(cats): " + client.get("cats").get());
 ```
 
 ### Benchmarks