You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@geode.apache.org by db...@apache.org on 2017/09/21 22:53:19 UTC
[geode] branch develop updated (1d51aa3 -> 79c2d26)
This is an automated email from the ASF dual-hosted git repository.
dbarnes pushed a change to branch develop
in repository https://gitbox.apache.org/repos/asf/geode.git.
from 1d51aa3 GEODE-3552: cleanup more MXBean tests
new 0ef3cad GEODE-3378: Document Snapshot Improvements
new d37729d Incorporate reviewer corrections (jmcallister)
new 79c2d26 Incorporate reviewer corrections (kmiller)
The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../source/subnavs/geode-subnav.erb | 6 +-
.../exporting_a_snapshot.html.md.erb | 37 +++++++--
.../filtering_snapshot_entries.html.md.erb | 2 +-
.../importing_a_snapshot.html.md.erb | 9 +-
.../gfsh/command-pages/export.html.md.erb | 66 +++++++++------
.../gfsh/command-pages/import.html.md.erb | 97 ++++++++++++++--------
.../gfsh/quick_ref_commands_by_area.html.md.erb | 35 +-------
7 files changed, 141 insertions(+), 111 deletions(-)
--
To stop receiving notification emails like this one, please contact
['"commits@geode.apache.org" <co...@geode.apache.org>'].
[geode] 02/03: Incorporate reviewer corrections (jmcallister)
Posted by db...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
dbarnes pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/geode.git
commit d37729dc2c0a640d558f047bf36eb6a1f80ddb16
Author: Dave Barnes <db...@pivotal.io>
AuthorDate: Wed Sep 20 16:54:48 2017 -0700
Incorporate reviewer corrections (jmcallister)
---
geode-docs/tools_modules/gfsh/command-pages/import.html.md.erb | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/geode-docs/tools_modules/gfsh/command-pages/import.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/import.html.md.erb
index d2ed23f..eca2336 100644
--- a/geode-docs/tools_modules/gfsh/command-pages/import.html.md.erb
+++ b/geode-docs/tools_modules/gfsh/command-pages/import.html.md.erb
@@ -33,7 +33,7 @@ You can import data into a region or import an existing cluster configuration in
## <a id="topic_vnv_grz_ck" class="no-quick-link"></a>import cluster-configuration
-Imports a previously-exported cluster configuration from a zip file into a locator. This command is useful when spinning up a new cluster and when
+Imports a previously exported cluster configuration from a zip file into a locator. This command is useful when spinning up a new cluster and when
upgrading from an older version of <%=vars.product_name%> to a new one.
- In a given cluster, only one locator needs to perform the import.
@@ -45,9 +45,9 @@ configuration changes have been made (such as new region definitions, for exampl
So, to ensure a consistent cluster configuration throughout your distributed system, perform these steps in the following order:
1. Spin up the new cluster
-2. If upgrading, an already-running cluster, shut down most (or all) data members (servers) before importing a shared configuration.
+2. If upgrading an already-running cluster, shut down most (or all) data members (servers) before importing a shared configuration.
3. Import the cluster configuration.
-4. Start or re-start all data members (servers).
+4. Start or restart all data members (servers).
**Availability:** Online. You must be connected in `gfsh` to a locator to use this command.
--
To stop receiving notification emails like this one, please contact
"commits@geode.apache.org" <co...@geode.apache.org>.
[geode] 01/03: GEODE-3378: Document Snapshot Improvements
Posted by db...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
dbarnes pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/geode.git
commit 0ef3cadc69a0962747d1b8fa6678263ad119d4d6
Author: Dave Barnes <db...@pivotal.io>
AuthorDate: Tue Sep 19 14:07:13 2017 -0700
GEODE-3378: Document Snapshot Improvements
---
.../source/subnavs/geode-subnav.erb | 6 +-
.../exporting_a_snapshot.html.md.erb | 36 ++++++--
.../filtering_snapshot_entries.html.md.erb | 2 +-
.../importing_a_snapshot.html.md.erb | 9 +-
.../gfsh/command-pages/export.html.md.erb | 54 +++++++-----
.../gfsh/command-pages/import.html.md.erb | 96 ++++++++++++++--------
.../gfsh/quick_ref_commands_by_area.html.md.erb | 35 +-------
7 files changed, 133 insertions(+), 105 deletions(-)
diff --git a/geode-book/master_middleman/source/subnavs/geode-subnav.erb b/geode-book/master_middleman/source/subnavs/geode-subnav.erb
index 0cf911b..a9513c4 100644
--- a/geode-book/master_middleman/source/subnavs/geode-subnav.erb
+++ b/geode-book/master_middleman/source/subnavs/geode-subnav.erb
@@ -1951,7 +1951,7 @@ gfsh</a>
<a href="/docs/guide/12/tools_modules/gfsh/command-pages/export.html#topic_C7C69306F93743459E65D46537F4A1EE">export config</a>
</li>
<li>
- <a href="/docs/guide/12/tools_modules/gfsh/command-pages/export.html#topic_263B70069BFC4A7185F86B3272012734">export data</a>
+ <a href="/docs/guide/12/tools_modules/gfsh/command-pages/export.html#topic_263B70069BFC4A7185F86B3272011734">export data</a>
</li>
<li>
<a href="/docs/guide/12/tools_modules/gfsh/command-pages/export.html#topic_B80978CC659244AE91E2B8CE56EBDFE3">export logs</a>
@@ -1983,10 +1983,10 @@ gfsh</a>
<a href="/docs/guide/12/tools_modules/gfsh/command-pages/import.html">import</a>
<ul>
<li>
- <a href="/docs/guide/12/tools_modules/gfsh/command-pages/import.html#topic_jw2_2ld_2l">import data</a>
+ <a href="/docs/guide/12/tools_modules/gfsh/command-pages/import.html#topic_vnv_grz_ck">import cluster-configuration</a>
</li>
<li>
- <a href="/docs/guide/12/tools_modules/gfsh/command-pages/import.html#topic_vnv_grz_ck">import cluster-configuration</a>
+ <a href="/docs/guide/12/tools_modules/gfsh/command-pages/import.html#topic_jw2_2ld_2l">import data</a>
</li>
</ul>
</li>
diff --git a/geode-docs/managing/cache_snapshots/exporting_a_snapshot.html.md.erb b/geode-docs/managing/cache_snapshots/exporting_a_snapshot.html.md.erb
index 0963c6a..85d73af 100644
--- a/geode-docs/managing/cache_snapshots/exporting_a_snapshot.html.md.erb
+++ b/geode-docs/managing/cache_snapshots/exporting_a_snapshot.html.md.erb
@@ -40,11 +40,11 @@ Cache cache = ...
cache.getSnapshotService().save(mySnapshotDir, SnapshotFormat.GEMFIRE);
```
-Optionally, you can set a filter on the snapshot entries during the export. See [Filtering Entries During Import or Export](filtering_snapshot_entries.html#concept_7E1F89E70A25465EBEBA584FADFEF353) for an example.
+Optionally, you can set a filter on the snapshot entries during the export. See [Filtering Entries During Import or Export](filtering_snapshot_entries.html) for an example.
## <a id="concept_D1A4D9677F4146078F65C73BF436C19D__section_30C1BBB41C194825A46E49E5756369D6" class="no-quick-link"></a>Exporting a Region Snapshot
-You can also export a specific region using the following API or gfsh command:
+You can also export a specific region using the following API or gfsh commands:
**Java API:**
@@ -60,15 +60,37 @@ region.getSnapshotService().save(mySnapshot, SnapshotFormat.GEMFIRE);
Open a gfsh prompt. After connecting to a <%=vars.product_name%> distributed system, at the prompt type:
``` pre
-gfsh>export data --region=Region --file=filename.gfd
---member=membername
+gfsh>export data --region=Region --file=FileName.gfd --member=MemberName
```
-where *Region* corresponds to the name of the region that you want to export, *filename* (must end in .gfd) corresponds to the name of the export file and *membername* corresponds to a member where the region to export is hosted. For example:
+where *Region* corresponds to the name of the region that you want to export, *FileName* (must end in .gfd) corresponds to the name of the export file and *MemberName* corresponds to a member where the region to export is hosted. For example:
``` pre
-gfsh>export data --region=region1 --file=region1_2012_10_10.gfd
---member=server1
+gfsh>export data --region=region1 --file=region1_2012_10_10.gfd --member=server1
```
The snapshot file will be written on the remote member at the location specified by the `--file` argument. For example, in the example command above, the `region1_2012_10_10.gfd` file will be written in the working directory of `server1`. For more information on this command, see [export data](../../tools_modules/gfsh/command-pages/export.html#topic_263B70069BFC4A7185F86B3272011734).
+
+###<a id="export_example_with_options" class="no-quick-link"></a>Export Example with Options
+
+These examples show how to include the `parallel` option for exporting partitioned regions.
+Note that the `parallel` option takes a directory rather than a file; see [export data](../../tools_modules/gfsh/command-pages/export.html#topic_263B70069BFC4A7185F86B3272011734) for details.
+
+**Java API:**
+
+``` pre
+File mySnapshotDir = ...
+Region<String, MyObject> region = ...
+
+SnapshotOptions<Integer, MyObject> options = region.getSnapshotServive.createOptions().setParallelMode(true);
+region.getSnapshotService().save(mySnapshotDir, SnapshotFormat.GEMFIRE, options);
+```
+
+**gfsh:**
+
+The Java API example, above, accomplishes the same purpose as the following gfsh command:
+
+``` pre
+gfsh>export data --parallel --region=region1 --dir=region1_2012_10_10 --member=server1
+```
+
diff --git a/geode-docs/managing/cache_snapshots/filtering_snapshot_entries.html.md.erb b/geode-docs/managing/cache_snapshots/filtering_snapshot_entries.html.md.erb
index 0acbaf3..a4f7d03 100644
--- a/geode-docs/managing/cache_snapshots/filtering_snapshot_entries.html.md.erb
+++ b/geode-docs/managing/cache_snapshots/filtering_snapshot_entries.html.md.erb
@@ -37,7 +37,7 @@ SnapshotFilter<Integer, MyObject> even = new SnapshotFilter<Integer, MyObject>()
};
RegionSnapshotService<Integer, MyObject> snapsrv = region.getSnapshotService();
-SnapshotOptions<Integer, MyObject> options = rss.createOptions().setFilter(even);
+SnapshotOptions<Integer, MyObject> options = snapsrv.createOptions().setFilter(even);
// only save cache entries with an even key
snapsrv.save(mySnapshot, SnapshotFormat.GEMFIRE, options);
diff --git a/geode-docs/managing/cache_snapshots/importing_a_snapshot.html.md.erb b/geode-docs/managing/cache_snapshots/importing_a_snapshot.html.md.erb
index b3670bf..6e9f558 100644
--- a/geode-docs/managing/cache_snapshots/importing_a_snapshot.html.md.erb
+++ b/geode-docs/managing/cache_snapshots/importing_a_snapshot.html.md.erb
@@ -65,17 +65,16 @@ region.getSnapshotService().load(mySnapshot, SnapshotFormat.GEMFIRE);
Open a gfsh prompt. After connecting to a <%=vars.product_name%> distributed system, at the prompt type:
``` pre
-gfsh>import data --region=Region --file=filename.gfd
---member=membername
+gfsh>import data --region=Region --file=FileName.gfd --member=MemberName
```
-where *Region* corresponds to the name of the region that you want to import data into; *filename* (must end in .gfd) corresponds to the name of the file to be imported; and *membername* corresponds to the member where the region to be imported is hosted. For example:
+where *Region* corresponds to the name of the region that you want to import data into; *FileName* (must end in .gfd) corresponds to the name of the file to be imported; and *MemberName* corresponds to the member where the region to be imported is hosted. For example:
``` pre
-gfsh>import data --region=region1 --file=region1_2012_10_10.gfd
---member=server2
+gfsh>import data --region=region1 --file=region1_2012_10_10.gfd --member=server2
```
The snapshot file must already reside on the specified member at the location specified in the `--file` argument before import.
For more information on this command, see [import data](../../tools_modules/gfsh/command-pages/import.html#topic_jw2_2ld_2l).
+For an example of how to invoke this command with additional options, see [Export Example with Options](exporting_a_snapshot.html#export_example_with_options).
diff --git a/geode-docs/tools_modules/gfsh/command-pages/export.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/export.html.md.erb
index 579169c..8fa0941 100644
--- a/geode-docs/tools_modules/gfsh/command-pages/export.html.md.erb
+++ b/geode-docs/tools_modules/gfsh/command-pages/export.html.md.erb
@@ -25,7 +25,7 @@ Export configurations, data, logs and stack-traces.
- **[export cluster-configuration](#topic_mdv_jgz_ck)**
- Exports a cluster configuration zip file that contains the `cache.xml` files, `gemfire.properties` files, and application jar files needed to configure and operate a <%=vars.product_name%> distributed system.
+ Export a cluster configuration zip file that contains the `cache.xml` files, `gemfire.properties` files, and application jar files needed to configure and operate a <%=vars.product_name%> distributed system.
- **[export config](#topic_C7C69306F93743459E65D46537F4A1EE)**
@@ -61,13 +61,13 @@ See [Overview of the Cluster Configuration Service](../../../configuring/cluster
export cluster-configuration --zip-file-name=value [--dir=value]
```
+**Export Cluster-Configuration Parameters:**
+
| Name | Description | Default Value |
|-------------------------------------------------------|--------------------------------------------------------------------------------------|-------------------|
| <span class="keyword parmname">\\-\\-zip-file-name</span> | *Required.* File name of the zip file to contain the exported cluster configuration. | |
| <span class="keyword parmname">\\-\\-dir</span> | Directory where the cluster configuration zip files is saved. | Locator directory |
-<span class="tablecap">Table 1. Export Cluster-Configuration Parameters</span>
-
**Example Commands:**
``` pre
@@ -96,14 +96,14 @@ export config [--members=value(,value)*] [--groups=value(,value)*]
[--dir=value]
```
+**Export Config Parameters:**
+
| Name | Description |
|------------------------------------------------|----------------------------------------------------------------------|
| <span class="keyword parmname">\\-\\-members</span> | Name/Id of the member(s) whose configuration will be exported. |
| <span class="keyword parmname">\\-\\-groups</span> | Group(s) of members whose configuration will be exported. |
| <span class="keyword parmname">\\-\\-dir</span> | Directory to which the exported configuration files will be written. |
-<span class="tablecap">Table 2. Export Config Parameters</span>
-
**Example Commands:**
``` pre
@@ -121,29 +121,46 @@ Downloading properties file: c:\PivotalGemFire70\Latest\.\member1-gf.properties
## <a id="topic_263B70069BFC4A7185F86B3272011734" class="no-quick-link"></a>export data
-Export user data from a region to a file.
+Export user data from a region to a file or files.
**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command.
**Syntax:**
+To export data from any region, replicated or partitioned, sequentially to a single file, use the `--file` option:
+
+``` pre
+export data --region=value --member=value --file=value
+```
+
+In this scenario, data from replicated and partitioned regions is exported sequentially to a single file on the specified member.
+
+In the case of partitioned regions, you can speed up the export process by using the `--parallel` option:
+
``` pre
-export data --region=value --file=value --member=value
+export data --parallel --region=value --member=value --dir=value
```
+In this scenario, partitioned region data is exported simultaneously on all hosting nodes to directories local to those respective nodes.
+
+- Parallel export applies only to partitioned regions.
+
+- The `--file` and `--dir` options are mutually exclusive; `--file` can be used only for serial export, `--dir` can be used for both serial and parallel exports.
+
+**Export Data Parameters:**
+
| Name | Description |
|------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|
| <span class="keyword parmname">\\-\\-region</span> | *Required.* Region from which data is to be exported. |
-| <span class="keyword parmname">\\-\\-file</span> | *Required.* File to which the exported data is to be written. The file must have an extension of `.gfd`. |
-| <span class="keyword parmname">‑‑member</span> | *Required.* Name/Id of a member that hosts the region. The data will be exported to the specified file on the host where the member is running. |
-
-<span class="tablecap">Table 3. Export Data Parameters</span>
+| <span class="keyword parmname">‑‑member</span> | *Required.* Name/Id of a member that hosts the region. In a serial export, all data is exported to the specified file on the host where the member is running. In a parallel export, data from a partitioned region partially hosted on this member is exported for each partition to files on the nodes that host those partitions. |
+| <span class="keyword parmname">\\-\\-file</span> | File to which the exported data is to be written. The file must have an extension of `.gfd`. Cannot be specified at the same time as \\-\\-dir, cannot be used with ‑‑parallel.|
+| <span class="keyword parmname">\\-\\-dir</span> | Directory to which the exported data is to be written. Required if \\-\\-parallel is true. Cannot be specified at the same time as \\-\\-file.|
+| <span class="keyword parmname">\\-\\-parallel</span> | Export local data on each node to a directory on that machine. Available for partitioned regions only. |
**Example Commands:**
``` pre
export data --region=region2 --file=region2_20121001.gfd --member=server2
-
```
**Sample Output:**
@@ -152,7 +169,6 @@ export data --region=region2 --file=region2_20121001.gfd --member=server2
gfsh>export data --region=region2 --file=region2_20121001.gfd --member=server1
Data succesfully exported from region : region2 to file : C:\PivotalGemFire70\
Latest\server1\region2_20121001.gfd on host : 192.0.2.0
-
```
## <a id="topic_B80978CC659244AE91E2B8CE56EBDFE3" class="no-quick-link"></a>export logs
@@ -174,6 +190,8 @@ export logs [--dir=value] [--groups=value(,value)*] [--members=value(,value)*]
[--stats-only(=value)?] [--file-size-limit(=value)?]
```
+**Export Logs Parameters:**
+
| Name | Description | Default Value |
|--------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|---------------|
| <span class="keyword parmname">\\-\\-dir</span> | Local directory to which log files will be written when logs are exported using an http connection. Ignored when the command is executed over JMX. | |
@@ -188,8 +206,6 @@ export logs [--dir=value] [--groups=value(,value)*] [--members=value(,value)*]
| <span class="keyword parmname">\\-\\-stats-only</span> | Whether to export only statistics (not logs) | If parameter not specified: false. If parameter specified without a value: true |
| <span class="keyword parmname">\\-\\-file-size-limit</span> | Limits total unzipped size of the exported files. Specify 0 (zero) for no limit. Value is in megabytes by default or [k,m,g,t] may be specified. | If parameter not specified: 100m. If parameter specified without a value: 0 |
-<span class="tablecap">Table 4. Export Logs Parameters</span>
-
**Example commands, showing output:**
``` pre
@@ -219,14 +235,14 @@ Export region data from an offline disk store into gemfire snapshot files.
export offline-disk-store --name=value --disk-dirs=value(,value)* --dir=value
```
+**Export Offline-Disk-Store Parameters:**
+
| Name | Description |
|---------------------------------------------------|----------------------------------------------------|
| <span class="keyword parmname">\\-\\-name</span> | *Required.* Name of the disk store to be exported. |
| <span class="keyword parmname">\\-\\-disk-dirs</span> | Directories which contain the disk store files. |
| <span class="keyword parmname">\\-\\-dir</span> | Directory to export the snapshot files to. |
-<span class="tablecap">Table 5. Export Offline-Disk-Store Parameters</span>
-
**Example Commands:**
``` pre
@@ -246,14 +262,14 @@ Export the stack trace for a member or members.
export stack-traces --file=value [--members=value(,value)*] [--groups=value(,value)*]
```
+**Export Stack-Traces Parameters:**
+
| Name | Description |
|------------------------------------------------|-----------------------------------------------------------------|
| <span class="keyword parmname">\\-\\-file</span> | *Required.* Filename to which the stack-traces will be written. |
| <span class="keyword parmname">\\-\\-members</span> | Name or ID of the member(s) whose log files will be exported. |
| <span class="keyword parmname">\\-\\-groups</span> | Group(s) of members whose log files will be exported. |
-<span class="tablecap">Table 6. Export Stack-Traces Parameters</span>
-
**Example Commands:**
``` pre
diff --git a/geode-docs/tools_modules/gfsh/command-pages/import.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/import.html.md.erb
index 464af25..d2ed23f 100644
--- a/geode-docs/tools_modules/gfsh/command-pages/import.html.md.erb
+++ b/geode-docs/tools_modules/gfsh/command-pages/import.html.md.erb
@@ -23,79 +23,103 @@ limitations under the License.
You can import data into a region or import an existing cluster configuration into the cluster.
-- **[import data](../../../tools_modules/gfsh/command-pages/import.html#topic_jw2_2ld_2l)**
+- **[import cluster-configuration](#topic_vnv_grz_ck)**
+
+ Import a cluster configuration.
+
+- **[import data](#topic_jw2_2ld_2l)**
Import user data from a file to a region.
-- **[import cluster-configuration](../../../tools_modules/gfsh/command-pages/import.html#topic_vnv_grz_ck)**
+## <a id="topic_vnv_grz_ck" class="no-quick-link"></a>import cluster-configuration
- Import a cluster configuration.
+Imports a previously-exported cluster configuration from a zip file into a locator. This command is useful when spinning up a new cluster and when
+upgrading from an older version of <%=vars.product_name%> to a new one.
-## <a id="topic_jw2_2ld_2l" class="no-quick-link"></a>import data
+- In a given cluster, only one locator needs to perform the import.
+That locator shares the imported configuration with all other connected locators in the distributed system.
+- Locators share the imported configuration with data members (servers) when they start, or if they have been recently started and no other
+configuration changes have been made (such as new region definitions, for example).
+- Data members that were already running before the import may need to be restarted to obtain the new cluster configuration.
-Import user data from a file to a region.
+So, to ensure a consistent cluster configuration throughout your distributed system, perform these steps in the following order:
-**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command.
+1. Spin up the new cluster
+2. If upgrading, an already-running cluster, shut down most (or all) data members (servers) before importing a shared configuration.
+3. Import the cluster configuration.
+4. Start or re-start all data members (servers).
+
+**Availability:** Online. You must be connected in `gfsh` to a locator to use this command.
**Syntax:**
``` pre
- import data --region=value --file=value --member=value [--invoke-callbacks=value]
+import cluster-configuration --zip-file-name=value
```
-<a id="topic_jw2_2ld_2l__table_lzg_3fg_2w"></a>
-
-| Name | Description | Default Value |
-|------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|
-| <span class="keyword parmname">\\-\\-region</span> | *Required.* Region into which data will be imported. | |
-| <span class="keyword parmname">\\-\\-file </span> | *Required.* File from which the imported data will be read. The file must have an extension of ".gfd" and must be on the file system of the member (or accessible to that member via NFS) that is being targeted for the import. | |
-| <span class="keyword parmname">‑‑member</span> | *Required.* Name/ID of a member that hosts the region. The data will be imported from the specified file on the host where the member is running. | |
-| <span class="keyword parmname">‑‑invoke-callbacks</span> | Boolean value that, when true, invokes callbacks during the data import. | false |
+**Import Cluster-Configuration Parameters:**
-<span class="tablecap">Table 1. Import Data Parameters</span>
+| Name | Description |
+|-------------------------------------------------------|-------------------------------------------------------------------------------------------------|
+| <span class="keyword parmname">\\-\\-zip-file-name</span> | *Required.* Name of the zip file containing the cluster configuration artifacts to be imported. |
**Example Commands:**
``` pre
-import data --region=region2 --file=/mnt5/region2_20121001.gfd --member=server1
+gfsh>import cluster-configuration --zip-file-name=/home/username/myClusterConfig.zip
```
-## <a id="topic_vnv_grz_ck" class="no-quick-link"></a>import cluster-configuration
+**Sample Output:**
+
+``` pre
+gfsh>import cluster-configuration --zip-file-name=/home/username/myClusterConfig.zip
+Cluster configuration successfully imported
+```
-Import a cluster configuration.
+## <a id="topic_jw2_2ld_2l" class="no-quick-link"></a>import data
-Imports all artifacts of a cluster configuration from a zip file.
+Import user data from a file or files to a region.
**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command.
-**Note:**
-Shutdown all data members (servers) before importing a shared configuration.
-
**Syntax:**
+If the data was exported sequentially to a single file, use the serial form of the `import` command to import the data:
+
``` pre
-import cluster-configuration --zip-file-name=value
+import data --region=value --file=value --member=value [--invoke-callbacks=value]
```
-<a id="topic_vnv_grz_ck__table_w1m_kfg_2w"></a>
+In this scenario, data from replicated and partitioned regions is imported sequentially from a single file on the specified member.
-| Name | Description |
-|-------------------------------------------------------|-------------------------------------------------------------------------------------------------|
-| <span class="keyword parmname">\\-\\-zip-file-name</span> | *Required.* Name of the zip file containing the cluster configuration artifacts to be imported. |
+See [export data](export.html#topic_263B70069BFC4A7185F86B3272011734) for an explanation of the difference between serial and parallel data exports.
-<span class="tablecap">Table 2. Import Cluster-Configuration Parameters</span>
-
-**Example Commands:**
+If the data was exported from a partitioned region in parallel format, use the `--parallel` option to import the data:
``` pre
-gfsh>import cluster-configuration --zip-file-name=/home/username/myClusterConfig.zip
+import data --parallel --region=value --member=value --dir=value [--invoke-callbacks=value]
```
-**Sample Output:**
+In this scenario, partitioned region data is imported simultaneously on all hosting nodes from directories local to those respective nodes.
+
+- Parallel import applies only to partitioned regions exported in parallel mode.
+
+- The `--file` and `--dir` options are mutually exclusive; `--file` can be used only for serial import, `--dir` can be used for both serial and parallel imports.
+
+
+**Import Data Parameters:**
+
+| Name | Description | Default Value |
+|------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|
+| <span class="keyword parmname">\\-\\-region</span> | *Required.* Region into which data will be imported. | |
+| <span class="keyword parmname">‑‑member</span> | *Required.* Name/ID of a member that hosts the region. In a serial import, all data is imported from the specified file on the host where the member is running. In a parallel import, data from a partitioned region partially hosted on this member is imported for each partition from files on the nodes that host those partitions. | |
+| <span class="keyword parmname">\\-\\-file </span> | File from which the imported data will be read. The file must have an extension of ".gfd" and must be on the file system of the member (or accessible to that member via NFS) that is being targeted for the import. Cannot be specified at the same time as \\-\\-dir, cannot be used with ‑‑parallel. | |
+| <span class="keyword parmname">\\-\\-dir</span> | Directory from which the data is to be imported. Required if \\-\\-parallel is true. Cannot be specified at the same time as \\-\\-file. If a given node has no data file in the specified directory, the import operation is silently skipped for that node. | |
+| <span class="keyword parmname">‑‑invoke‑callbacks</span> | Boolean value that, when true, invokes callbacks during the data import. | false |
+
+**Example Commands:**
``` pre
-gfsh>import cluster-configuration --zip-file-name=/home/username/myClusterConfig.zip
-Cluster configuration successfully imported
+import data --region=region2 --file=/mnt5/region2_20121001.gfd --member=server1
```
-
diff --git a/geode-docs/tools_modules/gfsh/quick_ref_commands_by_area.html.md.erb b/geode-docs/tools_modules/gfsh/quick_ref_commands_by_area.html.md.erb
index 0a52229..2ab62fe 100644
--- a/geode-docs/tools_modules/gfsh/quick_ref_commands_by_area.html.md.erb
+++ b/geode-docs/tools_modules/gfsh/quick_ref_commands_by_area.html.md.erb
@@ -35,8 +35,6 @@ limitations under the License.
| [sleep](command-pages/sleep.html) | Delay `gfsh` command execution. | online, offline |
| [version](command-pages/version.html) | Display product version information. | online, offline |
-<span class="tablecap">Table 1. Basic <%=vars.product_name%> gfsh Commands</span>
-
## <a id="topic_EB854534301A477BB01058B3B142AE1D" class="no-quick-link"></a>Configuration Commands
<a id="topic_EB854534301A477BB01058B3B142AE1D__table_uyf_jz1_3l"></a>
@@ -101,8 +99,6 @@ limitations under the License.
</tbody>
</table>
-<span class="tablecap">Table 2. Configuration Commands</span>
-
## <a id="topic_C7DB8A800D6244AE8FF3ADDCF139DCE4" class="no-quick-link"></a>Data Commands
<a id="topic_C7DB8A800D6244AE8FF3ADDCF139DCE4__table_rcv_jz1_3l"></a>
@@ -111,14 +107,12 @@ limitations under the License.
|-----------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|--------------|
| [export data](command-pages/export.html#topic_263B70069BFC4A7185F86B3272011734) | Export user data from a region to a file. | online |
| [get](command-pages/get.html) | Display an entry in a region. | online |
-| [import data](command-pages/import.html#topic_jw2_2ld_2l) | | online |
+| [import data](command-pages/import.html#topic_jw2_2ld_2l) | Import user data from a file to a region. | online |
| [locate entry](command-pages/locate.html#concept_73B980C1138743DDBBFACE68009BD1E3__section_04BD7EC0032147DFA9CCD1331EE3B694) | Locate a region entry on a member. | online |
| [put](command-pages/put.html) | Add or update a region entry. | online |
| [query](command-pages/query.html) | Run queries against <%=vars.product_name%> regions. | online |
| [remove](command-pages/remove.html) | Remove an entry from a region. | online |
-<span class="tablecap">Table 3. Data Commands</span>
-
## <a id="topic_1B47A0E110124EB6BF08A467EB510412" class="no-quick-link"></a>Deployment Commands
<a id="topic_1B47A0E110124EB6BF08A467EB510412__table_cdk_kz1_3l"></a>
@@ -129,8 +123,6 @@ limitations under the License.
| [list deployed](command-pages/list.html#topic_59DF60DE71AD4097B281749425254BFF) | Display a list of JARs that were deployed to members using the `deploy` command. | online |
| [undeploy](command-pages/undeploy.html) | Undeploy the JAR files that were deployed on members or groups using `deploy` command. | online |
-<span class="tablecap">Table 4. Deployment Commands</span>
-
## <a id="topic_1ACC91B493EE446E89EC7DBFBBAE00EA" class="no-quick-link"></a>Disk Store Commands
<a id="topic_1ACC91B493EE446E89EC7DBFBBAE00EA__table_trm_lz1_3l"></a>
@@ -150,8 +142,6 @@ limitations under the License.
| [show missing-disk-stores](command-pages/show.html#topic_7B3D624D5B4F41D1A0F8A9C3C8B2E780) | Display a summary of the disk stores that are currently missing from a distributed system. | online |
| [validate offline-disk-store](command-pages/validate.html) | Validate offline disk stores. | online, offline |
-<span class="tablecap">Table 5. Disk Store Commands</span>
-
## <a id="topic_10613D4850F04A3EB507F6B441AD3413" class="no-quick-link"></a>Durable CQ and Client Commands
<a id="topic_10613D4850F04A3EB507F6B441AD3413__table_kqb_mz1_3l"></a>
@@ -163,8 +153,6 @@ limitations under the License.
| [close durable-client](command-pages/close.html#topic_4125AAAB9FE44CD787166E48B694C41D) | Attempts to close the durable client. The client must be disconnected. | online |
| [show subscription-queue-size](command-pages/show.html#topic_395C96B500AD430CBF3D3C8886A4CD2E) | Shows the number of events in the subscription queue. If a CQ name is provided, it counts the number of events in the subscription queue for the specified CQ. | online |
-<span class="tablecap">Table 6. Durable CQ and Client Commands</span>
-
## <a id="topic_8BB061D1A7A9488C819FE2B7881A1278" class="no-quick-link"></a>Function Execution Commands
<a id="topic_8BB061D1A7A9488C819FE2B7881A1278__table_xqk_mz1_3l"></a>
@@ -175,8 +163,6 @@ limitations under the License.
| [execute function](command-pages/execute.html#concept_F2ED1987126E4338AEB14A7C8F561A2A__section_FB435A8AC76E4E1A8E72DBEA64BA2E57) | Execute the function with the specified ID. By default, executes on all members. | online |
| [list functions](command-pages/list.html#topic_DCC7CCBBEF5942B783A8F2A4A5B2FABF) | Display a list of registered functions. The default is to display functions for all members. | online |
-<span class="tablecap">Table 7. Function Execution Commands</span>
-
## <a id="topic_F0AE5CE40D6D49BF92247F5EF4F871D2" class="no-quick-link"></a>Gateway (WAN) Commands
<a id="topic_F0AE5CE40D6D49BF92247F5EF4F871D2__table_vp5_mz1_3l"></a>
@@ -199,8 +185,6 @@ limitations under the License.
| [stop gateway-receiver](command-pages/stop.html#topic_CD1D526FD6F84A7B80B25C741129ED30) | Stop the gateway receiver on a member or members. | online |
| [stop gateway-sender](command-pages/stop.html#topic_0BBDD4B3B8A44A65A610F766C9E85519) | top a gateway sender with a given id on a specified member or members of a specified member group. | online |
-<span class="tablecap">Table 8. Gateway (WAN) Commands</span>
-
## <a id="topic_F0AE5CE40D6D49BF92247F5EF4F871D3" class="no-quick-link"></a><%=vars.product_name%> AsyncEventQueue Commands
<a id="topic_F0AE5CE40D6D49BF92247F5EF4F871D3__table_vp5_mz1_3l"></a>
@@ -210,8 +194,6 @@ limitations under the License.
| [create async-event-queue](command-pages/create.html#topic_ryz_pb1_dk) | Creates an asynchronous event queue. | online |
| [list async-event-queues](command-pages/list.html#topic_j22_kzk_2l) | Display a list of async event queues for all members. | online |
-<span class="tablecap">Table 9. <%=vars.product_name%> AsyncEventQueue Commands</span>
-
## <a id="topic_B742E9E862BA457082E2346581C97D03" class="no-quick-link"></a><%=vars.product_name%> Monitoring Commands
<a id="topic_B742E9E862BA457082E2346581C97D03__table_pkf_nz1_3l"></a>
@@ -234,8 +216,6 @@ limitations under the License.
| [start jvisualvm](command-pages/start.html#topic_5B5BF8BEE905463D8B7762B89E2D65E7) | Start the JDK's Java VisualVM monitoring application in a separate process. | online, offline |
| [start pulse](command-pages/start.html#topic_E906BA7D9E7F4C5890FEFA7ECD40DD77) | Launch the <%=vars.product_name%> Pulse monitoring dashboard tool in the user's default system browser. | online, offline |
-<span class="tablecap">Table 10. <%=vars.product_name%> Monitoring Commands</span>
-
## <a id="topic_688C66526B4649AFA51C0F72F34FA45E" class="no-quick-link"></a>Index Commands
<a id="topic_688C66526B4649AFA51C0F72F34FA45E__table_k3p_nz1_3l"></a>
@@ -249,8 +229,6 @@ limitations under the License.
| [destroy index](command-pages/destroy.html#topic_D00219CCD6F64C1582A0802AC5CDF3F3) | Destroy or remove the specified index. | online |
| [list indexes](command-pages/list.html#topic_B3B51B6DEA484EE086C4F657EC9831F2) | Display the list of indexes created for all members. | online |
-<span class="tablecap">Table 11. Index Commands</span>
-
## <a id="topic_2A6DA4078E4E496A9F725A29BC4CFD0D" class="no-quick-link"></a>JMX Connection Commands
<a id="topic_2A6DA4078E4E496A9F725A29BC4CFD0D__table_ktf_4z1_3l"></a>
@@ -261,8 +239,6 @@ limitations under the License.
| [describe connection](command-pages/describe.html#topic_591DC6B781B641168E6173E69AC6D201) | Display connection information details. | online, offline |
| [disconnect](command-pages/disconnect.html) | Close any active connection(s). | online |
-<span class="tablecap">Table 12. JMX Connection Commands</span>
-
## <a id="topic_1C82E6F1B2AF4A65A8DA6B3C846BAC13" class="no-quick-link"></a>Locator Commands
<a id="topic_1C82E6F1B2AF4A65A8DA6B3C846BAC13__table_hy4_4z1_3l"></a>
@@ -273,8 +249,6 @@ limitations under the License.
| [status locator](command-pages/status.html#topic_E96D0EFA513C4CD79B833FCCDD69C832) | Displays the status of the specified locator. | online, offline |
| [stop locator](command-pages/stop.html#topic_EF61C54B35BA4AB7B14E58CF911F283E) | Stop a locator. | online, offline |
-<span class="tablecap">Table 13. Locator Commands</span>
-
## <a id="topic_lucene_commands" class="no-quick-link"></a>Lucene Commands
<a id="topic_1C82E6F1B2AF4A65A8DA6B3C846BAC13__table_hy4_4z1_3l"></a>
@@ -287,8 +261,6 @@ limitations under the License.
| [list lucene indexes](command-pages/list.html#list_lucene_indexes) | List Lucene indexes created for all members. The optional `--with-stats` qualifier shows activity on the indexes. | online |
| [search lucene](command-pages/search.html#search_lucene) | Search a Lucene index. | online |
-<span class="tablecap">Table 14. Lucene Commands</span>
-
## <a id="topic_cvg_bls_5q" class="no-quick-link"></a>PDX Commands
<a id="topic_cvg_bls_5q__table_tdf_cls_5q"></a>
@@ -298,8 +270,6 @@ limitations under the License.
| [configure pdx](command-pages/configure.html#topic_jdkdiqbgphqh) | Configure Portable Data eXchange for all the cache(s) in the cluster. | online, offline |
| [pdx rename](command-pages/pdx.html) | Renames PDX types in an offline disk store. | online, offline |
-<span class="tablecap">Table 15. PDX Commands</span>
-
## <a id="topic_EF03119A40EE492984F3B6248596E1DD" class="no-quick-link"></a>Region Commands
<a id="topic_EF03119A40EE492984F3B6248596E1DD__table_a5k_r31_3l"></a>
@@ -313,8 +283,6 @@ limitations under the License.
| [list regions](command-pages/list.html#topic_F0ECEFF26086474498598035DD83C588) | Display regions of a member or members. If no parameter is specified, all regions in the <%=vars.product_name%> distributed system are listed. | online |
| [rebalance](command-pages/rebalance.html) | Rebalance partitioned regions. | online |
-<span class="tablecap">Table 16. Region Commands</span>
-
## <a id="topic_8A341FF86958466E9E64CF06CD21FED9" class="no-quick-link"></a>Server Commands
<a id="topic_8A341FF86958466E9E64CF06CD21FED9__table_ehj_n31_3l"></a>
@@ -325,6 +293,5 @@ limitations under the License.
| [status server](command-pages/status.html#topic_E5DB49044978404D9D6B1971BF5D400D) | Display the status of the specified <%=vars.product_name%> cache server. | online, offline |
| [stop server](command-pages/stop.html#topic_723EE395A63A40D6819618AFC2902115) | Stop a <%=vars.product_name%> cache server. | online, offline |
-<span class="tablecap">Table 17. Server Commands</span>
--
To stop receiving notification emails like this one, please contact
"commits@geode.apache.org" <co...@geode.apache.org>.
[geode] 03/03: Incorporate reviewer corrections (kmiller)
Posted by db...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
dbarnes pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/geode.git
commit 79c2d26528ef32045eb05e375f2ed9c911a2913d
Author: Dave Barnes <db...@pivotal.io>
AuthorDate: Thu Sep 21 15:50:29 2017 -0700
Incorporate reviewer corrections (kmiller)
---
.../cache_snapshots/exporting_a_snapshot.html.md.erb | 5 +++--
.../cache_snapshots/importing_a_snapshot.html.md.erb | 2 +-
.../tools_modules/gfsh/command-pages/export.html.md.erb | 12 ++++++------
.../tools_modules/gfsh/command-pages/import.html.md.erb | 7 ++++---
4 files changed, 14 insertions(+), 12 deletions(-)
diff --git a/geode-docs/managing/cache_snapshots/exporting_a_snapshot.html.md.erb b/geode-docs/managing/cache_snapshots/exporting_a_snapshot.html.md.erb
index 85d73af..38b9bc0 100644
--- a/geode-docs/managing/cache_snapshots/exporting_a_snapshot.html.md.erb
+++ b/geode-docs/managing/cache_snapshots/exporting_a_snapshot.html.md.erb
@@ -63,7 +63,7 @@ Open a gfsh prompt. After connecting to a <%=vars.product_name%> distributed sys
gfsh>export data --region=Region --file=FileName.gfd --member=MemberName
```
-where *Region* corresponds to the name of the region that you want to export, *FileName* (must end in .gfd) corresponds to the name of the export file and *MemberName* corresponds to a member where the region to export is hosted. For example:
+where *Region* corresponds to the name of the region that you want to export, *FileName* (must end in .gfd) corresponds to the name of the export file and *MemberName* corresponds to a member that hosts the region. For example:
``` pre
gfsh>export data --region=region1 --file=region1_2012_10_10.gfd --member=server1
@@ -82,7 +82,8 @@ Note that the `parallel` option takes a directory rather than a file; see [expor
File mySnapshotDir = ...
Region<String, MyObject> region = ...
-SnapshotOptions<Integer, MyObject> options = region.getSnapshotServive.createOptions().setParallelMode(true);
+SnapshotOptions<Integer, MyObject> options =
+ region.getSnapshotServive.createOptions().setParallelMode(true);
region.getSnapshotService().save(mySnapshotDir, SnapshotFormat.GEMFIRE, options);
```
diff --git a/geode-docs/managing/cache_snapshots/importing_a_snapshot.html.md.erb b/geode-docs/managing/cache_snapshots/importing_a_snapshot.html.md.erb
index 6e9f558..bc8d644 100644
--- a/geode-docs/managing/cache_snapshots/importing_a_snapshot.html.md.erb
+++ b/geode-docs/managing/cache_snapshots/importing_a_snapshot.html.md.erb
@@ -68,7 +68,7 @@ Open a gfsh prompt. After connecting to a <%=vars.product_name%> distributed sys
gfsh>import data --region=Region --file=FileName.gfd --member=MemberName
```
-where *Region* corresponds to the name of the region that you want to import data into; *FileName* (must end in .gfd) corresponds to the name of the file to be imported; and *MemberName* corresponds to the member where the region to be imported is hosted. For example:
+where *Region* corresponds to the name of the region that you want to import data into; *FileName* (must end in .gfd) corresponds to the name of the file to be imported; and *MemberName* corresponds to a member that hosts the region. For example:
``` pre
gfsh>import data --region=region1 --file=region1_2012_10_10.gfd --member=server2
diff --git a/geode-docs/tools_modules/gfsh/command-pages/export.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/export.html.md.erb
index 8fa0941..203fdd8 100644
--- a/geode-docs/tools_modules/gfsh/command-pages/export.html.md.erb
+++ b/geode-docs/tools_modules/gfsh/command-pages/export.html.md.erb
@@ -71,14 +71,14 @@ export cluster-configuration --zip-file-name=value [--dir=value]
**Example Commands:**
``` pre
-gfsh>export cluster-configuration --zip-file-name=/home/username/gemfire80/myClusterConfig.zip
+gfsh>export cluster-configuration --zip-file-name=/home/username/gemfire/myClusterConfig.zip
```
**Sample Output:**
``` pre
gfsh>export cluster-configuration --zip-file-name=mySharedConfig.zip
-Downloading cluster configuration : /home/username/gemfire80/myClusterConfig.zip
+Downloading cluster configuration : /home/username/gemfire/myClusterConfig.zip
```
## <a id="topic_C7C69306F93743459E65D46537F4A1EE" class="no-quick-link"></a>export config
@@ -115,8 +115,8 @@ export config --members=member1
``` pre
gfsh>export config --members=member1
-Downloading Cache XML file: c:\PivotalGemFire70\Latest\.\member1-cache.xml
-Downloading properties file: c:\PivotalGemFire70\Latest\.\member1-gf.properties
+Downloading Cache XML file: c:\PivotalGemFire\Latest\.\member1-cache.xml
+Downloading properties file: c:\PivotalGemFire\Latest\.\member1-gf.properties
```
## <a id="topic_263B70069BFC4A7185F86B3272011734" class="no-quick-link"></a>export data
@@ -167,7 +167,7 @@ export data --region=region2 --file=region2_20121001.gfd --member=server2
``` pre
gfsh>export data --region=region2 --file=region2_20121001.gfd --member=server1
-Data succesfully exported from region : region2 to file : C:\PivotalGemFire70\
+Data succesfully exported from region : region2 to file : C:\PivotalGemFire\
Latest\server1\region2_20121001.gfd on host : 192.0.2.0
```
@@ -280,6 +280,6 @@ export stack-traces --file=stack.txt
``` pre
gfsh>export stack-traces --file=stack.txt
-stack-trace(s) exported to file: C:\PivotalGemFire70\Latest\locator1\stack.txt
+stack-trace(s) exported to file: C:\PivotalGemFire\Latest\locator1\stack.txt
On host : GemFireStymon
```
diff --git a/geode-docs/tools_modules/gfsh/command-pages/import.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/import.html.md.erb
index eca2336..b22ae4b 100644
--- a/geode-docs/tools_modules/gfsh/command-pages/import.html.md.erb
+++ b/geode-docs/tools_modules/gfsh/command-pages/import.html.md.erb
@@ -38,7 +38,7 @@ upgrading from an older version of <%=vars.product_name%> to a new one.
- In a given cluster, only one locator needs to perform the import.
That locator shares the imported configuration with all other connected locators in the distributed system.
-- Locators share the imported configuration with data members (servers) when they start, or if they have been recently started and no other
+- Locators share the imported configuration with data members (servers) when the servers start, or if the servers have been recently started and no other
configuration changes have been made (such as new region definitions, for example).
- Data members that were already running before the import may need to be restarted to obtain the new cluster configuration.
@@ -97,7 +97,8 @@ See [export data](export.html#topic_263B70069BFC4A7185F86B3272011734) for an exp
If the data was exported from a partitioned region in parallel format, use the `--parallel` option to import the data:
``` pre
-import data --parallel --region=value --member=value --dir=value [--invoke-callbacks=value]
+import data --parallel --region=value --member=value --dir=value
+ [--invoke-callbacks=value]
```
In this scenario, partitioned region data is imported simultaneously on all hosting nodes from directories local to those respective nodes.
@@ -113,7 +114,7 @@ In this scenario, partitioned region data is imported simultaneously on all host
|------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|
| <span class="keyword parmname">\\-\\-region</span> | *Required.* Region into which data will be imported. | |
| <span class="keyword parmname">‑‑member</span> | *Required.* Name/ID of a member that hosts the region. In a serial import, all data is imported from the specified file on the host where the member is running. In a parallel import, data from a partitioned region partially hosted on this member is imported for each partition from files on the nodes that host those partitions. | |
-| <span class="keyword parmname">\\-\\-file </span> | File from which the imported data will be read. The file must have an extension of ".gfd" and must be on the file system of the member (or accessible to that member via NFS) that is being targeted for the import. Cannot be specified at the same time as \\-\\-dir, cannot be used with ‑‑parallel. | |
+| <span class="keyword parmname">\\-\\-file </span> | File from which the imported data will be read. The file must have an extension of `.gfd` and must be on the file system of the member (or accessible to that member via NFS) that is being targeted for the import. Cannot be specified at the same time as \\-\\-dir, cannot be used with ‑‑parallel. | |
| <span class="keyword parmname">\\-\\-dir</span> | Directory from which the data is to be imported. Required if \\-\\-parallel is true. Cannot be specified at the same time as \\-\\-file. If a given node has no data file in the specified directory, the import operation is silently skipped for that node. | |
| <span class="keyword parmname">‑‑invoke‑callbacks</span> | Boolean value that, when true, invokes callbacks during the data import. | false |
--
To stop receiving notification emails like this one, please contact
"commits@geode.apache.org" <co...@geode.apache.org>.