[geode] branch develop updated: GEODE-4031: Update javadocs to include .gfd snapshot extension requirement (#1311)

[nr...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

nreich pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/geode.git


The following commit(s) were added to refs/heads/develop by this push:
     new c1cf5d1  GEODE-4031: Update javadocs to include .gfd snapshot extension requirement (#1311)
c1cf5d1 is described below

commit c1cf5d1505f35d6352d43969ef6f74a2fcb6b516
Author: Nick Reich <nr...@pivotal.io>
AuthorDate: Mon Jan 22 08:26:52 2018 -0800

    GEODE-4031: Update javadocs to include .gfd snapshot extension requirement (#1311)
---
 .../geode/cache/snapshot/CacheSnapshotService.java | 25 ++++++++++++++--------
 1 file changed, 16 insertions(+), 9 deletions(-)

diff --git a/geode-core/src/main/java/org/apache/geode/cache/snapshot/CacheSnapshotService.java b/geode-core/src/main/java/org/apache/geode/cache/snapshot/CacheSnapshotService.java
index 89320df..0bca766 100644
--- a/geode-core/src/main/java/org/apache/geode/cache/snapshot/CacheSnapshotService.java
+++ b/geode-core/src/main/java/org/apache/geode/cache/snapshot/CacheSnapshotService.java
@@ -25,7 +25,7 @@ import org.apache.geode.pdx.PdxSerializer;
 
 /**
  * Allows a snapshot of cache data to be imported and exported. Each region in the cache will be
- * included in the snapshot (one snapshot file for each region). Example usage:
+ * included in the snapshot, one snapshot file (.gfd) for each region. Example usage:
  *
  * <pre>
  * // obtain a snapshot
@@ -57,6 +57,13 @@ import org.apache.geode.pdx.PdxSerializer;
  * snapshot.save(new File("."), SnapshotFormat.GEMFIRE, options);
  * </pre>
  *
+ * When the parallel snapshot option is used for export, a file for each region will be created on
+ * every member that contains data for that region and the file name will include a unique
+ * identifier for the member that created the file. When loading a snapshot created using parallel
+ * mode, either the files from all members can be combined into a directory to load from on a single
+ * member or files can be distributed across any number of members and imported using the parallel
+ * snapshot option, provided the files are in the same directory on each member.
+ *
  * Note that the snapshot does not provide a consistency guarantee. Updates to data during the
  * course of import/export operations could result data inconsistencies.
  *
@@ -99,10 +106,10 @@ public interface CacheSnapshotService {
       throws IOException;
 
   /**
-   * Imports all files in the specified directory into the cache. The cache entries in a given
-   * snapshot file are loaded into the same region they were originally exported from (based on a
-   * corresponding region name). Files that do not match the supplied snapshot format will cause an
-   * import error.
+   * Imports all snapshot files (*.gfd) in the specified directory into the cache. The cache entries
+   * in a given snapshot file are loaded into the same region they were originally exported from
+   * (based on a corresponding region name). Files that do not match the supplied snapshot format
+   * will cause an import error.
    * <p>
    * Prior to loading data, all regions should have been created and any necessary serializers
    * (either {@link DataSerializer} or {@link PdxSerializer}) and {@link Instantiator}s should have
@@ -117,10 +124,10 @@ public interface CacheSnapshotService {
   void load(File dir, SnapshotFormat format) throws IOException, ClassNotFoundException;
 
   /**
-   * Imports the specified files into the cache by applying user-configured options. The cache
-   * entries in a given snapshot file are loaded into the same region they were originally exported
-   * from (based on a corresponding region name). Files that do not match the supplied snapshot
-   * format will cause an import error.
+   * Imports the specified snapshot files into the cache by applying user-configured options. Each
+   * file must have the snapshot file extension (.gfd). The cache entries in a given snapshot file
+   * are loaded into the same region they were originally exported from (based on a corresponding
+   * region name). Files that do not match the supplied snapshot format will cause an import error.
    * <p>
    * Prior to loading data, all regions should have been created and any necessary serializers
    * (either {@link DataSerializer} or {@link PdxSerializer}) and {@link Instantiator}s should have

-- 
To stop receiving notification emails like this one, please contact
nreich@apache.org.