[
https://issues.apache.org/jira/browse/GEODE-8198?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17121363#comment-17121363
]
ASF GitHub Bot commented on GEODE-8198:
---------------------------------------
davebarnes97 commented on a change in pull request #5191:
URL: https://github.com/apache/geode/pull/5191#discussion_r433511928
##########
File path:
geode-docs/basic_config/data_entries_custom_classes/managing_data_entries.html.md.erb
##########
@@ -60,36 +60,90 @@ You can also use the `gfsh put` command to add entries to a
region, and the `get
If you want only to create the entry (with a null value and with method
failure if the entry already exists), use `Region.create` instead.
-## <a id="managing_data_entries__section_7578349EA26A4621B732FE851D71A84F"
class="no-quick-link"></a>Batch Operations (getAll, putAll, removeAll)
+## <a id="getAll_method" class="no-quick-link"></a>The getAll Operation
-<%=vars.product_name%> provides three APIs to perform batch operations on
multiple region entries:
+The batch operation `Region.getAll`
+takes a collection of keys and returns a `Map` of key-value pairs for
+the provided keys. If a given key does not exist in the region, then that
key's value in the returned map will be null.
-- `Region.getAll`
-- `Region.putAll`
-- `Region.removeAll`
+## <a id="putAll_method" class="no-quick-link"></a>The putAll Operation
-The `getAll` method takes a collection of keys and returns a `Map` of values
for the provided keys. If a given key does not exist in the region, then that
key's value in the returned map will be null.
+The batch operation `Region.putAll`
+takes a `Map` of key-value pairs, puts them into the cache,
+and distributes them in a single operation.
-The `putAll` method takes a `Map` of key-value pairs and puts them into the
cache and distributes them in a single operation.
-**Example:**
+The updates to the cache are done individually in the order in which
+they were placed in the `Map`.
+For partitioned regions,
+multiple events are sent as a single message to the primary buckets
+and then distributed to the secondary buckets.
+
+The design of a client application within a client-server design pattern
+faces the possibility that a partial operation can occur.
+Some, all, or none of the specified entries may be completed with `putAll`.
+If either `ServerOperationException` or `ServerConnectivityException` are
Review comment:
"Either" is singular, so "If either.. is thrown..."
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
> Revise docs to better specify putAll() behavior
> -----------------------------------------------
>
> Key: GEODE-8198
> URL: https://issues.apache.org/jira/browse/GEODE-8198
> Project: Geode
> Issue Type: Improvement
> Components: docs
> Reporter: Karen Smoler Miller
> Priority: Major
>
> [GEODE-8171|https://issues.apache.org/jira/browse/GEODE-8171] updated the
> Javadocs for the Region.putAll() method. Our user guide should also specify
> the behavior under exceptions and give readers more context such that they
> can produce better apps.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
