Client-side cluster support in Redis - Mini Project: Build & Apply

Client-side Cluster Support with Redis

📖 Scenario: You are managing a Redis database that is distributed across multiple nodes in a cluster. To efficiently access data, you want to simulate client-side cluster support by mapping keys to specific nodes.

🎯 Goal: Build a simple Redis client-side cluster support setup by creating a dictionary that maps keys to nodes, configuring a hash slot function, and implementing a function to get the node for a given key.

📋 What You'll Learn

Create a dictionary called cluster_nodes with three nodes: 'node1', 'node2', and 'node3'.

Create a variable called hash_slots set to 16384 representing total hash slots in Redis cluster.

Write a function called get_node_for_key that takes a key and returns the node name by computing the hash slot modulo hash_slots and mapping it to a node.

Add a final dictionary called key_node_map that maps example keys 'user:1', 'order:5', and 'product:3' to their respective nodes using get_node_for_key.

💡 Why This Matters

🌍 Real World

Redis clusters distribute data across multiple nodes to improve performance and reliability. Client-side cluster support helps clients know which node to contact for a given key.

💼 Career

Understanding client-side cluster support is important for backend developers and database administrators working with distributed Redis setups.

1

Create cluster nodes dictionary

Create a dictionary called cluster_nodes with these exact entries: 0: 'node1', 1: 'node2', and 2: 'node3'.

Redis

# Create the cluster_nodes dictionary
# Your code here

Hint

Use a dictionary with integer keys 0, 1, 2 and string values 'node1', 'node2', 'node3'.

2

Set total hash slots

Create a variable called hash_slots and set it to 16384.

Redis

cluster_nodes = {0: 'node1', 1: 'node2', 2: 'node3'}
# Set the total number of hash slots
# Your code here

Hint

Assign the integer 16384 to the variable hash_slots.

3

Write function to get node for a key

Write a function called get_node_for_key that takes a parameter key. Inside, compute the hash slot by taking the built-in hash(key) modulo hash_slots. Then, get the node index by taking the hash slot modulo 3. Return the node name from cluster_nodes using this index.

Redis

cluster_nodes = {0: 'node1', 1: 'node2', 2: 'node3'}
hash_slots = 16384

# Define get_node_for_key function
# Your code here

Hint

Use hash(key) % hash_slots to get the slot, then slot % 3 to get the node index.

4

Map example keys to nodes

Create a dictionary called key_node_map that maps these keys: 'user:1', 'order:5', and 'product:3' to their respective nodes by calling get_node_for_key for each key.

Redis

cluster_nodes = {0: 'node1', 1: 'node2', 2: 'node3'}
hash_slots = 16384

def get_node_for_key(key):
    slot = hash(key) % hash_slots
    node_index = slot % 3
    return cluster_nodes[node_index]

# Create key_node_map dictionary
# Your code here

Hint

Use a dictionary with keys as strings and values from calling get_node_for_key on each key.

Practice

1. What is the main benefit of using client-side cluster support in Redis?

easy

A. It encrypts all data stored in Redis without extra setup.

B. It reduces the size of the Redis database automatically.

C. It merges all cluster nodes into a single server.

D. It allows the client to connect directly to the correct Redis node in the cluster.

Solution

1. Step 1: Understand client-side cluster support

   Client-side cluster support means the client knows how to talk to the right Redis node directly.

2. Step 2: Identify the main benefit

   This direct connection helps speed up requests and balances load across nodes.

3. Final Answer:

   It allows the client to connect directly to the correct Redis node in the cluster. -> Option D

4. Quick Check:

   Client-side cluster support = direct node connection [OK]

Hint: Client-side cluster means client talks directly to right node [OK]

Common Mistakes:

• Thinking it reduces database size automatically
• Confusing encryption with cluster support
• Believing it merges nodes into one server

2. Which of the following is the correct way to initialize a Redis client with cluster support in code?

easy

A. redis.createClient({ cluster: true, nodes: [...] })

B. redis.connectCluster(nodes)

C. redis.clusterConnect({ nodes: [...] })

