Introduction to Redis Lists

Welcome back! In the previous lessons, we explored connecting to Redis and performing operations with numbers. Now, let's explore another essential Redis data structure: lists. Lists in Redis are an excellent way to store ordered collections of items, such as names, messages, or even tasks.

By the end of this lesson, you'll know how to:

1. Use the rpush command to add items to a Redis list.
2. Retrieve list items using the lrange command.
3. Access specific items in a list using the lindex command.

Here's a quick look at how you'll be working with lists in Redis:

<?php

require 'vendor/autoload.php';

Predis\Autoloader::register();

// Connect to Redis
$client = new Predis\Client([
    'scheme' => 'tcp',
    'host'   => '127.0.0.1',
    'port'   => 6379,
]);

// Working with Redis lists
$client->rpush('students', ['Alice', 'Bob', 'Charlie']);

$students = $client->lrange('students', 0, -1);

echo "Students in the list: " . implode(", ", $students) . "\n";

// Accessing a specific item using LIndex
$student = $client->lindex('students', 1);

echo "Student at index 1: $student\n";

?>

In this example:

• The rpush command adds the names Alice, Bob, and Charlie to the list named students. The first argument is the list name, followed by an array of items to add.
  • Note that since Redis is a key-value store, if you run the same code multiple times, the list will keep growing with the same elements, as lists in Redis allow duplicates. Notice that the rpush command adds elements to the right end of the list, but you can also use the lpush command to add elements to the left end of the list.
• The lrange command retrieves all elements in the students list, and we print them out.
  • The lrange command takes the list name, a starting index, and an ending index as arguments. Here, we use 0 to indicate the first element and -1 to indicate the last element.
• The lindex command accesses a specific element in the list based on the provided index.
  • It takes the list name and index as arguments. In this example, it retrieves the student at index 1, which is Bob. Keep in mind that the first element in a list has an index of 0.

When working with lists in Redis and running your code multiple times, it's crucial to consider the deletion of keys. If you're re-running the code from the example, you'll notice that the list keeps growing with duplicate elements. To prevent this and start with a clean slate each time, you can delete the key corresponding to the list.

To delete a key in Redis, use the del command:

// Deleting the list key before adding new elements
$client->del('students');

Be cautious when using del to remove lists. Unlike databases that support transactions or soft deletes, Redis instantly and permanently removes the key.