docs(memorystore): added valkey leaderboard snippets

memorystore/valkey/leaderboard/snippets/pom.xml

@@ -0,0 +1,127 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+  Copyright 2020 Google LLC
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <groupId>com.example.memorystore</groupId>
+  <artifactId>caching</artifactId>
+  <version>1.0-SNAPSHOT</version>
+
+  <name>Google Cloud Memorystore Sample</name>
+  <url>http://www.example.com</url>
+
+          <!--
+        The parent pom defines common style checks and testing strategies for our samples.
+        Removing or replacing it should not affect the execution of the samples in anyway.
+    -->
+  <parent>
+      <groupId>com.google.cloud.samples</groupId>
+      <artifactId>shared-configuration</artifactId>
+      <version>1.2.0</version>
+  </parent>
+
+  <properties>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    <maven.compiler.release>11</maven.compiler.release>
+  </properties>
+
+  <dependencyManagement>
+    <dependencies>
+      <dependency>
+        <groupId>org.junit</groupId>
+        <artifactId>junit-bom</artifactId>
+        <version>5.11.0</version>
+        <type>pom</type>
+        <scope>import</scope>
+      </dependency>
+    </dependencies>
+  </dependencyManagement>
+
+  <dependencies>
+    <!-- Jedis Redis client library -->
+    <dependency>
+      <groupId>redis.clients</groupId>
+      <artifactId>jedis</artifactId>
+      <version>4.3.1</version>
+    </dependency>
+
+    <!-- Google Cloud Client Libraries -->
+    <dependency>
+      <groupId>com.google.cloud</groupId>
+      <artifactId>google-cloud-core</artifactId>
+      <version>2.16.0</version>
+    </dependency>
+
+    <!-- Unit testing libraries -->
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-api</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-params</artifactId>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+
+  <build>
+    <pluginManagement>
+      <plugins>
+        <plugin>
+          <artifactId>maven-clean-plugin</artifactId>
+          <version>3.4.0</version>
+        </plugin>
+        <plugin>
+          <artifactId>maven-resources-plugin</artifactId>
+          <version>3.3.1</version>
+        </plugin>
+        <plugin>
+          <artifactId>maven-compiler-plugin</artifactId>
+          <version>3.13.0</version>
+        </plugin>
+        <plugin>
+          <artifactId>maven-surefire-plugin</artifactId>
+          <version>3.3.0</version>
+        </plugin>
+        <plugin>
+          <artifactId>maven-jar-plugin</artifactId>
+          <version>3.4.2</version>
+        </plugin>
+        <plugin>
+          <artifactId>maven-install-plugin</artifactId>
+          <version>3.1.2</version>
+        </plugin>
+        <plugin>
+          <artifactId>maven-deploy-plugin</artifactId>
+          <version>3.1.2</version>
+        </plugin>
+        <plugin>
+          <artifactId>maven-site-plugin</artifactId>
+          <version>3.12.1</version>
+        </plugin>
+        <plugin>
+          <artifactId>maven-project-info-reports-plugin</artifactId>
+          <version>3.6.1</version>
+        </plugin>
+      </plugins>
+    </pluginManagement>
+  </build>
+</project>

memorystore/valkey/leaderboard/snippets/src/main/java/samples/MemorystoreAddScore.java

