LATEST VERSION: 8.0.0 - CHANGELOG
Pivotal GemFire® v8.0
Download Ask for Help PDF

Region Shortcuts Reference

Region Shortcuts Reference

This topic describes the various region shortcuts you can use to configure GemFire regions.

LOCAL

Description

A region configured with the LOCAL region shortcut is scoped only to its JVM and is not visible to other peer members. The region does not distribute data and operations to other caches.

For more information, see: .

Default Attributes

Region Attributes:

scope: local
data-policy: NORMAL

gfsh Command Example

gfsh>create region --name=myLOCALregion --type=LOCAL
gfsh>describe region --name=myLOCALregion
..........................................................
Name            : myLOCALregion
Data Policy     : normal
Hosting Members : server1
                  server2

Non-Default Attributes Shared By Hosting Members  

 Type  |    Name     | Value
------ | ----------- | ------
Region | data-policy | NORMAL
       | size        | 0
scope: local
data-policy: NORMAL

cache.xml Example

<region name="myLOCALregion">
   <region-attributes scope="local"/>
</region>
Parent topic: Region Shortcuts

LOCAL_HEAP_LRU

Description

A region configured with the LOCAL_HEAP_LRU region shortcut is scoped to its JVM and is not visible to other peer members. The region does not distribute data and operations to other caches. The region destroys the least recently used entries when it detects that the JVM is running low on memory.

For more information, see:

Default Attributes

Region Attributes

scope: local
data-policy: NORMAL
Eviction Attributes
eviction-algorithm: lru-heap-percentage
eviction-action: local-destroy

gfsh Command Example

gfsh>create region --name=myLHLregion --type=LOCAL_HEAP_LRU
gfsh>describe region --name=myLHLregion
...........................................................
Name            : myLHLregion
Data Policy     : normal
Hosting Members : server1
                  server2

Non-Default Attributes Shared By Hosting Members  

  Type   |        Name        | Value
-------- | ------------------ | -------------------
Region   | data-policy        | NORMAL
         | size               | 0
Eviction | eviction-algorithm | lru-heap-percentage
         | eviction-action    | local-destroy

cache.xml Example

<region name="myLHLregion">
   <region-attributes 
        scope="local">
      <eviction-attributes>
        <lru-heap-percentage 
           action="local-destroy">
          <class-name>
           com.gemstone.gemfire.internal.size.SizeClassOnceObjectSizer
          </class-name>
        </lru-heap-percentage>
      </eviction-attributes>
   </region-attributes>
</region>
Parent topic: Region Shortcuts

LOCAL_OVERFLOW

Description

A region configured with the LOCAL_OVERFLOW region shortcut is scoped only to its JVM and is not visible to other peer members. The region does not distribute data and operations to other caches. The region moves the values of entries to disk when it detects that the JVM is running low on memory.

For more information, see:

Default Attributes

Region Attributes

scope: local
data-policy: NORMAL

Eviction Attributes

eviction-algorithm: lru-heap-percentage
eviction-action: overflow-to-disk

gfsh Command Example

gfsh>create region --name=myLOregion --type=LOCAL_OVERFLOW
gfsh>describe region --name=myLOregion
...........................................................
Name            : myLOregion
Data Policy     : normal
Hosting Members : server1
                  server2

Non-Default Attributes Shared By Hosting Members  

  Type   |        Name        | Value
-------- | ------------------ | -------------------
Region   | data-policy        | NORMAL
         | size               | 0
Eviction | eviction-algorithm | lru-heap-percentage
         | eviction-action    | overflow-to-disk

cache.xml Example

<region name="myLOregion">
    <region-attributes 
        scope="local">
      <eviction-attributes>
        <lru-heap-percentage 
           action="overflow-to-disk"/>
      </eviction-attributes>
    </region-attributes>
</region>
Parent topic: Region Shortcuts

LOCAL_PERSISTENT

Description

