[jira] [Commented] (GEODE-3063) Improve docs on default string-based partition resolver

["ASF GitHub Bot (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/GEODE-3063?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16284179#comment-16284179 ] 

ASF GitHub Bot commented on GEODE-3063:
---------------------------------------

karensmolermiller commented on issue #1105: GEODE-3063 partition resolver doc revisions
URL: https://github.com/apache/geode/pull/1105#issuecomment-350367642
 
 
   Here are Darrel's comments on this PR:
   I would change: assigns new entries to buckets based on the entry key contents
   to: assigns new entries to buckets based on the entry key's hash code
   
   I think it is confusing to abbreviate : "standard custom partitioning" by dropping "custom" from it. So I would say we should include "custom"  in both "standard partitioning" and "fixed partitioning".
   
   change: "Using a custom class."
   to: "Using the partition resolver region attribute."
   Throughout this do not use the term "custom class" but instead use "partition resolver region attribute".
   Even though this is, strictly speaking, a "partition attribute", I think it is better to call it a "region attribute" since the attributes name is "partition resolver".
   
   change: "Specify this class as the partition resolver during region creation."
   to: "Implement the PartitionResolver interface with your own class and then specify that class as the partition resolver during region creation."
   
   change: "For keys implemented as objects, define the interface within the key’s class."
   to: "Have the entry key's class implement the PartitionResolver interface."
   
   change: "Using the cache callback class."
   to: "Using the callback argument's class."
   
   change: "Implement the interface within a cache callback’s class."
   to: "Have the class that implements your callback argument implement the PartitionResolver interface."
   Call it "callback argument" in this section not just "callback" or "cache callback".
   
   change: "Implementing the String-Based Partition Resolver"
   to "Using the String Prefix Partition Resolver"
   In general replace "String-Based" with "String Prefix".
   Add to that section "This class can be used as the partition resolver region attribute." and/or refer them to the section on configuring it.
   
   In the section titled "Configuring Standard Partitioning" change the title to "Configuring the Partition Resolver Region Attribute"
   and change the section to focus on this instead of "custom partitioning". For example I think you can just drop this sentence:
   "How you do this depends on where you chose to implement your custom partitioning."
   What it depends on is how you are configuring the product. You should start with gfsh, then java, and then xml. This ordering should be used throughout all the examples. We want to push gfsh.
   
   Delete these items from the configuration section:
   Entry key. Use the key object with the resolver implementation for every entry operation.
   Cache callback argument. Provide the argument to every call that accesses an entry. This restricts you to calls that take a callback argument.
   
   Delete this line: Define the class for the region at creation. The resolver will be used for every entry operation. Use one of these methods:

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


> Improve docs on default string-based partition resolver
> -------------------------------------------------------
>
>                 Key: GEODE-3063
>                 URL: https://issues.apache.org/jira/browse/GEODE-3063
>             Project: Geode
>          Issue Type: Bug
>          Components: docs
>            Reporter: Karen Smoler Miller
>            Assignee: Karen Smoler Miller
>
> The new default partition resolver at
> org.apache.geode.cache.util.StringPrefixPartitionResolver
> needs more detailed documentation.
> - An example of a string specifying a key in a region operation when this partition resolver is used.
> - What happens if the string specifying a key doesn't have a '|' delimiter.
> - An example of using this partition resolver to colocate two regions.



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)