Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Update in-memory cache warm up #7143

Merged
merged 4 commits into from
Apr 3, 2025
Merged

[docs] Update in-memory cache warm up #7143

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f8791f2
Update in-memory cache warm up
smyrick Mar 28, 2025
5aab30b
Update docs/source/routing/performance/caching/in-memory.mdx
smyrick Mar 28, 2025
071dcc3
Update in-memory.mdx
smyrick Apr 3, 2025
dc1e301
Update in-memory.mdx
smyrick Apr 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/source/routing/performance/caching/in-memory.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,19 @@ then look at `apollo.router.schema.loading.time` and `apollo.router.query_planni

If the router is using distributed caching for query plans, the warm-up phase will also store the new query plans in Redis. Since all Router instances might have the same distributions of queries in their in-memory cache, the list of queries is shuffled before warm-up, so each Router instance can plan queries in a different order and share their results through the cache.

<MinVersion version="1.61.0">

#### Cache warm-up with headers

</MinVersion>

With router v1.61.0+ and v2.x+, if you have enabled exposing query plans via `--dev` mode or `plugins.experimental.expose_query_plan: true`, you can pass the `Apollo-Expose-Query-Plan` header to return query plans in the GraphQL response extensions. You must set the header to one of the following values:

- `true`: Returns a human-readable string and JSON blob of the query plan while still executing the query to fetch data.
- `dry-run`: Generates the query plan and aborts without executing the query.

After using `dry-run`, query plans are saved to your configured cache locations. Using real, mirrored, or similar to production operations is a great way to warmup the caches before transitioning traffic to new router instances.

## Caching automatic persisted queries (APQ)

[Automatic Persisted Queries (**APQ**)](/apollo-server/performance/apq/) enable GraphQL clients to send a server the _hash_ of their query string, _instead of_ sending the query string itself. When query strings are very large, this can significantly reduce network usage.
Expand Down