A region configured with the LOCAL_PERSISTENT region shortcut is scoped to its JVM and is not visible to other peer members. The region does not distribute data and operations to other caches. The region writes its state to disk and can recover that state when the member restarts.

For more information, see:

Default Attributes

Region Attributes

scope: local
data-policy: PERSISTENT-REPLICATE

gfsh Command Example

gfsh>create region --name=myLPregion --type=LOCAL_PERSISTENT
Member  | Status
------- | -----------------------------------------
server2 | Region "/myLPregion" created on "server2"
server1 | Region "/myLPregion" created on "server1"

gfsh>describe region --name=myLPregion
..........................................................
Name            : myLPregion
Data Policy     : persistent replicate
Hosting Members : server1
                  server2

Non-Default Attributes Shared By Hosting Members  

 Type  | Name | Value
------ | ---- | -----
Region | size | 0

cache.xml Example

<region name="myLPregion">
    <region-attributes 
      scope="local" 
      data-policy="persistent-replicate"/>
</region>
Parent topic: Region Shortcuts

LOCAL_PERSISTENT_OVERFLOW

Description

A region configured with the LOCAL_PERSISTENT_OVERFLOW region shortcut is scoped to its JVM and is not visible to other peer members. The region does not distribute data and operations to other caches. The region writes its state to disk and can recover that state when the member restarts. The region also removes the values of entries from memory when it detects that the JVM is running low on memory.

For more information, see:

Default Attributes

Region Attributes

scope: local
data-policy: PERSISTENT-REPLICATE

Eviction Attributes

eviction-algorithm: lru-heap-percentage
eviction-action: overflow-to-disk

gfsh Command Example

gfsh>create region --name=myLPOregion --type=LOCAL_PERSISTENT_OVERFLOW
Member  | Status
------- | ------------------------------------------
server1 | Region "/myLPOregion" created on "server1"
server2 | Region "/myLPOregion" created on "server2"

gfsh>describe region --name=myLPOregion
...........................................................
Name            : myLPOregion
Data Policy     : persistent replicate
Hosting Members : server1
                  server2

Non-Default Attributes Shared By Hosting Members  

  Type   |        Name        | Value
-------- | ------------------ | -------------------
Region   | size               | 0
Eviction | eviction-algorithm | lru-heap-percentage
         | eviction-action    | overflow-to-disk

cache.xml Example

<region name="myLPOregion">
   <region-attributes 
        scope="local" 
        data-policy="persistent-replicate">
      <eviction-attributes>
        <lru-heap-percentage 
          action="overflow-to-disk"/>
      </eviction-attributes>
   </region-attributes>
</region>
Parent topic: Region Shortcuts

PARTITION

Description

A region configured with the PARTITION region shortcut has local scope that is partitioned across each peer member that created the region.

For more information, see:

Default Attributes

Region Attributes

data-policy: PARTITION

gfsh Command Example

gfsh>create region --name=myPregion --type=PARTITION
Member  | Status
------- | ----------------------------------------
server1 | Region "/myPregion" created on "server1"
server2 | Region "/myPregion" created on "server2"

gfsh>describe region --name=myPregion
..........................................................
Name            : myPregion
Data Policy     : partition
Hosting Members : server1
                  server2

Non-Default Attributes Shared By Hosting Members  

 Type  | Name | Value
------ | ---- | -----
Region | size | 0

cache.xml Example

<region name="myPregion">
    <region-attributes 
      data-policy="partition"/>
  </region>
Parent topic: Region Shortcuts

PARTITION_HEAP_LRU

Description

A region configured with PARTITION_HEAP_LRU has local scope that is partitioned across each peer member that created the region. The region destroys entries when it detects that the JVM is running low on memory.

For more information, see:

Default Attributes

Region Attributes

data-policy: PARTITION

Eviction Attributes

eviction-algorithm: lru-heap-percentage
eviction-action: local-destroy

gfsh Command Example

