Schema definition in GraphQL - Step-by-Step Execution

Concept Flow - Schema definition

Start Schema

↓

Define Types

↓

Add Fields to Types

↓

Specify Field Types

↓

Add Queries/Mutations

↓

Schema Ready for Use

The schema definition starts by defining types, adding fields with their types, then adding queries or mutations, resulting in a complete schema.

Execution Sample

GraphQL

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

type Query {
  books: [Book]
}

Defines a Book type with fields and a Query type to fetch books.

Execution Table

Step	Action	Definition Added	Resulting Schema Part
1	Define type Book	type Book { id: ID!, title: String!, author: String }	Book type with 3 fields
2	Define type Query	type Query { books: [Book] }	Query type with books field returning list of Book
3	Schema complete	All types and fields defined	Schema ready to use for queries

💡 All types and fields defined, schema is complete

Variable Tracker

Variable	Start	After Step 1	After Step 2	Final
Schema	empty	Book type defined	Book and Query types defined	Complete schema with Book and Query

Key Moments - 3 Insights

Why do we need to specify field types like String or ID?

Field types tell GraphQL what kind of data to expect; see execution_table step 1 where fields have types like ID! and String!

What does the exclamation mark (!) mean after a type?

It means the field is required (non-nullable), as shown in execution_table step 1 for id and title fields.

Why is the Query type important?

Query defines how clients can ask for data; in execution_table step 2, books field allows fetching Book list.

Visual Quiz - 3 Questions

Look at the execution_table, what is defined in Step 1?

A The Query type with books field

B The Book type with id, title, author fields

C The Mutation type

D The schema is complete

💡 Hint

Check execution_table row for Step 1 under 'Definition Added'

At which step is the Query type added to the schema?

A Step 1

B Step 3

C Step 2

D Query type is not added

💡 Hint

Look at execution_table row for Step 2

If we remove the exclamation mark from 'id: ID!' in Book type, what changes?

A id becomes optional (nullable)

B id becomes a list

C id becomes a mutation

D No change

💡 Hint

Refer to key_moments about exclamation mark meaning

Concept Snapshot

Schema definition in GraphQL:
- Define types with 'type TypeName { fields }'
- Fields have names and types (e.g., String, ID)
- '!' means field is required
- Query type defines how to fetch data
- Schema combines types and queries for API structure

Full Transcript

Schema definition in GraphQL involves creating types that describe the shape of data. Each type has fields with specific data types, such as String or ID. An exclamation mark after a type means the field is required and cannot be null. The Query type is special because it defines how clients can request data from the API. The schema is complete when all types and queries are defined, ready for use in fetching or modifying data.

Practice

1. What is the purpose of the schema block in a GraphQL schema definition?

easy

A. It specifies the database connection details.

B. It defines the main entry points like query and mutation types.

C. It creates new object types with fields.

D. It lists all the scalar types available.

Solution

1. Step 1: Understand the role of the schema block

   The schema block in GraphQL defines the entry points for the API, such as which types are used for queries and mutations.

2. Step 2: Differentiate from other schema parts

   Object types with fields are defined using type, not the schema block. Database connections and scalar types are not defined here.

3. Final Answer:

   It defines the main entry points like query and mutation types. -> Option B

4. Quick Check:

   Schema block = entry points (query, mutation) [OK]

Hint: Remember schema block sets query and mutation roots [OK]

Common Mistakes:

• Confusing schema block with type definitions
• Thinking schema block defines database details
• Assuming schema block lists scalar types

2. Which of the following is the correct syntax to define a simple object type Book with a title field of type String in GraphQL?

easy

A. schema Book { title: String }

B. object Book { title: String }

C. type Book { title: String }

D. define Book { title: String }

Solution

1. Step 1: Recall GraphQL syntax for object types

   GraphQL uses the keyword type to define object types, followed by the type name and fields inside curly braces.

2. Step 2: Check each option

   Only type Book { title: String } uses the correct keyword type and proper syntax. Others use invalid keywords like object, schema, or define.

3. Final Answer:

   type Book { title: String } -> Option C

4. Quick Check:

   Object type syntax = type + name + fields [OK]

Hint: Use 'type' keyword to define objects in GraphQL [OK]

Common Mistakes:

• Using 'object' or 'define' instead of 'type'
• Confusing schema block with type definition
• Missing curly braces around fields

3. Given the schema definition:

type Query {
  book: Book
}
type Book {
  title: String
  pages: Int
}

What fields can be queried under book?

medium

A. Only title

B. No fields, book is scalar

C. Only pages

D. title and pages

Solution

1. Step 1: Identify the type of book field in Query

   The book field in Query returns a Book object type.

2. Step 2: Check fields inside Book type

   The Book type has two fields: title (String) and pages (Int), so both can be queried.

3. Final Answer:

   title and pages -> Option D

4. Quick Check:

   Object fields = title + pages [OK]

Hint: Object fields are all listed inside its type definition [OK]

Common Mistakes:

• Assuming only one field is accessible
• Thinking book is a scalar, not an object
• Ignoring fields inside the Book type

4. Identify the error in this GraphQL schema snippet:

schema {
  query: Query
}
type Query {
  book: Book
}
type Book {
  title String
}

medium

A. Missing colon ':' after 'title' field name

B. Missing curly braces around Query type

C. Schema block should be named 'type Schema'

D. Book type cannot be used in Query

Solution

1. Step 1: Check field syntax in Book type

   The field title String is missing a colon ':' between the field name and type. It should be title: String.

2. Step 2: Verify other parts of the schema

   The schema block and Query type are correctly defined with proper braces and names.

3. Final Answer:

   Missing colon ':' after 'title' field name -> Option A

4. Quick Check:

   Field syntax requires colon ':' [OK]

Hint: Always put ':' between field name and type [OK]

Common Mistakes:

• Omitting colon ':' after field names
• Confusing schema block syntax
• Misnaming schema block as a type

5. You want to add a mutation to create a new Book with fields title (String) and pages (Int). Which schema definition correctly adds this mutation?

hard

A. type Mutation { createBook(title: String, pages: Int): Book } schema { mutation: Mutation }

B. schema { mutation: Mutation } type Mutation { createBook(title String, pages Int): Book }

C. type Mutation { createBook(title: String, pages: Int): Book } schema { query: Query }

D. type Mutation { createBook(title: String, pages: Int): Book }

Solution

1. Step 1: Define the Mutation type with correct field syntax

   The mutation field createBook must have arguments with colons, e.g., title: String, and return type Book. schema { mutation: Mutation } type Mutation { createBook(title String, pages Int): Book } has missing colons, so it's invalid.

2. Step 2: Link the Mutation type in the schema block

   The schema block must include mutation: Mutation to expose the mutation. type Mutation { createBook(title: String, pages: Int): Book } schema { mutation: Mutation } correctly includes this after defining Mutation.

3. Final Answer:

   type Mutation { createBook(title: String, pages: Int): Book } schema { mutation: Mutation } -> Option A

4. Quick Check:

   Mutation type + schema mutation entry = correct [OK]

Hint: Mutation must be linked in schema block with correct syntax [OK]

Common Mistakes:

• Omitting colons in argument definitions
• Not linking mutation type in schema block
• Only defining mutation type without schema entry