com.gemstone.gemfire.cache.snapshot.package.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gemfire-core Show documentation

SnappyData store based off Pivotal GemFireXD

There is a newer version: 2.0-BETA





 com.gemstone.gemfire.cache.snapshot



Provides API's for importing and exporting cached data into snapshot files. 
Each snapshot file contains the cache entries (key/value pairs) for a given 
region.

The {@link com.gemstone.gemfire.cache.snapshot.RegionSnapshotService} can be 
obtained for an individual region using 
{@link com.gemstone.gemfire.cache.Region#getSnapshotService}. To obtain a 
{@link com.gemstone.gemfire.cache.snapshot.CacheSnapshotService} (across all 
regions), invoke {@link com.gemstone.gemfire.cache.Cache#getSnapshotService}.

The {@link com.gemstone.gemfire.cache.snapshot.SnapshotOptions} can be used to
configure the behavior of import and export operations.

The {@link com.gemstone.gemfire.cache.snapshot.SnapshotReader} can be used to
programmatically read a snapshot created using the GEMFIRE
{@link com.gemstone.gemfire.cache.snapshot.SnapshotOptions.SnapshotFormat} 
format.

Example usage:
// obtain the snapshot service
RegionSnapshotService snapshot = region.getSnapshotService();

// export the region
snapshot.save(new File("myregion.snapshot"), SnapshotFormat.GEMFIRE);

// import the data
snapshot.load(new File("myregion.snapshot"), SnapshotFormat.GEMFIRE);