gfsh>create region --name=myPHLregion --type=PARTITION_HEAP_LRU
Member  | Status
------- | ------------------------------------------
server1 | Region "/myPHLregion" created on "server1"
server2 | Region "/myPHLregion" created on "server2"

gfsh>describe region --name=myPHLregion
...........................................................
Name            : myPHLregion
Data Policy     : partition
Hosting Members : server1
                  server2

Non-Default Attributes Shared By Hosting Members  

  Type   |        Name        | Value
-------- | ------------------ | -------------------
Region   | size               | 0
Eviction | eviction-algorithm | lru-heap-percentage
         | eviction-action    | local-destroy

cache.xml Example

<region name="myPHLregion">
  <region-attributes 
      data-policy="partition">
      <eviction-attributes>
        <lru-heap-percentage 
            action="local-destroy">
            <class-name>com.gemstone.gemfire.internal.size.SizeClassOnceObjectSizer</class-name>
        </lru-heap-percentage>
      </eviction-attributes>
  </region-attributes>
</region>
Parent topic: Region Shortcuts

PARTITION_OVERFLOW

Description

A region configured with the PARTITION_OVERFLOW region shortcut has local state that is partitioned across each peer member that created the region. The region moves the values of entries to disk when it detects that the JVM is running low on memory.

For more information, see:

Default Attributes

Region Attributes

data-policy: PARTITION

Eviction Attributes

eviction-algorithm: lru-heap-percentage
eviction-action: overflow-to-disk

gfsh Command Example

gfsh>create region --name=myPOregion --type=PARTITION_OVERFLOW
Member  | Status
------- | -----------------------------------------
server1 | Region "/myPOregion" created on "server1"
server2 | Region "/myPOregion" created on "server2"

gfsh>describe region --name=myPOregion
...........................................................
Name            : myPOregion
Data Policy     : partition
Hosting Members : server1
                  server2

Non-Default Attributes Shared By Hosting Members  

  Type   |        Name        | Value
-------- | ------------------ | -------------------
Region   | size               | 0
Eviction | eviction-algorithm | lru-heap-percentage
         | eviction-action    | overflow-to-disk

cache.xml Example

<region name="myPOregion">
    <region-attributes 
        data-policy="partition">
        <eviction-attributes>
           <lru-heap-percentage 
             action="overflow-to-disk"/>
        </eviction-attributes>
    </region-attributes>
</region>
Parent topic: Region Shortcuts

PARTITION_PERSISTENT

Description

A region configured with the PARTITION_PERSISTENT has local state that is partitioned across each peer member that created the region. The region writes its state to disk and can recover that state when the member restarts.

For more information, see:

Default Attributes

Region Attributes

data-policy: PERSISTENT-PARTITION

gfsh Command Example

gfsh>create region --name=myPPregion --type=PARTITION_PERSISTENT
Member  | Status
------- | -----------------------------------------
server1 | Region "/myPPregion" created on "server1"
server2 | Region "/myPPregion" created on "server2"

gfsh>describe region --name=myPPregion
..........................................................
Name            : myPPregion
Data Policy     : persistent partition
Hosting Members : server1
                  server2

Non-Default Attributes Shared By Hosting Members  

 Type  | Name | Value
------ | ---- | -----
Region | size | 0

cache.xml Example

<region name="myPPregion">
    <region-attributes 
     data-policy="persistent-partition"/>
</region>
Parent topic: Region Shortcuts

PARTITION_PERSISTENT_OVERFLOW

Description

A region configured with the PARTITION_PERSISTENT_OVERFLOW has local state that is partitioned across each peer member that created the region. The region writes its state to disk and can recover that state when the member restarts. . The region removes the values of entries from memory when it detects that the JVM is running low on memory.

For more information, see:

Default Attributes

Region Attributes

data-policy: PERSISTENT-PARTITION

Eviction Attributes

