Aliases for field renaming in GraphQL

Introduction

Aliases let you rename fields in your query results so you can avoid confusion or get clearer names.

When you want to get the same field twice with different arguments.

When the default field name is unclear or too technical.

When you want to combine data from different fields but keep their names distinct.

When you want to make the output easier to read for users or other developers.

Syntax

GraphQL

aliasName: fieldName

Use a new name (aliasName) before the colon to rename the field.

The original fieldName stays the same in the schema; alias only changes the output.

Examples

Renames the 'name' field to 'userName' in the result.

GraphQL

{
  userName: name
}

Fetches the 'email' field twice with different aliases.

GraphQL

{
  primaryEmail: email
  secondaryEmail: email
}

Gets the 'price' field twice with different arguments and aliases.

GraphQL

{
  oldPrice: price(currency: USD)
  newPrice: price(currency: EUR)
}

Sample Program

This query fetches two users by id and renames their fields to avoid confusion.

GraphQL

query {
  user1: user(id: "1") {
    userName: name
    userEmail: email
  }
  user2: user(id: "2") {
    userName: name
    userEmail: email
  }
}

Important Notes

Aliases only change the name in the query result, not the actual data or schema.

You can use aliases to fetch the same field multiple times with different arguments.

Always choose clear alias names to make your query results easy to understand.

Summary

Aliases rename fields in query results for clarity or to avoid conflicts.

Use the syntax aliasName: fieldName to rename fields.

Aliases help when fetching the same field multiple times or making output clearer.