PSUBSCRIBE for pattern matching in Redis - Mini Project: Build & Apply

Using PSUBSCRIBE for Pattern Matching in Redis

📖 Scenario: You are managing a chat application where users send messages to different chat rooms. You want to listen to messages from multiple chat rooms that share a common naming pattern.

🎯 Goal: Build a Redis subscriber that uses PSUBSCRIBE to listen to all chat rooms whose names start with room:.

📋 What You'll Learn

Create a Redis channel pattern variable called pattern with the value room:*

Use the PSUBSCRIBE command with the pattern variable to subscribe to matching channels

Implement a message handler function called message_handler that takes pattern, channel, and message as parameters

Print the received channel and message inside the message_handler function

💡 Why This Matters

🌍 Real World

Pattern matching subscriptions are useful in chat apps, notifications, and event-driven systems where you want to listen to groups of related channels.

💼 Career

Understanding PSUBSCRIBE helps in building scalable real-time applications and working with Redis Pub/Sub features in backend development.

1

Set up the Redis client connection

Create a Redis client connection variable called client using redis.Redis().

Redis

# Your code here to create Redis client connection

Hint

Use redis.Redis() to create a client connection to Redis.

2

Create the channel pattern variable

Create a variable called pattern and set it to the string 'room:*' to match all channels starting with room:.

Redis

import redis

client = redis.Redis()

# Create the pattern variable for PSUBSCRIBE

Hint

Use the wildcard * to match any channel name starting with room:.

3

Define the message handler function

Define a function called message_handler that takes three parameters: pattern, channel, and message. Inside the function, print the channel and message.

Redis

import redis

client = redis.Redis()

pattern = 'room:*'

# Define the message_handler function

Hint

Use an f-string to print the channel and message inside the function.

4

Subscribe to channels using PSUBSCRIBE with the pattern

Use client.pubsub() to create a PubSub object called pubsub. Then use pubsub.psubscribe() with the pattern and message_handler as the callback to subscribe to matching channels.

Redis

import redis

client = redis.Redis()

pattern = 'room:*'

def message_handler(pattern, channel, message):
    print(f"Received message from {channel}: {message}")

# Create pubsub and subscribe using PSUBSCRIBE

Hint

Use psubscribe with a dictionary mapping the pattern to the handler function.

Practice

1. What does the Redis command PSUBSCRIBE do?

easy

A. It subscribes to channels matching a pattern with wildcards.

B. It unsubscribes from all channels.

C. It publishes messages to a channel.

D. It deletes keys matching a pattern.

Solution

1. Step 1: Understand the purpose of PSUBSCRIBE

   PSUBSCRIBE listens to messages from channels that match a given pattern, using wildcards like '*'.

2. Step 2: Compare with other commands

   Unlike PUBLISH or UNSUBSCRIBE, PSUBSCRIBE focuses on pattern-based subscription.

3. Final Answer:

   It subscribes to channels matching a pattern with wildcards. -> Option A

4. Quick Check:

   PSUBSCRIBE = pattern subscription [OK]

Hint: PSUBSCRIBE listens to patterns, not single channels [OK]

Common Mistakes:

• Confusing PSUBSCRIBE with PUBLISH
• Thinking PSUBSCRIBE deletes keys
• Mixing PSUBSCRIBE with UNSUBSCRIBE

2. Which of the following is the correct syntax to subscribe to all channels starting with 'news.' using PSUBSCRIBE?

easy

A. PSUBSCRIBE news?

B. PSUBSCRIBE news.*

C. PSUBSCRIBE news#

D. PSUBSCRIBE news+

Solution

1. Step 1: Identify the wildcard for pattern matching

   In Redis PSUBSCRIBE, '*' matches any sequence of characters.

2. Step 2: Match the pattern for channels starting with 'news.'

   The pattern 'news.*' matches all channels beginning with 'news.' followed by anything.

3. Final Answer:

   PSUBSCRIBE news.* -> Option B

4. Quick Check:

   '*' wildcard = correct syntax [OK]

Hint: Use '*' to match any characters in PSUBSCRIBE patterns [OK]

Common Mistakes:

• Using '?' which matches exactly one character
• Using '#' or '+' which are not Redis wildcards
• Missing the dot after 'news'

3. Given the following Redis commands executed in order:

PSUBSCRIBE sports.*
PUBLISH sports.football "Goal!"
PUBLISH sports.basketball "Score!"
PUBLISH news.weather "Rain"

Which messages will the subscriber receive?

medium

A. "Goal!" and "Score!"

B. "Goal!" only

C. "Rain" only

D. All three messages

Solution

1. Step 1: Understand the subscription pattern

   The subscriber listens to channels matching 'sports.*', meaning any channel starting with 'sports.'.

2. Step 2: Check published messages against the pattern

   Messages on 'sports.football' and 'sports.basketball' match the pattern; 'news.weather' does not.

3. Final Answer:

   "Goal!" and "Score!" -> Option A

4. Quick Check:

   Pattern matches sports.* channels only [OK]

Hint: Only messages on matching channels are received [OK]

Common Mistakes:

• Assuming all published messages are received
• Confusing exact channel with pattern
• Ignoring the pattern prefix

4. You run the command PSUBSCRIBE sports.* but receive no messages when publishing to sports.football. What is the most likely mistake?

medium

A. You published messages before subscribing.

B. You used SUBSCRIBE instead of PSUBSCRIBE.

C. You subscribed to sports.* but published to sportsfootball without a dot.

D. You used the wrong Redis server version.

Solution

1. Step 1: Check the channel names for exact pattern match

   The pattern 'sports.*' matches channels starting with 'sports.' including the dot.

2. Step 2: Identify mismatch in published channel

   Publishing to 'sportsfootball' (no dot) does not match 'sports.*' pattern.

3. Final Answer:

   You subscribed to sports.* but published to sportsfootball without a dot. -> Option C

4. Quick Check:

   Pattern requires exact prefix including dot [OK]

Hint: Check exact channel names match pattern including dots [OK]

Common Mistakes:

• Confusing SUBSCRIBE with PSUBSCRIBE
• Ignoring dot in channel names
• Assuming order of commands affects delivery

5. You want to listen to all channels that contain the word 'chat' anywhere in their name using PSUBSCRIBE. Which pattern should you use?

hard

A. chat

B. chat*

C. *chat

D. *chat*

Solution

1. Step 1: Understand the wildcard '*' usage

   '*' matches any sequence of characters, including none.

2. Step 2: Create pattern to match 'chat' anywhere

   Using '*chat*' matches any channel with 'chat' anywhere in its name.

3. Final Answer:

   *chat* -> Option D

4. Quick Check:

   Use '*' before and after 'chat' to match anywhere [OK]

Hint: Use '*' before and after word to match anywhere [OK]

Common Mistakes:

• Using 'chat' alone matches exact channel only
• Using 'chat*' matches only channels starting with 'chat'
• Using '*chat' matches only channels ending with 'chat'