Query arguments in GraphQL - Step-by-Step Execution

Concept Flow - Query arguments

Start Query

↓

Define Arguments

↓

Pass Arguments in Query

↓

Server Receives Arguments

↓

Use Arguments to Filter Data

↓

Return Filtered Results

↓

Display Results

The query starts by defining and passing arguments, which the server uses to filter data and return only the requested results.

Execution Sample

GraphQL

query GetBooks($author: String!) {
  books(author: $author) {
    title
    author
  }
}

This query asks for books by a specific author, passing the author's name as an argument.

Execution Table

Step	Action	Argument Value	Server Processing	Output
1	Start query execution	N/A	Prepare to receive arguments	No output yet
2	Receive argument $author	"J.K. Rowling"	Receive and validate argument	No output yet
3	Query books with author filter	"J.K. Rowling"	Filter books where author = 'J.K. Rowling'	Books list filtered
4	Return filtered books	"J.K. Rowling"	Send filtered books data	[{"title": "Harry Potter and the Sorcerer's Stone", "author": "J.K. Rowling"}, {"title": "Harry Potter and the Chamber of Secrets", "author": "J.K. Rowling"}]
5	Display results to client	N/A	Render data	List of books by J.K. Rowling shown

💡 Query completes after returning filtered books matching the argument.

Variable Tracker

Variable	Start	After Step 2	After Step 3	Final
$author	undefined	"J.K. Rowling"	"J.K. Rowling"	"J.K. Rowling"
books	undefined	undefined	filtered list of books by J.K. Rowling	filtered list of books by J.K. Rowling

Key Moments - 2 Insights

Why do we need to define the argument type like String!?

The exclamation mark (!) means the argument is required. Without it, the argument could be missing, and the server might not know how to filter. See execution_table step 2 where the argument is received.

What happens if the argument value does not match any data?

The server returns an empty list because no books match the filter. This is shown in execution_table step 4 where filtered books are returned.

Visual Quiz - 3 Questions

Look at the execution_table, what is the value of $author after step 2?

A "J.K. Rowling"

B undefined

C null

D "Harry Potter"

💡 Hint

Check the 'Argument Value' column at step 2 in execution_table.

At which step does the server filter books using the argument?

A Step 2

B Step 3

C Step 1

D Step 5

💡 Hint

Look at the 'Server Processing' column to find when filtering happens.

If the argument $author was missing, what would likely happen?

A The server returns all books

B The server returns no books

C The server returns an error

D The server ignores the query

💡 Hint

Recall the meaning of String! in the argument definition and check key_moments about required arguments.

Concept Snapshot

GraphQL query arguments let you pass values to filter or customize data.
Arguments are defined with types, e.g., String!, where ! means required.
You pass arguments when calling the query.
The server uses arguments to filter data before returning results.
Missing required arguments cause errors.
Arguments make queries flexible and efficient.

Full Transcript

This visual execution shows how GraphQL query arguments work step-by-step. The query starts and defines an argument $author of type String! which means it is required. When the query runs, the argument value "J.K. Rowling" is passed. The server receives this argument and uses it to filter the books data to only those written by J.K. Rowling. The filtered list is then returned and displayed. Variables like $author hold the argument value throughout execution. Key moments include understanding why the argument type is required and what happens if no data matches the argument. The quizzes test understanding of argument values at different steps and consequences of missing arguments. This helps beginners see how arguments control query results in GraphQL.

Practice

1. What is the purpose of query arguments in GraphQL?

easy

A. To write comments inside queries

B. To define new types in the schema

C. To specify exactly what data you want from the server

D. To create mutations for updating data

Solution

1. Step 1: Understand what query arguments do

   Query arguments allow you to tell the server exactly which data you want, like filtering or limiting results.

2. Step 2: Compare options to the purpose

   Only To specify exactly what data you want from the server describes specifying data in queries. Other options describe unrelated tasks.

3. Final Answer:

   To specify exactly what data you want from the server -> Option C

4. Quick Check:

   Query arguments = specify data [OK]

