Entity references in GraphQL - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is an entity reference in GraphQL?

An entity reference is a way to uniquely identify an object across services in a federated GraphQL setup, allowing different services to share and resolve the same entity.

beginner

How do you mark a type as an entity in GraphQL federation?

You add the @key directive to the type, specifying one or more fields that uniquely identify the entity.

intermediate

What is the purpose of the _entities field in a federated GraphQL schema?

The _entities field allows querying multiple entities by their references, resolving them to their full data from the appropriate service.

intermediate

Explain how entity references help in a microservices architecture using GraphQL.

Entity references let different microservices own parts of the data but still link and fetch complete entities by their unique keys, enabling a unified API.

beginner

What directive is used to specify the fields that form the unique key for an entity?

The @key directive is used to specify the unique identifying fields of an entity in GraphQL federation.

Which directive marks a GraphQL type as an entity for federation?

A @key

B @entity

C @reference

D @unique

The @key directive marks a type as an entity by specifying its unique identifying fields.

What is the purpose of the _entities field in a federated GraphQL schema?

A To query multiple entities by their references

B To list all types in the schema

C To define new types

D To delete entities

The _entities field allows querying multiple entities by their references to fetch full data.

In GraphQL federation, what does an entity reference usually contain?

A The entire entity data

B The unique key fields of the entity

C Only the entity's type name

D The service URL

An entity reference contains the unique key fields that identify the entity.

Why are entity references important in a microservices GraphQL architecture?

A They encrypt data between services

B They speed up database queries

C They allow services to share and resolve the same entity data

D They replace REST APIs

Entity references enable different services to share and resolve the same entity data across the federated schema.

Which of the following is NOT true about entity references?

A They rely on the @key directive

B They are used to fetch full entity data

C They uniquely identify an entity across services

D They store the entire entity data locally

Entity references do not store the entire entity data locally; they only contain unique identifiers.

Describe what an entity reference is and how it works in GraphQL federation.

Think about how different services share data about the same object.

Explain why entity references are useful in a microservices environment using GraphQL.

Consider how multiple teams manage parts of data but want a single API.

Practice

1. What is the main purpose of entity references in GraphQL?

easy

A. To create mutations for updating data

B. To define scalar types like Int and String

C. To connect one type to another and fetch related data

D. To write raw SQL queries inside GraphQL

Solution

1. Step 1: Understand entity references

   Entity references link one GraphQL type to another, allowing related data to be fetched together.

2. Step 2: Compare options

   Only To connect one type to another and fetch related data describes connecting types and fetching related data, which is the purpose of entity references.

3. Final Answer:

   To connect one type to another and fetch related data -> Option C

4. Quick Check:

   Entity references = connect types [OK]

Hint: Entity references link types to get related info fast [OK]

Common Mistakes:

• Confusing entity references with scalar type definitions
• Thinking entity references are for mutations
• Assuming entity references are raw SQL queries

2. Which of the following is the correct way to define an entity reference in a GraphQL schema?

easy

A. type Book { author: Boolean }

B. type Book { author: String }

C. type Book { author: Int }

D. type Book { author: Author }

Solution

1. Step 1: Identify entity reference syntax

   Entity references use another type's name as the field type, e.g., author: Author.

2. Step 2: Check options

   Only type Book { author: Author } uses a type name (Author) as a field type, correctly defining an entity reference.

3. Final Answer:

   type Book { author: Author } -> Option D

4. Quick Check:

   Entity reference = field with another type name [OK]

Hint: Use type names, not scalars, for entity references [OK]

Common Mistakes:

• Using scalar types instead of type names for references
• Confusing field names with types
• Missing curly braces in type definitions

3. Given the schema:

type Author { id: ID! name: String! } type Book { id: ID! title: String! author: Author }

What will the query { book { title author { name } } } return if the book's title is "GraphQL Guide" and the author's name is "Alice"?

medium

A. {"book": {"title": "GraphQL Guide", "author": "Alice"}}

B. {"book": {"title": "GraphQL Guide", "author": {"name": "Alice"}}}

C. {"book": {"title": "GraphQL Guide", "author": null}}

D. SyntaxError

Solution

1. Step 1: Understand the query structure

   The query requests the book's title and the nested author's name, matching the schema's entity reference.

2. Step 2: Predict the output

   The response will include the book title and an object for author with the name field, as in {"book": {"title": "GraphQL Guide", "author": {"name": "Alice"}}}.

3. Final Answer:

   {"book": {"title": "GraphQL Guide", "author": {"name": "Alice"}}} -> Option B

4. Quick Check:

   Nested entity reference returns nested object [OK]

Hint: Nested fields return nested objects, not strings [OK]

Common Mistakes:

• Expecting author as a string instead of an object
• Assuming null author when data exists
• Confusing syntax errors with valid queries

4. Consider this schema snippet:

type Book { id: ID! title: String! author: Author }

and this query:

{ book { title author } }

Why will this query cause an error?

medium

A. Because author is an object type and requires subfields

B. Because title is missing

C. Because book is not defined

D. Because author should be a scalar type

Solution

1. Step 1: Check field types in query

   The author field is an object type, so GraphQL requires specifying which subfields to fetch.

2. Step 2: Identify error cause

   Querying author without subfields causes a validation error, as in Because author is an object type and requires subfields.

3. Final Answer:

   Because author is an object type and requires subfields -> Option A

4. Quick Check:

   Object fields need subfields in queries [OK]

Hint: Always specify subfields for object-type fields [OK]

Common Mistakes:

• Querying object fields without subfields
• Assuming scalar fields need subfields
• Ignoring schema definitions

5. You have these types:

type User { id: ID! name: String! posts: [Post!]! } type Post { id: ID! content: String! author: User! }

How can you write a query to get each user's name and the content of their posts?

hard

A. { user { name posts { content } } }

B. { user { name posts } }

C. { user { posts { content } } }

D. { user { name content } }

Solution

1. Step 1: Understand the schema relations

   User has a list of posts, each post has content. To get user name and posts content, query both fields with nested subfields.

2. Step 2: Check query options

   { user { name posts { content } } } correctly queries user name and nested posts content. Others miss fields or subfields.

3. Final Answer:

   { user { name posts { content } } } -> Option A

4. Quick Check:

   Nested lists need subfields for content [OK]

Hint: Query nested lists with subfields for details [OK]

Common Mistakes:

• Omitting subfields for list items
• Missing user name field
• Trying to query scalar fields as objects