@@ -0,0 +1,74 @@
+/*
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import java.util.AbstractMap.SimpleEntry;
+import java.util.List;
+import redis.clients.jedis.Jedis;
+import redis.clients.jedis.JedisPool;
+
+public final class MemorystoreAddScore {
+
+  /** Replace the Memorystore instance id. */
+  private static final String INSTANCE_ID = "INSTANCE_ID";
+
+  /** Replace the Memorystore port, if not the default port. */
+  private static final int PORT = 6379;
+
+  /** Set the name for the Leaderboard */
+  private static final String LEADERBOARD_KEY = "leaderboard";
+
+  /** Replace the names and scores to write to Memorystore. */
+  private static final List<SimpleEntry<String, Double>> USER_SCORES = List.of(
+      new SimpleEntry<>("User1", 100.0),
+      new SimpleEntry<>("User2", 80.0),
+      new SimpleEntry<>("User3", 95.0),
+      new SimpleEntry<>("User4", 70.0));
+
+  private MemorystoreAddScore() {
+    // No-op; won't be called
+  }
+
+  /**
+   * Writes to Memorystore before verifying the item exists.
+   *
+   * @param args command-line arguments
+   */
+  public static void main(final String[] args) {
+    // Connect to the Memorystore instance
+    JedisPool pool = new JedisPool(INSTANCE_ID, PORT);
+
+    try (Jedis jedis = pool.getResource()) {
+      // Add the scores to the leaderboard
+      for (SimpleEntry<String, Double> entry : USER_SCORES) {
+        jedis.zadd(LEADERBOARD_KEY, entry.getValue(), entry.getKey());
+        System.out.printf(
+            "Added/Updated %s with score %s%n", entry.getKey(), entry.getValue());
+      }
+
+      // Verify that scores have been added
+      for (String userKey : USER_SCORES.keySet()) {
+        // Find the user score based on the user key
+        Double userScore = jedis.zscore(LEADERBOARD_KEY, userKey);
+
+        // Print out the user score
+        System.out.printf("User %s has a score of %s%n", userKey, userScore);
+      }
+    } catch (Exception e) {
+      // Print any errors found in the exception
+      System.err.printf("Error connecting to Redis: %s%n", e.getMessage());
+    }
+  }
+}

memorystore/valkey/leaderboard/snippets/src/main/java/samples/MemorystoreLeaderboardPagination.java

@@ -0,0 +1,113 @@
+/*
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import java.util.AbstractMap.SimpleEntry;
+import java.util.List;
+import java.util.Set;
+import redis.clients.jedis.Jedis;
+import redis.clients.jedis.JedisPool;
+
+public final class MemorystoreLeaderboardPagination {
+
+  /** Replace the Memorystore instance id. */
+  private static final String INSTANCE_ID = "INSTANCE_ID";
+
+  /** Replace the Memorystore port, if not the default port. */
+  private static final int PORT = 6379;
+
+  /** Set the name for the Leaderboard */
+  private static final String LEADERBOARD_KEY = "leaderboard";
+
+  /** Number of users per page */
+  private static final int PAGE_SIZE = 2;
+
+  /** Sample user scores */
+  private static final List<SimpleEntry<String, Double>> USER_SCORES = List.of(
+      new SimpleEntry<>("User1", 100.0),
+      new SimpleEntry<>("User2", 80.0),
+      new SimpleEntry<>("User3", 95.0),
+      new SimpleEntry<>("User4", 70.0),
+      new SimpleEntry<>("User5", 60.0),
+      new SimpleEntry<>("User6", 50.0));
+
+  private MemorystoreLeaderboardPagination() {
+    // No-op; won't be called
+  }
+
+  /**
+   * Writes to Memorystore and retrieves the leaderboard using pagination.
+   *
+   * @param args command-line arguments (page number)
+   */
+  public static void main(final String[] args) {
+    // Validate input arguments
+    int pageNumber = args.length > 0 ? Integer.parseInt(args[0]) : 1;
+    if (pageNumber < 1) {
+      System.out.println("Invalid page number. Defaulting to page 1.");
+      pageNumber = 1;
+    }
+
+    // Connect to the Memorystore instance
+    JedisPool pool = new JedisPool(INSTANCE_ID, PORT);
+
+    try (Jedis jedis = pool.getResource()) {
+      // Add the scores to the leaderboard
+      for (SimpleEntry<String, Double> entry : USER_SCORES) {
+        jedis.zadd(LEADERBOARD_KEY, entry.getValue(), entry.getKey());
+        System.out.printf(
+            "Added/Updated %s with score %s%n", entry.getKey(), entry.getValue());
+      }
+
+      // Display Users on page 1
+      System.out.printf("\nLeaderboard - Page %d:\n", 1);
+      displayPaginatedLeaderboard(jedis, 1);
+
+      // Display Users on page 2
+      System.out.printf("\nLeaderboard - Page %d:\n", 2);
+      displayPaginatedLeaderboard(jedis, 2);
+    } catch (Exception e) {
+      System.err.printf("Error connecting to Redis: %s%n", e.getMessage());
+    }
+  }
+
+  /**
+   * Fetches and displays leaderboard users based on the given page number.
+   *
+   * @param jedis Redis client instance
+   * @param page  The page number to fetch
+   */
+  private static void displayPaginatedLeaderboard(Jedis jedis, int page) {
+    // Caulcate the start and end index for each page
+    int start = (page - 1) * PAGE_SIZE;
+    int end = start + PAGE_SIZE - 1;
+
+    // Use zrevrange to find users between the start and end index
+    Set<String> paginatedUsers = jedis.zrevrange(LEADERBOARD_KEY, start, end);
+
+    // If no users are found, print a message and return
+    if (paginatedUsers.isEmpty()) {
+      System.out.println("No users found on this page.");
+      return;
+    }
+
+    int ranking = start + 1;
+    for (String user : paginatedUsers) {
+      System.out.printf(
+          "Rank %d: %s, Score: %s%n",
+          ranking++, user, jedis.zscore(LEADERBOARD_KEY, user));
+    }
+  }
+}