Hint: Arguments filter or limit data inside parentheses [OK]

Common Mistakes:

• Confusing arguments with schema definitions
• Thinking arguments create mutations
• Using arguments for comments

2. Which of the following is the correct syntax to pass an argument named id with value 5 to a GraphQL query field user?

easy

A. user(id: 5) { name }

B. user[id=5] { name }

C. user{id=5} { name }

D. user(id=5) { name }

Solution

1. Step 1: Recall GraphQL argument syntax

   Arguments go inside parentheses after the field name, with colon separating name and value.

2. Step 2: Check each option's syntax

   user(id: 5) { name } uses parentheses and colon correctly. Options B and C use brackets or braces incorrectly. user(id=5) { name } uses equals sign instead of colon.

3. Final Answer:

   user(id: 5) { name } -> Option A

4. Quick Check:

   Arguments use (name: value) syntax [OK]

Hint: Use parentheses and colon for arguments (name: value) [OK]

Common Mistakes:

• Using square brackets instead of parentheses
• Using equals sign instead of colon
• Placing arguments inside braces

3. Given the query { books(limit: 2) { title } } and a database with books titled 'A', 'B', 'C', what will the query return?

medium

A. [{ title: 'A' }, { title: 'B' }, { title: 'C' }]

B. [] (empty list)

C. Error: 'limit' is not a valid argument

D. [{ title: 'A' }, { title: 'B' }]

Solution

1. Step 1: Understand the limit argument

   The limit: 2 argument restricts the number of returned books to 2.

2. Step 2: Predict the returned data

   From books 'A', 'B', 'C', only the first two 'A' and 'B' will be returned.

3. Final Answer:

   [{ title: 'A' }, { title: 'B' }] -> Option D

4. Quick Check:

   limit: 2 returns 2 items [OK]

Hint: Limit argument restricts number of results [OK]

Common Mistakes:

• Assuming all items return ignoring limit
• Thinking limit causes error
• Expecting empty list when data exists

4. Identify the error in this GraphQL query: { users(age: 'twenty') { name } } assuming age expects an integer argument.

medium

A. The field name 'users' is invalid

B. The argument value should be an integer, not a string

C. Missing curly braces around the argument

D. The query is correct and will run without errors

Solution

1. Step 1: Check argument type requirements

   The age argument expects an integer, but the query passes a string 'twenty'.

2. Step 2: Identify the type mismatch error

   Passing a string instead of an integer causes a type error in GraphQL.

3. Final Answer:

   The argument value should be an integer, not a string -> Option B

4. Quick Check:

   Argument types must match schema [OK]

Hint: Match argument types exactly as defined [OK]

Common Mistakes:

• Passing strings instead of numbers
• Assuming field names cause errors
• Thinking braces are needed around arguments

5. You want to query a list of products sorted by price descending and limited to 3 items. Which query correctly uses arguments to achieve this?

hard

A. { products(sortBy: "price_desc", limit: 3) { name price } }

B. { products(limit: 3, order: "desc") { name price } }

C. { products(sort: price, limit: 3) { name price } }

D. { products(limit: 3, sortBy: "desc_price") { name price } }

Solution

1. Step 1: Identify correct argument names and values

   The argument sortBy with value "price_desc" clearly indicates sorting by price descending. The limit argument limits results to 3.

2. Step 2: Evaluate each option's correctness

   { products(sortBy: "price_desc", limit: 3) { name price } } uses both arguments correctly. { products(limit: 3, order: "desc") { name price } } uses 'order' which may be invalid. { products(sort: price, limit: 3) { name price } } uses 'sort' without quotes and no direction. { products(limit: 3, sortBy: "desc_price") { name price } } uses 'desc_price' which is not standard.

3. Final Answer:

   { products(sortBy: "price_desc", limit: 3) { name price } } -> Option A

4. Quick Check:

   Use correct argument names and values [OK]

Hint: Use exact argument names and values from schema [OK]

Common Mistakes:

• Using wrong argument names like 'order' or 'sort'
• Passing unquoted values for strings
• Mixing argument order incorrectly