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-native.git
The following commit(s) were added to refs/heads/develop by this push:
new 10bdc85 GEODE-4728: Geode Native Documentation Improvements -
simplify docs for region configuration
10bdc85 is described below
commit 10bdc85e32a8e9f07e6f08850e0570ca2ab40a0a
Author: Dave Barnes <[email protected]>
AuthorDate: Thu Sep 6 09:48:05 2018 -0700
GEODE-4728: Geode Native Documentation Improvements - simplify docs for
region configuration
---
.../regions/region-attributes.html.md.erb | 149 ---------------------
1 file changed, 149 deletions(-)
diff --git a/docs/geode-native-docs/regions/region-attributes.html.md.erb
b/docs/geode-native-docs/regions/region-attributes.html.md.erb
index f3a0144..d7eabe8 100644
--- a/docs/geode-native-docs/regions/region-attributes.html.md.erb
+++ b/docs/geode-native-docs/regions/region-attributes.html.md.erb
@@ -63,152 +63,3 @@ You can add data eviction for non-PROXY regions:
`ENTRY_LRU`
> causes least recently used data to be evicted from memory when the region
> reaches the entry count limit.
-### <a id="customizing-region-attributes"></a>Customizing Region Attributes
-
-You can also create custom region attributes and store them with an identifier
for later
-retrieval. Both types of stored attributes are referred to as named region
attributes. You can
-create and store your attribute settings through the API or in the `cache.xml`
file.
-
-Retrieve named attributes by providing the ID to the region creation. This
example uses the shortcut
-`CACHING_PROXY` attributes to create a region:
-
-``` pre
-<region name="testRegion" refid="CACHING_PROXY"/>
-```
-
-You can modify named attributes as needed. For example, this adds a cache
listener to the region:
-
-``` pre
-<region name="testRegion" refid="CACHING_PROXY">
- <region-attributes>
- <cache-listener library-name="myAppLib"
- library-function-name ="myCacheListener" />
- </region-attributes>
-</region>
-```
-
-In this example, the modified region shortcut is saved to the cache using the
region attribute id, for retrieval and use by a second region:
-
-``` pre
-<region name="testRegion" refid="CACHING_PROXY">
- <region-attributes id="Caching_Proxy_With_Listener">
- <cache-listener library-name="myAppLib"
- library-function-name ="myCacheListener" />
- </region-attributes>
-</region>
-<region name="newTestRegion" refid="Caching_Proxy_With_Listener"/>
-```
-
-## <a id="immutable-region-attributes"></a>Immutable Region Attributes
-
-Attributes that are immutable (fixed) after region creation govern storage
location, data
-distribution, statistics, application plug-ins, and the configuration and
management of the region's
-data hashmap.
-
-This table lists the immutable attributes and their default settings.
-
-| Immutable Region Attribute | Default
Setting |
-|--------------------------------------------------------------------|-----------------|
-| [CachingEnabled](#caching-enabled) | true
|
-| [InitialCapacity](#initial-capacity) | 16
(entries) |
-| [LoadFactor](#load-factor) | 0.75
|
-| [ConcurrencyLevel](#concurrency-level) | 16
|
-| [ConcurrencyChecksEnabled](#concurrency-checks-enabled)
| true |
-| [DiskPolicy](../client-cache/disk-policy.html#disk-policy)
| |
-|
[PersistenceManager](../client-cache/persistence-manager.html#persistence-manager)
| NULL |
-|
[PartitionResolver](../client-cache/application-plugins.html#application-plugins_partitionresolver)
| |
-
-
-### <a id="caching-enabled"></a>CachingEnabled
-
-This attribute determines whether data is cached in this region. For example,
you might choose to
-configure the distributed system as a simple messaging service where clients
run without a cache.
-
-**Note:**
-You can configure the most common of these options with the predefined region
attributes. See
-[Region Shortcuts](#region-shortcuts) and the API docs for `RegionShortcut`.
-
-If `CachingEnabled` is false (no caching), an `IllegalStateException` is
thrown if any of these cache behavior attributes are set:
-
-- [InitialCapacity](#initial-capacity)
--
[EntryTimeToLive](../client-cache/expiration-attributes.html#expiration-attributes)
--
[EntryIdleTimeout](../client-cache/expiration-attributes.html#expiration-attributes)
-- [LoadFactor](#load-factor)
-- [ConcurrencyLevel](#concurrency-level)
-- [LruEntriesLimit](#lru-entries-limit)
-- [DiskPolicy](../client-cache/disk-policy.html#disk-policy)
-
-### <a id="initial-capacity"></a>InitialCapacity
-
-Use this attribute, together with the `LoadFactor` attribute, to set the
initial parameters on the
-underlying hashmap that stores region entries. This is the number of entries
that the region map
-will be ready to hold when it is created.
-
-### <a id="load-factor"></a>LoadFactor
-
-Use this attribute, together with the `InitialCapacity` attribute, to set the
initial parameters on
-the underlying hashmap that stores region entries. When the number of entries
in the map exceeds the
-`LoadFactor` times current capacity, the capacity is increased and the map is
rehashed. You get the
-best performance if you configure a properly sized region at the start and do
not have to rehash it.
-
-### <a id="concurrency-level"></a>ConcurrencyLevel
-
-This attribute estimates the maximum number of application threads that
concurrently access a region
-entry at one time. This attribute helps optimize the use of system resources
and reduce thread
-contention.
-
-**Note:**
-When `CachingEnabled` is `false`, do not set the `ConcurrencyLevel` attribute.
An `IllegalStateException` is thrown if the attribute is set.
-
-### <a id="concurrency-checks-enabled"></a>ConcurrencyChecksEnabled
-
-This attribute determines whether members perform checks to provide consistent
handling for
-concurrent or out-of-order updates to distributed regions.
-
-A client cache can disable consistency checking for a region even if server
caches enable
-consistency checking for the same region. This configuration (with checking
disabled on the client
-region but enabled on the server region) ensures that the client sees all
events for the region, but it
-does not prevent the client cache region from becoming out-of-sync with the
server cache.
-
-See [Region Consistency](consistency-checking-in-regions.html) for more
information.
-
-## <a id="mutable-region-attributes"></a>Mutable Region Attributes
-
-Mutable region attributes identify expiration and cache listener, cache writer
and cache loader
-actions that are run from the defining client. The mutable attributes listed
in the following table
-generally can be set by `RegionFactory` before region creation or modified
after region creation by
-using the `AttributesMutator` for the region.
-
-| Mutable Region Attribute
| Default Setting |
-|----------------------------------------------------------------------------------------------|-----------------|
-| [Expiration
attributes](../client-cache/expiration-attributes.html#expiration-attributes)
| no expiration |
-| [LruEntriesLimit](#lru-entries-limit)
| 0 (no limit) |
-|
[CacheLoader](../client-cache/application-plugins.html#application-plugins_cacheloader)
| |
-|
[CacheWriter](../client-cache/application-plugins.html#application-plugins_cachewriter)
| |
-|
[CacheListener](../client-cache/application-plugins.html#application-plugins_cachelistener)
| |
-
-
-See
[AttributesMutator](../client-cache/application-plugins.html#application-plugins_attributesmutator)
for
-information about using `AttributesMutator` with cache listeners, cache
loaders, and cache writers.
-
-### <a id="lru-entries-limit"></a>LruEntriesLimit
-
-This attribute sets the maximum number of entries to hold in a caching region.
When the capacity of
-the caching region is exceeded, a least-recently-used (LRU) algorithm is used
to evict entries.
-
-**Note:**
-This is a tuning parameter that affects system performance.
-
-When eviction is configured, memory consumption or entry count is monitored
and, when capacity is
-reached, <%=vars.product_name%> makes way for new entries by removing or
overflowing the stalest LRU
-entries to disk.
-
-If you use disk data overflow to supplement memory for your data cache, make
sure you have enough disk space to store the data.
-
-Evicted entries can be destroyed or moved to disk as an extension of the
cache. See [DiskPolicy](../client-cache/disk-policy.html#disk-policy).
-
-**Note:**
-When `CachingEnabled` is `false`, do not set the `LruEntriesLimit` attribute.
An `IllegalStateException` is thrown if the attribute is set.
-
-
-