eviction-algorithm: lru-heap-percentage
eviction-action: overflow-to-disk

gfsh Command Example

gfsh>create region --name=myPPOregion --type=PARTITION_PERSISTENT_OVERFLOW
Member  | Status
------- | ------------------------------------------
server2 | Region "/myPPOregion" created on "server2"
server1 | Region "/myPPOregion" created on "server1"

gfsh>describe region --name=myPPOregion
...........................................................
Name            : myPPOregion
Data Policy     : persistent partition
Hosting Members : server1
                  server2

Non-Default Attributes Shared By Hosting Members  

  Type   |        Name        | Value
-------- | ------------------ | -------------------
Region   | size               | 0
Eviction | eviction-algorithm | lru-heap-percentage
         | eviction-action    | overflow-to-disk

cache.xml Example

<region name="myPPOregion">
   <region-attributes 
        data-policy="persistent-partition">
        <eviction-attributes>
          <lru-heap-percentage 
             action="overflow-to-disk"/>
        </eviction-attributes>
   </region-attributes>
</region>
Parent topic: Region Shortcuts

PARTITION_PROXY

Description

A region configured with the PARTITION_PROXY region shortcut has no local state and forwards all operations to a peer region configured with the PARTITION shortcut or a peer region configured with the PARTITION_PERSISTENT shortcut.

See:

Default Attributes

Region Attributes

data-policy: PARTITION
Partition Attributes
local-max-memory: 0

gfsh Command Example

gfsh>create region --name=myPPXYregion --type=PARTITION_PROXY
Member  | Status
------- | -------------------------------------------
server1 | Region "/myPPXYregion" created on "server1"
server2 | Region "/myPPXYregion" created on "server2"

gfsh>describe region --name=myPPXYregion
...........................................................
Name             : myPPXYregion
Data Policy      : partition
Accessor Members : server1
                   server2

Non-Default Attributes Shared By Accessor Members  

  Type    |       Name       | Value
--------- | ---------------- | -----
Region    | size             | 0
Partition | local-max-memory | 0

cache.xml Example

<region name="myPPXYregion">
    <region-attributes 
        data-policy="partition">
        <partition-attributes 
           local-max-memory="0"/>
    </region-attributes>
</region>
Parent topic: Region Shortcuts

PARTITION_PROXY_REDUNDANT

Description

A region configured with the PARTITION_PROXY_REDUNDANT region shortcut has no local state and forwards all operations to a peer region configured with the PARTITION_REDUNDANT shortcut or a peer region configured with the PARTITION_REDUNDANT_PERSISTENT shortcut.

See:

Default Attributes

Region Attributes

data-policy: PARTITION
Partition Attributes
redundant-copies: 1
local-max-memory 0

gfsh Command Example

gfsh>create region --name=myPPRregion --type=PARTITION_PROXY_REDUNDANT
Member  | Status
------- | ------------------------------------------
server1 | Region "/myPPRregion" created on "server1"
server2 | Region "/myPPRregion" created on "server2"

gfsh>describe region --name=myPPRregion
...........................................................
Name             : myPPRregion
Data Policy      : partition
Accessor Members : server1
                   server2

Non-Default Attributes Shared By Accessor Members  

  Type    |       Name       | Value
--------- | ---------------- | -----
Region    | size             | 0
Partition | redundant-copies | 1
          | local-max-memory | 0

cache.xml Example

<region name="myPPRregion">
    <region-attributes 
       data-policy="partition">
       <partition-attributes 
        redundant-copies="1" 
        local-max-memory="0"/>
    </region-attributes>
</region>
Parent topic: Region Shortcuts

PARTITION_REDUNDANT

Description

A region configured with the PARTITION_REDUNDANT region shortcut has local state that is partitioned across each peer member that created the region. The region maintains an extra copy of the data in memory.

See:

Default Attributes

Region Attributes

data-policy: PARTITION
Partition Attributes
redundant-copies: 1

