Skip to content

Persisted Queries

In this lesson you will learn persisted queries in GraphQL, why it matters within performance, and how to use it correctly with clear, copy-ready examples.

Persisted Queries Overview

At its core, persisted queries is about doing one thing well inside your GraphQL project. Once you understand the pattern, you can apply it consistently across features and teams.

Good persisted queries pays off across the whole codebase: fewer surprises, easier testing, and smoother onboarding. The snippet below is a solid starting point.

import { ApolloServer } from '@apollo/server';
import { startStandaloneServer } from '@apollo/server/standalone';

const server = new ApolloServer({ typeDefs, resolvers });
const { url } = await startStandaloneServer(server, { listen: { port: 4000 } });

A GraphQL API is a schema plus resolvers served by Apollo Server or GraphQL Yoga.

Persisted Queries Example

const typeDefs = gql`
  type Query { hello: String! }
`;
const resolvers = { Query: { hello: () => 'world' } };
const server = new ApolloServer({ typeDefs, resolvers });
  • Start from a minimal Persisted Queries example and grow it only as needed.
  • Keep configuration explicit so Persisted Queries behaves the same in every environment.
  • Name things clearly so teammates understand your Persisted Queries at a glance.
  • Add tests around Persisted Queries early to lock in expected behaviour.

GraphQL Cheatsheet

Quick GraphQL reference related to persisted queries.

Concept Example Purpose
Schema type Query { user(id: ID!): User } Define the API shape
Resolver Query: { user: (_, { id }) => ... } Provide field data
Query query { user(id: 1) { name } } Read exactly what you need
Mutation mutation { createUser(input) { id } } Change data
Subscription subscription { postAdded { id } } Real-time updates
Context context: ({ req }) => ({ user }) Auth and shared state
DataLoader loader.load(id) Batch to avoid N+1

How Persisted Queries Works in GraphQL

Persisted Queries fits into GraphQL's model of a single typed schema that clients query for exactly the data they need. The server resolves each requested field through resolver functions.

A GraphQL API is a schema plus resolvers served by Apollo Server or GraphQL Yoga.

  • The schema is the contract between client and server.
  • Resolvers fetch data field by field, including nested types.
  • Clients request only the fields they use, avoiding over-fetching.
  • Context carries auth and shared services into every resolver.

Practical Guidance for Persisted Queries

In production, persisted queries should be efficient and secure. Batch data access with DataLoader, guard resolvers with authorization, and limit query depth and complexity.

Concern Recommendation
N+1 queries Batch with DataLoader
Security Auth in context, depth/complexity limits
Errors Typed GraphQLError with extension codes
Performance Cache and paginate large lists

Common Mistakes

  • Copying persisted queries snippets without understanding what each line does.
  • Skipping error handling and edge cases when wiring up persisted queries.
  • Leaving persisted queries untested, so regressions slip into production.
  • Over-engineering persisted queries before you actually need the extra flexibility.

Key Takeaways

  • Persisted Queries is a core part of working effectively with GraphQL.
  • Start small and keep persisted queries focused on a single responsibility.
  • Apply consistent patterns so persisted queries scales across your project.
  • Test and document persisted queries to keep it maintainable over time.

Pro Tip

Bookmark this persisted queries pattern and reuse it. Consistency across your GraphQL codebase is worth more than clever one-off solutions.