org.apache.geode.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 org.apache.geode.cache.snapshot.RegionSnapshotService} can be obtained for an individual region using {@link org.apache.geode.cache.Region#getSnapshotService}. To obtain a {@link org.apache.geode.cache.snapshot.CacheSnapshotService} (across all regions), invoke {@link org.apache.geode.cache.Cache#getSnapshotService}.

The {@link org.apache.geode.cache.snapshot.SnapshotOptions} can be used to configure the behavior of import and export operations.

The {@link org.apache.geode.cache.snapshot.SnapshotReader} can be used to programmatically read a snapshot created using the GEMFIRE {@link org.apache.geode.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);