memorystore/valkey/leaderboard/snippets/src/main/java/samples/MemorystoreSortByScoreAsc.java

@@ -0,0 +1,78 @@
+/*
+* Copyright 2025 Google LLC
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+import java.util.AbstractMap.SimpleEntry;
+import java.util.List;
+import java.util.Set;
+import redis.clients.jedis.Jedis;
+import redis.clients.jedis.JedisPool;
+
+public final class MemorystoreSortByScoreAsc {
+
+  /** Replace the Memorystore instance id. */
+  private static final String INSTANCE_ID = "INSTANCE_ID";
+
+  /** Replace the Memorystore port, if not the default port. */
+  private static final int PORT = 6379;
+
+  /** Set the name for the Leaderboard */
+  private static final String LEADERBOARD_KEY = "leaderboard";
+
+  /** Replace the names and scores to write to Memorystore. */
+  private static final List<SimpleEntry<String, Double>> USER_SCORES = List.of(
+      new SimpleEntry<>("User1", 100.0),
+      new SimpleEntry<>("User2", 80.0),
+      new SimpleEntry<>("User3", 95.0),
+      new SimpleEntry<>("User4", 70.0));
+
+  private MemorystoreSortByScoreAsc() {
+    // No-op; won't be called
+  }
+
+  /**
+   * Writes to Memorystore and retrieves the leaderboard sorted in ascending
+   * order.
+   *
+   * @param args command-line arguments
+   */
+  public static void main(final String[] args) {
+    // Connect to the Memorystore instance
+    JedisPool pool = new JedisPool(INSTANCE_ID, PORT);
+
+    try (Jedis jedis = pool.getResource()) {
+      // Add the scores to the leaderboard
+      for (SimpleEntry<String, Double> entry : USER_SCORES) {
+        jedis.zadd(LEADERBOARD_KEY, entry.getValue(), entry.getKey());
+        System.out.printf(
+            "Added/Updated %s with score %s%n", entry.getKey(), entry.getValue());
+      }
+
+      // Retrieve and print all users sorted by score in ascending order
+      Set<String> sortedUsers = jedis.zrange(LEADERBOARD_KEY, 0, -1);
+
+      // Print the leaderboard in ascending order
+      System.out.printf("Leaderboad (Ascending)");
+
+      // For each user, print the score
+      for (String user : sortedUsers) {
+        System.out.printf(
+            "User: %s, Score: %s%n", user, jedis.zscore(LEADERBOARD_KEY, user));
+      }
+    } catch (Exception e) {
+      System.err.printf("Error connecting to Redis: %s%n", e.getMessage());
+    }
+  }
+}