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
The following commit(s) were added to refs/heads/develop by this push:
new 9b54af4 GEODE-4794 User Guide - update description of `gfsh configure
pdx` command. (#3244)
9b54af4 is described below
commit 9b54af49afbae3776bd2451e86842028f68b332a
Author: Dave Barnes <[email protected]>
AuthorDate: Wed Feb 27 17:37:34 2019 -0800
GEODE-4794 User Guide - update description of `gfsh configure pdx` command.
(#3244)
* GEODE-4794 User Guide - update description of `gfsh configure pdx`
command.
* GEODE-4794 User Guide - update description of `gfsh configure pdx`
command. Incorporate reviewer feedback.
* GEODE-4794 User Guide - update description of `gfsh configure pdx`
command. Incorporate reviewer feedback.
* GEODE-4794 User Guide - update description of `gfsh configure pdx`
command. Incorporate reviewer feedback.
---
.../gfsh/command-pages/configure.html.md.erb | 39 ++++++++++++----------
1 file changed, 21 insertions(+), 18 deletions(-)
diff --git a/geode-docs/tools_modules/gfsh/command-pages/configure.html.md.erb
b/geode-docs/tools_modules/gfsh/command-pages/configure.html.md.erb
index ad4ecae..73e150d 100644
--- a/geode-docs/tools_modules/gfsh/command-pages/configure.html.md.erb
+++ b/geode-docs/tools_modules/gfsh/command-pages/configure.html.md.erb
@@ -22,15 +22,17 @@ limitations under the License.
<a id="concept_C2DCEE6743304549825C9B62E66DBADF"></a>
-Configure Portable Data eXchange for all the cache(s) in the cluster.
+Configure Portable Data eXchange (PDX) for all the cache(s) in the cluster.
## <a id="topic_jdkdiqbgphqh" class="no-quick-link"></a>configure pdx
<a id="topic_jdkdiqbgphqh__section_C27BE964CE554180A65968DBEBF50B23"></a>
-Configures <%=vars.product_name%>'s Portable Data eXchange for all the
cache(s) in the cluster. This command does not effect on the running members in
the system. This command persists the pdx configuration in the locator with
cluster configuration service.
-**Note:**
-This command should be issued before starting any data members.
+Configures <%=vars.product_name%>'s Portable Data eXchange for all the
cache(s) in the cluster
+and persists the pdx configuration in the locator with the cluster
configuration service.
+
+For consistent results, PDX should be configured before any servers have
started.
+A server that is running at the time PDX is configured will not adopt the new
configuration until it has been restarted.
**Availability:** Online.
@@ -38,21 +40,19 @@ This command should be issued before starting any data
members.
``` pre
configure pdx [--read-serialized=value] [--ignore-unread-fields=value]
- [--disk-store=value] [--auto-serializable-classes=value(,value)*]
- [--portable-auto-serializable-classes=value(,value)*
+ [--disk-store(=value)?] [--auto-serializable-classes=value(,value)*]
+ [--portable-auto-serializable-classes=value(,value)*]
```
-<a id="topic_jdkdiqbgphqh__table_B25D38C67FA047EB8F00A521573F1375"></a>
-
-| Name |
Description
[...]
-|----------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
-| <span class="keyword parmname">\\-\\-read-serialized</span>
| Set to true to have PDX deserialization produce a PdxInstance instead of an
instance of the domain class.
[...]
-| <span class="keyword parmname">\\-\\-ignore-unread-fields</span>
| Controls whether PDX ignores fields that were unread during
deserialization. The default is to preserve unread fields be including their
data during serialization. However, if you configure the cache to ignore unread
fields then their data will be lost during serialization.You should only set
this attribute to true if you know this member will only be reading cache data.
In this use case you do not need to [...]
-| <span class="keyword parmname">\\-\\-disk-store</span>
| Named disk store where the PDX type data will be stored.
[...]
-| <span class="keyword parmname">\\-\\-auto-serializable-classes</span>
| Configures ReflectionBasedAutoSerializer as the PDX serializer for member
classes. The patterns that are matched against domain class names to determine
whether they should be auto-serialized. Classes are not checked for portability
to non-java languages (equivalent to `check-portability=false`).
[...]
-| <span class="keyword
parmname">\\-\\-portable-auto-serializable-classes</span> | Configures
ReflectionBasedAutoSerializer as the PDX serializer for member classes. The
patterns that are matched against domain class names to determine whether they
should be serialized. Serialization done by the PDX autoserializer will throw
an exception if the object of these classes are not portable to non-Java
languages (equivalent to `check-portability=true`).
[...]
+**Parameters, configure pdx:**
-<span class="tablecap">Table 1. Configure PDX Parameters</span>
+| Name | Description | Default |
+|--------------------------------------------|-------------|---------|
+| <span class="keyword parmname">\\-\\-read-serialized</span>
| When true, PDX deserialization produces a PdxInstance instead of an instance
of the domain class. | false |
+| <span class="keyword parmname">\\-\\-ignore-unread-fields</span>
| Controls whether PDX ignores fields that were unread during
deserialization. The default is to preserve unread fields by including their
data during serialization. However, if you configure the cache to ignore unread
fields, then their data will be lost during serialization. You should set this
attribute to true only if you know this member will only be reading cache data.
In this use case you do not need [...]
+| <span class="keyword parmname">\\-\\-disk-store</span> | Named
disk store where the PDX type data will be stored. If specified without a
value, then "DEFAULT" is used. | none |
+| <span class="keyword parmname">\\-\\-auto-serializable-classes</span>
| Configures ReflectionBasedAutoSerializer as the PDX serializer for member
classes. Specifies patterns to be matched against domain class names to
determine whether they should be auto-serialized. Classes are not checked for
portability to non-java languages (equivalent to `check-portability=false`). |
none |
+| <span class="keyword
parmname">\\-\\-portable-auto-serializable-classes</span> | Configures
ReflectionBasedAutoSerializer as the PDX serializer for member classes.
Specifies patterns to be matched against domain class names to determine
whether they should be serialized. Serialization done by the PDX autoserializer
will throw an exception if the object of these classes are not portable to
non-Java languages (equivalent to `check-portability=true`). | none |
**Example Commands:**
@@ -77,9 +77,12 @@ ignore-unread-fields = false
**Error Messages:**
-``` pre
+```console
+Configure pdx failed because cluster configuration is disabled.
+```
+
+```console
"Failed to persist the configuration changes due to this command, Revert the
command to maintain consistency.
Please use "status cluster-config-service" to determing whether Cluster
configuration service is RUNNING."
```
-