gfsh Command Example

gfsh>create region --name=myPRregion --type=PARTITION_REDUNDANT
Member  | Status
------- | -----------------------------------------
server1 | Region "/myPRregion" created on "server1"
server2 | Region "/myPRregion" created on "server2"

gfsh>describe region --name=myPRregion
..........................................................
Name            : myPRregion
Data Policy     : partition
Hosting Members : server1
                  server2

Non-Default Attributes Shared By Hosting Members  

  Type    |       Name       | Value
--------- | ---------------- | -----
Region    | size             | 0
Partition | redundant-copies | 1

cache.xml Example

<region name="myPRregion">
   <region-attributes 
       data-policy="partition">
       <partition-attributes 
          redundant-copies="1"/>
   </region-attributes>
</region>
Parent topic: Region Shortcuts

PARTITION_REDUNDANT_HEAP_LRU

Description

A region configured with the PARTITION_REDUNDANT_HEAP_LRU region shortcut has local state that is partitioned across each peer member that created the region. The region keeps an extra copy of the data in memory. The region destroys entries when it detects that the JVM is running low on memory.

For more information, see:

Default Attributes

Region Attributes

data-policy: PARTITION

Eviction Attributes

eviction-algorithm: lru-heap-percentage
eviction-action: local-destroy
Partition Attributes
redundant-copies: 1

gfsh Command Example

gfsh>create region --name=myPRHLregion --type=PARTITION_REDUNDANT_HEAP_LRU
Member  | Status
------- | -------------------------------------------
server1 | Region "/myPRHLregion" created on "server1"
server2 | Region "/myPRHLregion" created on "server2"

gfsh>describe region --name=myPRHLregion
...........................................................
Name            : myPRHLregion
Data Policy     : partition
Hosting Members : server1
                  server2

Non-Default Attributes Shared By Hosting Members  

  Type    |        Name        | Value
--------- | ------------------ | -------------------
Region    | size               | 0
Eviction  | eviction-algorithm | lru-heap-percentage
          | eviction-action    | local-destroy
Partition | redundant-copies   | 1

cache.xml Example

<region name="myPRHLregion">
    <region-attributes 
        data-policy="partition">
        <partition-attributes redundant-copies="1"/>
        <eviction-attributes>
          <lru-heap-percentage action="local-destroy">
           <class-name>
            com.gemstone.gemfire.internal.size.SizeClassOnceObjectSizer
           </class-name>
          </lru-heap-percentage>
      </eviction-attributes>
   </region-attributes>
</region>
Parent topic: Region Shortcuts

PARTITION_REDUNDANT_OVERFLOW

Description

A region configured with the PARTITION_REDUNDANT_OVERFLOW region shortcut has local state that is partitioned across each peer member that created the region. The region keeps an extra copy of the data in memory. The region moves the values of entries to disk when it detects that the JVM is running low on memory.

For more information, see:

Default Attributes

Region Attributes

data-policy: PARTITION

Eviction Attributes

eviction-algorithm: lru-heap-percentage
eviction-action: overflow-to-disk
Partition Attributes
redundant-copies: 1

gfsh Command Example

gfsh>create region --name=myPROregion --type=PARTITION_REDUNDANT_OVERFLOW
Member  | Status
------- | ------------------------------------------
server2 | Region "/myPROregion" created on "server2"
server1 | Region "/myPROregion" created on "server1"

gfsh>describe region --name=myPROregion
...........................................................
Name            : myPROregion
Data Policy     : partition
Hosting Members : server1
                  server2

Non-Default Attributes Shared By Hosting Members  

  Type    |        Name        | Value
--------- | ------------------ | -------------------
Region    | size               | 0
Eviction  | eviction-algorithm | lru-heap-percentage
          | eviction-action    | overflow-to-disk
Partition | redundant-copies   | 1

cache.xml Example

