Adding caching and persistence

You're viewing Apigee Edge documentation.
Go to the Apigee X documentation.

Apigee Edge provides caching for runtime persistence of data across requests. You access the cache with policies, such as Populate Cache policy, LookupCache policy, InvalidateCache policy, and Response Cache policy.

Your organization includes access to a shared cache that is useful for most cases. You can also configure your own cache if you want finer control of performance.

You might want to use a cache to:

  • Reduce latency and traffic. Requests are satisfied in a shorter time and with reused representations.
  • Persist data across transactions. You can store session data for reuse across HTTP transactions.
  • Support security. Scope access to cache entries so they can be accessed only in a particular environment or by a specific API proxy.

Using persistence

Get background and examples on the persistence features provided by Edge.

Persistence tools in Edge.

Find out how policies support general purpose caching, backend response caching, and key-value maps.

Example: General purpose caching

View code that shows how Populate Cache policy, LookupCache policy, and InvalidateCache policy are used together.

Working with cache keys

Understand the options for creating unique identifiers for cache entries.

Creating and editing an environment cache

Create your own caches when the included shared cache won't meet your needs.

Cache internals

Find out how the cache system is structured and how cache defaults interact with policies.

Working with key value maps

Create and manage collections of encrypted or unencrypted, non-expiring key/value pairs.

Support for HTTP response headers

Learn how HTTP response headers are handled when you're using the ResponseCache policy.

Policy references

Use these policies for persistence.

PopulateCache policy

Put data into the general purpose cache.

LookupCache policy

Get data from the general purpose cache.

InvalidateCache policy

Remove an entry from the general purpose cache.

ResponseCache policy

Get and put data from a backend resource.

Key Value Map Operations policy

Use a key/value map store for long-term persistence.

API references

Use these APIs to work with caches.

Clear a cache entry

Clears a cache entry using the cache key.

Create a cache in an environment

Creates a cache in an environment.

Get information about a cache

Gets information about a cache.

Clear all cache entries

Clears cache entries. Can be scoped by cache key prefix.

List caches in an environment

Lists the caches in an environment.

Update a cache in an environment

Updates a cache in an environment.

Delete a cache

Deletes a cache.

Key/value maps

Create and manage collections (maps) of persisted key/value pairs at multiple scopes.