Skip to page content Skip to main navigation
English | Site Directory

e.g. "templates" or "datastore"

# Memcache Java API Overview

High performance scalable web applications often use a distributed in-memory data cache in front of or in place of robust persistent storage for some tasks. App Engine includes a memory cache service for this purpose.

- Caching Data with JCache
- When to Use a Memory Cache
- How Cached Data Expires
- Quotas and Limits

## Caching Data with JCache

The Memcache Java API implements the JCache interface (javax.cache), a draft standard described by JSR 107. JCache provides a Map-like interface to cached data. You store and retrieve values in the cache using keys. Keys and values can be of any Serializable type or class.

    import java.util.Collections;
    import javax.cache.Cache;
    import javax.cache.CacheException;
    import javax.cache.CacheManager;

    // ...
            Cache cache;

            try {
                cache = CacheManager.getInstance().getCacheFactory().createCache(Collections.emptyMap());
            } catch (CacheException e) {
                // ...
            }

            String key;      // ...
            byte[] value;    // ...

            // Put the value into the cache.
            cache.put(key, value);

            // Get the value from the cache.
            value = (byte[]) cache.get(key);

## When to Use a Memory Cache

One use of a memory cache is to speed up common datastore queries. If many requests make the same query with the same parameters, and changes to the results do not need to appear on the web site right away, the app can cache the results in the memcache. Subsequent requests can check the memcache, and only perform the datastore query if the results are absent or expired. Session data, user preferences, and any other queries performed on most pages of a site are good candidates for caching.

Memcache may be useful for other temporary values. However, when considering whether to store a value solely in the memcache and not backed by other persistent storage, be sure that your application behaves acceptably when the value is suddenly not available. Values can expire from the memcache at any time, and may be expired prior to the expiration deadline set for the value. For example, if the sudden absence of a user's session data would cause the session to malfunction, that data should probably be stored in the datastore in addition to the memcache.

## How Cached Data Expires

By default, values stored in memcache are retained as long as possible. Values may be evicted from the cache when a new value is added to the cache if the cache is low on memory. When values are evicted due to memory pressure, the least recently used values are evicted first.

The app can provide an expiration time when a value is stored, as either a number of seconds relative to when the value is added, or as an absolute Unix epoch time in the future (a number of seconds from midnight January 1, 1970). The value will be evicted no later than this time, though it may be evicted for other reasons.

Under rare circumstances, values may also disappear from the cache prior to expiration for reasons other than memory pressure. While memcache is resilient to server failures, memcache values are not saved to disk, so a service failure may cause values to become unavailable.

In general, an application should not expect a cached value to always be available.

## Quotas and Limits

Each Memcache call counts toward the Memcache API Calls quota.

Data sent by the application to the memcache counts toward the Data Sent to (Memcache) API quota. Data received from the memcache counts toward the Data Received from (Memcache) API quota.

For more information on quotas, see Quotas, and the "Quota Details" section of the Admin Console.

In addition to quotas, the following limits apply to the use of the Mail service:

Limit | Amount
--- | ---
maximum size of a cached value | 1 megabyte