<region name="myPROregion">
   <region-attributes 
       data-policy="partition">
       <partition-attributes 
          redundant-copies="1"/>
       <eviction-attributes>
         <lru-heap-percentage 
           action="overflow-to-disk"/>
       </eviction-attributes>
   </region-attributes>
</region>
Parent topic: Region Shortcuts

PARTITION_REDUNDANT_PERSISTENT

Description

A region configured with the PARTITION_REDUNDANT_PERSISTENT region shortcut has local state that is partitioned across each peer member that created the region. The region writes its state to disk and recovers its state from disk when the region is created. The region maintains an extra copy of the data in memory.

For more information, see:

Default Attributes

Region Attributes

data-policy: PERSISTENT-PARTITION
Partition Attributes
redundant-copies: 1

gfsh Command Example

gfsh>create region --name=myPRPregion --type=PARTITION_REDUNDANT_PERSISTENT
Member  | Status
------- | ------------------------------------------
server2 | Region "/myPRPregion" created on "server2"
server1 | Region "/myPRPregion" created on "server1"

gfsh>describe region --name=myPRPregion
..........................................................
Name            : myPRPregion
Data Policy     : persistent partition
Hosting Members : server1
                  server2

Non-Default Attributes Shared By Hosting Members  

  Type    |       Name       | Value
--------- | ---------------- | -----
Region    | size             | 0
Partition | redundant-copies | 1

cache.xml Example

<region name="myPRPregion">
   <region-attributes 
       data-policy="persistent-partition">
       <partition-attributes 
        redundant-copies="1"/>
   </region-attributes>
</region>
Parent topic: Region Shortcuts

PARTITION_REDUNDANT_PERSISTENT_OVERFLOW

Description

A region configured with the PARTITION_REDUNDANT_PERSISTENT_OVERFLOW region shortcut has local state that is partitioned across each peer member that created the region. The region writes its state to disk and recovers its state from disk when the region is created. The region maintains an extra copy of the data in memory. The region removes the values of entries from memory when it detects that the JVM is running out of memory.

For more information, see:

Default Attributes

Region Attributes

data-policy: PERSISTENT-PARTITION

Eviction Attributes

eviction-algorithm: lru-heap-percentage
eviction-action: overflow-to-disk
Partition Attributes
redundant-copies: 1

gfsh Command Example

create region --name=myPRPOregion --type=PARTITION_REDUNDANT_PERSISTENT_OVERFLOW
describe region --name=myPRPOregion
...........................................................
Name            : myPRPOregion
Data Policy     : persistent partition
Hosting Members : server1
                  server2

Non-Default Attributes Shared By Hosting Members  

  Type    |        Name        | Value
--------- | ------------------ | -------------------
Region    | size               | 0
Eviction  | eviction-algorithm | lru-heap-percentage
          | eviction-action    | overflow-to-disk
Partition | redundant-copies   | 1

cache.xml Example

<region name="myPRPOregion">
    <region-attributes 
       data-policy="persistent-partition">
       <partition-attributes 
           redundant-copies="1"/>
       <eviction-attributes>
         <lru-heap-percentage 
            action="overflow-to-disk"/>
      </eviction-attributes>
    </region-attributes>
</region>
Parent topic: Region Shortcuts

REPLICATE

Description

A region configured with the REPLICATE region shortcut has local state that is kept in sync with all other peer regions configured with a REPLICATE data policy.

For more information, see:

Default Attributes

Region Attributes

data-policy: REPLICATE
scope: distributed-ack

gfsh Command Example

gfsh>create region --name=myRregion --type=REPLICATE

REPLICATE                       REPLICATE_PERSISTENT            REPLICATE_OVERFLOW              
REPLICATE_PERSISTENT_OVERFLOW   REPLICATE_HEAP_LRU              REPLICATE_PROXY                 

gfsh>create region --name=myRregion --type=REPLICATE
Member  | Status
------- | ----------------------------------------
server1 | Region "/myRregion" created on "server1"
server2 | Region "/myRregion" created on "server2"

