Implementing your own Cache
Internally, Apollo Server uses the
KeyValueCache interface to provide a caching store for the Data Sources. An in-memory LRU cache is used by default, and we provide connectors for Memcached/Redis backends.
Built with extensibility in mind, you can also implement your own cache to use with Apollo Server, in a way that best suits your application needs. It needs to implement the following interface that can be exported from
ttlvalue for the
optionsis specified in seconds.
Testing cache implementations
You can export and run a jest test suite from
apollo-server-caching to test your implementation:
// ../__tests__/YourKeyValueCache.test.ts;;testKeyValueCachenew MemcachedCache'localhost';
testKeyValueCache helper will run all key-value store tests on the specified store, including basic
set functionality, along with time-based expunging rules.
Some key-value cache implementations may not be able to support the full suite of tests (for example, some tests might not be able to expire based on time). For those cases, there are more granular implementations which can be used:
For more details, consult the source for
Run tests with