Required fields with non-null (!) in GraphQL

Introduction

We use required fields with non-null (!) to make sure some data is always given. This helps keep data complete and reliable.

When you want to make sure a user's name is always provided in a form.

When an email address must be given to create an account.

When a product's price should never be missing in a store database.

When a post must always have a title before saving.

When a required setting must be set before running a program.

Syntax

GraphQL

type TypeName {
  fieldName: FieldType!
}

The exclamation mark ! after the type means the field is required and cannot be null.

If you omit !, the field can be empty or missing.

Examples

id and name must always have values. email can be empty.

GraphQL

type User {
  id: ID!
  name: String!
  email: String
}

name and price are required fields. description is optional.

GraphQL

type Product {
  name: String!
  price: Float!
  description: String
}

Sample Program

This defines a Book type where title and author must always be provided. publishedYear is optional.

GraphQL

type Book {
  title: String!
  author: String!
  publishedYear: Int
}

Important Notes

Using ! helps catch errors early by forcing required data.

Be careful not to mark too many fields as required, or it can make data input hard.

Summary

Adding ! after a field type makes it required and non-null.

Required fields help keep your data complete and trustworthy.

Optional fields can be left empty or missing.

Practice

1. What does adding ! after a field type in GraphQL schema mean?

easy

A. The field is required and cannot be null

B. The field is optional and can be null

C. The field is deprecated

D. The field is a list type

Solution

1. Step 1: Understand the role of ! in GraphQL

   In GraphQL, adding ! after a type means the field is non-nullable, so it must have a value.

2. Step 2: Interpret the meaning for data completeness

   This means the field is required and cannot be left empty or null, ensuring data completeness.

3. Final Answer:

   The field is required and cannot be null -> Option A

4. Quick Check:

   Non-null ! means required = C [OK]

Hint: Remember: ! means must have a value, no null allowed [OK]

Common Mistakes:

• Thinking ! means optional
• Confusing ! with list type
• Assuming ! marks deprecated fields

2. Which of the following is the correct syntax to declare a required string field named name in GraphQL?

easy

A. name: String

B. name!: String

C. name: !String

D. name: String!

Solution

1. Step 1: Recall GraphQL syntax for required fields

   In GraphQL, to make a field required, you add ! after the type, not before the type or after the field name.

2. Step 2: Match the correct syntax

   The correct syntax is name: String! meaning the field name is a non-null string.

3. Final Answer:

   name: String! -> Option D

4. Quick Check:

   Required field syntax = type + ! after type [OK]

Hint: Put ! right after the type, never before field name [OK]

Common Mistakes:

• Placing ! before the type
• Adding ! after the field name
• Omitting ! for required fields

3. Given this GraphQL type definition:

type User {
  id: ID!
  email: String!
  phone: String
}

Which of these queries will cause an error if email is missing in the data?

medium

A. Query requesting only phone

B. Query requesting id and phone only

C. Query requesting id and email

D. Query requesting only id

Solution

1. Step 1: Identify required fields in the type

   The fields id and email are marked with !, so they must not be null or missing.

2. Step 2: Analyze queries requesting email

   If the data is missing email, any query requesting it will cause an error because it's required.

3. Final Answer:

   Query requesting id and email -> Option C

4. Quick Check:

   Requesting missing required field causes error = A [OK]

Hint: Queries asking for missing required fields cause errors [OK]

Common Mistakes:

• Assuming optional fields cause errors if missing
• Ignoring ! meaning required
• Thinking missing required fields return null

4. Consider this GraphQL schema snippet:

type Product {
  id: ID!
  name: String!
  description: String
}

Which change fixes the error when a query returns null for name?

medium

A. Add ! to description field

B. Remove ! from name field

C. Change id type to ID without !

D. Rename name field to title

Solution

1. Step 1: Understand the error cause

   The error occurs because name is required (String!) but the query returns null, violating the non-null rule.

2. Step 2: Fix by making name optional

   Removing ! from name allows it to be null, fixing the error.

3. Final Answer:

   Remove ! from name field -> Option B

4. Quick Check:

   Null returned for required field? Remove ! [OK]

Hint: If null causes error, remove ! to allow optional [OK]

Common Mistakes:

• Adding ! to optional fields instead of removing
• Changing unrelated fields
• Renaming fields without fixing null issue

5. You have this GraphQL input type:

input NewUserInput {
  username: String!
  email: String!
  phone: String
}

You want to ensure phone is also required but keep it optional for some mutations. How can you design this?

hard

A. Create two input types: one with phone: String! and one with phone: String

B. Add ! to phone in the existing input type

C. Remove ! from username and email

D. Make all fields optional by removing all !

Solution

1. Step 1: Understand requirement for conditional field requirement

   You want phone required in some cases but optional in others, so a single input type cannot express both.

2. Step 2: Use multiple input types for flexibility

   Creating two input types--one with phone: String! and one with phone: String--lets you choose which to use per mutation.

3. Final Answer:

   Create two input types: one with phone: String! and one with phone: String -> Option A

4. Quick Check:

   Use multiple input types for conditional required fields [OK]

Hint: Use separate input types to toggle required fields flexibly [OK]

Common Mistakes:

• Trying to toggle ! dynamically in one input type
• Removing required from always required fields
• Making all fields optional losing data integrity