Difference between revisions of "EclipseLink/UserGuide/JPA/Basic JPA Development/Caching/Expiration"

From Eclipsepedia

Jump to: navigation, search
(Cache Expiration and Invalidation)
(Cache Expiration and Invalidation)
 
(13 intermediate revisions by one user not shown)
Line 4: Line 4:
 
|eclipselink=y
 
|eclipselink=y
 
|eclipselinktype=JPA
 
|eclipselinktype=JPA
 +
|api=y
 +
|apis=
 +
*[http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/annotations/Cache.html @Cache]
 +
*[http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/annotations/TimeOfDay.html @TimeOfDay]
 +
|nativeapi=y
 +
|nativeapis=
 +
*[http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/descriptors/CachePolicy.html CachePolicy]
 +
*[http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/descriptors/invalidation/CacheInvalidationPolicy.html CacheInvalidationPolicy]
 +
*[http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/descriptors/invalidation/DailyCacheInvalidationPolicy.html DailyCacheInvalidationPolicy]
 +
*[http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/descriptors/invalidation/TimeToLiveCacheInvalidationPolicy.html TimeToLiveCacheInvalidationPolicy]
 
|examples=y
 
|examples=y
 
|example=
 
|example=
Line 10: Line 20:
 
}}
 
}}
 
=Cache Expiration and Invalidation=
 
=Cache Expiration and Invalidation=
By default, objects remain in the shared cache until they are explicitly deleted or garbage collected.
+
By default, entities remain in the shared cache until they are explicitly deleted or garbage collected.
  
 
You can configure any entity with a <tt>expiry</tt> that lets you specify, either the number of milliseconds after which an entity instance should expire from the cache, or a time of day that all instances of the entity class should expire from the cache.  Expiry is set on the <tt>@Cache</tt> annotation or <tt><cache></tt> XML element, and can be configured in two ways:
 
You can configure any entity with a <tt>expiry</tt> that lets you specify, either the number of milliseconds after which an entity instance should expire from the cache, or a time of day that all instances of the entity class should expire from the cache.  Expiry is set on the <tt>@Cache</tt> annotation or <tt><cache></tt> XML element, and can be configured in two ways:
Line 19: Line 29:
 
When an instance expires, it is only invalidated in the cache.  It is not removed from the cache, but when next accessed it will be refreshed from the database as part of the query that was used to access it.
 
When an instance expires, it is only invalidated in the cache.  It is not removed from the cache, but when next accessed it will be refreshed from the database as part of the query that was used to access it.
  
It is also possible to define your own expiry or invalidation policy by defining your own <tt>CacheInvalidationPolicy</tt> and setting it in your entity's descriptor using a <tt>DescriptorCustomizer</tt>.
+
The application can also explicitly invalidate objects in the cache using the JPA <tt>Cache</tt> API, or the EclipseLink <tt>JpaCache</tt> API (see [[EclipseLink/UserGuide/JPA/Basic JPA Development/Caching/Cache API|Cache API]]).
  
