Connection pattern (edges, nodes, pageInfo) in GraphQL - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of the edges field in the connection pattern?

The edges field holds an array of objects, each representing a link between nodes. It contains the actual data node and a cursor for pagination.

beginner

Explain the role of the nodes field in a GraphQL connection.

The nodes field is a simplified list of the actual data items without pagination cursors. It provides direct access to the data nodes.

intermediate

What information does the pageInfo object provide in the connection pattern?

The pageInfo object gives details about pagination state, such as whether there are more pages before or after the current set, and the cursors for the first and last items.

beginner

Why is the connection pattern useful in GraphQL APIs?

It standardizes how lists with pagination are handled, making it easier to fetch data in chunks and navigate through large datasets efficiently.

intermediate

In the connection pattern, what is a cursor and how is it used?

A cursor is a unique identifier for a position in the list. It helps the API know where to start or continue fetching data for pagination.

Which field in the connection pattern contains the actual data items without pagination info?

A edges

B pageInfo

C nodes

D cursor

The nodes field contains the list of data items directly, without pagination cursors.

What does the pageInfo object NOT provide?

A The total count of all items in the list

B Whether there are pages before the current one

C Cursor for the last item in the current page

D Whether there are more pages after the current one

pageInfo does not include total count; it focuses on pagination state like cursors and page availability.

In the connection pattern, what is stored inside each edge?

A Both the data node and a cursor

B Only the data node

C Only the cursor

D Pagination info like page numbers

Each edge contains the data node and a cursor used for pagination.

Why are cursors important in the connection pattern?

A They store the total number of items

B They identify the position of items for pagination

C They hold the actual data

D They replace the need for <code>pageInfo</code>

Cursors mark positions in the list to help fetch the next or previous set of items.

Which of these is NOT part of the standard connection pattern?

A edges

B nodes

C pageInfo

D totalCount

totalCount is optional and not part of the core connection pattern fields.

Describe the three main parts of the connection pattern and their roles.

Think about how data and pagination info are separated.

Explain how cursors and pageInfo work together to enable pagination in GraphQL.

Consider how you move through pages of data.

Practice

1. What is the main purpose of the pageInfo field in the GraphQL connection pattern?

easy

A. To define the schema of the connection

B. To list all the nodes in the connection

C. To provide information about pagination like if there are more pages

D. To store the actual data items

Solution

1. Step 1: Understand the role of pageInfo

   The pageInfo field contains metadata about pagination such as whether there are more pages available.

2. Step 2: Differentiate from edges and nodes

   Unlike edges or nodes which hold data items, pageInfo only provides pagination status.

3. Final Answer:

   To provide information about pagination like if there are more pages -> Option C

4. Quick Check:

   pageInfo = pagination info [OK]

Hint: Remember pageInfo tells if more pages exist [OK]

Common Mistakes:

• Confusing pageInfo with nodes or edges
• Thinking pageInfo holds actual data items
• Ignoring pagination metadata role

2. Which of the following is the correct way to query the edges and node fields in a GraphQL connection?

easy

A. { users { edge { node { id name } } } }

B. { users { nodes { id name } } }

C. { users { pageInfo { hasNextPage } } }

D. { users { edges { node { id name } } } }

Solution

1. Step 1: Recall correct field names in connection pattern

   The connection pattern uses edges (plural) and inside each edge a node (singular) holds the data.

2. Step 2: Check each option's syntax

   { users { edges { node { id name } } } }

   correctly uses edges and node.

   { users { nodes { id name } } }

   uses nodes which is valid but not with edges.

   { users { pageInfo { hasNextPage } } }

   queries only pageInfo.

   { users { edge { node { id name } } } }

   uses edge singular which is incorrect.

3. Final Answer:

   { users { edges { node { id name } } } } -> Option D

4. Quick Check:

   edges plural, node singular inside edges [OK]

Hint: Edges is plural; node is singular inside edges [OK]

Common Mistakes:

• Using 'edge' instead of 'edges'
• Mixing nodes and edges syntax
• Querying pageInfo instead of data fields

3. Given this GraphQL query:

{ posts(first: 2) { edges { cursor node { id title } } pageInfo { hasNextPage } } }

And the server returns two posts with ids 101 and 102, what will pageInfo.hasNextPage be if there are more posts after these two?

medium

A. true

B. false

C. null

D. undefined

Solution

1. Step 1: Understand the meaning of hasNextPage

   hasNextPage is true if more items exist beyond the current page.

2. Step 2: Apply to given scenario

   Since the server returns 2 posts but more posts exist after them, hasNextPage must be true.

3. Final Answer:

   true -> Option A

4. Quick Check:

   More posts after current page means hasNextPage = true [OK]

Hint: More items after current page means hasNextPage true [OK]

Common Mistakes:

• Assuming hasNextPage is false when items equal page size
• Confusing hasNextPage with hasPreviousPage
• Expecting null or undefined instead of boolean

4. You wrote this GraphQL query:

{ comments { edge { node { id text } } } }

But it returns an error. What is the likely cause?

medium

A. The field 'node' should be 'nodes'

B. The field should be 'edges' not 'edge'

C. Missing 'pageInfo' field causes error

D. The query must include 'pageInfo' and 'nodes' together

Solution

1. Step 1: Check the connection field names

   The connection pattern uses edges (plural) not edge (singular).

2. Step 2: Identify the error cause

   Using edge causes a field not found error because the schema expects edges.

3. Final Answer:

   The field should be 'edges' not 'edge' -> Option B

4. Quick Check:

   edges plural required, edge singular causes error [OK]

Hint: Use 'edges' plural, not 'edge' singular [OK]

Common Mistakes:

• Using 'edge' instead of 'edges'
• Thinking 'node' should be plural
• Assuming pageInfo is mandatory for query success

5. You want to fetch a list of products with their IDs and names using the connection pattern. You only need the list of products without pagination info. Which query is best?

hard

A. { products { nodes { id name } } }

B. { products { edges { node { id name } } pageInfo { hasNextPage } } }

C. { products { pageInfo { hasPreviousPage } } }

D. { products { edges { cursor } } }

Solution

1. Step 1: Understand the difference between nodes and edges

   nodes gives a simple list of items without pagination details, while edges includes cursors for pagination.

2. Step 2: Choose the query matching the need

   Since pagination info is not needed, querying nodes directly is simpler and efficient.

3. Final Answer:

   { products { nodes { id name } } } -> Option A

4. Quick Check:

   Use nodes for simple list without pagination [OK]

Hint: Use nodes for simple lists without pagination [OK]

Common Mistakes:

• Using edges and pageInfo when not needed
• Querying only pageInfo without data
• Ignoring simpler nodes field for lists