cache.xml Example

<region name="myRregion">
    <region-attributes 
       scope="distributed-ack" 
       data-policy="replicate"/>
</region>
Parent topic: Region Shortcuts

REPLICATE_HEAP_LRU

Description

A region configured with the REPLICATE_HEAP_LRU region shortcut has local state that is kept in sync with all other peer regions configured with a REPLICATE data policy. The region destroys entries when it detects that the JVM is running low on memory.

Note: Normally, you cannot have a local-destroy eviction policy on replicated regions. However, the REPLICATE_HEAP_LRU region is not the same as other replicated regions. This region is preloaded and remains in synch by registering interest in the keys of its peer's replicated regions.
For more information, see:

Default Attributes

Region Attributes

data-policy: preloaded
scope: distributed-ack

Eviction Attributes

eviction-algorithm: lru-heap-percentage
eviction-action: local-destroy
Note: Normally, you cannot have a local-destroy eviction policy on replicated regions. However, the REPLICATE_HEAP_LRU region is not the same as other replicated regions. This region is preloaded and remains in synch by registering interest in the keys of its peer's replicated regions.
Subscription Attributes
interest-policy: all

gfsh Command Example

gfsh>create region --name=myRHLregion --type=REPLICATE_HEAP_LRU
Member  | Status
------- | -------------------------------------------
server1 | Region "/myRHLregion2" created on "server1"
server2 | Region "/myRHLregion2" created on "server2"

gfsh>describe region --name=myRHLregion
...........................................................
Name            : myRHLregion
Data Policy     : preloaded
Hosting Members : server1
                  server2

Non-Default Attributes Shared By Hosting Members  

  Type   |        Name        | Value
-------- | ------------------ | -------------------
Region   | size               | 0
Eviction | eviction-algorithm | lru-heap-percentage
         | eviction-action    | local-destroy

cache.xml Example

<region name="myRHLregion">
    <region-attributes 
       scope="distributed-ack" 
       data-policy="preloaded">
       <subscription-attributes 
          interest-policy="all"/>
       <eviction-attributes>
         <lru-heap-percentage 
            action="local-destroy">
            <class-name>com.gemstone.gemfire.internal.size.SizeClassOnceObjectSizer</class-name>
         </lru-heap-percentage>
       </eviction-attributes>
    </region-attributes>
</region>
Parent topic: Region Shortcuts

REPLICATE_OVERFLOW

Description

A region configured with the REPLICATE_OVERFLOW region shortcut has local state that is kept in sync with all other peer regions configured with a REPLICATE data policy.

For more information, see:

Default Attributes

Region Attributes

data-policy: replicate
scope: distributed-ack

Eviction Attributes

eviction-algorithm: lru-heap-percentage
eviction-action: overflow-to-disk

gfsh Command Example

gfsh>create region --name=myROregion --type=REPLICATE_OVERFLOW
Member  | Status
------- | -----------------------------------------
server2 | Region "/myROregion" created on "server2"
server1 | Region "/myROregion" created on "server1"

gfsh>describe region --name=myROregion
...........................................................
Name            : myROregion
Data Policy     : replicate
Hosting Members : server1
                  server2

Non-Default Attributes Shared By Hosting Members  

  Type   |        Name        | Value
-------- | ------------------ | -------------------
Region   | size               | 0
Eviction | eviction-algorithm | lru-heap-percentage
         | eviction-action    | overflow-to-disk

cache.xml Example

<region name="myROregion">
    <region-attributes 
       scope="distributed-ack" 
       data-policy="replicate">
       <eviction-attributes>
          <lru-heap-percentage 
           action="overflow-to-disk"/>
       </eviction-attributes>
    </region-attributes>
</region>
Parent topic: Region Shortcuts

REPLICATE_PERSISTENT

Description