The application can also explicitly invalidate objects in the cache using the JPA <tt>Cache</tt> API, or the EclipseLink <tt>JpaCache</tt> API (see [[#Cache API|Cache API]]).
+
Expiry can also be used in the query results cache (see [[EclipseLink/UserGuide/JPA/Basic JPA Development/Caching/Query Cache|Query Results Cache]]).
  
Expiry can also be used in the query results cache (see [[#Query Results Cache|Query Results Cache]]).
+
Invalidation can also be used in a cluster through cache coordination (see [[EclipseLink/UserGuide/JPA/Basic JPA Development/Caching/Coordination|Clustering and Cache Coordination]]), or from database events using database event notification (see [[EclipseLink/UserGuide/JPA/Basic JPA Development/Caching/DatabaseEvents|Database Event Notification and Oracle DCN/QCN]]).
  
Invalidation can also be used in a cluster through cache coordination (see [[#Cache Coordination|Cache Coordination]]), or from database events using database event notification (see [[#Database Events Notification|Database Events Notification]]).
+
======''Cache expiry annotation example''======
 +
<source lang="java">
 +
...
 +
@Entity
 +
@Cache(
 +
  expiry=600000 // 10 minutes
 +
)
 +
public class Employee {
 +
  ...
 +
}
 +
</source>
  
 +
<source lang="java">
 +
...
 +
@Entity
 +
@Cache(
 +
  expiryTimeOfDay=@TimeOfDay(hour=3) // 3:00 AM
 +
)
 +
public class Project {
 +
  ...
 +
}
 +
</source>
 +
 +
======''Cache expiry XML example''======
 +
<source lang="xml">
 +
<?xml version="1.0"?>
 +
<entity-mappings
 +
xmlns="http://www.eclipse.org/eclipselink/xsds/persistence/orm"
 +
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 +
xsi:schemaLocation="http://www.eclipse.org/eclipselink/xsds/persistence/orm http://www.eclipse.org/eclipselink/xsds/eclipselink_orm_2_4.xsd"
 +
version="2.4">
 +
    <entity name="Employee" class="org.acme.Employee" access="FIELD">
 +
        <cache>
 +
            <expiry>600000</expiry>
 +
        </cache>
 +
    </entity>
 +
    <entity name="Project" class="org.acme.Project" access="FIELD">
 +
        <cache>
 +
            <expiry-time-of-day hour="3"/>
 +
        </cache>
 +
    </entity>
 +
</entity-mappings>
 +
</source>
 +
 +
==Advanced Cache Invalidation==
 +
EclipseLink's cache expiry and invalidation support is provided through the <tt>CacheInvalidationPolicy</tt> class and its subclasses.  The EclipseLink API offers a few advanced features that are not available through annotations or XML.  It is also possible to define your own expiry or invalidation policy by defining your own <tt>CacheInvalidationPolicy</tt>. Advanced configuration can be done through using a <tt>DescriptorCustomizer</tt> to customize your entity's <tt>ClassDescriptor</tt>.
 +
 +
<tt>CacheInvalidationPolicy</tt> advanced options:
 +
* <tt>isInvalidationRandomized</tt> - This allows the invalidation time to be randomized by 10% to avoid a large number of instances becoming invalid at the same time and causing a bottleneck in the database load.  This is not used by default.
 +
* <tt>shouldRefreshInvalidObjectsOnClone</tt> - This ensures that an invalid object accessed through a relationship from another object will be refresh in the persistence context.  This is enabled by default.
 +
* <tt>shouldUpdateReadTimeOnUpdate</tt> - This updates an objects read time when the object is successfully updated.  This is not enabled by default.
  
 
{{EclipseLink_JPA
 
{{EclipseLink_JPA
 
|previous= [[EclipseLink/UserGuide/JPA/Basic_JPA_Development/Caching/Type and Size|Cache Type and Size]]
 
|previous= [[EclipseLink/UserGuide/JPA/Basic_JPA_Development/Caching/Type and Size|Cache Type and Size]]
|next=[[EclipseLink/UserGuide/JPA/Basic_JPA_Development/Caching/Coordination|Cache Coordination]]
+
|next=[[EclipseLink/UserGuide/JPA/Basic_JPA_Development/Caching/Coordination|Clustering and Cache Coordination]]
 
|up=[[EclipseLink/UserGuide/JPA/Basic_JPA_Development/Caching|Caching]]
 
|up=[[EclipseLink/UserGuide/JPA/Basic_JPA_Development/Caching|Caching]]
 
|version=2.4 DRAFT}}
 
|version=2.4 DRAFT}}

Latest revision as of 11:16, 29 May 2012

EclipseLink JPA

[edit] Cache Expiration and Invalidation

By default, entities remain in the shared cache until they are explicitly deleted or garbage collected.

You can configure any entity with a expiry that lets you specify, either the number of milliseconds after which an entity instance should expire from the cache, or a time of day that all instances of the entity class should expire from the cache. Expiry is set on the @Cache annotation or <cache> XML element, and can be configured in two ways:

  • expiry - The number of milliseconds to expiry an entity instance in the cache after it has been read.
  • expiryTimeOfDay - The @TimeOfDay represent the 24h time of day to expiry all instances of the entity class in the cache.

When an instance expires, it is only invalidated in the cache. It is not removed from the cache, but when next accessed it will be refreshed from the database as part of the query that was used to access it.

The application can also explicitly invalidate objects in the cache using the JPA Cache API, or the EclipseLink JpaCache API (see Cache API).

Expiry can also be used in the query results cache (see Query Results Cache).

Invalidation can also be used in a cluster through cache coordination (see Clustering and Cache Coordination), or from database events using database event notification (see Database Event Notification and Oracle DCN/QCN).

[edit] Cache expiry annotation example
...
@Entity
@Cache(
  expiry=600000 // 10 minutes
)
public class Employee {
  ...
}
...
@Entity
@Cache(
  expiryTimeOfDay=@TimeOfDay(hour=3) // 3:00 AM
)
public class Project {
  ...
}
[edit] Cache expiry XML example
<?xml version="1.0"?>
<entity-mappings
	xmlns="http://www.eclipse.org/eclipselink/xsds/persistence/orm"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.eclipse.org/eclipselink/xsds/persistence/orm http://www.eclipse.org/eclipselink/xsds/eclipselink_orm_2_4.xsd"
	version="2.4">
    <entity name="Employee" class="org.acme.Employee" access="FIELD">
        <cache>
            <expiry>600000</expiry>
        </cache>
    </entity>
    <entity name="Project" class="org.acme.Project" access="FIELD">
        <cache>
            <expiry-time-of-day hour="3"/>
        </cache>
    </entity>
</entity-mappings>

[edit] Advanced Cache Invalidation

EclipseLink's cache expiry and invalidation support is provided through the CacheInvalidationPolicy class and its subclasses. The EclipseLink API offers a few advanced features that are not available through annotations or XML. It is also possible to define your own expiry or invalidation policy by defining your own CacheInvalidationPolicy. Advanced configuration can be done through using a DescriptorCustomizer to customize your entity's ClassDescriptor.

CacheInvalidationPolicy advanced options:

  • isInvalidationRandomized - This allows the invalidation time to be randomized by 10% to avoid a large number of instances becoming invalid at the same time and causing a bottleneck in the database load. This is not used by default.
  • shouldRefreshInvalidObjectsOnClone - This ensures that an invalid object accessed through a relationship from another object will be refresh in the persistence context. This is enabled by default.
  • shouldUpdateReadTimeOnUpdate - This updates an objects read time when the object is successfully updated. This is not enabled by default.

Eclipselink-logo.gif
Version: 2.4 DRAFT
Other versions...