Sorting arguments in GraphQL

Introduction

Sorting arguments help you get data in the order you want, like sorting names from A to Z or numbers from smallest to largest.

When you want to see a list of products sorted by price from low to high.

When you need to display users ordered by their signup date, newest first.

When showing blog posts sorted by popularity or number of comments.

When you want to list movies sorted alphabetically by title.

When you want to get events sorted by their start date.

Syntax

GraphQL

query {
  items(orderBy: {field: ASC}) {
    id
    name
  }
}

orderBy is the argument used to sort data.

You specify the field to sort by and the direction: ASC for ascending or DESC for descending.

Examples

This sorts users by their name in ascending order (A to Z).

GraphQL

query {
  users(orderBy: {name: ASC}) {
    id
    name
  }
}

This sorts products by price in descending order (highest to lowest).

GraphQL

query {
  products(orderBy: {price: DESC}) {
    id
    price
  }
}

This sorts posts by creation date, newest first.

GraphQL

query {
  posts(orderBy: {createdAt: DESC}) {
    id
    title
  }
}

Sample Program

This query gets a list of books sorted alphabetically by their title.

GraphQL

query {
  books(orderBy: {title: ASC}) {
    id
    title
  }
}

Important Notes

Sorting works only on fields that support ordering, like strings, numbers, or dates.

If you don't specify sorting, the order of results may be random or default.

You can often combine sorting with filtering to get exactly the data you want.

Summary

Sorting arguments let you control the order of data returned by a query.

Use orderBy with a field and direction (ASC or DESC).

Sorting makes data easier to read and find what you need quickly.

Practice

1. What does the orderBy argument do in a GraphQL query?

easy

A. It sorts the returned data by a specified field and direction.

B. It filters the data to only include certain fields.

C. It limits the number of results returned.

D. It groups the data by a specific field.

Solution

1. Step 1: Understand the purpose of orderBy

   The orderBy argument is used to arrange data in a specific order based on a field.

2. Step 2: Identify sorting behavior

   It sorts data either ascending (ASC) or descending (DESC) by the chosen field.

3. Final Answer:

   It sorts the returned data by a specified field and direction. -> Option A

4. Quick Check:

   Sorting = orderBy usage [OK]

Hint: Remember: orderBy controls sorting order in queries [OK]

Common Mistakes:

• Confusing orderBy with filtering or limiting results
• Thinking orderBy groups data instead of sorting
• Assuming orderBy changes the data fields returned

2. Which of the following is the correct syntax to sort users by their name in ascending order using orderBy?

easy

A. { users(orderBy: [name, ASC]) { id name } }

B. { users(orderBy: name ASC) { id name } }

C. { users(orderBy: { name: ASC }) { id name } }

D. { users(orderBy: { ASC: name }) { id name } }

Solution

1. Step 1: Review GraphQL orderBy syntax

   The correct syntax uses an object with the field as key and direction as value inside curly braces.

2. Step 2: Match syntax to options

   { users(orderBy: { name: ASC }) { id name } } matches this pattern: { name: ASC }. Others use incorrect formats.

3. Final Answer:

   { users(orderBy: { name: ASC }) { id name } } -> Option C

4. Quick Check:

   Correct orderBy syntax = { users(orderBy: { name: ASC }) { id name } } [OK]

Hint: Use curly braces with field: direction inside orderBy [OK]

Common Mistakes:

• Using parentheses or brackets incorrectly in orderBy
• Placing direction before field name
• Omitting curly braces around orderBy argument

3. Given this GraphQL query:

{ products(orderBy: { price: DESC }) { id name price } }

What will be the order of products in the result?

medium

A. Products sorted by price from highest to lowest.

B. Products sorted by price from lowest to highest.

C. Products sorted alphabetically by name.

D. Products returned in random order.

Solution

1. Step 1: Identify sorting field and direction

   The query uses orderBy: { price: DESC }, meaning sort by price descending.

2. Step 2: Understand descending order

   Descending order means highest values come first, then lower values.

3. Final Answer:

   Products sorted by price from highest to lowest. -> Option A

4. Quick Check:

   DESC means highest to lowest [OK]

Hint: DESC means descending (high to low), ASC means ascending (low to high) [OK]

Common Mistakes:

• Confusing DESC with ascending order
• Assuming sorting is by name instead of price
• Thinking orderBy does not affect order

4. You wrote this query to sort posts by date ascending:

{ posts(orderBy: { date: ASC }) { id title date } }

But you get an error. What is the likely mistake?

medium

A. You must use sortBy instead of orderBy.

B. The orderBy argument should be a list, not an object.

C. The direction ASC is not valid in GraphQL.

D. The date field is missing from the schema.

Solution

1. Step 1: Check schema fields

   If date is not defined in the posts schema, sorting by it causes an error.

2. Step 2: Validate other options

   orderBy accepts an object, ASC is valid, and sortBy is not standard GraphQL.

3. Final Answer:

   The date field is missing from the schema. -> Option D

4. Quick Check:

   Sorting field must exist in schema [OK]

Hint: Ensure sorting field exists in schema before using orderBy [OK]

Common Mistakes:

• Using invalid direction keywords
• Confusing orderBy with other arguments
• Assuming orderBy requires a list always

5. You want to fetch a list of employees sorted first by department ascending, then by salary descending. Which orderBy argument correctly achieves this?

hard

A. { employees(orderBy: { department: ASC, salary: DESC }) { id name department salary } }

B. { employees(orderBy: [{ department: ASC }, { salary: DESC }]) { id name department salary } }

C. { employees(orderBy: [department: ASC, salary: DESC]) { id name department salary } }

D. { employees(orderBy: { salary: DESC, department: ASC }) { id name department salary } }

Solution

1. Step 1: Understand multi-level sorting syntax

   To sort by multiple fields, orderBy usually takes a list of objects, each specifying a field and direction.

2. Step 2: Match correct syntax

   { employees(orderBy: [{ department: ASC }, { salary: DESC }]) { id name department salary } } uses a list with two objects: first { department: ASC }, then { salary: DESC }, which is correct.

3. Step 3: Check other options

   { employees(orderBy: { department: ASC, salary: DESC }) { id name department salary } } uses a single object with two keys, which may not guarantee order. { employees(orderBy: [department: ASC, salary: DESC]) { id name department salary } } has invalid syntax. { employees(orderBy: { salary: DESC, department: ASC }) { id name department salary } } reverses sorting priority.

4. Final Answer:

   { employees(orderBy: [{ department: ASC }, { salary: DESC }]) { id name department salary } } -> Option B

5. Quick Check:

   Multi-field orderBy = list of objects [OK]

Hint: Use a list of objects for multi-level sorting in orderBy [OK]

Common Mistakes:

• Using a single object for multiple sort fields
• Reversing the order of sorting priorities
• Incorrect syntax for list of sorting fields