http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/84cfbdfc/geode-docs/reference/topics/cache_xml.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/reference/topics/cache_xml.html.md.erb b/geode-docs/reference/topics/cache_xml.html.md.erb deleted file mode 100644 index 8d3187b..0000000 --- a/geode-docs/reference/topics/cache_xml.html.md.erb +++ /dev/null @@ -1,3107 +0,0 @@ ---- -title: "<cache> Element Reference" ---- - -<!-- -Licensed to the Apache Software Foundation (ASF) under one or more -contributor license agreements. See the NOTICE file distributed with -this work for additional information regarding copyright ownership. -The ASF licenses this file to You under the Apache License, Version 2.0 -(the "License"); you may not use this file except in compliance with -the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. ---> -<a id="cache_xml_cache"></a> - - -This section documents the `cache.xml` sub-elements used for Geode server configuration. All elements are sub-elements of the `<cache>` element. - -For Geode client configuration, see [<client-cache> Element Reference](client-cache.html#cc-client-cache). - -**API**:`org.apache.geode.cache.CacheFactory` - -<a id="cache_xml_cache__table_B079C5A320194B3A98AD82DDB67DA43D"></a> - -<table> -<caption><span class="tablecap">Table 1. <cache> Element Attributes</span></caption> -<colgroup> -<col width="30%" /> -<col width="50%" /> -<col width="20%" /> -</colgroup> -<thead> -<tr class="header"> -<th>Attribute</th> -<th>Description</th> -<th>Default</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td>copy-on-read</td> -<td><p>Boolean indicating whether entry value retrieval methods return direct references to the entry value objects in the cache (false) or copies of the objects (true).</p></td> -<td>False</td> -</tr> -<tr class="even"> -<td>is-server</td> -<td><p>Boolean indicating whether this member is a cache server.</p></td> -<td>False</td> -</tr> -<tr class="odd"> -<td>lock-timeout</td> -<td><p>The timeout, in seconds, for implicit object lock requests. This setting affects automatic locking only, and does not apply to manual locking. If a lock request does not return before the specified timeout period, it is cancelled and returns with a failure.</p></td> -<td>60</td> -</tr> -<tr class="even"> -<td>lock-lease</td> -<td><p>The timeout, in seconds, for implicit and explicit object lock leases. This affects both automatic locking and manual locking. Once a lock is obtained, it can remain in force for the lock lease time period before being automatically cleared by the system.</p></td> -<td>120</td> -</tr> -<tr class="odd"> -<td>message-sync-interval</td> -<td><p>Used for client subscription queue synchronization when this member acts as a server to clients and server redundancy is used. Sets the frequency (in seconds) at which the primary server sends messages to its secondary servers to remove queued events that have already been processed by the clients.</p></td> -<td>1</td> -</tr> -<tr class="even"> -<td>search-timeout</td> -<td><p>How many seconds a <code class="ph codeph">netSearch</code> operation can wait for data before timing out. You may want to change this based on your knowledge of the network load or other factors.</p></td> -<td>300</td> -</tr> -</tbody> -</table> - -<span class="tablecap">Table 1. <cache> Element Attributes</span> - -**Example:** - -``` pre -<cache> - <cache-server port="40404" /> - <region name="root"> - <region-attributes refid="REPLICATE"/> - <region name="cs_region" refid="REPLICATE"> - <region-attributes> - <cache-loader> - <class-name>cacheRunner.StringLoader</class-name> - </cache-loader> - <cache-listener> - <class-name>cacheRunner.LoggingCacheListener</class-name> - </cache-listener> - </region-attributes> - </region> - </region> -</cache> -``` - -## <a id="cache-transaction-manager" class="no-quick-link"></a><cache-transaction-manager> - -Specifies a transaction listener. - -**API:** `CacheTransactionManager` - -**Example:** - -``` pre -<cache search-timeout="60"> - <cache-transaction-manager> - <transaction-listener> - <class-name>com.company.data.MyTransactionListener</class-name> - <parameter name="URL"> - <string>jdbc:cloudscape:rmi:MyData</string> - </parameter> - </transaction-listener> - <transaction-listener>... </transaction-listener> - <transaction-writer> - <class-name>com.company.data.MyTransactionWriter</class-name> - <parameter name="URL"> - <string>jdbc:cloudscape:rmi:MyData</string> - </parameter> - <parameter> - </transaction-writer> - </cache-transaction-manager> .. . -</cache> -``` - -## <a id="transaction-listener" class="no-quick-link"></a><transaction-listener> - -When a transaction ends, its thread calls the TransactionListener to perform the appropriate follow-up for successful commits, failed commits, or voluntary rollbacks. - -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="transaction-writer" class="no-quick-link"></a><transaction-writer> - -When you commit a transaction, a TransactionWriter can perform additional tasks, including aborting the transaction. - -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="dynamic-region-factory" class="no-quick-link"></a><dynamic-region-factory> - -The `<dynamic-region-factory>` element configures a dynamic region factory for this cache. You can use this element to dynamically create regions in your application code. Use the <span class="keyword apiname">createDynamicRegion()</span> method of the <span class="keyword apiname">org.apache.geode.cache.DynamicRegionFactory</span> class in your Java code to dynamically create regions. - -**Note:** -You can not use this element to dynamically create *partitioned* regions. - -We recommend that you use functions to dynamically create regions. See [Creating Regions Dynamically](../../developing/region_options/dynamic_region_creation.html). - -The optional `<disk-dir>` sub-element specifies the directory to store the persistent files that are used for dynamic region bookkeeping. It defaults to the current directory. - -Set the `pool-name` attribute to set the name of the connection pool used by client applications in a client/server cache configuration. Do not specify the `pool-name` attribute in servers or peers. - -**API:** `org.apache.geode.cache.DynamicRegionFactory` - -<a id="dynamic-region-factory__table_6B7271DE968946CC9757FE241E9F872C"></a> - -| Attribute | Description | Default | -|---------------------------|--------------------------------------------------------------------------------------------------------------------------------|---------| -| disable-persist-backup | When set to false, the factory is persisted on disk. | false | -| 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 -<dynamic-region-factory - pool-name=myPool> - <disk-dir>/home/gemfire/myDiskdir</disk-dir> -</dynamic-region-factory> -``` - -## <a id="id_utn_c3p_wk" class="no-quick-link"></a><disk-dir> - -Specifies a region or disk store's disk directory. - -<a id="id_utn_c3p_wk__table_877FDB097F454F33AE90FB16FAD212AE"></a> - -<table> -<caption><span class="tablecap">Table 3. <disk-dir> Attributes</span></caption> -<colgroup> -<col width="33%" /> -<col width="33%" /> -<col width="33%" /> -</colgroup> -<thead> -<tr class="header"> -<th>Attribute</th> -<th>Description</th> -<th>Default</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td>dir-size</td> -<td>Maximum amount of space to use for the disk store, in megabytes.</td> -<td>214748364 -<p>(2 petabytes)</p></td> -</tr> -</tbody> -</table> - -<span class="tablecap">Table 3. <disk-dir> Attributes</span> - -**Example:** - -``` pre -<disk-dir - dir-size="20480">/host3/users/gf/memberA_DStore</disk-dir> -``` - -## <a id="async-event-queue" class="no-quick-link"></a><async-event-queue> - -Configures a queue for sending region events to an AsyncEventListener implementation (for example, for write-behind event handling). - -**API:** `org.apache.geode.cache.asyncqueue.AsyncEventQueue` - -<a id="async-event-queue__table_5CEA4FE481D741E4913C098B67735714"></a> - -<table> -<caption><span class="tablecap">Table 4. <async-event-queue> Attributes</span></caption> -<colgroup> -<col width="30%" /> -<col width="50%" /> -<col width="20%" /> -</colgroup> -<thead> -<tr class="header"> -<th>Attribute</th> -<th>Description</th> -<th>Default</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td>id</td> -<td>Unique identifier for the queue. This attribute is required.</td> -<td>null</td> -</tr> -<tr class="even"> -<td>parallel</td> -<td>Value of "true" or "false" that specifies the type of queue that Geode creates.</td> -<td>false</td> -</tr> -<tr class="odd"> -<td>batch-size</td> -<td>Maximum number of messages that a batch can contain.</td> -<td>100</td> -</tr> -<tr class="even"> -<td>batch-time-interval</td> -<td>Maximum number of milliseconds that can elapse between sending batches.</td> -<td>5</td> -</tr> -<tr class="odd"> -<td>enable-batch-conflation</td> -<td>Boolean value that determines whether Geode should conflate messages.</td> -<td>false</td> -</tr> -<tr class="even"> -<td>disk-store-name</td> -<td>Named disk store to use for storing queue overflow, or for persisting the queue. If you specify a value, the named disk store must exist. If you specify a null value, Geode uses the default disk store for overflow and queue persistence.</td> -<td>null specifies the default disk store</td> -</tr> -<tr class="odd"> -<td>disk-synchronous</td> -<td>For regions that write to disk, boolean that specifies whether disk writes are done synchronously for the region.</td> -<td>true</td> -</tr> -<tr class="even"> -<td>dispatcher-threads</td> -<td>Number of dispatcher threads that are used to process region events from the queue.</td> -<td>5</td> -</tr> -<tr class="odd"> -<td>forward-expiration-destroy</td> -<td>When true, forwards expiration destroy operations to AsyncEventListener.</td> -<td>false</td> -</tr> -<tr class="even"> -<td>maximum-queue-memory</td> -<td>Maximum amount of memory in megabytes that the queue can consume before overflowing to disk.</td> -<td>100 mb</td> -</tr> -<tr class="odd"> -<td>order-policy</td> -<td>When the <code class="ph codeph">dispatcher-threads</code> attribute is greater than 1, <code class="ph codeph">order-policy</code> configures the way in which multiple dispatcher threads process region events from the queue. This attribute can have one of the following values: -<ul> -<li><strong>key</strong>. When distributing region events from the local queue, multiple dispatcher threads preserve the order of key updates.</li> -<li><strong>thread</strong>. When distributing region events from the local queue, multiple dispatcher threads preserve the order in which a given thread added region events to the queue.</li> -<li><strong>partition</strong>. This option is valid for parallel event queues. When distributing region events from the local queue, multiple dispatcher threads preserve the order in which region events were added to the local queue. For a partitioned region, this means that all region events delivered to a specific partition are delivered in the same order to the remote Geode site. For a distributed region, this means that all key updates delivered to the local queue are distributed to the remote site in the same order.</li> -</ul></td> -<td>key</td> -</tr> -<tr class="even"> -<td>persistent</td> -<td>Boolean value that determines whether Geode persists this queue.</td> -<td>False</td> -</tr> -</tbody> -</table> - -<span class="tablecap">Table 4. <async-event-queue> Attributes</span> - -**Example:** - -``` pre -<cache> - <async-event-queue - id="sampleQueue" - persistent="true" - disk-store-name="exampleStore" - parallel="false"> - <async-event-listener> - <class-name>MyAsyncEventListener</class-name> - <parameter name="url"> - <string>jdbc:db2:SAMPLE</string> - </parameter> - <parameter name="username"> - <string>gfeadmin</string> - </parameter> - <parameter name="password"> - <string>admin1</string> - </parameter> - </async-event-listener> - </async-event-queue> - ... -</cache> -``` - -## <a id="gateway-event-filter" class="no-quick-link"></a><gateway-event-filter> - -A GatewayEventFilter implementation determines whether a region event is placed in a gateway sender queue and/or whether an event in a gateway queue is distributed to a remote site. You can optionally add one or more GatewayEventFilter implementations to an async event queue, either in the cache.xml configuration file or using the Java API. - -Specify the Java class and its initialization parameters with the `<class-name>` and `<parameter>` sub-elements. See [<class-name> and <parameter>](#class-name_parameter). - -**Example:** - -``` pre -<gateway-event-filter> - <class-name>org.apache.geode.util.SampleEventFilter</class-name> - <parameter name="param1"> - <string>"value1"</string> - </parameter> -</gateway-event-filter> -``` - -## <a id="gateway-event-substitution-filter" class="no-quick-link"></a><gateway-event-substitution-filter> - -A GatewayEventSubstitutionFilter provides a way to specify a substitute value to be stored in the GatewayQueueEvent and enqueued in the RegionQueue. You can optionally add one GatewayEventSubstitutionFilter implementation to an async event queue. - -Specify the Java class and its initialization parameters with the `<class-name>` and `<parameter>` sub-elements. See [<class-name> and <parameter>](#class-name_parameter). - -**Example:** - -``` pre -<gateway-event-substitution-filter> - <class-name>org.apache.geode.util.SampleEventSubstitutionFilter</class-name> - <parameter name="param1"> - <string>"value1"</string> - </parameter> -</gateway-event-substitution-filter> -``` - -## <a id="async-event-listener" class="no-quick-link"></a><async-event-listener> - -An AsyncEventListener receives callbacks for events that change region data. You can use an AsyncEventListener implementation as a write-behind cache event handler to synchronize region updates with a database. - -Specify the Java class and its initialization parameters with the `<class-name>` and `<parameter>` sub-elements. See [<class-name> and <parameter>](#class-name_parameter). - -**API:** `org.apache.geode.cache.asyncqueue.AsyncEventListener` - -**Example:** - -``` pre -... - <async-event-listener> - <class-name>MyAsyncEventListener</class-name> - <parameter name="url"> - <string>jdbc:db2:SAMPLE</string> - </parameter> - <parameter name="username"> - <string>gfeadmin</string> - </parameter> - <parameter name="password"> - <string>admin1</string> - </parameter> - </async-event-listener> -... -``` - -## <a id="cache-server" class="no-quick-link"></a><cache-server> - -Configures the cache to serve region data to clients in a client/server caching system. This element indicates the port the server listens on for client communication. - -The `cacheserver` process uses only `cache.xml` configuration. For application servers, you can set the same configuration properties using the `org.apache.geode.cache.server.CacheServer` and `org.apache.geode.cache.Cache` interfaces. For detailed information, see the online Java API documentation. - -**API:** `org.apache.geode.cache.server.CacheServer` - -<a id="cache-server__table_78A30804A5394C2AA190579C8A1E22D8"></a> - -<table> -<caption><span class="tablecap">Table 5. <cache-server> Attributes</span></caption> -<colgroup> -<col width="30%" /> -<col width="50%" /> -<col width="20%" /> -</colgroup> -<thead> -<tr class="header"> -<th>Attribute</th> -<th>Description</th> -<th>Default Value</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td>bind-address</td> -<td>Hostname or IP address that the server is to listen on for client connections. If null, the server listens on the machineâs default address.</td> -<td>null</td> -</tr> -<tr class="even"> -<td>hostname-for-clients</td> -<td>Hostname or IP address to pass to the client as the location where the server is listening. When the server connects to the locator it tells the locator the host and port where it is listening for client connections. If the host the server uses by default is one that the client canât translate into an IP address, the client will have no route to the serverâs host and wonât be able to find the server. For this situation, you must supply the serverâs alternate hostname for the locator to pass to the client. If null, the serverâs <code class="ph codeph">bind-address</code> setting is used.</td> -<td>null</td> -</tr> -<tr class="odd"> -<td>load-poll-interval</td> -<td>Frequency, in milliseconds, to poll the load probe for load information on the server.</td> -<td>5000 -<p>(5 seconds)</p></td> -</tr> -<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"> -<b>Note:</b> -<p>Set this at least as high as max-threads.</p> -</div></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"> -<b>Note:</b> -<p>Set this no higher than max-connections.</p> -</div></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"> -<b>Note:</b> -<p>Used only if <code class="ph codeph">client-subscription</code> is not configured.</p> -</div></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"> -<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> -<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"> -<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> -<td>180 -<p>(3 minutes)</p></td> -</tr> -<tr class="odd"> -<td>port</td> -<td>Port that the server listens on for client communication.</td> -<td>40404</td> -</tr> -<tr class="even"> -<td>socket-buffer-size</td> -<td>Size for socket buffers used for server-to-client communication.</td> -<td>32768</td> -</tr> -<tr class="odd"> -<td>tcp-no-delay</td> -<td>When set to true, enables TCP_NODELAY for Geode server connections to clients.</td> -<td>false</td> -</tr> -</tbody> -</table> - -<span class="tablecap">Table 5. <cache-server> Attributes</span> - -**Example:** - -``` pre -<cache> - <cache-server - port="40404" - /> - ... -</cache> -``` - -## <a id="group" class="no-quick-link"></a><group> - -Deprecated as of GemFire 7.0. Specify server groups in the gemfire.properties file. See [Organizing Servers Into Logical Member Groups](../../topologies_and_comm/cs_configuration/configure_servers_into_logical_groups.html). - -## <a id="client-subscription" class="no-quick-link"></a><client-subscription> - -Overflow specification for client subscription queues. Sets a capacity limit on the in-memory queue and specifies where to overflow when capacity is reached. By default no overflow is used. Specified in three parts: - -**Default:** no overflow - -**API:** - -<a id="client-subscription__table_7A3AC0C448185019B1382600182"></a> - -| Attribute | Description | Default | -|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| -| eviction-policy | How the capacity is calculated. The options are mem for memory use, entry for message count, and null for no overflow. | null | -| 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 | -| overflow-directory | DEPRECATED as of GemFire version 6.5. See the `disk-store-name` attribute of the element [<region-attributes>](cache_xml.html#region-attributes). | Â | - -<span class="tablecap">Table 6. <client-subscription> Attributes</span> - -**Example:** - -``` pre -<cache-server port=4444> -</cache> -``` - -## <a id="custom-load-probe" class="no-quick-link"></a><custom-load-probe> - -Application plug-in used to provide current and predicted server load information to the server locators. - -Specify the Java class and its initialization parameters with the `<class-name>` and `<parameter>` sub-elements. See [<class-name> and <parameter>](#class-name_parameter). - -**Default:** If this is not defined, the default Geode load probe is used. - -**API:** `org.apache.geode.cache.server.setLoadProbe` - -**Example:** - -``` pre -<custom-load-probe> - <class-name> - myPackage.MyLoadProbe - </class-name> - </custom-load-probe> -``` - -## <a id="pool" class="no-quick-link"></a><pool> - -Use for client caches. Defines a client's server pool used to communicate with servers running in a different distributed system. - -**API:** `org.apache.geode.cache.client.PoolFactory` - -<a id="pool__table_14D991AC65A6414BB71EF7AC67B59771"></a> - -<table> -<caption><span class="tablecap">Table 7. <pool> Attributes</span></caption> -<colgroup> -<col width="30%" /> -<col width="50%" /> -<col width="20%" /> -</colgroup> -<thead> -<tr class="header"> -<th>Attribute</th> -<th>Description</th> -<th>Default</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td>free-connection-timeout</td> -<td>Amount of time a thread will wait to get a pool connection before timing out with an exception. This timeout keeps threads from waiting indefinitely when the poolâs <code class="ph codeph">max-connections</code> has been reached and all connections in the pool are in use by other threads.</td> -<td>10000</td> -</tr> -<tr class="even"> -<td>idle-timeout</td> -<td>Maximum time, in milliseconds, a pool connection can stay open without being used when there are more than <code class="ph codeph">min-connections</code> in the pool. Pings over the connection do not count as connection use. If set to -1, there is no idle timeout.</td> -<td>5000</td> -</tr> -<tr class="odd"> -<td>load-conditioning-interval</td> -<td>Amount of time, in milliseconds, a pool connection can remain open before being eligible for silent replacement to a less-loaded server.</td> -<td>300000 -<p>(5 minutes)</p></td> -</tr> -<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"> -<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> -<td>-1</td> -</tr> -<tr class="odd"> -<td>min-connections</td> -<td>Minimum number of pool connections to keep available at all times. Used to establish the initial connection pool. If set to 0 (zero), no connection is created until an operation requires it. This number is the starting point, with more connections added later as needed, up to the <code class="ph codeph">max-connection</code> setting. The setting must be an integer greater than or equal to 0.</td> -<td>1</td> -</tr> -<tr class="even"> -<td>multiuser-authentication</td> -<td>Used for installations with security where you want to accommodate multiple users within a single client. If set to true, the pool provides authorization for multiple user instances in the same client application, and each user accesses the cache through its own <code class="ph codeph">RegionService</code> instance. If false, the client either uses no authorization or just provides credentials for the single client process.</td> -<td>false</td> -</tr> -<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"> -<b>Note:</b> -<p>This is a required property with no default setting.</p> -</div></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"> -<b>Note:</b> -<p>Set this lower than the serverâs <code class="ph codeph">maximum-time-between-pings</code>.</p> -</div></td> -<td>10000</td> -</tr> -<tr class="odd"> -<td>pr-single-hop-enabled</td> -<td>Setting used to improve access to partitioned region data in the servers. Indicates whether to use metadata about the partitioned region data storage locations to decide where to send some data requests. This allows a client to send a data operation directly to the server hosting the key. Without this, the client contacts any available server and that server contacts the data store. This is used only for operations that can be carried out on a server-by-server basis, like put, get, and destroy.</td> -<td>true</td> -</tr> -<tr class="even"> -<td>read-timeout</td> -<td>Maximum time, in milliseconds, for the client to wait for a response from a server.</td> -<td>10000</td> -</tr> -<tr class="odd"> -<td>retry-attempts</td> -<td>Number of times to retry a client request before giving up. If one server fails, the pool moves to the next, and so on until it is successful or it hits this limit. If the available servers are fewer than this setting, the pool will retry servers that have already failed until it reaches the limit. If this is set to -1, the pool tries every available server once.</td> -<td>-1</td> -</tr> -<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"> -<b>Note:</b> -<p>This is only used when the <code class="ph codeph">locator</code> list is defined.</p> -</div></td> -<td>null</td> -</tr> -<tr class="odd"> -<td>socket-buffer-size</td> -<td>Size for socket buffers from the client to the server. Default: 32768.</td> -<td>32768</td> -</tr> -<tr class="even"> -<td>statistic-interval</td> -<td>Interval, in milliseconds, at which to send client statistics to the server. If set to -1, statistics are not sent.</td> -<td>-1</td> -</tr> -<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"> -<b>Note:</b> -<p>Used only when <code class="ph codeph">subscription-redundancy</code> is not â0â (zero).</p> -</div></td> -<td>100</td> -</tr> -<tr class="even"> -<td>subscription-enabled</td> -<td>Boolean indicating whether the server should connect back to the client and automatically sends server-side cache update information. Any bind address information for the client is automatically passed to the server for use in the callbacks.</td> -<td>false</td> -</tr> -<tr class="odd"> -<td>subscription-message- -<p>tracking-timeout</p></td> -<td>Time-to-live, in milliseconds, for entries in the clientâs message tracking list.</td> -<td>900000 -<p>(15 minutes)</p></td> -</tr> -<tr class="even"> -<td>subscription-redundancy</td> -<td>Number of servers to use as backup to the primary for highly available subscription queue management. If set to 0, none are used. If set to -1, all available servers are used.</td> -<td>0</td> -</tr> -<tr class="odd"> -<td>thread-local-connections</td> -<td>Boolean specifying whether connections are sticky. True causes the connection to stick to the thread for multiple requests. False causes each connection to be returned to the pool after a request finishes. A sticky connection is returned to the pool when the thread releases it through the <code class="ph codeph">Pool</code> method <code class="ph codeph">releaseThreadLocalConnection</code>, when the <code class="ph codeph">idle-timeout</code> is reached, or when the pool is destroyed.</td> -<td>false</td> -</tr> -</tbody> -</table> - -<span class="tablecap">Table 7. <pool> Attributes</span> - -**Example:** - -``` pre -<pool - name="publisher" - subscription-enabled="true"> - <locator - host="myLocatorAddress1" - port="12345"/> - <locator - host="myLocatorAddress2" - port="45678"/> -</pool> -``` - -## <a id="locator" class="no-quick-link"></a><locator> - -Addresses and ports of the locators to connect to. You can define multiple locators for the pool. - -**Note:** -Provide a locator list or `server` list, but not both. - -**API:** `org.apache.geode.distributed.LocatorLauncher` - -<a id="locator__table_10BEB4E1383B475795ED4E290676E058"></a> - -| Attribute | Description | Default | -|-----------|----------------------------|---------| -| host | Hostname of the locator | Â | -| port | Port number of the locator | Â | - -<span class="tablecap">Table 8. <locator> Attributes</span> - -**Example:** - -``` pre -<pool ...> -<locator - host="myLocatorHost" - port="12345"/> -``` - -## <a id="server" class="no-quick-link"></a><server> - -Addresses and ports of the servers to connect to. - -**Note:** -Provide a server list or `locator` list, but not both. - -**Default:** - -**API:** `org.apache.geode.distributed.ServerLauncher` - -<a id="server__table_BD0B19AA44FF4CA68BBBC785E46E03F1"></a> - -| Attribute | Description | Default | -|-----------|---------------------------|---------| -| host | Hostname of the server | Â | -| port | Port number of the server | Â | - -<span class="tablecap">Table 9. <server> Attributes</span> - -**Example:** - -``` pre -<pool ...> - <server - host="myServerHost" - port="123456"/> -</pool> -``` - -## <a id="disk-store" class="no-quick-link"></a><disk-store> - -Defines a pool of one or more disk stores, which can be used by regions, and client subscription queues. - -**Default:** The cache default disk store, named "DEFAULT", is used when disk is used but no disk store is named. - -**API:** `org.apache.geode.cache.DiskStore` - -<a id="disk-store__table_C90DEC71FBD74C2F98E5447E961E899F"></a> - -<table> -<caption><span class="tablecap">Table 10. <disk-store> Attributes</span></caption> -<colgroup> -<col width="30%" /> -<col width="50%" /> -<col width="20%" /> -</colgroup> -<thead> -<tr class="header"> -<th>Attribute</th> -<th>Description</th> -<th>Default</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td>name</td> -<td>The name of the Disk Store.</td> -<td>Â </td> -</tr> -<tr class="even"> -<td>auto-compact</td> -<td>Set to true to automatically compact the disk files.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td>compaction-threshold</td> -<td>The threshold at which an oplog will become compactable. Until it reaches this threshold the oplog will not be compacted. -<p>The threshold is a percentage in the range 0 to 100.</p></td> -<td>Â </td> -</tr> -<tr class="even"> -<td>allow-force-compaction</td> -<td>Set to true to allow disk compaction to be forced on this disk store.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td>max-oplog-size</td> -<td>The maximum size, in megabytes, of an oplog (operation log) file.</td> -<td>Â </td> -</tr> -<tr class="even"> -<td>time-interval</td> -<td>The number of milliseconds that can elapse before unwritten data is written to disk.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td>write-buffer-size</td> -<td>The size of the write buffer that this disk store uses when writing data to disk. Larger values may increase performance but use more memory. The disk store allocates one direct memory buffer of this size.</td> -<td>Â </td> -</tr> -<tr class="even"> -<td>queue-size</td> -<td>Maximum number of operations that can be asynchronously queued to be written to disk.</td> -<td>Â </td> -</tr> -<tr class="odd"> -<td>disk-usage-warning-percentage</td> -<td>Disk usage above this threshold generates a warning message. For example, if the threshold is set to 90%, then on a 1 TB drive falling under 100 GB of free disk space generates the warning. -<p>Set to "0" (zero) to disable.</p></td> -<td>90</td> -</tr> -<tr class="even"> -<td>disk-usage-critical-percentage</td> -<td>Disk usage above this threshold generates an error message and shuts down the member's cache. For example, if the threshold is set to 99%, then falling under 10 GB of free disk space on a 1 TB drive generates the error and shuts down the cache. -<p>Set to "0" (zero) to disable.</p></td> -<td>99</td> -</tr> -</tbody> -</table> - -<span class="tablecap">Table 10. <disk-store> Attributes</span> - -**Example:** - -``` pre -<disk-store - name="DEFAULT" - allow-force-compaction="true"> - <disk-dirs> - <disk-dir>/export/thor/customerData</disk-dir> - <disk-dir>/export/odin/customerData</disk-dir> - <disk-dir>/export/embla/customerData</disk-dir> - </disk-dirs> -</disk-store> -``` - -## <a id="disk-dirs" class="no-quick-link"></a><disk-dirs> - -An element of a disk store that defines a set of `<disk-dir>` elements. - -## <a id="disk-dir" class="no-quick-link"></a><disk-dir> - -Specifies a region or disk store's disk directory. - -<a id="disk-dir__table_877FDB097F454F33AE90FB16FAD212AE"></a> - -<table> -<caption><span class="tablecap">Table 11. <disk-dir> Attributes</span></caption> -<colgroup> -<col width="30%" /> -<col width="50%" /> -<col width="20%" /> -</colgroup> -<thead> -<tr class="header"> -<th>Attribute</th> -<th>Description</th> -<th>Default</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td>dir-size</td> -<td>Maximum amount of space to use for the disk store, in megabytes.</td> -<td>214748364 -<p>(2 petabytes)</p></td> -</tr> -</tbody> -</table> - -<span class="tablecap">Table 11. <disk-dir> Attributes</span> - -**Example:** - -``` pre -<disk-dir - dir-size="20480">/host3/users/gf/memberA_DStore</disk-dir> -``` - -## <a id="pdx" class="no-quick-link"></a><pdx> - -Specifies the configuration for the Portable Data eXchange (PDX) method of serialization. - -**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> - -| Attribute | Description | Default | -|----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------| -| read-serialized | Set it to true if you want PDX deserialization to produce a PdxInstance instead of an instance of the domain class. | Â | -| ignore-unread-fields | Set it to true if you do not want unread PDX fields to be preserved during deserialization. You can use this option to save memory. Set to true only in members that are only reading data from the cache. | Â | -| 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 -<cache> - <pdx persistent="true" disk-store-name="myDiskStore"> - <pdx-serializer> - <class-name> - org.apache.geode.pdx.ReflectionBasedAutoSerializer - </class-name> - <parameter name="classes"> - <string>com.company.domain.DomainObject</string>> - </parameter> - </pdx-serializer> - </pdx> - ... -</cache> -``` - -## <a id="pdx-serializer_24898989679" class="no-quick-link"></a><pdx-serializer> - -Allows you to configure the PdxSerializer for this Geode member. - -Specify the Java class and its initialization parameters with the `<class-name>` and `<parameter>` sub-elements. See [<class-name> and <parameter>](#class-name_parameter). - -**Default:** - -**API:** `org.apache.geode.cache.CacheFactory.setPdxSerializer` - -**Example:** - -``` pre -<cache> - <pdx> - <pdx-serializer> - <class-name>com.company.ExamplePdxSerializer</class-name> - </pdx-serializer> - </pdx> - ... -</cache> -``` - -## <a id="region-attributes" class="no-quick-link"></a><region-attributes> - -Specifies a region attributes template that can be named (by `id`) and referenced (by `refid`) later in the `cache.xml` and through the API. - -**API:** `org.apache.geode.cache.RegionFactory` or `org.apache.geode.cache.ClientRegionFactory` - -<a id="region-attributes__table_028B4DC4FB72488AB6359AAA13E0B5B0"></a> - -<table> -<caption><span class="tablecap">Table 13. <region-attributes> Attributes</span></caption> -<colgroup> -<col width="20%" /> -<col width="60%" /> -<col width="20%" /> -</colgroup> -<thead> -<tr class="header"> -<th>Attribute</th> -<th>Description</th> -<th>Default</th> -</tr> -</thead> -<tbody> -<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 Geode 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"> -<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> -<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 - concurrency-level="10"> -</region-attributes></code></pre></td> -<td>16 (threads)</td> -</tr> -<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"> -<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 delivery to and from the local cache without the memory overhead of data storage.</p> -</div> -<p>You can specify the following data policies:</p> -<div class="p"> -<table> -<tbody> -<tr class="odd"> -<td>empty</td> -<td>No data storage in the local cache. The region always appears empty. Use this for event delivery to and from the local cache without the memory overhead of data storage - zero-footprint producers that only distribute data to others and zero-footprint consumers that only see events. To receive events with this, set the region's <code class="ph codeph">subscription-attributes</code> <code class="ph codeph">interest-policy</code> to all.</td> -</tr> -<tr class="even"> -<td>normal</td> -<td>Data used locally (accessed with <code class="ph codeph">get</code>, stored with <code class="ph codeph">put</code>, etc.) is stored in the local cache. This policy allows the contents in the cache to differ from other caches.</td> -</tr> -<tr class="odd"> -<td>partition</td> -<td>Data is partitioned across local and remote caches using the automatic data distribution behavior of partitioned regions. Additional configuration is done in the <code class="ph codeph">partition-attributes</code>.</td> -</tr> -<tr class="even"> -<td>replicate</td> -<td>The region is initialized with the data from other caches. After initialization, all events for the distributed region are automatically copied into the local region, maintaining a replica of the entire distributed region in the local cache. Operations that would cause the contents to differ with other caches are not allowed. This is compatible with local <code class="ph codeph">scope</code>, behaving the same as for normal.</td> -</tr> -<tr class="odd"> -<td>persistent-partition</td> -<td>Behaves the same as <code class="ph codeph">partition</code> and also persists data to disk.</td> -</tr> -<tr class="even"> -<td>persistent-replicate</td> -<td>Behaves the same as <code class="ph codeph">replicate</code> and also persists data to disk.</td> -</tr> -<tr class="odd"> -<td>preloaded</td> -<td>Initializes like a replicated region, then, once initialized, behaves like a normal region.</td> -</tr> -</tbody> -</table> -<strong>API:</strong> <code class="ph codeph">setDataPolicy</code> -</div> -<p><strong>Example</strong>:</p> -<pre class="pre codeblock language-xml"><code><region-attributes - data-policy="replicate"> -</region-attributes></code></pre> -<p>This is similar to using a region shortcut with<code class="ph codeph">refid</code>, however when you use the REPLICATE region shortcut, it automatically sets the region's scope to <code class="ph codeph">distributed-ack</code>.</p> -<pre class="pre codeblock language-xml"><code><region-attributes - refid="REPLICATE"> -</region-attributes></code></pre> -<p>If you use <code class="ph codeph">data-policy</code>, you must set the scope explicitly.</p></td> -<td>normal</td> -</tr> -<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. This attribute does not apply to client/server communication or to communication using the UDP unicast or IP multicast protocols.</p> -<div class="note note"> -<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> -<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 - enable-async-conflation="false"> -</region-attributes></code></pre></td> -<td>true</td> -</tr> -<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"> -<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 - enable-subscription-conflation="true"> - </region-attributes></code></pre></td> -<td>false</td> -</tr> -<tr class="even"> -<td>gateway-sender-ids</td> -<td><p>Specifies one or more gateway sender IDs to use for distributing region events to remote Geode sites. Specify multiple IDs as a comma-separated list.</p> -<p><strong>API:</strong> <code class="ph codeph">addGatewaySenderId</code></p> -<p><strong>Example:</strong></p> -<pre class="pre codeblock language-xml"><code><region-attributes - gateway-sender-ids="nwsender,swsender"> -</region-attributes></code></pre></td> -<td>not set</td> -</tr> -<tr class="odd"> -<td>async-event-queue-ids</td> -<td>Specifies one or more asynchronous event queues to use for distributing region events an <code class="ph codeph">AsyncEventListener</code> implementation (for example, for write-behind cache event handling). Specify multiple IDs as a comma-separated list. -<p><strong>API</strong>: <code class="ph codeph">addAsyncEventQueueId</code></p> -<strong>Example</strong>: -<pre class="pre codeblock language-xml"><code><region-attributes - async-event-queue-ids="customerqueue,ordersqueue"> -</region-attributes></code></pre></td> -<td>not set</td> -</tr> -<tr class="even"> -<td>hub-id</td> -<td><p>If the <code class="ph codeph">enable-gateway</code> attribute is set to true, a comma-separated list of gateway hub IDs that receive events from the region.</p> -<p>Used only with GemFire version 6.x gateway configurations. For GemFire 7.0 configuration, see the <code class="ph codeph">gateway-sender-id</code> attribute of the <code class="ph codeph"><region-attributes></code> element.</p></td> -<td>null</td> -</tr> -<tr class="odd"> -<td>id</td> -<td><p>Stores the region attribute settings in the cache with this identifier. Once stored, the attributes can be retrieved using the region attribute <code class="ph codeph">refid</code>.</p> -<p><strong>API:</strong> <code class="ph codeph">setId</code></p> -<p><strong>Example:</strong></p> -<pre class="pre codeblock language-xml"><code><region-attributes - id="persistent-replicated"> -</region-attributes></code></pre></td> -<td>not set</td> -</tr> -<tr class="even"> -<td>ignore-jta</td> -<td><p>Boolean that determines whether operations on this region participate in active JTA transactions or ignore them and operate outside of the transactions. This is primarily used in cache loaders, writers, and listeners that need to perform non-transactional operations on a region, such as caching a result set.</p> -<p><strong>API:</strong> <code class="ph codeph">setIgnoreJTA</code></p> -<p><strong>Example:</strong></p> -<pre class="pre codeblock language-xml"><code><region-attributes - ignore-jta="true"> -</region-attributes></code></pre></td> -<td>false</td> -</tr> -<tr class="odd"> -<td>index-update-type</td> -<td><p>Specifies whether region indexes are maintained synchronously with region modifications, or asynchronously in a background thread. In the <code class="ph codeph">cache.xml</code> file, this is set as a value, asynchronous or synchronous, assigned to the <code class="ph codeph">index-update-type</code> region attribute. Set this through the API by passing a boolean to the <code class="ph codeph">setIndexMaintenanceSynchronous</code> method.</p> -<p><strong>API:</strong> <code class="ph codeph">setIndexMaintenanceSynchronous</code></p> -<p><strong>Example:</strong></p> -<pre class="pre codeblock language-xml"><code><region-attributes - index-update-type="asynchronous"> -</region-attributes></code></pre></td> -<td>synchronous updates</td> -</tr> -<tr class="even"> -<td>initial-capacity</td> -<td><p>Together with the <code class="ph codeph">load-factor</code> region attribute, sets the initial parameters on the underlying <code class="ph codeph">java.util.ConcurrentHashMap</code> used for storing region entries.</p> -<p><strong>API:</strong> <code class="ph codeph">setInitialCapacity</code></p> -<p><strong>Example:</strong></p> -<pre class="pre codeblock language-xml"><code><region-attributes - initial-capacity="20"> -</region-attributes></code></pre></td> -<td>16</td> -</tr> -<tr class="odd"> -<td>is-lock-grantor</td> -<td><p>Determines whether this member defines itself as the lock grantor for the region at region creation time. This only specifies whether the member becomes lock grantor at creation and does not reflect the current state of the memberâs lock grantor status. The memberâs lock grantor status may change if another member subsequently defines the region with <code class="ph codeph">is-lock-grantor</code> set to true. This attribute is only relevant for regions with <code class="ph codeph">global</code> <code class="ph codeph">scope</code>, as only they allow locking. It affects implicit and explicit locking.</p> -<p><strong>API:</strong> <code class="ph codeph">setLockGrantor</code></p> -<p><strong>Example:</strong></p> -<pre class="pre codeblock language-xml"><code><region-attributes - is-lock-grantor="true"> -</region-attributes></code></pre></td> -<td>false</td> -</tr> -<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"> -<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 - load-factor="0.85"> -</region-attributes></code></pre></td> -<td>.75</td> -</tr> -<tr class="odd"> -<td>mirror-type</td> -<td>Deprecated</td> -<td>Â </td> -</tr> -<tr class="even"> -<td>multicast-enabled</td> -<td><p>Boolean that specifies whether distributed operations on a region should use multicasting. To enable this, multicast must be enabled for the distributed system with the <code class="ph codeph">mcast-port</code> <code class="ph codeph">gemfire.properties</code> setting.</p> -<p><strong>API:</strong> <code class="ph codeph">setMulticastEnabled</code></p> -<p><strong>Example:</strong></p> -<pre class="pre codeblock language-xml"><code><region-attributes - multicast-enabled="true"> -</region-attributes></code></pre></td> -<td>false</td> -</tr> -<tr class="odd"> -<td>pool-name</td> -<td><p>Identifies the region as a client region and specifies the server pool the region is to use. The named pool must be defined in the client cache before the region is created. If this is not set, the region does not connect to the servers as a client region.</p> -<p><strong>API:</strong> <code class="ph codeph">setPoolName</code></p> -<p><strong>Examples:</strong></p> -<p>This declaration creates the region as a client region with a server pool named DatabasePool. This pool-name specification is required, as there are multiple pools in the client cache:</p> -<pre class="pre codeblock language-xml"><code><client-cache> - <pool name="DatabasePool" - subscription-enabled="true"> - ... - </pool> - <pool > - name="OtherPool" - subscription-enabled="true"> - ... - </pool> - <region ... - <region-attributes - pool-name="DatabasePool"> - </region-attributes> - ...</code></pre> -<p>This declaration creates the region as a client region assigned the single pool that is defined for the client cache. Here the pool-name specification is implied to be the only pool that exists in the cache:</p> -<pre class="pre codeblock language-xml"><code><client-cache> - <pool - name="publisher" - subscription-enabled="true"> - ... - </pool> - <region - name="myRegion" - refid="CACHING_PROXY"> - </region> -</client-cache></code></pre></td> -<td>not set</td> -</tr> -<tr class="even"> -<td>disk-store-name</td> -<td><p>Assigns the region to the disk store with this name from the disk stores defined for the cache. Persist region data to disk by defining the region as persistent using the Shortcut Attribute Options or data-policy settings. Overflow data to disk by implementing LRU eviction-attributes with an action of overflow to disk. Each disk store defines the file system directories to use, how data is written to disk, and other disk storage maintenance properties. In addition, the <code class="ph codeph">disk-synchronous</code> region attribute specifies whether writes are done synchronously or asynchronously.</p> -<p><strong>API:</strong> <code class="ph codeph">setDiskStoreName</code></p> -<p><strong>Example:</strong></p> -<pre class="pre codeblock language-xml"><code><region-attributes - disk-store-name="myStoreA" > -</region-attributes></code></pre></td> -<td>null</td> -</tr> -<tr class="odd"> -<td>disk-synchronous</td> -<td><p>For regions that write to disk, boolean that specifies whether disk writes are done synchronously for the region.</p> -<p><strong>API:</strong> <code class="ph codeph">setDiskSynchronous</code></p> -<p><strong>Example:</strong></p> -<pre class="pre codeblock language-xml"><code><region-attributes - disk-store-name="myStoreA" - disk-synchronous="true"> -</region-attributes></code></pre></td> -<td>true</td> -</tr> -<tr class="even"> -<td>refid</td> -<td><p>Retrieves region shortcuts and user-defined named region attributes for attributes initialization</p> -<p><strong>API:</strong> <code class="ph codeph">setRefId</code></p> -<p><strong>Example:</strong></p> -<pre class="pre codeblock language-xml"><code><region-attributes - refid="persistent-replicated"> - <!-- Override any stored - attribute settings that you - need to ... --> -</region-attributes></code></pre></td> -<td>not set</td> -</tr> -<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"> -<b>Note:</b> -<p>You can configure the most common of these options with Geodeâs region shortccuts in <code class="ph codeph">RegionShortcut</code> and <code class="ph codeph">ClientRegionShortcut</code>.</p> -</div> -<div class="note note"> -<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> -<tbody> -<tr class="odd"> -<td>local</td> -<td>No distribution. The region is visible only to threads running inside the member.</td> -</tr> -<tr class="even"> -<td>distributed-no-ack</td> -<td>Events are distributed to remote caches with no acknowledgement required.</td> -</tr> -<tr class="odd"> -<td>distributed-ack</td> -<td>Events are distributed to remote caches with receipt acknowledgement required. Region entry versions are used to provide consistent updates across members of the distributed system.</td> -</tr> -<tr class="even"> -<td>global</td> -<td>Events are distributed to remote caches with global locking to ensure distributed cache consistency.</td> -</tr> -</tbody> -</table> -<strong>API:</strong> <code class="ph codeph">setScope</code> -</div> -<p><strong>Example:</strong></p> -<pre class="pre codeblock language-xml"><code><region-attributes - scope="distributed-ack"> -</region-attributes></code></pre></td> -<td>distributed-no-ack</td> -</tr> -<tr class="even"> -<td>statistics-enabled</td> -<td>Boolean specifying whether to gather statistics on the region. Must be true to use expiration on the region. Geode provides a standard set of statistics for cached regions and region entries, which give you information for fine-tuning your distributed system. Unlike other Geode statistics, statistics for local and distributed regions are not archived and cannot be charted. They are kept in instances of <code class="ph codeph">org.apache.geode.cache.CacheStatistics</code> and made available through the region and its entries through the <code class="ph codeph">Region.getStatistics</code> and <code class="ph codeph">Region.Entry.getStatistics</code> methods. -<p><strong>API:</strong> <code class="ph codeph">setStatisticsEnabled</code></p> -<p><strong>Example:</strong></p> -<pre class="pre codeblock language-xml"><code><region-attributes - statistics-enabled="true"> -</region-attributes></code></pre></td> -<td>false</td> -</tr> -<tr class="odd"> -<td>cloning-enabled</td> -<td><p>Determines how <code class="ph codeph">fromDelta</code> applies deltas to the local cache for delta propagation. When true, the updates are applied to a clone of the value and then the clone is saved to the cache. When false, the value is modified in place in the cache.</p> -<p><strong>API:</strong> <code class="ph codeph">setCloningEnabled</code></p> -<p><strong>Example:</strong></p> -<pre class="pre codeblock language-xml"><code><region-attributes - cloning-enabled="true"> -</region-attributes></code></pre></td> -<td>false</td> -</tr> -<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"> -<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. Geode 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> -<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 - concurrency-checks-enabled="true"> -</region-attributes></code></pre></td> -<td>true</td> -</tr> -<tr class="odd"> -<td>off-heap</td> -<td><p>Specifies that the region uses off-heap memory to store entry values, including values for region entries and queue entries. The region will still use heap memory for everything else, such as entry keys and the ConcurrentHashMap.</p> -<p><strong>API:</strong> <code class="ph codeph">setOffHeap</code></p> -<p><strong>Example:</strong></p> -<pre class="pre codeblock language-xml"><code><region-attributes - off-heap="true"> -</region-attributes></code></pre></td> -<td>false</td> -</tr> -</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. - -**Note:** -Set the constraint in every cache where you create or update the region entries. For client/server installations, match constraints between client and server and between distributed systems. The constraint is only checked in the cache that does the entry `put` or `create` operation. To avoid deserializing the object, the constraint is not checked when the entry is distributed to other caches. - -**Default:** not set - -**API:** `org.apache.geode.cache.RegionFactory.setKeyConstraint` - -**Example:** - -``` pre -<region-attributes> - <key-constraint> - java.lang.String - </key-constraint> -</region-attributes> -``` - -## <a id="value-constraint" class="no-quick-link"></a><value-constraint> - -Defines the type of object to be allowed for the region entry values. This must be a fully-qualified class name. If value constraint isnât used, the regionâs value can be of any class. This attribute, along with `key-constraint`, is useful for querying and indexing because it provides object type information to the query engine. - -**Note:** -Set the constraint in every cache where you create or update the region entries. For client/server installations, match constraints between client and server and between distributed systems. The constraint is only checked in the cache that does the entry `put` or `create` operation. To avoid deserializing the object, the constraint is not checked when the entry is distributed to other caches. - -**Default:** not set - -**API:** `org.apache.geode.cache.RegionFactory.setValueConstraint` - -**Example:** - -``` pre -<region-attributes> - <value-constraint> - cacheRunner.Portfolio - </value-constraint> -</region-attributes> -``` - -## <a id="region-time-to-live" class="no-quick-link"></a><region-time-to-live> - -Expiration setting that specifies how long the region can remain in the cache without anyone accessing or updating it. - -**Default:** not set - no expiration of this type - -**API:** `org.apache.geode.cache.RegionFactory.setRegionTimeToLive` - -**Example:** - -``` pre -<region-attributes - statistics-enabled="true"> - <region-time-to-live> - <expiration-attributes - timeout="3600" - action="local-destroy"/> - </region-time-to-live> -</region-attributes> -``` - -## <a id="expiration-attributes" class="no-quick-link"></a><expiration-attributes> - -Within the `entry-time-to-live` or `entry-idle-time` element, this element specifies the expiration rules for removing old region entries that you are not using. You can destroy or invalidate entries, either locally or across the distributed system. Within the `region-time-to-live` or `region-idle-time` element, this element specifies the expiration rules for the entire region. - -**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> - -<table> -<caption><span class="tablecap">Table 14. <expiration-attributes> Attributes</span></caption> -<colgroup> -<col width="20%" /> -<col width="60%" /> -<col width="20%" /> -</colgroup> -<thead> -<tr class="header"> -<th>Attribute</th> -<th>Description</th> -<th>Default</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td>timeout</td> -<td>Number of seconds before a region or an entry expires. If timeout is not specified, it defaults to zero (which means no expiration).</td> -<td>0</td> -</tr> -<tr class="even"> -<td>action</td> -<td>Action that should take place when a region or an entry expires. -<div class="p"> -Select one of the following expiration actions: -<table> -<tbody> -<tr class="odd"> -<td><span class="keyword option">local-destroy</span></td> -<td>Removes the region or entry from the local cache, but does not distribute the removal operation to remote members. You cannot use this action on partitioned region entries.</td> -</tr> -<tr class="even"> -<td><span class="keyword option">destroy</span></td> -<td>Removes the region or entry completely from the cache. Destroy actions are distributed according to the region's distribution settings. Use this option when the region or entry is no longer needed for any application in the distributed system.</td> -</tr> -<tr class="odd"> -<td><span class="keyword option">invalidate</span></td> -<td>Default expiration action. Marks an entry or all entries in the region as invalid. Distributes the invalidation according to the region's scope. This is the proper choice when the region or the entry is no longer valid for any application in the distributed system.</td> -</tr> -<tr class="even"> -<td><span class="keyword option">local-invalidate</span></td> -<td>Marks an entry or all entries in the region as invalid but does not distribute the operation. You cannot use this action on partitioned region entries. Local region invalidation is only supported for regions that are not configured as replicated regions.</td> -</tr> -</tbody> -</table> -</div></td> -<td>invalidate</td> -</tr> -</tbody> -</table> - -<span class="tablecap">Table 14. <expiration-attributes> Attributes</span> - -**Example:** - -``` pre -<region-attributes - statistics-enabled="true"> - <region-time-to-live> - <expiration-attributes - timeout="60" - action="local-destroy"/> - </region-time-to-live> -</region-attributes> -``` - -## <a id="custom-expiry" class="no-quick-link"></a><custom-expiry> - -Specifies the custom class that implements `org.apache.geode.cache.CustomExpiry`. You define this class in order to override the region-wide settings for specific entries. See [Configure Data Expiration](../../developing/expiration/configuring_data_expiration.html) for an example. - -Specify the Java class and its initialization parameters with the `<class-name>` and `<parameter>` sub-elements. - -**API:** `org.apache.geode.cache.RegionFactory.setCustomEntryIdleTimeout`, `setCustomeEntryTimeToLive` - -**Example:** - -``` pre -<region-attributes> - <expiration-attributes - timeout="60" - action="local-destroy"> - <custom-expiry> - <class-name> - com.megaconglomerate.mypackage.MyClass - </class-name> - </custom-expiry> -</region-attributes> -``` - -Specify the Java class and its initialization parameters with the `<class-name>` and `<parameter>` sub-elements. - -## <a id="region-idle-time" class="no-quick-link"></a><region-idle-time> - -Expiration setting that specifies how long the region can remain in the cache without anyone accessing it. - -**Note:** -To ensure reliable read behavior across the partitioned region, use `region-time-to-live` for region expiration instead of this setting. - -**Default:** not set - no expiration of this type - -**API:** `org.apache.geode.cache.RegionFactory.setRegionIdleTimeout` - -**Example:** - -``` pre -<region-attributes statistics-enabled="true"> - <region-idle-time> - <expiration-attributes - timeout="3600" - action="local-destroy"/> - </region-idle-time> -</region-attributes> -``` - -## <a id="region-idle-time_expiration-attributes" class="no-quick-link"></a><expiration-attributes> - -Within the `entry-time-to-live` or `entry-idle-time` element, this element specifies the expiration rules for removing old region entries that you are not using. You can destroy or invalidate entries, either locally or across the distributed system. Within the `region-time-to-live` or `region-idle-time` element, this element specifies the expiration rules for the entire region. - -**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> - -<table> -<caption><span class="tablecap">Table 15. <expiration-attributes> Attributes</span></caption> -<colgroup> -<col width="20%" /> -<col width="60%" /> -<col width="20%" /> -</colgroup> -<thead> -<tr class="header"> -<th>Attribute</th> -<th>Description</th> -<th>Default</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td>timeout</td> -<td>Number of seconds before a region or an entry expires. If timeout is not specified, it defaults to zero (which means no expiration).</td> -<td>0</td> -</tr> -<tr class="even"> -<td>action</td> -<td>Action that should take place when a region or an entry expires. -<div class="p"> -Select one of the following expiration actions: -<table> -<tbody> -<tr class="odd"> -<td><span class="keyword option">local-destroy</span></td> -<td>Removes the region or entry from the local cache, but does not distribute the removal operation to remote members. You cannot use this action on partitioned region entries.</td> -</tr> -<tr class="even"> -<td><span class="keyword option">destroy</span></td> -<td>Removes the region or entry completely from the cache. Destroy actions are distributed according to the region's distribution settings. Use this option when the region or entry is no longer needed for any application in the distributed system.</td> -</tr> -<tr class="odd"> -<td><span class="keyword option">invalidate</span></td> -<td>Default expiration action. Marks an entry or all entries in the region as invalid. Distributes the invalidation according to the region's scope. This is the proper choice when the region or the entry is no longer valid for any application in the distributed system.</td> -</tr> -<tr class="even"> -<td><span class="keyword option">local-invalidate</span></td> -<td>Marks an entry or all entries in the region as invalid but does not distribute the operation. You cannot use this action on partitioned region entries. Local region invalidation is only supported for regions that are not configured as replicated regions.</td> -</tr> -</tbody> -</table> -</div></td> -<td>invalidate</td> -</tr> -</tbody> -</table> - -<span class="tablecap">Table 15. <expiration-attributes> Attributes</span> - -**Example:** - -``` pre -<region-attributes - statistics-enabled="true"> - <region-idle-time> - <expiration-attributes - timeout="60" - action="local-destroy"/> - </region-idle-time> -</region-attributes> -``` - -## <a id="region-idle-time_custom-expiry" class="no-quick-link"></a><custom-expiry> - -Specifies the custom class that implements `org.apache.geode.cache.CustomExpiry`. You define this class in order to override the region-wide settings for specific entries. See [Configure Data Expiration](../../developing/expiration/configuring_data_expiration.html) for an example. - -Specify the Java class and its initialization parameters with the `<class-name>` and `<parameter>` sub-elements. - -**API:** `org.apache.geode.cache.RegionFactory.setCustomEntryIdleTimeout`, `setCustomeEntryTimeToLive` - -**Example:** - -``` pre -<region-attributes> - <expiration-attributes - timeout="60" - action="local-destroy"> - <custom-expiry> - <class-name> - com.megaconglomerate.mypackage.MyClass - </class-name> - </custom-expiry> -</region-attributes> -``` - -Specify the Java class and its initialization parameters with the `<class-name>` and `<parameter>` sub-elements. - -## <a id="entry-time-to-live" class="no-quick-link"></a><entry-time-to-live> - -Expiration setting that specifies how long the regionâs entries can remain in the cache without anyone accessing or updating them. See [<expiration-attributes>](#expiration-attributes) for details. - -**Default:** not set - no expiration of this type. - -**API:** `org.apache.geode.cache.RegionFactory.setEntryTimeToLive` - -**Example:** - -``` pre -<region-attributes - statistics-enabled="true"> - <entry-time-to-live> - <expiration-attributes - timeout="60" - action="local-destroy"/> - </entry-time-to-live> -</region-attributes> -``` - -## <a id="entry-time-to-live_expiration-attributes" class="no-quick-link"></a><expiration-attributes> - -Within the `entry-time-to-live` or `entry-idle-time` element, this element specifies the expiration rules for removing old region entries that you are not using. You can destroy or invalidate entries, either locally or across the distributed system. Within the `region-time-to-live` or `region-idle-time` element, this element specifies the expiration rules for the entire region. - -**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> - -<table> -<caption><span class="tablecap">Table 16. <expiration-attributes> Attributes</span></caption> -<colgroup> -<col width="20%" /> -<col width="60%" /> -<col width="20%" /> -</colgroup> -<thead> -<tr class="header"> -<th>Attribute</th> -<th>Description</th> -<th>Default</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td>timeout</td> -<td>Number of seconds before a region or an entry expires. If timeout is not specified, it defaults to zero (which means no expiration).</td> -<td>0</td> -</tr> -<tr class="even"> -<td>action</td> -<td>Action that should take place when a region or an entry expires. -<div class="p"> -Select one of the following expiration actions: -<table> -<tbody> -<tr class="odd"> -<td><span class="keyword option">local-destroy</span></td> -<td>Removes the region or entry from the local cache, but does not distribute the removal operation to remote members. You cannot use this action on partitioned region entries.</td> -</tr> -<tr class="even"> -<td><span class="keyword option">destroy</span></td> -<td>Removes the region or entry completely from the cache. Destroy actions are distributed according to the region's distribution settings. Use this option when the region or entry is no longer needed for any application in the distributed system.</td> -</tr> -<tr class="odd"> -<td><span class="keyword option">invalidate</span></td> -<td>Default expiration action. Marks an entry or all entries in the region as invalid. Distributes the invalidation according to the region's scope. This is the proper choice when the region or the entry is no longer valid for any application in the distributed system.</td> -</tr> -<tr class="even"> -<td><span class="keyword option">local-invalidate</span></td> -<td>Marks an entry or all entries in the region as invalid but does not distribute the operation. You cannot use this action on partitioned region entries. Local region invalidation is only supported for regions that are not configured as replicated regions.</td> -</tr> -</tbody> -</table> -</div></td> -<td>invalidate</td> -</tr> -</tbody> -</table> - -<span class="tablecap">Table 16. <expiration-attributes> Attributes</span> - -**Example:** - -``` pre -<region-attributes - statistics-enabled="true"> - <entry-time-to-live> - <expiration-attributes - timeout="60" - action="local-destroy"/> - </entry-time-to-live> -</region-attributes> -``` - -## <a id="entry-time-to-live_custom_expiry" class="no-quick-link"></a><custom-expiry> - -Specifies the custom class that implements `org.apache.geode.cache.CustomExpiry`. You define this class in order to override the region-wide settings for specific entries. See [Configure Data Expiration](../../developing/expiration/configuring_data_expiration.html) for an example. - -Specify the Java class and its initialization parameters with the `<class-name>` and `<parameter>` sub-elements. - -**API:** `org.apache.geode.cache.RegionFactory.setCustomEntryIdleTimeout`, `setCustomeEntryTimeToLive` - -**Example:** - -``` pre -<region-attributes> - <expiration-attributes - timeout="60" - action="local-destroy"> - <custom-expiry> - <class-name> - com.megaconglomerate.mypackage.MyClass - </class-name> - </custom-expiry> -</region-attributes> -``` - -Specify the Java class and its initialization parameters with the `<class-name>` and `<parameter>` sub-elements. - -## <a id="entry-idle-time" class="no-quick-link"></a><entry-idle-time> - -Expiration setting that specifies how long the regionâs entries can remain in the cache without anyone accessing them. See [<expiration-attributes>](#expiration-attributes) for details. - -**Note:** -To ensure reliable read behavior across the partitioned region, use `entry-time-to-live` for entry expiration instead of this setting. - -**API:** `org.apache.geode.cache.RegionFactory.setEntryIdleTimeout` - -**Example:** - -``` pre -<region-attributes - statistics-enabled="true"> - <entry-idle-time> - <expiration-attributes - timeout="60" - action="local-invalidate"/> - </expiration-attributes> - </entry-idle-time> -</region-attributes> -``` - -## <a id="entry-idle-time_expiration-attributes" class="no-quick-link"></a><expiration-attributes> - -Within the `entry-time-to-live` or `entry-idle-time` element, this element specifies the expiration rules for removing old region entries that you are not using. You can destroy or invalidate entries, either locally or across the distributed system. Within the `region-time-to-live` or `region-idle-time` element, this element specifies the expiration rules for the entire region. - -**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> - -<table> -<caption><span class="tablecap">Table 17. <expiration-attributes> Attributes</span></caption> -<colgroup> -<col width="20%" /> -<col width="60%" /> -<col width="20%" /> -</colgroup> -<thead> -<tr class="header"> -<th>Attribute</th> -<th>Description</th> -<th>Default</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td>timeout</td> -<td>Number of seconds before a region or an entry expires. If timeout is not specified, it defaults to zero (which means no expiration).</td> -<td>0</td> -</tr> -<tr class="even"> -<td>action</td> -<td>Action that should take place when a region or an entry expires. -<div class="p"> -Select one of the following expiration actions: -<table> -<tbody> -<tr class="odd"> -<td><span class="keyword option">local-destroy</span></td> -<td>Removes the region or entry from the local cache, but does not distribute the removal operation to remote members. You cannot use this action on partitioned region entries.</td> -</tr> -<tr class="even"> -<td><span class="keyword option">destroy</span></td> -<td>Removes the region or entry completely from the cache. Destroy actions are distributed according to the region's distribution settings. Use this option when the region or entry is no longer needed for any application in the distributed system.</td> -</tr> -<tr class="odd"> -<td><span class="keyword option">invalidate</span></td> -<td>Default expiration action. Marks an entry or all entries in the region as invalid. Distributes the invalidation according to the region's scope. This is the proper choice when the region or the entry is no longer valid for any application in the distributed system.</td> -</tr> -<tr class="even"> -<td><span class="keyword option">local-invalidate</span></td> -<td>Marks an entry or all entries in the region as invalid but does not distribute the operation. You cannot use this action on partitioned region entries. Local region invalidation is only supported for regions that are not configured as replicated regions.</td> -</tr> -</tbody> -</table> -</div></td> -<td>invalidate</td> -</tr> -</tbody> -</table> - -<span class="tablecap">Table 17. <expiration-attributes> Attributes</span> - -**Example:** - -``` pre -<region-attributes - statistics-enabled="true"> - <entry-idle-time> - <expiration-attributes - timeout="60" - action="local-destroy"/> - </entry-idle-time> -</region-attributes> -``` - -## <a id="entry-idle-time_custom-expiry" class="no-quick-link"></a><custom-expiry> - -Specifies the custom class that implements `org.apache.geode.cache.CustomExpiry`. You define this class in order to override the region-wide settings for specific entries. See [Configure Data Expiration](../../developing/expiration/configuring_data_expiration.html) for an example. - -Specify the Java class and its initialization parameters with the `<class-name>` and `<parameter>` sub-elements. - -**API:** `org.apache.geode.cache.RegionFactory.setCustomEntryIdleTimeout`, `setCustomeEntryTimeToLive` - -**Example:** - -``` pre -<region-attributes> - <expiration-attributes - timeout="60" - action="local-destroy"> - <custom-expiry> - <class-name> - com.megaconglomerate.mypackage.MyClass - </class-name> - </custom-expiry> -</region-attributes> -``` - -Specify the Java class and its initialization parameters with the `<class-name>` and `<parameter>` sub-elements. - -## <a id="partition-attributes" class="no-quick-link"></a><partition-attributes> - -Defines the region as partitioned and controls partitioning behavior. This is set during the region creation in the first data store for the partitioned region. - -**Note:** -With the exception of `local-max-memory`, all members defining a partitioned region must use the same partition attribute settings. - -**API:** `org.apache.geode.cache.RegionFactory.setPartitionAttributes` - -<a id="partition-attributes__table_5CB4AC52DDA94E60A2B8325BA31E1253"></a> - -| 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, Geode issues a warning, but operation continues. Besides setting the maximum memory to use for the member, this setting also tells Geode how to balance the load between members where the region is defined. For example, if one member sets this value to twice the value of another memberâs setting, Geode works to keep the ratio between the first and the second at two-to-one, regardless of
<TRUNCATED>