A region configured with the REPLICATE_PERSISTENT region shortcut has local state that is kept in sync with all other peer regions that are configured with a REPLICATE data policy. The region writes its state to disk and recovers that state when the member restarts.

For more information, see:

Default Attributes

Region Attributes

data-policy: PERSISTENT-REPLICATE
scope: distributed-ack

gfsh Command Example

gfsh>create region --name=myRPregion --type=REPLICATE_PERSISTENT
Member  | Status
------- | -----------------------------------------
server2 | Region "/myRPregion" created on "server2"
server1 | Region "/myRPregion" created on "server1"

gfsh>describe region --name=myRPregion
..........................................................
Name            : myRPregion
Data Policy     : persistent replicate
Hosting Members : server1
                  server2

Non-Default Attributes Shared By Hosting Members  

 Type  | Name | Value
------ | ---- | -----
Region | size | 0

cache.xml Example

<region name="myRPregion">
    <region-attributes 
        scope="distributed-ack" 
        data-policy="empty"/>
</region>
Parent topic: Region Shortcuts

REPLICATE_PERSISTENT_OVERFLOW

Description

A region configured with the REPLICATE_PERSISTENT_OVERFLOW region shortcut has local state that is kept in sync with all other peer regions configured with a REPLICATE data policy. The region writes its state to disk and recovers that state when the member restarts. The region removes the values of entries from memory when it detects that the JVM is running low on memory.

For more information, see:

Default Attributes

Region Attributes

data-policy: PERSISTENT-REPLICATE
scope: distributed-ack

Eviction Attributes

eviction-algorithm: lru-heap-percentage
eviction-action: overflow-to-disk

gfsh Command Example

gfsh>create region --name=myRPOregion --type=REPLICATE_PERSISTENT

REPLICATE_PERSISTENT            REPLICATE_PERSISTENT_OVERFLOW   

gfsh>create region --name=myRPOregion --type=REPLICATE_PERSISTENT_OVERFLOW
Member  | Status
------- | ------------------------------------------
server1 | Region "/myRPOregion" created on "server1"
server2 | Region "/myRPOregion" created on "server2"

gfsh>describe region --name=myRPOregion
...........................................................
Name            : myRPOregion
Data Policy     : persistent replicate
Hosting Members : server1
                  server2

Non-Default Attributes Shared By Hosting Members  

  Type   |        Name        | Value
-------- | ------------------ | -------------------
Region   | size               | 0
Eviction | eviction-algorithm | lru-heap-percentage
         | eviction-action    | overflow-to-disk

cache.xml Example

 <region name="myRPOregion">
    <region-attributes 
       scope="distributed-ack" 
       data-policy="persistent-replicate">
       <eviction-attributes>
         <lru-heap-percentage 
             action="overflow-to-disk"/>
      </eviction-attributes>
    </region-attributes>
</region>
Parent topic: Region Shortcuts

REPLICATE_PROXY

Description

A region configured with the REPLICATE_PROXY region shortcut has no local state and forwards all operations to a peer region configured with the REPLICATE or REPLICATE_PERSISTENT region shortcut.

For more information, see:

Default Attributes

Region Attributes

data-policy: EMPTY
scope: distributed-ack

gfsh Command Example

gfsh>create region --name=myRPXYregion --type=REPLICATE_PROXY
Member  | Status
------- | -------------------------------------------
server1 | Region "/myRPXYregion" created on "server1"
server2 | Region "/myRPXYregion" created on "server2"

gfsh>describe region --name=myRPXYregion
...........................................................
Name             : myRPXYregion
Data Policy      : empty
Accessor Members : server1
                   server2

Non-Default Attributes Shared By Accessor Members  

 Type  | Name | Value
------ | ---- | -----
Region | size | 0

cache.xml Example

<region name="myRPXYregion">
    <region-attributes 
        scope="distributed-ack" 
        data-policy="empty"/>
</region>
Parent topic: Region Shortcuts