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 e7867c5 User Guide: Fixed format issues in <cache> element reference
e7867c5 is described below
commit e7867c53dc87cfa5a63a652aefc53044fa485140
Author: Dave Barnes <dbar...@pivotal.io>
AuthorDate: Fri Feb 9 17:47:17 2018 -0800
User Guide: Fixed format issues in <cache> element reference
---
geode-docs/reference/topics/cache_xml.html.md.erb | 326 ++++++++--------------
1 file changed, 119 insertions(+), 207 deletions(-)
diff --git a/geode-docs/reference/topics/cache_xml.html.md.erb
b/geode-docs/reference/topics/cache_xml.html.md.erb
index e5f5095..370d640 100644
--- a/geode-docs/reference/topics/cache_xml.html.md.erb
+++ b/geode-docs/reference/topics/cache_xml.html.md.erb
@@ -21,14 +21,13 @@ limitations under the License.
This section documents the `cache.xml` sub-elements used for
<%=vars.product_name%> server configuration. All elements are sub-elements of
the `<cache>` element.
-For <%=vars.product_name%> client configuration, see [<client-cache>
Element Reference](client-cache.html#cc-client-cache).
+For <%=vars.product_name%> client configuration, see [<client-cache>
Element Reference](client-cache.html).
**API**:`org.apache.geode.cache.CacheFactory`
-<a id="cache_xml_cache__table_B079C5A320194B3A98AD82DDB67DA43D"></a>
+**<cache> Attributes**
<table>
-<caption><span class="tablecap">Table 1. <cache> Element
Attributes</span></caption>
<colgroup>
<col width="30%" />
<col width="50%" />
@@ -75,8 +74,6 @@ For <%=vars.product_name%> client configuration, see
[<client-cache> Eleme
</tbody>
</table>
-<span class="tablecap">Table 1. <cache> Element Attributes</span>
-
**Example:**
``` pre
@@ -154,7 +151,8 @@ Set the `pool-name` attribute to set the name of the
connection pool used by cli
**API:** `org.apache.geode.cache.DynamicRegionFactory`
-<a id="dynamic-region-factory__table_6B7271DE968946CC9757FE241E9F872C"></a>
+**<dynamic-region-factory> Attributes**
+
| Attribute | Description
|
Default |
|---------------------------|--------------------------------------------------------------------------------------------------------------------------------|---------|
@@ -162,8 +160,6 @@ Set the `pool-name` attribute to set the name of the
connection pool used by cli
| disable-register-interest | When set to false, client regions created by the
factory register interest in all keys in a corresponding server cache region. |
false |
| pool-name | The name of a connection pool used by the client
factory to communicate with the server-side factory. |
none |
-<span class="tablecap">Table 2. <dynamic-region-factory>
Attributes</span>
-
**Example:**
``` pre
@@ -177,13 +173,12 @@ Set the `pool-name` attribute to set the name of the
connection pool used by cli
Specifies a region or disk store's disk directory.
+**<disk-dir> Attributes**
+
| Attribute | Description
| Default |
|---------------------------|------------------------------------------------------------------------------------------|--------------------------|
| dir-size | Maximum amount of space to use for the disk
store, in megabytes. | 214748364 (2 petabytes) |
-
-<span class="tablecap">Table 3. <disk-dir> Attributes</span>
-
**Example:**
``` pre
@@ -197,10 +192,8 @@ Configures a gateway sender to distribute region events to
another <%=vars.produ
**API:** `GatewaySender`
-<a id="gateway-sender__table_E3CCD986A16F4FE8B9C6BB0F70E90E2E"></a>
-
+**<gateway-sender> Attributes**
<table>
-<caption><span class="tablecap">Table 4. Attributes</span></caption>
<colgroup>
<col width="30%" />
<col width="50%" />
@@ -303,8 +296,6 @@ Configures a gateway sender to distribute region events to
another <%=vars.produ
</tbody>
</table>
-: <span class="tablecap">Table 4. Attributes</span>
-
**Example:**
``` pre
@@ -391,14 +382,13 @@ Configures a gateway receiver to receive and apply region
events that were distr
**API:** `GatewayReceiverFactory`, `GatewayTransportFilter`
-<a id="gateway-receiver__table_430418178B3B4D94B0EEAB9A83E005CF"></a>
+**<gateway-receiver> Attributes**
<table>
-<caption><span class="tablecap">Table 5. Attributes</span></caption>
<colgroup>
-<col width="33%" />
-<col width="33%" />
-<col width="33%" />
+<col width="30%" />
+<col width="50%" />
+<col width="20%" />
</colgroup>
<thead>
<tr class="header">
@@ -448,8 +438,6 @@ Configures a gateway receiver to receive and apply region
events that were distr
</tbody>
</table>
-: <span class="tablecap">Table 5. Attributes</span>
-
**Example:**
``` pre
@@ -508,10 +496,9 @@ Configures a queue for sending region events to an
AsyncEventListener implementa
**API:** `org.apache.geode.cache.asyncqueue.AsyncEventQueue`
-<a id="async-event-queue__table_5CEA4FE481D741E4913C098B67735714"></a>
+**<async-event-queue> Attributes**
<table>
-<caption><span class="tablecap">Table 4. <async-event-queue>
Attributes</span></caption>
<colgroup>
<col width="30%" />
<col width="50%" />
@@ -594,8 +581,6 @@ Configures a queue for sending region events to an
AsyncEventListener implementa
</tbody>
</table>
-<span class="tablecap">Table 4. <async-event-queue> Attributes</span>
-
**Example:**
``` pre
@@ -657,10 +642,9 @@ The `cacheserver` process uses only `cache.xml`
configuration. For application s
**API:** `org.apache.geode.cache.server.CacheServer`
-<a id="cache-server__table_78A30804A5394C2AA190579C8A1E22D8"></a>
+**<cache-server> Attributes**
<table>
-<caption><span class="tablecap">Table 5. <cache-server>
Attributes</span></caption>
<colgroup>
<col width="30%" />
<col width="50%" />
@@ -693,47 +677,42 @@ The `cacheserver` process uses only `cache.xml`
configuration. For application s
<tr class="even">
<td>max-connections</td>
<td>Maximum number of client connections for the server. When the maximum is
reached, the server refuses additional client connections.
-<div class="note note">
+<p>
<b>Note:</b>
-<p>Set this at least as high as max-threads.</p>
-</div></td>
+Set this at least as high as max-threads.</p></td>
<td>800</td>
</tr>
<tr class="odd">
<td>max-threads</td>
<td>Maximum number of threads allowed in this server to service client
connections. When the limit is reached, server threads begin servicing multiple
connections. A zero setting causes the server to use a thread for every client
connection.
-<div class="note note">
+<p>
<b>Note:</b>
-<p>Set this no higher than max-connections.</p>
-</div></td>
+Set this no higher than max-connections.</p></td>
<td>0</td>
</tr>
<tr class="even">
<td>maximum-message-count</td>
<td>Maximum number of messages allowed in a subscription queue. When the queue
reaches this limit, messages block.
-<div class="note note">
+<p>
<b>Note:</b>
-<p>Used only if <code class="ph codeph">client-subscription</code> is not
configured.</p>
-</div></td>
+Used only if <code class="ph codeph">client-subscription</code> is not
configured.</p></td>
<td>230000</td>
</tr>
<tr class="odd">
<td>maximum-time-between-pings</td>
<td>Maximum time, in milliseconds, the server allows to pass between messages
or pings indicating a client is healthy.
-<div class="note note">
+<p>
<b>Note:</b>
-<p>A setting of 0 or a negative number turns off client health monitoring. Be
careful not to do this accidentally.</p>
-</div></td>
+A setting of 0 or a negative number turns off client health monitoring. Be
careful not to do this accidentally.</p></td>
<td>60000
<p>(1 minute)</p></td>
</tr>
<tr class="even">
<td>message-time-to-live</td>
<td>Setting used for highly available subscription queues. The expiration
time, in seconds, for non-durable messages in the secondary server’s client
subscription queue. The system removes non-durable messages that have been in
the queue beyond this time. If set to 0 (zero), the messages are never removed.
-<div class="note note">
+<p>
<b>Note:</b>
-<p>Set this high enough to avoid removing messages that are still valid, to
aovid losing messages during server failover.</p>
-</div></td>
+Set this high enough to avoid removing messages that are still valid, to aovid
losing messages during server failover.</p></td>
<td>180
<p>(3 minutes)</p></td>
</tr>
@@ -755,8 +734,6 @@ The `cacheserver` process uses only `cache.xml`
configuration. For application s
</tbody>
</table>
-<span class="tablecap">Table 5. <cache-server> Attributes</span>
-
**Example:**
``` pre
@@ -774,9 +751,9 @@ Overflow specification for client subscription queues. Sets
a capacity limit on
**Default:** no overflow
-**API:**
+**API:** `org.apache.geode.cache.server.ClientSubscriptionConfig`
-<a id="client-subscription__table_7A3AC0C448185019B1382600182"></a>
+**<client-subscription> Attributes**
| Attribute | Description
| Default |
|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|
@@ -784,12 +761,14 @@ Overflow specification for client subscription queues.
Sets a capacity limit on
| capacity | Used if eviction-policy is not null. Specified in
megabytes for mem and as a positive integer for entry.
| 1 |
| disk-store-name | Used if eviction-policy is not null. Default: default
disk store. If specified, the disk-store-name must specify a disk store that is
already defined in the cache. | default disk store |
-<span class="tablecap">Table 6. <client-subscription> Attributes</span>
-
**Example:**
``` pre
-<cache-server port=4444>
+<cache>
+ <cache-server port=4444>
+ <client-subscription eviction-policy="entry | mem" capacity=35
overflow-directory="OverflowDir"></client-subscription>
+ ...
+ </cache-server>
</cache>
```
@@ -819,10 +798,9 @@ Use for client caches. Defines a client's server pool used
to communicate with s
**API:** `org.apache.geode.cache.client.PoolFactory`
-<a id="pool__table_14D991AC65A6414BB71EF7AC67B59771"></a>
+**<pool> Attributes**
<table>
-<caption><span class="tablecap">Table 7. <pool>
Attributes</span></caption>
<colgroup>
<col width="30%" />
<col width="50%" />
@@ -855,10 +833,9 @@ Use for client caches. Defines a client's server pool used
to communicate with s
<tr class="even">
<td>max-connections</td>
<td>Maximum number of pool connections the pool can create. If the maximum
connections are in use, an operation requiring a client-to-server connection
blocks until a connection becomes available or the <code class="ph
codeph">free-connection-timeout</code> is reached. If set to -1, there is no
maximum. The setting must indicate a cap greater than <code class="ph
codeph">min-connections</code>.
-<div class="note note">
+<p>
<b>Note:</b>
-<p>If you need to use this to cap your pool connections, you should disable
the pool attribute <code class="ph codeph">pr-single-hop-enabled</code>.
Leaving single hop enabled can increase thrashing and lower performance.</p>
-</div></td>
+If you need to use this to cap your pool connections, you should disable the
pool attribute <code class="ph codeph">pr-single-hop-enabled</code>. Leaving
single hop enabled can increase thrashing and lower performance.</p></td>
<td>-1</td>
</tr>
<tr class="odd">
@@ -874,19 +851,17 @@ Use for client caches. Defines a client's server pool
used to communicate with s
<tr class="odd">
<td>name</td>
<td>Name of this pool. Used in the client region pool-name to assign this pool
to a region in the client cache.
-<div class="note note">
+<p>
<b>Note:</b>
-<p>This is a required property with no default setting.</p>
-</div></td>
+This is a required property with no default setting.</p></td>
<td>none</td>
</tr>
<tr class="even">
<td>ping-interval</td>
<td>How often to communicate with the server to show the client is alive, set
in milliseconds. Pings are only sent when the ping-interval elapses between
normal client messages.
-<div class="note note">
+<p>
<b>Note:</b>
-<p>Set this lower than the server’s <code class="ph
codeph">maximum-time-between-pings</code>.</p>
-</div></td>
+Set this lower than the server’s <code class="ph
codeph">maximum-time-between-pings</code>.</p></td>
<td>10000</td>
</tr>
<tr class="odd">
@@ -907,10 +882,9 @@ Use for client caches. Defines a client's server pool used
to communicate with s
<tr class="even">
<td>server-group</td>
<td>Logical named server group to use from the pool. A null value uses the
global server group to which all servers belong.
-<div class="note note">
+<p>
<b>Note:</b>
-<p>This is only used when the <code class="ph codeph">locator</code> list is
defined.</p>
-</div></td>
+This is only used when the <code class="ph codeph">locator</code> list is
defined.</p></td>
<td>null</td>
</tr>
<tr class="odd">
@@ -926,10 +900,9 @@ Use for client caches. Defines a client's server pool used
to communicate with s
<tr class="odd">
<td>subscription-ack-interval</td>
<td>Time, in milliseconds, between messages to the primary server to
acknowledge event receipt.
-<div class="note note">
+<p>
<b>Note:</b>
-<p>Used only when <code class="ph codeph">subscription-redundancy</code> is
not ‘0’ (zero).</p>
-</div></td>
+Used only when <code class="ph codeph">subscription-redundancy</code> is not
‘0’ (zero).</p></td>
<td>100</td>
</tr>
<tr class="even">
@@ -957,8 +930,6 @@ Use for client caches. Defines a client's server pool used
to communicate with s
</tbody>
</table>
-<span class="tablecap">Table 7. <pool> Attributes</span>
-
**Example:**
``` pre
@@ -983,15 +954,13 @@ Provide a locator list or `server` list, but not both.
**API:** `org.apache.geode.distributed.LocatorLauncher`
-<a id="locator__table_10BEB4E1383B475795ED4E290676E058"></a>
+**<locator> Attributes**
| Attribute | Description | Default |
|-----------|----------------------------|---------|
| host | Hostname of the locator | |
| port | Port number of the locator | |
-<span class="tablecap">Table 8. <locator> Attributes</span>
-
**Example:**
``` pre
@@ -1012,15 +981,13 @@ Provide a server list or `locator` list, but not both.
**API:** `org.apache.geode.distributed.ServerLauncher`
-<a id="server__table_BD0B19AA44FF4CA68BBBC785E46E03F1"></a>
+**<server> Attributes**
| Attribute | Description | Default |
|-----------|---------------------------|---------|
| host | Hostname of the server | |
| port | Port number of the server | |
-<span class="tablecap">Table 9. <server> Attributes</span>
-
**Example:**
``` pre
@@ -1039,7 +1006,7 @@ Defines a pool of one or more disk stores, which can be
used by regions, and cli
**API:** `org.apache.geode.cache.DiskStore`
-<a id="disk-store__table_C90DEC71FBD74C2F98E5447E961E899F"></a>
+**<disk-store> Attributes**
<table>
<caption><span class="tablecap">Table 10. <disk-store>
Attributes</span></caption>
@@ -1112,8 +1079,6 @@ Defines a pool of one or more disk stores, which can be
used by regions, and cli
</tbody>
</table>
-<span class="tablecap">Table 10. <disk-store> Attributes</span>
-
**Example:**
``` pre
@@ -1136,10 +1101,9 @@ An element of a disk store that defines a set of
`<disk-dir>` elements.
Specifies a region or disk store's disk directory.
-<a id="disk-dir__table_877FDB097F454F33AE90FB16FAD212AE"></a>
+**<disk-dir> Attributes**
<table>
-<caption><span class="tablecap">Table 11. <disk-dir>
Attributes</span></caption>
<colgroup>
<col width="30%" />
<col width="50%" />
@@ -1162,8 +1126,6 @@ Specifies a region or disk store's disk directory.
</tbody>
</table>
-<span class="tablecap">Table 11. <disk-dir> Attributes</span>
-
**Example:**
``` pre
@@ -1177,7 +1139,7 @@ Specifies the configuration for the Portable Data
eXchange (PDX) method of seria
**API:** `org.apache.geode.cache.CacheFactory.setPdxReadSerialized`,
`setPdxDiskStore`, `setPdxPersistent`, `setPdxIgnoreUnreadFields` and
`org.apache.geode.cache.ClientCacheFactory.setPdxReadSerialized`,
`setPdxDiskStore`, `setPdxPersistent`, `setPdxIgnoreUnreadFields`
-<a id="pdx__table_DE49C41CAD444DA9B01F055C401920BF"></a>
+**<pdx> Attributes**
| Attribute | Description
| Default |
|----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|
@@ -1186,8 +1148,6 @@ Specifies the configuration for the Portable Data
eXchange (PDX) method of seria
| persistent | Set to true if you are using persistent regions. This
causes the PDX type information to be written to disk.
| |
| disk-store-name | If using persistence, this attribute allows you to
configure the disk store that the PDX type data will be stored in. By default,
the default disk store is used. |
|
-<span class="tablecap">Table 12. <pdx> Attributes</span>
-
**Example:**
``` pre
@@ -1235,10 +1195,9 @@ Specifies a region attributes template that can be named
(by `id`) and reference
**API:** `org.apache.geode.cache.RegionFactory` or
`org.apache.geode.cache.ClientRegionFactory`
-<a id="region-attributes__table_028B4DC4FB72488AB6359AAA13E0B5B0"></a>
+**<region-attributes> Attributes**
<table>
-<caption><span class="tablecap">Table 13. <region-attributes>
Attributes</span></caption>
<colgroup>
<col width="20%" />
<col width="60%" />
@@ -1255,10 +1214,9 @@ Specifies a region attributes template that can be named
(by `id`) and reference
<tr class="odd">
<td>concurrency-level</td>
<td>Gives an estimate of the maximum number of application threads that will
concurrently access a region entry at one time. This attribute does not apply
to partitioned regions. This attribute helps <%=vars.product_name%> optimize
the use of system resources and reduce thread contention. This sets an initial
parameter on the underlying <code class="ph
codeph">java.util.ConcurrentHashMap</code> used for storing region entries.
-<div class="note note">
+<p>
<b>Note:</b>
-<p>Before you modify this, read the concurrency level description, then see
the Java API documentation for <code class="ph
codeph">java.util.ConcurrentHashMap</code>.</p>
-</div>
+Before you modify this, read the concurrency level description, then see the
Java API documentation for <code class="ph
codeph">java.util.ConcurrentHashMap</code>.</p>
<p><strong>API:</strong> <code class="ph codeph">setConcurrencyLevel</code></p>
<p><strong>Example:</strong></p>
<pre class="pre codeblock language-xml"><code><region-attributes
@@ -1269,10 +1227,9 @@ Specifies a region attributes template that can be named
(by `id`) and reference
<tr class="even">
<td>data-policy</td>
<td><p>Specifies how the local cache handles data for a region. This setting
controls behavior such as local data storage and region initialization.</p>
-<div class="note note">
+<p>
<b>Note:</b>
-<p>Configure the most common options using the region shortcuts, <code
class="ph codeph">RegionShortcut</code> and <code class="ph
codeph">ClientRegionShortcut</code>. The default <code class="ph
codeph">data-policy</code> of <code class="ph codeph">normal</code> specifies
local cache storage. The empty policy specifies no local storage. In the region
shortcuts, empty corresponds to the settings with the string <code class="ph
codeph">PROXY</code>. You can use an empty region for event d [...]
-</div>
+Configure the most common options using the region shortcuts, <code class="ph
codeph">RegionShortcut</code> and <code class="ph
codeph">ClientRegionShortcut</code>. The default <code class="ph
codeph">data-policy</code> of <code class="ph codeph">normal</code> specifies
local cache storage. The empty policy specifies no local storage. In the region
shortcuts, empty corresponds to the settings with the string <code class="ph
codeph">PROXY</code>. You can use an empty region for event deli [...]
<p>You can specify the following data policies:</p>
<div class="p">
<table>
@@ -1323,10 +1280,9 @@ Specifies a region attributes template that can be named
(by `id`) and reference
<tr class="odd">
<td>enable-async-conflation</td>
<td><p>For TCP/IP distributions between peers, specifies whether to allow
aggregation of asynchronous messages sent by the producer member for the
region. This is a special-purpose voolean attribute that applies only when
asynchronous queues are used for slow consumers. A false value disables
conflation so that all asynchronous messages are sent individually. This
special-purpose attribute gives you extra control over peer-to-peer
communication between distributed regions using TCP/IP. T [...]
-<div class="note note">
+<p>
<b>Note:</b>
-<p>To use this attribute, the <code class="ph codeph">multicast-enabled</code>
region attribute <code class="ph codeph">disable-tcp</code> in <code class="ph
codeph">gemfire.properties</code> must be false (the default for both). In
addition, asynchronous queues must be enabled for slow consumers, specified
with the <code class="ph codeph">async</code>* gemfire properties.</p>
-</div>
+To use this attribute, the <code class="ph codeph">multicast-enabled</code>
region attribute <code class="ph codeph">disable-tcp</code> in <code class="ph
codeph">gemfire.properties</code> must be false (the default for both). In
addition, asynchronous queues must be enabled for slow consumers, specified
with the <code class="ph codeph">async</code>* gemfire properties.</p>
<p><strong>API:</strong> <code class="ph
codeph">setEnableAsyncConflation</code></p>
<p><strong>Example:</strong></p>
<pre class="pre codeblock language-xml"><code><region-attributes
@@ -1337,10 +1293,9 @@ Specifies a region attributes template that can be named
(by `id`) and reference
<tr class="odd">
<td>enable-subscription-conflation</td>
<td><p>Boolean for server regions that specifies whether the server can
conflate its messages to the client. A true value enables conflation.</p>
-<div class="note note">
+<p>
<b>Note:</b>
<p>The client can override this setting with the <code class="ph
codeph">conflate-events</code> property in its <code class="ph
codeph">gemfire.properties</code>.</p>
-</div>
<p><strong>API:</strong> <code class="ph
codeph">setEnableSubscriptionConflation</code></p>
<p><strong>Example:</strong></p>
<pre class="pre codeblock language-xml"><code><region-attributes
@@ -1427,10 +1382,9 @@ Specifies a region attributes template that can be named
(by `id`) and reference
<tr class="even">
<td>load-factor</td>
<td><p>Together with the initial-capacity region attribute, sets the initial
parameters on the underlying <code class="ph
codeph">java.util.ConcurrentHashMap</code> used for storing region entries.
This must be a floating point number between 0 and 1, inclusive.</p>
-<div class="note note">
+<p>
<b>Note:</b>
<p>Before you set this attribute, read the discussion of initial capacity and
load factor, then see the Java API documentation for <code class="ph
codeph">java.util.ConcurrentHashMap</code>.</p>
-</div>
<p><strong>API:</strong> <code class="ph codeph">setLoadFactor</code></p>
<p><strong>Example:</strong></p>
<pre class="pre codeblock language-xml"><code><region-attributes
@@ -1525,14 +1479,12 @@ Specifies a region attributes template that can be
named (by `id`) and reference
<tr class="odd">
<td>scope</td>
<td><p>Definition: Determines how updates to region entries are distributed to
the other caches in the distributed system where the region and entry are
defined. Scope also determines whether to allow remote invocation of some of
the region’s event handlers, and whether to use region entry versions to
provide consistent updates across replicated regions.</p>
-<div class="note note">
+<p>
<b>Note:</b>
<p>You can configure the most common of these options with
<%=vars.product_name%> region shortcuts in <code class="ph
codeph">RegionShortcut</code> and <code class="ph
codeph">ClientRegionShortcut</code>.</p>
-</div>
-<div class="note note">
+<p>
<b>Note:</b>
<p>Server regions that are not partitioned must be replicated with <code
class="ph codeph">distributed-ack</code> or <code class="ph
codeph">global</code> scope. The region shortcuts that specify <code class="ph
codeph">REPLICATE</code> have <code class="ph codeph">distributed-ack</code>
scope.</p>
-</div>
<p>Set one of the following scope values:</p>
<div class="p">
<table>
@@ -1586,10 +1538,9 @@ Specifies a region attributes template that can be named
(by `id`) and reference
<tr class="even">
<td>concurrency-checks-enabled</td>
<td><p>Determines whether members perform checks to provide consistent
handling for concurrent or out-of-order updates to distributed regions. See
[Consistency for Region
Updates](../../developing/distributed_regions/region_entry_versions.html#topic_CF2798D3E12647F182C2CEC4A46E2045).</p>
-<div class="note note">
+<p>
<b>Note:</b>
-<p>Applications that use a <code class="ph codeph">client-cache</code> may
want to disable concurrency checking in order to see all events for a region.
<%=vars.product_name%> server members can continue using concurrency checks for
the region, but they will pass all events to the client cache. This
configuration ensures that the client sees all events, but it does not prevent
the client cache from becoming out-of-sync with the server cache.</p>
-</div>
+Applications that use a <code class="ph codeph">client-cache</code> may want
to disable concurrency checking in order to see all events for a region.
<%=vars.product_name%> server members can continue using concurrency checks for
the region, but they will pass all events to the client cache. This
configuration ensures that the client sees all events, but it does not prevent
the client cache from becoming out-of-sync with the server cache.</p>
<p><strong>API:</strong> <code class="ph
codeph">setConcurrencyChecksEnabled</code></p>
<p><strong>Example:</strong></p>
<pre class="pre codeblock language-xml"><code><region-attributes
@@ -1610,8 +1561,6 @@ Specifies a region attributes template that can be named
(by `id`) and reference
</tbody>
</table>
-<span class="tablecap">Table 13. <region-attributes> Attributes</span>
-
## <a id="key-constraint" class="no-quick-link"></a><key-constraint>
Defines the type of object to be allowed for the region entry keys. This must
be a fully-qualified class name. The attribute ensures that the keys for the
region entries are all of the same class. If key-constraint is not used, the
region’s keys can be of any class. This attribute, along with value-constraint,
is useful for querying and indexing because it provides object type information
to the query engine.
@@ -1681,10 +1630,9 @@ Within the `entry-time-to-live` or `entry-idle-time`
element, this element speci
**API:** See APIs for `entry-time-to-live`, `entry-idle-time`,
`region-time-to-live`, `region-idle-time`
-<a id="expiration-attributes__table_E9AFB36CA3C345CEBF10F2AE482D9878"></a>
+**<expiration-attributes> Attributes**
<table>
-<caption><span class="tablecap">Table 14. <expiration-attributes>
Attributes</span></caption>
<colgroup>
<col width="20%" />
<col width="60%" />
@@ -1734,8 +1682,6 @@ Select one of the following expiration actions:
</tbody>
</table>
-<span class="tablecap">Table 14. <expiration-attributes>
Attributes</span>
-
**Example:**
``` pre
@@ -1803,10 +1749,9 @@ Within the `entry-time-to-live` or `entry-idle-time`
element, this element speci
**API:** See APIs for `entry-time-to-live`, `entry-idle-time`,
`region-time-to-live`, `region-idle-time`
-<a
id="region-idle-time_expiration-attributes__table_E9AFB36CA3C345CEBF10F2AE482D9878"></a>
+**<expiration-attributes> Attributes**
<table>
-<caption><span class="tablecap">Table 15. <expiration-attributes>
Attributes</span></caption>
<colgroup>
<col width="20%" />
<col width="60%" />
@@ -1856,8 +1801,6 @@ Select one of the following expiration actions:
</tbody>
</table>
-<span class="tablecap">Table 15. <expiration-attributes>
Attributes</span>
-
**Example:**
``` pre
@@ -1923,10 +1866,9 @@ Within the `entry-time-to-live` or `entry-idle-time`
element, this element speci
**API:** See APIs for `entry-time-to-live`, `entry-idle-time`,
`region-time-to-live`, `region-idle-time`
-<a
id="entry-time-to-live_expiration-attributes__table_E9AFB36CA3C345CEBF10F2AE482D9878"></a>
+**<expiration-attributes> Attributes**
<table>
-<caption><span class="tablecap">Table 16. <expiration-attributes>
Attributes</span></caption>
<colgroup>
<col width="20%" />
<col width="60%" />
@@ -1976,8 +1918,6 @@ Select one of the following expiration actions:
</tbody>
</table>
-<span class="tablecap">Table 16. <expiration-attributes>
Attributes</span>
-
**Example:**
``` pre
@@ -2045,10 +1985,9 @@ Within the `entry-time-to-live` or `entry-idle-time`
element, this element speci
**API:** See APIs for `entry-time-to-live`, `entry-idle-time`,
`region-time-to-live`, `region-idle-time`
-<a
id="entry-idle-time_expiration-attributes__table_E9AFB36CA3C345CEBF10F2AE482D9878"></a>
+**<expiration-attributes> Attributes**
<table>
-<caption><span class="tablecap">Table 17. <expiration-attributes>
Attributes</span></caption>
<colgroup>
<col width="20%" />
<col width="60%" />
@@ -2098,8 +2037,6 @@ Select one of the following expiration actions:
</tbody>
</table>
-<span class="tablecap">Table 17. <expiration-attributes>
Attributes</span>
-
**Example:**
``` pre
@@ -2147,19 +2084,17 @@ With the exception of `local-max-memory`, all members
defining a partitioned reg
**API:** `org.apache.geode.cache.RegionFactory.setPartitionAttributes`
-<a id="partition-attributes__table_5CB4AC52DDA94E60A2B8325BA31E1253"></a>
+**<partition-attributes> Attributes**
-| Attribute | Description
[...]
-|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
-| colocated-with | The full name of a region to colocate with this
region. The named region must exist before this region is created.
[...]
+| Attribute | Description | Default |
+|------------------------|--------------------|----------------------|
+| colocated-with | The full name of a region to colocate with this
region. The named region must exist before this region is created.
| null |
| local-max-memory | Maximum megabytes of memory set aside for this
region in the local member. This is all memory used for this partitioned region
- for primary buckets and any redundant copies. This value must be smaller than
the Java settings for the initial or maximum JVM heap. When the memory use goes
above this value, <%=vars.product_name%> issues a warning, but operation
continues. Besides setting the maximum memory to use for the member, this
setting also tells <%=vars.prod [...]
-| recovery-delay | Applies when `redundant-copies` is greater than
zero. The number of milliseconds to wait after a member crashes before
reestablishing redundancy for the region. A setting of -1 disables automatic
recovery of redundancy after member failure.
[...]
-| redundant-copies | Number of extra copies that the partitioned region
must maintain for each entry. Range: 0-3. If you specify 1, this partitioned
region maintains the original and one backup, for a total of two copies. A
value of 0 disables redundancy.
[...]
-| startup-recovery-delay | Applies when `redundant-copies` is greater than
zero. The number of milliseconds a newly started member should wait before
trying to satisfy redundancy of region data stored on other members. A setting
of -1 disables automatic recovery of redundancy after new members join.
[...]
-| total-max-memory | Maximum combined megabytes of memory to be used by
all processes hosting this region for all copies, primary and redundant.
[...]
-| total-num-buckets | Total number of buckets or data storage areas
allotted for the entire partitioned region in the distributed cache. As data
moves from one member to another, the entries in a bucket move as one unit.
This value should be a prime number at least four times the number of data
stores. More buckets increases overhead, however, especially when
redundant-copies = 2 or 3 .
[...]
-
-<span class="tablecap">Table 18. <partition-attributes> Attributes</span>
+| recovery-delay | Applies when `redundant-copies` is greater than
zero. The number of milliseconds to wait after a member crashes before
reestablishing redundancy for the region. A setting of -1 disables automatic
recovery of redundancy after member failure. | -1
|
+| redundant-copies | Number of extra copies that the partitioned region
must maintain for each entry. Range: 0-3. If you specify 1, this partitioned
region maintains the original and one backup, for a total of two copies. A
value of 0 disables redundancy. | 0 |
+| startup-recovery-delay | Applies when `redundant-copies` is greater than
zero. The number of milliseconds a newly started member should wait before
trying to satisfy redundancy of region data stored on other members. A setting
of -1 disables automatic recovery of redundancy after new members join. | 0
|
+| total-max-memory | Maximum combined megabytes of memory to be used by
all processes hosting this region for all copies, primary and redundant. | `
Integer.MAX_VALUE` |
+| total-num-buckets | Total number of buckets or data storage areas
allotted for the entire partitioned region in the distributed cache. As data
moves from one member to another, the entries in a bucket move as one unit.
This value should be a prime number at least four times the number of data
stores. More buckets increases overhead, however, especially when
redundant-copies = 2 or 3 .| 113 |
**Example:**
@@ -2179,14 +2114,12 @@ Describes a custom PartitionResolver for a region.
Specify the Java class and its initialization parameters with the
`<class-name>` and `<parameter>` sub-elements. See [<class-name> and
<parameter>](#class-name_parameter).
-<a id="partition-resolver__table_7644DF062B5A4B04AFA806F87FB0912A"></a>
+**<partition-resolver> Attributes**
| Attribute | Description | Default |
|-----------|--------------------------------------------|---------|
| name | The name of this custom PartitionResolver. | |
-<span class="tablecap">Table 19. <partition-resolver> Attributes</span>
-
**Example:**
``` pre
@@ -2229,7 +2162,7 @@ Describes a partition in a Fixed Partitioned Region.
**API:**
`org.apache.geode.cache.PartitionAttributesFactory.addFixedPartitionAttributes`
-<a id="fixed-partition-attributes__table_E3929FDFD5A24946919936F67D6DE46E"></a>
+**<fixed-partition-attributes> Attributes**
| Attribute | Description |
Default |
|----------------|---------------------------------------------------------|---------|
@@ -2237,7 +2170,6 @@ Describes a partition in a Fixed Partitioned Region.
| is-primary | Set to true if this partition is the primary partition. |
false |
| num-buckets | The number of buckets assigned to this partition. |
|
-<span class="tablecap">Table 20. <fixed-partition-attributes>
Attributes</span>
**Example:**
@@ -2267,10 +2199,9 @@ Establishes reliability requirements and behavior for a
region. Use this to conf
**API:** `org.apache.geode.cache.RegionFactory.setMembershipAttributes`
-<a id="membership-attributes__table_EBF62709899C48CFA1D2032656F95D0F"></a>
+**<membership-attributes> Attributes**
<table>
-<caption><span class="tablecap">Table 21. <membership-attributes>
Attributes</span></caption>
<colgroup>
<col width="20%" />
<col width="60%" />
@@ -2333,8 +2264,6 @@ Specifies how the region is affected by resumption of
reliability when one or mo
</tbody>
</table>
-<span class="tablecap">Table 21. <membership-attributes>
Attributes</span>
-
**Example:**
``` pre
@@ -2357,14 +2286,12 @@ Specifies a role that is required for reliable access
to the region.
**API:** `org.apache.geode.cache.MembershipAttributes`
-<a id="required-role__table_8DE73CB4967F4906ACEF6FFFB91186B7"></a>
+**<required-role> Attributes**
| Attribute | Description | Default |
|-----------|--------------------------------|---------|
| name | The name of the required role. | |
-<span class="tablecap">Table 22. <required-role> Attributes</span>
-
**Example:**
``` pre
@@ -2384,10 +2311,9 @@ The interest policy determines which events are
delivered, but the `data-policy`
**API:** `org.apache.geode.cache.RegionFactory.setSubscriptionAttributes`
-<a id="subscription-attributes__table_63C8ADF9549740BCA4CA8F1CFB7CD75F"></a>
+**<subscription-attributes> Attributes**
<table>
-<caption><span class="tablecap">Table 23. <subscription-attributes>
Attributes</span></caption>
<colgroup>
<col width="20%" />
<col width="60%" />
@@ -2423,8 +2349,6 @@ The interest policy determines which events are
delivered, but the `data-policy`
</tbody>
</table>
-<span class="tablecap">Table 23. <subscription-attributes>
Attributes</span>
-
**Example:**
``` pre
@@ -2529,10 +2453,9 @@ Specifies whether and how to control a region’s size.
Size is controlled by re
Using the maximum attribute, specifies maximum region capacity based on entry
count.
-<a id="lru-entry-count__lru-entry-count_attributes"></a>
+**<lru-entry-count> Attributes**
<table>
-<caption><span class="tablecap">Table 24. <lru-entry-count>
Attributes</span></caption>
<colgroup>
<col width="20%" />
<col width="60%" />
@@ -2573,18 +2496,18 @@ Using the maximum attribute, specifies maximum region
capacity based on entry co
</tbody>
</table>
-<span class="tablecap">Table 24. <lru-entry-count> Attributes</span>
-
## <a id="lru-heap-percentage"
class="no-quick-link"></a><lru-heap-percentage>
-Runs evictions when the <%=vars.product_name%> resource manager says to. The
manager orders evictions when the total cache size is over the heap percentage
limit specified in the manager configuration. You can declare a Java class that
implements the ObjectSizer interface to measure the size of objects in the
Region.
+Runs evictions when the <%=vars.product_name%> resource manager says to. The
manager orders
+evictions when the total cache size is over the heap or off-heap percentage
limit specified in the resource manager
+configuration. You can declare a Java class that implements the ObjectSizer
interface to measure the
+size of objects in the Region.
Specify the Java class and its initialization parameters with the
`<class-name>` and `<parameter>` sub-elements. See [<class-name> and
<parameter>](#class-name_parameter).
-<a id="lru-heap-percentage__table_BE5E06D0A882475986AD06D396A6C9D5"></a>
+**<lru-heap-percentage> Attributes**
<table>
-<caption><span class="tablecap">Table 25. <lru-heap-percentage>
Attributes</span></caption>
<colgroup>
<col width="20%" />
<col width="60%" />
@@ -2620,18 +2543,15 @@ Specify the Java class and its initialization
parameters with the `<class-name>`
</tbody>
</table>
-<span class="tablecap">Table 25. <lru-heap-percentage> Attributes</span>
-
## <a id="lru-memory-size" class="no-quick-link"></a><lru-memory-size>
Using the maximum attribute, specifies maximum region capacity based on the
amount of memory used, in megabytes. You can declare a Java class that
implements the ObjectSizer interface to measure the size of objects in the
Region.
Specify the Java class and its initialization parameters with the
`<class-name>` and `<parameter>` sub-elements. See [<class-name> and
<parameter>](#class-name_parameter).
-<a id="lru-memory-size__table_FF23FEF0F5884955B7AA55370790F357"></a>
+**<lru-memory-size> Attributes**
<table>
-<caption><span class="tablecap">Table 26. <lru-memory-size>
Attributes</span></caption>
<colgroup>
<col width="20%" />
<col width="60%" />
@@ -2672,8 +2592,6 @@ Specify the Java class and its initialization parameters
with the `<class-name>`
</tbody>
</table>
-<span class="tablecap">Table 26. <lru-memory-size> Attributes</span>
-
## <a id="jndi-bindings" class="no-quick-link"></a><jndi-bindings>
Specifies the binding for a data-source used in transaction management. See
[Configuring Database Connections Using
JNDI](../../developing/transactions/configuring_db_connections_using_JNDI.html#topic_A5E3A67C808D48C08E1F0DC167C5C494).
@@ -2718,10 +2636,9 @@ For every datasource that is bound to the JNDI tree,
there should be one `<jndi-
We recommend that you set the username and password with the `user-name` and
`password` jndi-binding attributes rather than using the `<config-property>`
element.
-<a id="jndi-binding__table_ACB9FB992BD8456AB2052017C2B2CCB4"></a>
+**<jndi-binding> Attributes**
<table>
-<caption><span class="tablecap">Table 27. <jndi-binding>
Attributes</span></caption>
<colgroup>
<col width="33%" />
<col width="33%" />
@@ -2748,10 +2665,9 @@ We recommend that you set the username and password with
the `user-name` and `pa
<tr class="odd">
<td>connection-url</td>
<td>URL for connecting to the datasource.
-<div class="note note">
+<p>
<b>Note:</b>
-<p>If you are connecting to a JCA data source driver that implements XA
transactions (where the jndi-binding type is
<strong>XAPooledDataSource</strong>), do not use this attribute. Instead,
define configuration properties for your database. See
[<config-property>](#config-property) for an example.</p>
-</div></td>
+<p>If you are connecting to a JCA data source driver that implements XA
transactions (where the jndi-binding type is
<strong>XAPooledDataSource</strong>), do not use this attribute. Instead,
define configuration properties for your database. See
[<config-property>](#config-property) for an example.</p></td>
<td> </td>
</tr>
<tr class="even">
@@ -2860,8 +2776,6 @@ Set one of the following types:
</tbody>
</table>
-<span class="tablecap">Table 27. <jndi-binding> Attributes</span>
-
## <a id="config-property" class="no-quick-link"></a><config-property>
A configuration property of the datasource. Use the sub-elements to identify
the name, datatype, and value of the property.
@@ -2902,15 +2816,13 @@ Defines a region in the cache. See
[<region-attributes>](#region-attribute
**API:** `org.apache.geode.cache.RegionFactory` or
`org.apache.geode.cache.ClientRegionFactory`
-<a id="region__table_4D95B5BF161844CE8DE2E11A3ED40041"></a>
+**<region> Attributes**
-| Attribute | Description
[...]
-|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
-| name | Specify the name for the region. See [Region
Management](../../basic_config/data_regions/managing_data_regions.html) for
details.
[...]
+| Attribute | Description | Default |
+|-----------|-------------|---------|
+| name | Specify the name for the region. See [Region
Management](../../basic_config/data_regions/managing_data_regions.html) for
details. | |
| refid | Used to apply predefined attributes to the region being defined.
If the nested "region-attributes" element has its own "refid", then it will
cause the "refid" on the region to be ignored. The "refid" region attriibute
can be set to the name of a RegionShortcut or a ClientRegionShortcut. For more
information, see [Region Shortcuts and Custom Named Region
Attributes](../../basic_config/data_regions/region_shortcuts.html) and [Storing
and Retrieving Region Shortcuts and Custom [...]
-<span class="tablecap">Table 28. <region> Attributes</span>
-
**Example:**
``` pre
@@ -2942,20 +2854,18 @@ Describes an index to be created on a region. The index
node, if any, should all
**Default:**
-**API:** `org.apache.geode.cache.query.QueryService.createIndex,
createKeyIndex, createHashIndex`
+**API:** `org.apache.geode.cache.query.QueryService.createIndex,
createKeyIndex, createHashIndex`
-<a id="index__table_43625CFF95114DADB2F07052F3743BCC"></a>
+**<index> Attributes**
-| Attribute | Description
| Default |
-|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|
-| name | Required. Name of the index.
| |
-| from-clause | Specifies the collection(s) of objects that the index ranges
over. The from-clause must only contain one and only one region path.
| |
-| expression | Specifies the lookup value of the index.
| |
+| Attribute | Description | Default |
+|-------------|-------------|---------|
+| name | Required. Name of the index. | |
+| from-clause | Specifies the collection(s) of objects that the index ranges
over. The from-clause must only contain one and only one region path. |
|
+| expression | Specifies the lookup value of the index. | |
| imports | String containing the imports used to create the index. String
should be specified in the query language syntax with each import statement
separated by a semicolon. The imports statement provides packages and classes
used in variable typing in the indexed and FROM expressions. | |
-| key-index | True or false. Whether the index should be a key index. If
true, the region key specified in the indexed expression is used to evaluate
queries
| |
-| type | Possible values are "hash" or "range".
| range |
-
-<span class="tablecap">Table 29. <index> Attributes</span>
+| key-index | True or false. Whether the index should be a key index. If
true, the region key specified in the indexed expression is used to evaluate
queries | |
+| type | Possible values are "hash" or "range". | range |
**Example:**
@@ -2988,6 +2898,7 @@ namespace also defines an `index` element (for OQL
indexes).
**API:** `org.apache.geode.cache.lucene` package
+**<lucene:index> Attributes**
| Attribute | Description
| Default |
|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|
| name | Required. Name of the Lucene index. | |
@@ -3024,8 +2935,9 @@ but is not required.
**API:** `org.apache.geode.cache.lucene` package
-| Attribute | Description
| Default |
-|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|
+**<lucene:field> Attributes**
+| Attribute | Description | Default |
+|-------------|-------------|---------|
| name | Required. A string that defines the name of the field. If a
single field is defined by the value `"__REGION_VALUE_FIELD"`, then the entire
value is used as a single field. | |
| analyzer | A string that provides the path to the analyzer to use for
this field. A value of `"null"` uses the default analyzer. | `"null"` |
@@ -3198,10 +3110,9 @@ A memory monitor that tracks cache size as a percentage
of total heap or off-hea
**API:** `org.apache.geode.cache.control.ResourceManager`
-<a id="resource-manager__table_1132A19E9DC54A67B8C7A625338E346D"></a>
+**<resource-manager> Attributes**
<table>
-<caption><span class="tablecap">Table 30. <resource-manager> Attributes
</span></caption>
<colgroup>
<col width="20%" />
<col width="60%" />
@@ -3223,13 +3134,15 @@ A memory monitor that tracks cache size as a percentage
of total heap or off-hea
</tr>
<tr class="even">
<td>eviction-heap-percentage</td>
-<td><p>Set the percentage of heap at or above which the eviction should begin
on Regions configured for HeapLRU eviction.</p>
-<p>Changing this value may cause eviction to begin immediately.</p></td>
-<td><ul>
-<li>0, If no region is configured with heap eviction</li>
+<td><p>Set the percentage of heap at or above which the eviction should begin
on regions configured for HeapLRU eviction.</p>
+<p>Changing this value may cause eviction to begin immediately.</p>
+<ul>
+<li>The default is 0, if no region is configured with heap eviction</li>
<li>If <code class="ph codeph">critical-heap-percentage</code> is set to a
non-zero value, 5% less than that value.</li>
<li>80%, if <code class="ph codeph">critical-heap-percentage</code> is not
configured.</li>
-</ul></td>
+</ul>
+</td>
+<td>0</td>
</tr>
<tr class="odd">
<td>critical-off-heap-percentage</td>
@@ -3238,18 +3151,18 @@ A memory monitor that tracks cache size as a percentage
of total heap or off-hea
</tr>
<tr class="even">
<td>eviction-off-heap-percentage</td>
-<td>Set the percentage of off-heap memory at or above which the eviction
should begin on Regions configured for HeapLRU eviction.</td>
-<td><ul>
-<li>0, If no region is configured with heap eviction</li>
+<td>Set the percentage of off-heap memory at or above which the eviction
should begin on Regions configured for HeapLRU eviction.
+<ul>
+<li>The default is 0, if no region is configured with heap eviction</li>
<li>If <code class="ph codeph">critical-off-heap-percentage</code> is set to a
non-zero value, 5% less than that value.</li>
<li>80%, if <code class="ph codeph">critical-off-heap-percentage</code> is not
configured.</li>
-</ul></td>
+</ul>
+</td>
+<td>0</td>
</tr>
</tbody>
</table>
-<span class="tablecap">Table 30. <resource-manager> Attributes </span>
-
**Example:**
``` pre
@@ -3294,13 +3207,12 @@ Specify the Java class and its initialization
parameters with the `<class-name>`
You can also directly specify `<instantiator>` as a sub-element of `<cache>`.
Use the `org.apache.geode.Instantiator` API to register a `DataSerializable`
implementation as the serialization framework for the cache. The following
table lists the attribute that can be specified for an `<instantiator>`.
-<a id="instantiator__table_AEEBB1AB95174276B95861A55C07FBB1"></a>
+**<instantiator> Attributes**
| Attribute | Description
| Default |
|-----------|---------------------------------------------------------------------------------------|---------|
| id | Required. ID that the Instantiator should associate with the
`DataSerializable` type. | |
-<span class="tablecap">Table 31. <instantiator> Attributes</span>
## <a id="backup" class="no-quick-link"></a><backup>
--
To stop receiving notification emails like this one, please contact
dbar...@apache.org.
