Accessing keys and arguments in Redis - Mini Project: Build & Apply

Accessing keys and arguments in Redis Lua scripts

📖 Scenario: You are managing a Redis database for a small online store. You want to write a Lua script that can access keys and arguments passed to it, to perform operations like checking stock or updating prices.

🎯 Goal: Build a Redis Lua script that accesses keys and arguments correctly using KEYS and ARGV arrays.

📋 What You'll Learn

Create a Lua script that reads one key from KEYS

Read two arguments from ARGV

Use the key and arguments in the script logic

Return a combined string showing the key and arguments

💡 Why This Matters

🌍 Real World

Redis Lua scripts are used to perform atomic operations on Redis data by accessing keys and arguments passed from the client.

💼 Career

Understanding how to access KEYS and ARGV in Redis Lua scripts is essential for backend developers working with Redis to implement efficient and safe data operations.

1

Create a Lua script with one key in KEYS

Create a Lua script that accesses the first key from the KEYS array and stores it in a variable called productKey.

Redis

-- Access the first key from KEYS
-- Your code here

Hint

Remember, KEYS is an array of keys passed to the script. Use KEYS[1] to get the first key.

2

Access two arguments from ARGV

Add code to access the first and second arguments from the ARGV array and store them in variables called arg1 and arg2.

Redis

local productKey = KEYS[1]
-- Access the first and second arguments from ARGV
-- Your code here

Hint

Use ARGV[1] and ARGV[2] to get the first and second arguments passed to the script.

3

Combine the key and arguments into a string

Create a variable called result that concatenates productKey, arg1, and arg2 separated by commas.

Redis

local productKey = KEYS[1]
local arg1 = ARGV[1]
local arg2 = ARGV[2]
-- Concatenate productKey, arg1, and arg2 into result
-- Your code here

Hint

Use the Lua string concatenation operator .. to join strings with commas.

4

Return the combined string from the script

Add a return statement to return the result variable from the Lua script.

Redis

local productKey = KEYS[1]
local arg1 = ARGV[1]
local arg2 = ARGV[2]
local result = productKey .. "," .. arg1 .. "," .. arg2
-- Return the result
-- Your code here

Hint

Use return to send the result back from the Lua script.

Practice

1. In a Redis Lua script, which array is used to access the keys passed to the script?

easy

A. KEYS

B. ARGV

C. KEYSARGS

D. ARGS

Solution

1. Step 1: Understand Redis script inputs

   Redis Lua scripts receive keys and arguments separately.

2. Step 2: Identify the array for keys

   The keys are accessed using the KEYS array inside the script.

3. Final Answer:

   KEYS -> Option A

4. Quick Check:

   Keys = KEYS [OK]

Hint: Keys are always in KEYS array, arguments in ARGV [OK]

Common Mistakes:

• Confusing KEYS with ARGV
• Using ARGS instead of ARGV
• Assuming keys are in ARGV

2. Which of the following is the correct way to access the first argument (not key) inside a Redis Lua script?

easy

A. KEYS[1]

B. ARGV[0]

C. ARGV[1]

D. ARGS[1]

Solution

1. Step 1: Recall Lua array indexing

   Lua arrays start at 1, not 0.

2. Step 2: Identify argument array

   Arguments are accessed via ARGV array, so first argument is ARGV[1].

3. Final Answer:

   ARGV[1] -> Option C

4. Quick Check:

   First argument = ARGV[1] [OK]

Hint: Lua arrays start at 1, so first argument is ARGV[1] [OK]

Common Mistakes:

• Using zero-based index ARGV[0]
• Confusing KEYS with ARGV
• Using ARGS instead of ARGV

3. Consider this Redis Lua script snippet:

local key1 = KEYS[1]
local arg1 = ARGV[1]
return key1 .. '-' .. arg1

If the script is called with keys = ["user:1"] and arguments = ["active"], what is the returned result?

medium

A. "user:1-active"

B. "active-user:1"

C. "user:1active"

D. An error occurs

Solution

1. Step 1: Assign values from KEYS and ARGV

   key1 = "user:1", arg1 = "active" from the inputs.

2. Step 2: Concatenate with separator

   Return value is key1 .. '-' .. arg1 = "user:1-active".

3. Final Answer:

   "user:1-active" -> Option A

4. Quick Check:

   Concatenate KEYS[1] and ARGV[1] with '-' = "user:1-active" [OK]

Hint: Concatenate KEYS and ARGV with .. operator in Lua [OK]

Common Mistakes:

• Swapping KEYS and ARGV values
• Missing separator '-' in concatenation
• Using zero-based indexing

4. You wrote this Redis Lua script:

local key = KEYS[1]
local arg = ARGV[0]
return key .. arg

When running the script with one key and one argument, what will happen?

medium

A. It throws an error due to invalid index

B. It returns nil concatenated with key

C. It returns only the key

D. It returns concatenated key and argument

Solution

1. Step 1: Check Lua indexing rules

   Lua arrays start at 1, so ARGV[0] is invalid but returns nil.

2. Step 2: Understand behavior on invalid index

   Accessing ARGV[0] returns nil, concatenating key .. nil results in key .. "nil" or error depending on Lua version.

3. Final Answer:

   It returns nil concatenated with key -> Option B

4. Quick Check:

   Lua arrays start at 1, ARGV[0] returns nil, concatenation with nil results in string with 'nil' [OK]

Hint: Lua arrays start at 1, never use index 0 [OK]

Common Mistakes:

• Using zero-based index ARGV[0]
• Assuming ARGV[0] returns first argument
• Ignoring Lua indexing rules

5. You want to write a Redis Lua script that takes two keys and one argument. The script should return the value of the first key concatenated with the argument, then the value of the second key. Which is the correct way to access these inside the script?

hard

A. ARGV[1], KEYS[1], KEYS[2]

B. ARGV[0], KEYS[1], ARGV[1]

C. KEYS[0], ARGV[0], KEYS[1]

D. KEYS[1], ARGV[1], KEYS[2]

Solution

1. Step 1: Identify keys and argument positions

   Two keys are KEYS[1] and KEYS[2], one argument is ARGV[1].

2. Step 2: Access in correct order

   Access first key as KEYS[1], argument as ARGV[1], second key as KEYS[2].

3. Final Answer:

   KEYS[1], ARGV[1], KEYS[2] -> Option D

4. Quick Check:

   Keys in KEYS[], args in ARGV[], Lua index starts at 1 [OK]

Hint: Keys in KEYS[], args in ARGV[], index from 1 [OK]

Common Mistakes:

• Using zero-based indexes
• Mixing KEYS and ARGV order
• Using ARGV for keys