D. redis.newClusterClient(nodes)

Solution

1. Step 1: Recall Redis client cluster initialization syntax

   The standard way is to create a client with cluster option and provide nodes list.

2. Step 2: Match syntax to options

   redis.createClient({ cluster: true, nodes: [...] }) matches the known syntax: redis.createClient({ cluster: true, nodes: [...] }). Others are invalid method names.

3. Final Answer:

   redis.createClient({ cluster: true, nodes: [...] }) -> Option A

4. Quick Check:

   Correct cluster client init = createClient with cluster true [OK]

Hint: Use createClient with cluster:true and nodes array [OK]

Common Mistakes:

• Using non-existent methods like connectCluster
• Forgetting to set cluster: true
• Passing nodes incorrectly

3. Given a Redis cluster with nodes at ports 7000 and 7001, what will the following code do?

const client = redis.createClient({ cluster: true, nodes: [ { port: 7000 }, { port: 7001 } ] });
await client.connect();
await client.set('key1', 'value1');
const val = await client.get('key1');
console.log(val);

medium

A. It will print 'value1' after storing the key in the correct cluster node.

B. It will throw an error because set is not supported in cluster mode.

C. It will print null because the key is not stored.

D. It will connect only to port 7000 and ignore 7001.

Solution

1. Step 1: Understand cluster client behavior on set/get

   The client connects to multiple nodes and routes commands to the right node based on key hashing.

2. Step 2: Analyze code flow

   It sets 'key1' with 'value1' and then gets 'key1'. The client handles routing, so get returns 'value1'.

3. Final Answer:

   It will print 'value1' after storing the key in the correct cluster node. -> Option A

4. Quick Check:

   Cluster client routes keys correctly = prints value1 [OK]

Hint: Cluster client routes keys, so get returns stored value [OK]

Common Mistakes:

• Thinking set/get are unsupported in cluster mode
• Assuming only one node is used
• Expecting null because of cluster complexity

4. You wrote this code to connect to a Redis cluster but get a connection error:

const client = redis.createClient({ cluster: true, nodes: [ { port: 7000 } ] });
await client.connect();

What is the most likely cause?

medium

A. The client library does not support cluster mode.

B. The port 7000 is incorrect; cluster nodes use port 6379.

C. You need to provide at least two nodes for cluster support.

D. You forgot to set cluster: false in options.

Solution

1. Step 1: Check cluster node requirements

   For cluster support, the client should know multiple nodes to discover the cluster topology.

2. Step 2: Analyze given nodes array

   Only one node is provided, so the client cannot properly discover the cluster, causing connection errors.

3. Final Answer:

   You need to provide at least two nodes for cluster support. -> Option C

4. Quick Check:

   Cluster client needs multiple nodes to connect [OK]

Hint: Provide multiple nodes to connect to cluster [OK]

Common Mistakes:

• Assuming single node is enough for cluster
• Confusing default Redis port with cluster ports
• Misconfiguring cluster option

5. You want to optimize your Redis cluster client to handle failover smoothly. Which approach best uses client-side cluster support to achieve this?

hard

A. Connect only to the master node and manually switch to replicas on failure.

B. Configure the client with multiple cluster nodes and enable automatic node discovery and retries.

C. Disable cluster mode and connect to nodes one by one in round-robin fashion.

D. Use a single client connection and restart it on any error.

Solution

1. Step 1: Understand failover handling in cluster clients

   Good cluster clients support automatic discovery of nodes and retry commands on failover.

2. Step 2: Evaluate options for smooth failover

   Configure the client with multiple cluster nodes and enable automatic node discovery and retries. uses multiple nodes and automatic discovery, which helps the client adapt to cluster changes without manual intervention.

3. Final Answer:

   Configure the client with multiple cluster nodes and enable automatic node discovery and retries. -> Option B

4. Quick Check:

   Automatic discovery and retries = smooth failover [OK]

Hint: Use multiple nodes and enable auto discovery for failover [OK]

Common Mistakes:

• Relying on manual failover switching
• Disabling cluster mode loses benefits
• Restarting client on every error is inefficient