http://git-wip-us.apache.org/repos/asf/geode-native/blob/ff80a931/geode-docs/reference/topics/region_shortcuts_reference.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/reference/topics/region_shortcuts_reference.html.md.erb b/geode-docs/reference/topics/region_shortcuts_reference.html.md.erb deleted file mode 100644 index f3d9ca9..0000000 --- a/geode-docs/reference/topics/region_shortcuts_reference.html.md.erb +++ /dev/null @@ -1,1482 +0,0 @@ ---- -title: Region Shortcuts Reference ---- - -This topic describes the various region shortcuts you can use to configure Geode regions. - -## <span class="keyword parmname">LOCAL</span> - -### <a id="reference_w2h_3cd_lk__section_36EBE4321D89491A96865922A41813FB" class="no-quick-link"></a>Description - -A region configured with the <span class="keyword parmname">LOCAL</span> 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: - -- [Local Regions](../../developing/region_options/region_types.html#region_types__section_A8150BDBC74E4019B1942481877A4370) -- [RegionShortcuts for Peers and Servers](../../basic_config/data_regions/region_shortcuts.html#region_shortcuts__section_D0975C76572E41F79C1A6EE7CF371251) - -### <a id="reference_w2h_3cd_lk__section_54BD7A01BDB14D8A9FE5928F03E0D33D" class="no-quick-link"></a>Default Attributes - -<span class="keyword parmname">Region Attributes</span> - -| | | -|--------|-------| -| scope: | local | -| data-policy: | NORMAL | - -### <a id="reference_w2h_3cd_lk__section_FF6CC3A9EB9D4705A68ED9B345900D6A" class="no-quick-link"></a>gfsh Command Example - -``` pre -gfsh>create region --name=myLOCALregion --type=LOCAL -``` - -``` pre -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 -``` - -### <a id="reference_w2h_3cd_lk__section_506C4E195E0A412482931CB2BA30D1DD" class="no-quick-link"></a>XML Definition of <span class="keyword parmname">LOCAL</span> - -``` pre -<region name="myLOCALregion"> - <region-attributes scope="local"/> -</region> -``` - -## <span class="keyword parmname">LOCAL\_HEAP\_LRU</span> - -### <a id="reference_wd5_lpy_lk__section_2FA756DED1494EADA5E0061B365638EF" class="no-quick-link"></a>Description - -A region configured with the <span class="keyword parmname">LOCAL\_HEAP\_LRU</span> 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: - -- [Eviction](../../developing/eviction/chapter_overview.html) -- [Local Regions](../../developing/region_options/region_types.html#region_types__section_A8150BDBC74E4019B1942481877A4370) - -### <a id="reference_wd5_lpy_lk__section_2E433A09EE974B90A0482766268DE433" class="no-quick-link"></a>Default Attributes - -<span class="keyword parmname">Region Attributes</span> - -| | | -|----|----| -| scope: | local | -| data-policy: | NORMAL | - -<span class="keyword parmname">Eviction Attributes</span> - -| | | -|---------------------|---------------------| -| eviction-algorithm: | lru-heap-percentage | -| eviction-action: | local-destroy | - -### <a id="reference_wd5_lpy_lk__section_C7C04C729B204034A9AA8232C2A582A6" class="no-quick-link"></a>gfsh Command Example - -``` pre -gfsh>create region --name=myLHLregion --type=LOCAL_HEAP_LRU -``` - -``` pre -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 -``` - -### <a id="reference_wd5_lpy_lk__section_C9C0A77F6EF548898E0B24BDC8C92CD8" class="no-quick-link"></a>XML Definition of <span class="keyword parmname">LOCAL\_HEAP\_LRU</span> - -``` pre -<region name="myLHLregion"> - <region-attributes - scope="local"> - <eviction-attributes> - <lru-heap-percentage - action="local-destroy"> - <class-name> - org.apache.geode.internal.size.SizeClassOnceObjectSizer - </class-name> - </lru-heap-percentage> - </eviction-attributes> - </region-attributes> -</region> -``` - -## <span class="keyword parmname">LOCAL\_OVERFLOW</span> - -### <a id="reference_adk_y4y_lk__section_7EDCA6AB41E24F4BA63EC083224E93B5" class="no-quick-link"></a>Description - -A region configured with the <span class="keyword parmname">LOCAL\_OVERFLOW</span> 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: - -- [Persistence and Overflow](../../developing/storing_data_on_disk/chapter_overview.html) -- [Local Regions](../../developing/region_options/region_types.html#region_types__section_A8150BDBC74E4019B1942481877A4370) -- [Eviction](../../developing/eviction/chapter_overview.html) - -### <a id="reference_adk_y4y_lk__section_DA75B0D2F8A94AE1A4FD48A8B59F4554" class="no-quick-link"></a>Default Attributes - -<span class="keyword parmname">Region Attributes</span> - -| | | -|----|----| -| scope: | local | -| data-policy: | NORMAL | - -<span class="keyword parmname">Eviction Attributes</span> - -| | | -|---------------------|---------------------| -| eviction-algorithm: | lru-heap-percentage | -| eviction-action: | overflow-to-disk | - -### <a id="reference_adk_y4y_lk__section_FCEA598100164237B548C60EAA1556FF" class="no-quick-link"></a>gfsh Command Example - -``` pre -gfsh>create region --name=myLOregion --type=LOCAL_OVERFLOW -``` - -``` pre -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 -``` - -### <a id="reference_adk_y4y_lk__section_6E6C4A4B92D248C59FEAB20C63558F30" class="no-quick-link"></a>XML Definition of <span class="keyword parmname">LOCAL\_OVERFLOW</span> - -``` pre -<region name="myLOregion"> - <region-attributes - scope="local"> - <eviction-attributes> - <lru-heap-percentage - action="overflow-to-disk"/> - </eviction-attributes> - </region-attributes> -</region> -``` - -## <span class="keyword parmname">LOCAL\_PERSISTENT</span> - -### <a id="reference_l5r_y4y_lk__section_CBC85A6AEF944EBC9C7B7A414D90B286" class="no-quick-link"></a>Description - -A region configured with the <span class="keyword parmname">LOCAL\_PERSISTENT</span> 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: - -- [Persistence and Overflow](../../developing/storing_data_on_disk/chapter_overview.html) -- [Local Regions](../../developing/region_options/region_types.html#region_types__section_A8150BDBC74E4019B1942481877A4370) - -### <a id="reference_l5r_y4y_lk__section_338E763857B845BD8C2ED4C3C0D62E4E" class="no-quick-link"></a>Default Attributes - -<span class="keyword parmname">Region Attributes</span> - -| | | -|----|----| -| scope: | local | -| data-policy: | PERSISTENT_REPLICATE | - -### <a id="reference_l5r_y4y_lk__section_E41981F332664D48A3914D4BEEC50902" class="no-quick-link"></a>gfsh Command Example - -``` pre -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 -``` - -### <a id="reference_l5r_y4y_lk__section_3FC68C0F5413452C924C71DC2F8D6BDF" class="no-quick-link"></a>XML Definition of <span class="keyword parmname">LOCAL\_PERSISTENT</span> - -``` pre -<region name="myLPregion"> - <region-attributes - scope="local" - data-policy="persistent-replicate"/> -</region> -``` - -## <span class="keyword parmname">LOCAL\_PERSISTENT\_OVERFLOW</span> - -### <a id="reference_a45_y4y_lk__section_9D76AA9F92AC461C8702945AE990303E" class="no-quick-link"></a>Description - -A region configured with the <span class="keyword parmname">LOCAL\_PERSISTENT\_OVERFLOW</span> 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: - -- [Persistence and Overflow](../../developing/storing_data_on_disk/chapter_overview.html) -- [Local Regions](../../developing/region_options/region_types.html#region_types__section_A8150BDBC74E4019B1942481877A4370) - -### <a id="reference_a45_y4y_lk__section_06524290FD6347B19D91BBB2B98B6D7E" class="no-quick-link"></a>Default Attributes - -<span class="keyword parmname">Region Attributes</span> - -| | | -|----|----| -| scope: | local | -| data-policy: | PERSISTENT_REPLICATE | - -<span class="keyword parmname">Eviction Attributes</span> - -| | | -|---------------------|---------------------| -| eviction-algorithm: | lru-heap-percentage | -| eviction-action: | overflow-to-disk | - -### <a id="reference_a45_y4y_lk__section_F81B5ACAFE3A41948BD8D15406ECA1A1" class="no-quick-link"></a>gfsh Command Example - -``` pre -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 -``` - -### <a id="reference_a45_y4y_lk__section_97980143983D4624B6736F19A9AD42FE" class="no-quick-link"></a>XML Definition of <span class="keyword parmname">LOCAL\_PERSISTENT\_OVERFLOW</span> - -``` pre -<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> -``` - -## <span class="keyword parmname">PARTITION</span> - -### <a id="reference_ow5_4qy_lk__section_FC75463878014EB99450012BB2BF56F3" class="no-quick-link"></a>Description - -A region configured with the <span class="keyword parmname">PARTITION</span> region shortcut has local scope that is partitioned across each peer member that created the region. - -For more information, see: - -- [Local Regions](../../developing/region_options/region_types.html#region_types__section_A8150BDBC74E4019B1942481877A4370) -- [Partitioned Regions](../../developing/partitioned_regions/chapter_overview.html) -- [RegionShortcuts for Peers and Servers](../../basic_config/data_regions/region_shortcuts.html#region_shortcuts__section_D0975C76572E41F79C1A6EE7CF371251) - -### <a id="reference_ow5_4qy_lk__section_8F8F7C54F95B41D79ED814717E62961E" class="no-quick-link"></a>Default Attributes - -<span class="keyword parmname">Region Attributes</span> - -| | | -|----|----| -| data-policy: | PARTITION | - -### <a id="reference_ow5_4qy_lk__section_7989417AE95E4B5F8569CD545663A33D" class="no-quick-link"></a>gfsh Command Example - -``` pre -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 -``` - -### <a id="reference_ow5_4qy_lk__section_309654CBE5C24F5A85650CEE3AAB38DB" class="no-quick-link"></a>XML Definition of <span class="keyword parmname">PARTITION</span> - -``` pre -<region name="myPregion"> - <region-attributes - data-policy="partition"/> - </region> -``` - -## <span class="keyword parmname">PARTITION\_HEAP\_LRU</span> - -### <a id="reference_twx_y4y_lk__section_AC539D91DDBC4CC5B7F5E12190ECAD01" class="no-quick-link"></a>Description - -A region configured with <span class="keyword parmname">PARTITION\_HEAP\_LRU</span> 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: - -- [Persistence and Overflow](../../developing/storing_data_on_disk/chapter_overview.html) -- [Local Regions](../../developing/region_options/region_types.html#region_types__section_A8150BDBC74E4019B1942481877A4370) -- [Eviction](../../developing/eviction/chapter_overview.html) -- [Partitioned Regions](../../developing/partitioned_regions/chapter_overview.html) - -### <a id="reference_twx_y4y_lk__section_4A9CCE754E8F486FB33CC1D7B91D3B7C" class="no-quick-link"></a>Default Attributes - -<span class="keyword parmname">Region Attributes</span> - -| | | -|----|----| -| data-policy: | PARTITION | - -<span class="keyword parmname">Eviction Attributes</span> - -| | | -|---------------------|---------------------| -| eviction-algorithm: | lru-heap-percentage | -| eviction-action: | local-destroy | - -### <a id="reference_twx_y4y_lk__section_F804443937334AF7AE6CE4AF700A01C6" class="no-quick-link"></a>gfsh Command Example - -``` pre -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 -``` - -### <a id="reference_twx_y4y_lk__section_53D3C52436A746918383D437FEEC648E" class="no-quick-link"></a>XML Definition of <span class="keyword parmname">PARTITION\_HEAP\_LRU</span> - -``` pre -<region name="myPHLregion"> - <region-attributes - data-policy="partition"> - <eviction-attributes> - <lru-heap-percentage - action="local-destroy"> - <class-name>org.apache.geode.internal.size.SizeClassOnceObjectSizer</class-name> - </lru-heap-percentage> - </eviction-attributes> - </region-attributes> -</region> -``` - -## <span class="keyword parmname">PARTITION\_OVERFLOW</span> - -### <a id="reference_js1_z4y_lk__section_2D3C2F9081DF4102826B8A1273FE1A4D" class="no-quick-link"></a>Description - -A region configured with the <span class="keyword parmname">PARTITION\_OVERFLOW</span> 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: - -- [Persistence and Overflow](../../developing/storing_data_on_disk/chapter_overview.html) -- [Local Regions](../../developing/region_options/region_types.html#region_types__section_A8150BDBC74E4019B1942481877A4370) -- [Partitioned Regions](../../developing/partitioned_regions/chapter_overview.html) -- [Eviction](../../developing/eviction/chapter_overview.html) - -### <a id="reference_js1_z4y_lk__section_06393B7E4B3A4BEABF992607626555DE" class="no-quick-link"></a>Default Attributes - -<span class="keyword parmname">Region Attributes</span> - -| | | -|----|----| -| data-policy: | PARTITION | - -<span class="keyword parmname">Eviction Attributes</span> - -| | | -|---------------------|---------------------| -| eviction-algorithm: | lru-heap-percentage | -| eviction-action: | overflow-to-disk | - -### <a id="reference_js1_z4y_lk__section_5054474CFB19482E96FA3802B38A84DD" class="no-quick-link"></a>gfsh Command Example - -``` pre -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 -``` - -### <a id="reference_js1_z4y_lk__section_1B882ACE4D234D39BDCF281969593B26" class="no-quick-link"></a>XML Definition of <span class="keyword parmname">PARTITION\_OVERFLOW</span> - -``` pre -<region name="myPOregion"> - <region-attributes - data-policy="partition"> - <eviction-attributes> - <lru-heap-percentage - action="overflow-to-disk"/> - </eviction-attributes> - </region-attributes> -</region> -``` - -## <span class="keyword parmname">PARTITION\_PERSISTENT</span> - -### <a id="reference_d4k_jpy_lk__section_449C439FCF224960B25CBADA6B15559F" class="no-quick-link"></a>Description - -A region configured with the <span class="keyword parmname">PARTITION\_PERSISTENT</span> 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: - -- [RegionShortcuts for Peers and Servers](../../basic_config/data_regions/region_shortcuts.html#region_shortcuts__section_D0975C76572E41F79C1A6EE7CF371251) - -- [Persistence and Overflow](../../developing/storing_data_on_disk/chapter_overview.html) -- [Partitioned Regions](../../developing/partitioned_regions/chapter_overview.html) - -### <a id="reference_d4k_jpy_lk__section_CFD6C4ADD9C84C48A846166DD047621C" class="no-quick-link"></a>Default Attributes - -<span class="keyword parmname">Region Attributes</span> - -| | | -|----|----| -| data-policy: | PERSISTENT_PARTITION | - -### <a id="reference_d4k_jpy_lk__section_F2B651B4803341E3991F554544EF8551" class="no-quick-link"></a>gfsh Command Example - -``` pre -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 -``` - -### <a id="reference_d4k_jpy_lk__section_FF304DDCE61C4260AE2BD038C4AE4C65" class="no-quick-link"></a>XML Definition of <span class="keyword parmname">PARTITION\_PERSISTENT</span> - -``` pre -<region name="myPPregion"> - <region-attributes - data-policy="persistent-partition"/> -</region> -``` - -## <span class="keyword parmname">PARTITION\_PERSISTENT\_OVERFLOW</span> - -### <a id="reference_v5l_jpy_lk__section_63D18AA41CDE4E02AAA0EB3AA8437422" class="no-quick-link"></a>Description - -A region configured with the <span class="keyword parmname">PARTITION\_PERSISTENT\_OVERFLOW</span> 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: - -- [RegionShortcuts for Peers and Servers](../../basic_config/data_regions/region_shortcuts.html#region_shortcuts__section_D0975C76572E41F79C1A6EE7CF371251) -- [Persistence and Overflow](../../developing/storing_data_on_disk/chapter_overview.html) -- [Partitioned Regions](../../developing/partitioned_regions/chapter_overview.html) - -### <a id="reference_v5l_jpy_lk__section_3A5BF41715ED499193A42119F9F4C8B8" class="no-quick-link"></a>Default Attributes - -<span class="keyword parmname">Region Attributes</span> - -| | | -|----|----| -| data-policy: | PERSISTENT_PARTITION | - -<span class="keyword parmname">Eviction Attributes</span> - -| | | -|---------------------|---------------------| -| eviction-algorithm: | lru-heap-percentage | -| eviction-action: | overflow-to-disk | - -### <a id="reference_v5l_jpy_lk__section_64138E9923064EBC8007B6803223E64F" class="no-quick-link"></a>gfsh Command Example - -``` pre -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 -``` - -### <a id="reference_v5l_jpy_lk__section_C73C1D158A034627BC73A7FA46FA4A96" class="no-quick-link"></a>XML Definition of <span class="keyword parmname">PARTITION\_PERSISTENT\_OVERFLOW</span> - -``` pre -<region name="myPPOregion"> - <region-attributes - data-policy="persistent-partition"> - <eviction-attributes> - <lru-heap-percentage - action="overflow-to-disk"/> - </eviction-attributes> - </region-attributes> -</region> -``` - -## <span class="keyword parmname">PARTITION\_PROXY</span> - -### <a id="reference_v4m_jpy_lk__section_90846BE9CEC64883B03F83312A0876FB" class="no-quick-link"></a>Description - -A region configured with the <span class="keyword parmname">PARTITION\_PROXY</span> region shortcut has no local state and forwards all operations to a peer region configured with the <span class="keyword parmname">PARTITION</span> shortcut or a peer region configured with the <span class="keyword parmname">PARTITION\_PERSISTENT</span> shortcut. - -See: - -- [RegionShortcuts for Peers and Servers](../../basic_config/data_regions/region_shortcuts.html#region_shortcuts__section_D0975C76572E41F79C1A6EE7CF371251) -- [Partitioned Regions](../../developing/partitioned_regions/chapter_overview.html) - -### <a id="reference_v4m_jpy_lk__section_527EB23A43234FD3A1B8A1A98BF2D4F4" class="no-quick-link"></a>Default Attributes - -<span class="keyword parmname">Region Attributes</span> - -| | | -|----|----| -| data-policy: | PARTITION | - -<span class="keyword parmname">Partition Attributes</span> - -| | | -|-------------------|-----| -| local-max-memory: | 0 | - -### <a id="reference_v4m_jpy_lk__section_1BDB4F2D00644B0B9C69D2F1F89C409E" class="no-quick-link"></a>gfsh Command Example - -``` pre -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 -``` - -### <a id="reference_v4m_jpy_lk__section_63DE16AB9EC84F4281488D566C0C1AF4" class="no-quick-link"></a>XML Definition of <span class="keyword parmname">PARTITION\_PROXY</span> - -``` pre -<region name="myPPXYregion"> - <region-attributes - data-policy="partition"> - <partition-attributes - local-max-memory="0"/> - </region-attributes> -</region> -``` - -## <span class="keyword parmname">PARTITION\_PROXY\_REDUNDANT</span> - -### <a id="reference_c1n_jpy_lk__section_DB38EA21A67C42AFB10FBA19320F9F2C" class="no-quick-link"></a>Description - -A region configured with the <span class="keyword parmname">PARTITION\_PROXY\_REDUNDANT</span> region shortcut has no local state and forwards all operations to a peer region configured with the <span class="keyword parmname">PARTITION\_REDUNDANT</span> shortcut or a peer region configured with the <span class="keyword parmname">PARTITION\_REDUNDANT\_PERSISTENT</span> shortcut. - -See: - -- [RegionShortcuts for Peers and Servers](../../basic_config/data_regions/region_shortcuts.html#region_shortcuts__section_D0975C76572E41F79C1A6EE7CF371251) -- [Partitioned Regions](../../developing/partitioned_regions/chapter_overview.html) - -### <a id="reference_c1n_jpy_lk__section_2279D137C360400B885C5CEFD1F24579" class="no-quick-link"></a>Default Attributes - -<span class="keyword parmname">Region Attributes</span> - -| | | -|----|----| -| data-policy: | PARTITION | - -<span class="keyword parmname">Partition Attributes</span> - -| | | -|-------------------|-----| -| redundant-copies: | 1 | -| local-max-memory | 0 | - -### <a id="reference_c1n_jpy_lk__section_D385EB36652A4E25B240C0A1BF91117E" class="no-quick-link"></a>gfsh Command Example - -``` pre -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 -``` - -### <a id="reference_c1n_jpy_lk__section_F6D8A5F0DB014475BE8FE57185DCD4DB" class="no-quick-link"></a>XML Definition of <span class="keyword parmname">PARTITION\_PROXY\_REDUNDANT</span> - -``` pre -<region name="myPPRregion"> - <region-attributes - data-policy="partition"> - <partition-attributes - redundant-copies="1" - local-max-memory="0"/> - </region-attributes> -</region> -``` - -## <span class="keyword parmname">PARTITION\_REDUNDANT</span> - -### <a id="reference_shn_jpy_lk__section_ECFF0FB6A1E84E1182C0CAFCD29419B1" class="no-quick-link"></a>Description - -A region configured with the <span class="keyword parmname">PARTITION\_REDUNDANT</span> 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: - -- [RegionShortcuts for Peers and Servers](../../basic_config/data_regions/region_shortcuts.html#region_shortcuts__section_D0975C76572E41F79C1A6EE7CF371251) -- [Partitioned Regions](../../developing/partitioned_regions/chapter_overview.html) - -### <a id="reference_shn_jpy_lk__section_5F453E9AC5094AE6AA4FF111A7E5DB75" class="no-quick-link"></a>Default Attributes - -<span class="keyword parmname">Region Attributes</span> - -| | | -|----|----| -| data-policy: | PARTITION | - -<span class="keyword parmname">Partition Attributes</span> - -| | | -|-------------------|-----| -| redundant-copies: | 1 | - -### <a id="reference_shn_jpy_lk__section_75BDE5C09ABD40CCBBC61B3D1D2DF7CA" class="no-quick-link"></a>gfsh Command Example - -``` pre -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 -``` - -### <a id="reference_shn_jpy_lk__section_512F8B9D526544DE8BD22E08CFDEC471" class="no-quick-link"></a>XML Definition of <span class="keyword parmname">PARTITION\_REDUNDANT</span> - -``` pre -<region name="myPRregion"> - <region-attributes - data-policy="partition"> - <partition-attributes - redundant-copies="1"/> - </region-attributes> -</region> -``` - -## <span class="keyword parmname">PARTITION\_REDUNDANT\_HEAP\_LRU</span> - -### <a id="reference_m4n_jpy_lk__section_3EE028397BF149C98156ECF677D10802" class="no-quick-link"></a>Description - -A region configured with the <span class="keyword parmname">PARTITION\_REDUNDANT\_HEAP\_LRU</span> 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: - -- [Persistence and Overflow](../../developing/storing_data_on_disk/chapter_overview.html) -- [Local Regions](../../developing/region_options/region_types.html#region_types__section_A8150BDBC74E4019B1942481877A4370) -- [Eviction](../../developing/eviction/chapter_overview.html) -- [RegionShortcuts for Peers and Servers](../../basic_config/data_regions/region_shortcuts.html#region_shortcuts__section_D0975C76572E41F79C1A6EE7CF371251) -- [Partitioned Regions](../../developing/partitioned_regions/chapter_overview.html) - -### <a id="reference_m4n_jpy_lk__section_9439F1B932754F3085175C331431425A" class="no-quick-link"></a>Default Attributes - -<span class="keyword parmname">Region Attributes</span> - -| | | -|----|----| -| data-policy: | PARTITION | - -<span class="keyword parmname">Eviction Attributes</span> - -| | | -|---------------------|---------------------| -| eviction-algorithm: | lru-heap-percentage | -| eviction-action: | local-destroy | - -<span class="keyword parmname">Partition Attributes</span> - -| | | -|-------------------|-----| -| redundant-copies: | 1 | - -### <a id="reference_m4n_jpy_lk__section_A3C8919EF7DF4B17AD0C3F31254B7340" class="no-quick-link"></a>gfsh Command Example - -``` pre -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 -``` - -### <a id="reference_m4n_jpy_lk__section_9C65B716E4C747D3AD7D1F904FF4B7DA" class="no-quick-link"></a>XML Definition of <span class="keyword parmname">PARTITION\_REDUNDANT\_HEAP\_LRU</span> - -``` pre -<region name="myPRHLregion"> - <region-attributes - data-policy="partition"> - <partition-attributes redundant-copies="1"/> - <eviction-attributes> - <lru-heap-percentage action="local-destroy"> - <class-name> - org.apache.geode.internal.size.SizeClassOnceObjectSizer - </class-name> - </lru-heap-percentage> - </eviction-attributes> - </region-attributes> -</region> -``` - -## <span class="keyword parmname">PARTITION\_REDUNDANT\_OVERFLOW</span> - -### <a id="reference_own_jpy_lk__section_B547C6D2F1B140A1ABAB1F45AD0D92F2" class="no-quick-link"></a>Description - -A region configured with the <span class="keyword parmname">PARTITION\_REDUNDANT\_OVERFLOW</span> 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: - -- [Persistence and Overflow](../../developing/storing_data_on_disk/chapter_overview.html) -- [Local Regions](../../developing/region_options/region_types.html#region_types__section_A8150BDBC74E4019B1942481877A4370) -- [Eviction](../../developing/eviction/chapter_overview.html) -- [RegionShortcuts for Peers and Servers](../../basic_config/data_regions/region_shortcuts.html#region_shortcuts__section_D0975C76572E41F79C1A6EE7CF371251) -- [Partitioned Regions](../../developing/partitioned_regions/chapter_overview.html) - -### <a id="reference_own_jpy_lk__section_78AD311F20D4495E9CDBA219F64CB79D" class="no-quick-link"></a>Default Attributes - -<span class="keyword parmname">Region Attributes</span> - -| | | -|----|----| -| data-policy: | PARTITION | - -<span class="keyword parmname">Eviction Attributes</span> - -| | | -|---------------------|---------------------| -| eviction-algorithm: | lru-heap-percentage | -| eviction-action: | overflow-to-disk | - -<span class="keyword parmname">Partition Attributes</span> - -| | | -|-------------------|-----| -| redundant-copies: | 1 | - -### <a id="reference_own_jpy_lk__section_C131CE53EFAF4C6DA03D3B30607FB715" class="no-quick-link"></a>gfsh Command Example - -``` pre -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 -``` - -### <a id="reference_own_jpy_lk__section_045EF130769244CDA2C83AFB6170A3C7" class="no-quick-link"></a>XML Definition of <span class="keyword parmname">PARTITION\_REDUNDANT\_OVERFLOW</span> - -``` pre -<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> -``` - -## <span class="keyword parmname">PARTITION\_REDUNDANT\_PERSISTENT</span> - -### <a id="reference_bd4_jpy_lk__section_F0C1C42195A54F03AA385982DA15DF2C" class="no-quick-link"></a>Description - -A region configured with the <span class="keyword parmname">PARTITION\_REDUNDANT\_PERSISTENT</span> 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: - -- [Persistence and Overflow](../../developing/storing_data_on_disk/chapter_overview.html) -- [RegionShortcuts for Peers and Servers](../../basic_config/data_regions/region_shortcuts.html#region_shortcuts__section_D0975C76572E41F79C1A6EE7CF371251). -- [Partitioned Regions](../../developing/partitioned_regions/chapter_overview.html) - -### <a id="reference_bd4_jpy_lk__section_390DABC994794F9C9FF19A50B8E53D71" class="no-quick-link"></a>Default Attributes - -<span class="keyword parmname">Region Attributes</span> - -| | | -|----|----| -| data-policy: | PERSISTENT_PARTITION | - -<span class="keyword parmname">Partition Attributes</span> - -| | | -|-------------------|-----| -| redundant-copies: | 1 | - -### <a id="reference_bd4_jpy_lk__section_8D226B0DB7B04878850B2A14BE0EA409" class="no-quick-link"></a>gfsh Command Example - -``` pre -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 -``` - -### <a id="reference_bd4_jpy_lk__section_4E26C39621AC4A1D8B27D44CC2690209" class="no-quick-link"></a>XML Definition of <span class="keyword parmname">PARTITION\_REDUNDANT\_PERSISTENT</span> - -``` pre -<region name="myPRPregion"> - <region-attributes - data-policy="persistent-partition"> - <partition-attributes - redundant-copies="1"/> - </region-attributes> -</region> -``` - -## <span class="keyword parmname">PARTITION\_REDUNDANT\_PERSISTENT\_OVERFLOW</span> - -### <a id="reference_xqq_tvc_lk__section_27D3FA56EF3D4A6F9BF1EFF86C0EBBC2" class="no-quick-link"></a>Description - -A region configured with the <span class="keyword parmname">PARTITION\_REDUNDANT\_PERSISTENT\_OVERFLOW</span> 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: - -- [Persistence and Overflow](../../developing/storing_data_on_disk/chapter_overview.html) -- [RegionShortcuts for Peers and Servers](../../basic_config/data_regions/region_shortcuts.html#region_shortcuts__section_D0975C76572E41F79C1A6EE7CF371251). -- [Partitioned Regions](../../developing/partitioned_regions/chapter_overview.html) - -### <a id="reference_xqq_tvc_lk__section_BADCEF8DBEDC446A85A353EF846C12C8" class="no-quick-link"></a>Default Attributes - -<span class="keyword parmname">Region Attributes</span> - -| | | -|----|----| -| data-policy: | PERSISTENT_PARTITION | - -<span class="keyword parmname">Eviction Attributes</span> - -| | | -|---------------------|---------------------| -| eviction-algorithm: | lru-heap-percentage | -| eviction-action: | overflow-to-disk | - -<span class="keyword parmname">Partition Attributes</span> - -| | | -|-------------------|-----| -| redundant-copies: | 1 | - -### <a id="reference_xqq_tvc_lk__section_7D4A02096A9D4F119C58125D3ECA1965" class="no-quick-link"></a>gfsh Command Example - -``` pre -create region --name=myPRPOregion --type=PARTITION_REDUNDANT_PERSISTENT_OVERFLOW -``` - -``` pre -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 -``` - -### <a id="reference_xqq_tvc_lk__section_0B8062252F014FCCA3826C220499232E" class="no-quick-link"></a>XML Definition of <span class="keyword parmname">PARTITION\_REDUNDANT\_PERSISTENT\_OVERFLOW</span> - -``` pre -<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> -``` - -## <span class="keyword parmname">REPLICATE</span> - -### <a id="reference_wq4_jpy_lk__section_FBCA755812B9401D8EB1F94C062A207D" class="no-quick-link"></a>Description - -A region configured with the <span class="keyword parmname">REPLICATE</span> 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: - -- [Persistence and Overflow](../../developing/storing_data_on_disk/chapter_overview.html) -- [RegionShortcuts for Peers and Servers](../../basic_config/data_regions/region_shortcuts.html#region_shortcuts__section_D0975C76572E41F79C1A6EE7CF371251) -- [Distributed and Replicated Regions](../../developing/distributed_regions/chapter_overview.html) - -### <a id="reference_wq4_jpy_lk__section_CAC42D7285E14540AA825F8A111D295D" class="no-quick-link"></a>Default Attributes - -<span class="keyword parmname">Region Attributes</span> - -| | | -|----|----| -| scope: | distributed-ack | -| data-policy: | REPLICATE | - - ### <a id="reference_wq4_jpy_lk__section_91941611D45D45609402EF2D1E5A7885" class="no-quick-link"></a>gfsh Command Example - -``` pre -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" -``` - -### <a id="reference_wq4_jpy_lk__section_1CEC0DACC13C4092BB2ACD1A9BA0CD66" class="no-quick-link"></a>XML Definition of <span class="keyword parmname">REPLICATE</span> - -``` pre -<region name="myRregion"> - <region-attributes - scope="distributed-ack" - data-policy="replicate"/> -</region> -``` - -## <span class="keyword parmname">REPLICATE\_HEAP\_LRU</span> - -### <a id="reference_xx4_jpy_lk__section_DEAA6152FA324D5B8A266294FA8ADBF7" class="no-quick-link"></a>Description - -A region configured with the <span class="keyword parmname">REPLICATE\_HEAP\_LRU</span> 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: - -- [RegionShortcuts for Peers and Servers](../../basic_config/data_regions/region_shortcuts.html#region_shortcuts__section_D0975C76572E41F79C1A6EE7CF371251) -- [Eviction](../../developing/eviction/chapter_overview.html) -- [Distributed and Replicated Regions](../../developing/distributed_regions/chapter_overview.html) - -### <a id="reference_xx4_jpy_lk__section_ECA05E395EBC4671BA3AA2C05EC50868" class="no-quick-link"></a>Default Attributes - -<span class="keyword parmname">Region Attributes</span> - -| | | -|----|----| -| scope: | distributed-ack | -| data-policy: | PRELOADED | - - <span class="keyword parmname">Eviction Attributes</span> - -<table> -<colgroup> -<col width="50%" /> -<col width="50%" /> -</colgroup> -<tbody> -<tr class="odd"> -<td>eviction-algorithm:</td> -<td>lru-heap-percentage</td> -</tr> -<tr class="even"> -<td>eviction-action:</td> -<td>local-destroy -<div class="note note"> -<b>Note:</b> -<p>Normally, you cannot have a <code class="ph codeph">local-destroy</code> 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.</p> -</div></td> -</tr> -</tbody> -</table> - -| | | -|------------------|-----| -| interest-policy: | all | - -### <a id="reference_xx4_jpy_lk__section_34CA13FA44C94181B57AF30A9CE5A0FD" class="no-quick-link"></a>gfsh Command Example - -``` pre -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 -``` - -### <a id="reference_xx4_jpy_lk__section_4033265D958B4551AB93F16DBB084DA8" class="no-quick-link"></a>XML Definition of <span class="keyword parmname">REPLICATE\_HEAP\_LRU</span> - -``` pre -<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>org.apache.geode.internal.size.SizeClassOnceObjectSizer</class-name> - </lru-heap-percentage> - </eviction-attributes> - </region-attributes> -</region> -``` - -## <span class="keyword parmname">REPLICATE\_OVERFLOW</span> - -### <a id="reference_t2p_jpy_lk__section_7980E9B8EE1049CEB7ABF243B068E1BB" class="no-quick-link"></a>Description - -A region configured with the <span class="keyword parmname">REPLICATE\_OVERFLOW</span> region shortcut has local state that is kept in sync with all other peer regions configured with a <span class="keyword parmname">REPLICATE</span> data policy. - -For more information, see: - -- [Persistence and Overflow](../../developing/storing_data_on_disk/chapter_overview.html) -- [RegionShortcuts for Peers and Servers](../../basic_config/data_regions/region_shortcuts.html#region_shortcuts__section_D0975C76572E41F79C1A6EE7CF371251) -- [Distributed and Replicated Regions](../../developing/distributed_regions/chapter_overview.html) - -### <a id="reference_t2p_jpy_lk__section_446237A732494640B82C918E0274E300" class="no-quick-link"></a>Default Attributes - -<span class="keyword parmname">Region Attributes</span> - -| | | -|----|----| -| scope: | distributed-ack | -| data-policy: | REPLICATE | - -<span class="keyword parmname">Eviction Attributes</span> - -| | | -|---------------------|---------------------| -| eviction-algorithm: | lru-heap-percentage | -| eviction-action: | overflow-to-disk | - -### <a id="reference_t2p_jpy_lk__section_E6BF992DE8774584BDB8B0E77DC00FA9" class="no-quick-link"></a>gfsh Command Example - -``` pre -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 -``` - -### <a id="reference_t2p_jpy_lk__section_03CBA2AB88084878A5EE83D9B4DE5BF4" class="no-quick-link"></a>XML Definition of <span class="keyword parmname">REPLICATE\_OVERFLOW</span> - -``` pre -<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> -``` - -## <span class="keyword parmname">REPLICATE\_PERSISTENT</span> - -### <a id="reference_emp_jpy_lk__section_4DCA5EAD6CDB482CB0BC7F543686C9B2" class="no-quick-link"></a>Description - -A region configured with the <span class="keyword parmname">REPLICATE\_PERSISTENT</span> region shortcut has local state that is kept in sync with all other peer regions that are configured with a <span class="keyword parmname">REPLICATE</span> data policy. The region writes its state to disk and recovers that state when the member restarts. - -For more information, see: - -- [Persistence and Overflow](../../developing/storing_data_on_disk/chapter_overview.html) -- [RegionShortcuts for Peers and Servers](../../basic_config/data_regions/region_shortcuts.html#region_shortcuts__section_D0975C76572E41F79C1A6EE7CF371251) -- [Distributed and Replicated Regions](../../developing/distributed_regions/chapter_overview.html) - -### <a id="reference_emp_jpy_lk__section_667FE780E8B040478B1A88EA4782DCD7" class="no-quick-link"></a>Default Attributes - -<span class="keyword parmname">Region Attributes</span> - -| | | -|----|----| -| scope: | distributed-ack | -| data-policy: | PERSISTENT_REPLICATE | - -### <a id="reference_emp_jpy_lk__section_71C90F066BDC4013B8AB7B68D4766B5B" class="no-quick-link"></a>gfsh Command Example - -``` pre -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 -``` - -### <a id="reference_emp_jpy_lk__section_9B8780A631D64431966A0D8723C920F5" class="no-quick-link"></a>XML Definition of <span class="keyword parmname">REPLICATE\_PERSISTENT</span> - -``` pre -<region name="myRPregion"> - <region-attributes - scope="distributed-ack" - data-policy="empty"/> -</region> -``` - -## <span class="keyword parmname">REPLICATE\_PERSISTENT\_OVERFLOW</span> - -### <a id="reference_tsp_jpy_lk__section_74EF03750D3A4531A6276F88071E62F0" class="no-quick-link"></a>Description - -A region configured with the <span class="keyword parmname">REPLICATE\_PERSISTENT\_OVERFLOW</span> region shortcut has local state that is kept in sync with all other peer regions configured with a <span class="keyword parmname">REPLICATE</span> 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: - -- [Persistence and Overflow](../../developing/storing_data_on_disk/chapter_overview.html) -- [RegionShortcuts for Peers and Servers](../../basic_config/data_regions/region_shortcuts.html#region_shortcuts__section_D0975C76572E41F79C1A6EE7CF371251) -- [Distributed and Replicated Regions](../../developing/distributed_regions/chapter_overview.html) - -### <a id="reference_tsp_jpy_lk__section_5992CA09DAC145D88940879ED690C8CA" class="no-quick-link"></a>Default Attributes - -<span class="keyword parmname">Region Attributes</span> - -| | | -|----|----| -| scope: | distributed-ack | -| data-policy: | PERSISTENT_REPLICATE | - -<span class="keyword parmname">Eviction Attributes</span> - -| | | -|---------------------|---------------------| -| eviction-algorithm: | lru-heap-percentage | -| eviction-action: | overflow-to-disk | - -### <a id="reference_tsp_jpy_lk__section_090DD0E7DD9A40E581BFB90BB93C6081" class="no-quick-link"></a>gfsh Command Example - -``` pre -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 -``` - -### <a id="reference_tsp_jpy_lk__section_ED067AAEB4604438A570CCE3EAFF4F31" class="no-quick-link"></a>XML Definition of <span class="keyword parmname">REPLICATE\_PERSISTENT\_OVERFLOW</span> - -``` pre - <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> -``` - -## <span class="keyword parmname">REPLICATE\_PROXY</span> - -### <a id="reference_n1q_jpy_lk__section_71E08A97BCFD4CD59032843064BD202A" class="no-quick-link"></a>Description - -A region configured with the <span class="keyword parmname">REPLICATE\_PROXY</span> region shortcut has no local state and forwards all operations to a peer region configured with the [REPLICATE](#reference_wq4_jpy_lk) or [REPLICATE_PERSISTENT](#reference_emp_jpy_lk) region shortcut. - -For more information, see: - -- [RegionShortcuts for Peers and Servers](../../basic_config/data_regions/region_shortcuts.html#region_shortcuts__section_D0975C76572E41F79C1A6EE7CF371251) -- [Distributed and Replicated Regions](../../developing/distributed_regions/chapter_overview.html) - -### <a id="reference_n1q_jpy_lk__section_C9BA03C04A0A4FBFAC42D6413B353A2B" class="no-quick-link"></a>Default Attributes - -<span class="keyword parmname">Region Attributes</span> - -| | | -|----|----| -| scope: | distributed-ack | -| data-policy: | EMPTY | - -### <a id="reference_n1q_jpy_lk__section_4AE0D8F15CAC4CFD8198007BCF91FA85" class="no-quick-link"></a>gfsh Command Example - -``` pre -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 -``` - -### <a id="reference_n1q_jpy_lk__section_7B52EA99FD054123BBF5546EC0614FA2" class="no-quick-link"></a>XML Definition of <span class="keyword parmname">REPLICATE\_PROXY</span> - -``` pre -<region name="myRPXYregion"> - <region-attributes - scope="distributed-ack" - data-policy="empty"/> -</region> -```
http://git-wip-us.apache.org/repos/asf/geode-native/blob/ff80a931/geode-docs/reference/topics/region_shortcuts_table.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/reference/topics/region_shortcuts_table.html.md.erb b/geode-docs/reference/topics/region_shortcuts_table.html.md.erb deleted file mode 100644 index b73f9af..0000000 --- a/geode-docs/reference/topics/region_shortcuts_table.html.md.erb +++ /dev/null @@ -1,502 +0,0 @@ ---- -title: Region Shortcuts Quick Reference ---- - -This section provides a quick reference for all region shortcuts. - -<a id="reference_ufj_5kz_4k__section_6B142E06F22C4B0EACE7CA369F9C2618"></a> -[Region Shortcuts Default Configurations](#reference_ufj_5kz_4k__table_lkl_hws_mk) summarizes the default configurations for each region shortcut. See the cross reference for additional information about each shortcut. - -<a id="reference_ufj_5kz_4k__table_lkl_hws_mk"></a> - -<table> -<caption><span class="tablecap">Table 1. Region Shortcuts Default Configurations</span></caption> -<colgroup> -<col width="20%" /> -<col width="30%" /> -<col width="50%" /> -</colgroup> -<thead> -<tr class="header"> -<th>Region Shortcut</th> -<th>Region Attributes</th> -<th>Other Attributes</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td><p><a href="region_shortcuts_reference.html#reference_w2h_3cd_lk)">LOCAL</a></p></td> -<td><div id="reference_ufj_5kz_4k__p_q44_t11_nk" class="p"> -scope: -local<br /> -data-policy: -NORMAL -</div></td> -<td> </td> -</tr> -<tr class="even"> -<td><p><a href="region_shortcuts_reference.html#reference_wd5_lpy_lk">LOCAL_HEAP_LRU</a></p></td> -<td><div id="reference_ufj_5kz_4k__p_axf_z11_nk" class="p"> -scope: -local<br /> -data-policy: -NORMAL -</div></td> -<td><div id="reference_ufj_5kz_4k__p_mwf_gb1_nk" class="p"> -<span class="keyword parmname">Eviction Attributes</span> -<table> -<tbody> -<tr class="odd"> -<td>eviction-algorithm:</td> -<td>lru-heap-percentage</td> -</tr> -<tr class="even"> -<td>eviction-action:</td> -<td>local-destroy</td> -</tr> -</tbody> -</table> -</div></td> -</tr> -<tr class="odd"> -<td><p>[LOCAL_OVERFLOW](region_shortcuts_reference.html#reference_adk_y4y_lk)</p></td> -<td><div id="reference_ufj_5kz_4k__p_fsq_jc1_nk" class="p"> -scope: -local<br /> -data-policy: -NORMAL -</div></td> -<td><p><span class="keyword parmname">Eviction Attributes</span></p> -<div id="reference_ufj_5kz_4k__p_rsq_jc1_nk" class="p"> -<table> -<tbody> -<tr class="odd"> -<td>eviction-algorithm:</td> -<td>lru-heap-percentage</td> -</tr> -<tr class="even"> -<td>eviction-action:</td> -<td>overflow-to-disk</td> -</tr> -</tbody> -</table> -</div></td> -</tr> -<tr class="even"> -<td><p>[LOCAL_PERSISTENT](region_shortcuts_reference.html#reference_l5r_y4y_lk)</p></td> -<td><div id="reference_ufj_5kz_4k__p_ctq_jc1_nk" class="p"> -scope: -local<br /> -data-policy: -PERSISTENT\_REPLICATE -</div></td> -<td> </td> -</tr> -<tr class="odd"> -<td><p>[LOCAL\_PERSISTENT\_OVERFLOW](region_shortcuts_reference.html#reference_a45_y4y_lk)</p></td> -<td><div id="reference_ufj_5kz_4k__p_ttq_jc1_nk" class="p"> -scope: -local<br /> -data-policy: -PERSISTENT\_REPLICATE -</div></td> -<td><p><span class="keyword parmname">Eviction Attributes</span></p> -<div id="reference_ufj_5kz_4k__p_e5q_jc1_nk" class="p"> -<table> -<tbody> -<tr class="odd"> -<td>eviction-algorithm:</td> -<td>lru-heap-percentage</td> -</tr> -<tr class="even"> -<td>eviction-action:</td> -<td>overflow-to-disk</td> -</tr> -</tbody> -</table> -</div></td> -</tr> -<tr class="even"> -<td><p>[PARTITION](region_shortcuts_reference.html#reference_ow5_4qy_lk)</p></td> -<td><div id="reference_ufj_5kz_4k__p_p5q_jc1_nk" class="p"> -data-policy: -PARTITION -</div></td> -<td> </td> -</tr> -<tr class="odd"> -<td><p>[PARTITION\_HEAP\_LRU](region_shortcuts_reference.html#reference_twx_y4y_lk)</p></td> -<td><div id="reference_ufj_5kz_4k__p_bvq_jc1_nk" class="p"> -data-policy: -PARTITION -</div></td> -<td><p><span class="keyword parmname">Eviction Attributes</span></p> -<div id="reference_ufj_5kz_4k__p_lvq_jc1_nk" class="p"> -<table> -<tbody> -<tr class="odd"> -<td>eviction-algorithm:</td> -<td>lru-heap-percentage</td> -</tr> -<tr class="even"> -<td>eviction-action:</td> -<td>local-destroy</td> -</tr> -</tbody> -</table> -</div></td> -</tr> -<tr class="even"> -<td><p>[PARTITION_OVERFLOW](region_shortcuts_reference.html#reference_js1_z4y_lk)</p></td> -<td><div id="reference_ufj_5kz_4k__p_wvq_jc1_nk" class="p"> -data-policy: -PARTITION -</div></td> -<td><p><span class="keyword parmname">Eviction Attributes</span></p> -<div id="reference_ufj_5kz_4k__p_gwq_jc1_nk" class="p"> -<table> -<tbody> -<tr class="odd"> -<td>eviction-algorithm:</td> -<td>lru-heap-percentage</td> -</tr> -<tr class="even"> -<td>eviction-action:</td> -<td>overflow-to-disk</td> -</tr> -</tbody> -</table> -</div></td> -</tr> -<tr class="odd"> -<td><p>[PARTITION_PERSISTENT](region_shortcuts_reference.html#reference_d4k_jpy_lk)</p></td> -<td><div id="reference_ufj_5kz_4k__p_qwq_jc1_nk" class="p"> -data-policy: -PERSISTENT\_PARTITION -</div></td> -<td> </td> -</tr> -<tr class="even"> -<td><p>[PARTITION\_PERSISTENT\_OVERFLOW](region_shortcuts_reference.html#reference_v5l_jpy_lk)</p></td> -<td><div id="reference_ufj_5kz_4k__p_axq_jc1_nk" class="p"> -data-policy: -PERSISTENT\_PARTITION -</div></td> -<td><p><span class="keyword parmname">Eviction Attributes</span></p> -<div id="reference_ufj_5kz_4k__p_lxq_jc1_nk" class="p"> -<table> -<tbody> -<tr class="odd"> -<td>eviction-algorithm:</td> -<td>lru-heap-percentage</td> -</tr> -<tr class="even"> -<td>eviction-action:</td> -<td>overflow-to-disk</td> -</tr> -</tbody> -</table> -</div></td> -</tr> -<tr class="odd"> -<td><p>[PARTITION_PROXY](region_shortcuts_reference.html#reference_v4m_jpy_lk)</p></td> -<td><div id="reference_ufj_5kz_4k__p_wxq_jc1_nk" class="p"> -data-policy: -PARTITION -</div></td> -<td><div id="reference_ufj_5kz_4k__p_dyq_jc1_nk" class="p"> -<span class="keyword parmname">Partition Attributes</span> -<table> -<tbody> -<tr class="odd"> -<td>local-max-memory:</td> -<td>0</td> -</tr> -</tbody> -</table> -</div></td> -</tr> -<tr class="even"> -<td><p>[PARTITION\_PROXY\_REDUNDANT](region_shortcuts_reference.html#reference_c1n_jpy_lk)</p></td> -<td><div id="reference_ufj_5kz_4k__p_oyq_jc1_nk" class="p"> -data-policy: -PARTITION -</div></td> -<td><div id="reference_ufj_5kz_4k__p_uyq_jc1_nk" class="p"> -<span class="keyword parmname">Partition Attributes</span> -<table> -<tbody> -<tr class="odd"> -<td>redundant-copies:</td> -<td>1</td> -</tr> -<tr class="even"> -<td>local-max-memory</td> -<td>0</td> -</tr> -</tbody> -</table> -</div></td> -</tr> -<tr class="odd"> -<td><p>[PARTITION_REDUNDANT](region_shortcuts_reference.html#reference_shn_jpy_lk)</p></td> -<td><div id="reference_ufj_5kz_4k__p_gzq_jc1_nk" class="p"> -data-policy: -PARTITION -</div></td> -<td><div id="reference_ufj_5kz_4k__p_lzq_jc1_nk" class="p"> -<span class="keyword parmname">Partition Attributes</span> -<table> -<tbody> -<tr class="odd"> -<td>redundant-copies:</td> -<td>1</td> -</tr> -</tbody> -</table> -</div></td> -</tr> -<tr class="even"> -<td>[PARTITION\_REDUNDANT\_HEAP_LRU](region_shortcuts_reference.html#reference_m4n_jpy_lk)</td> -<td><div id="reference_ufj_5kz_4k__p_szq_jc1_nk" class="p"> -data-policy: -PARTITION -</div></td> -<td><p><span class="keyword parmname">Eviction Attributes</span></p> -<div id="reference_ufj_5kz_4k__p_a1r_jc1_nk" class="p"> -<table> -<tbody> -<tr class="odd"> -<td>eviction-algorithm:</td> -<td>lru-heap-percentage</td> -</tr> -<tr class="even"> -<td>eviction-action:</td> -<td>local-destroy</td> -</tr> -</tbody> -</table> -</div> -<div id="reference_ufj_5kz_4k__p_f1r_jc1_nk" class="p"> -<span class="keyword parmname">Partition Attributes</span> -<table> -<tbody> -<tr class="odd"> -<td>redundant-copies:</td> -<td>1</td> -</tr> -</tbody> -</table> -</div></td> -</tr> -<tr class="odd"> -<td><p>[PARTITION\_REDUNDANT\_OVERFLOW](region_shortcuts_reference.html#reference_own_jpy_lk)</p></td> -<td><div id="reference_ufj_5kz_4k__p_n1r_jc1_nk" class="p"> -data-policy: -PARTITION -</div></td> -<td><p><span class="keyword parmname">Eviction Attributes</span></p> -<div id="reference_ufj_5kz_4k__p_w1r_jc1_nk" class="p"> -<table> -<tbody> -<tr class="odd"> -<td>eviction-algorithm:</td> -<td>lru-heap-percentage</td> -</tr> -<tr class="even"> -<td>eviction-action:</td> -<td>overflow-to-disk</td> -</tr> -</tbody> -</table> -</div> -<div id="reference_ufj_5kz_4k__p_bbr_jc1_nk" class="p"> -<span class="keyword parmname">Partition Attributes</span> -<table> -<tbody> -<tr class="odd"> -<td>redundant-copies:</td> -<td>1</td> -</tr> -</tbody> -</table> -</div></td> -</tr> -<tr class="even"> -<td><p>[PARTITION\_REDUNDANT\_PERSISTENT](region_shortcuts_reference.html#reference_bd4_jpy_lk)</p></td> -<td><div id="reference_ufj_5kz_4k__p_jbr_jc1_nk" class="p"> -data-policy: -PERSISTENT\_PARTITION -</div></td> -<td><div id="reference_ufj_5kz_4k__p_pbr_jc1_nk" class="p"> -<span class="keyword parmname">Partition Attributes</span> -<table> -<tbody> -<tr class="odd"> -<td>redundant-copies:</td> -<td>1</td> -</tr> -</tbody> -</table> -</div></td> -</tr> -<tr class="odd"> -<td><p>[PARTITION\_REDUNDANT\_PERSISTENT_OVERFLOW](region_shortcuts_reference.html#reference_xqq_tvc_lk)</p></td> -<td><div id="reference_ufj_5kz_4k__p_xbr_jc1_nk" class="p"> -data-policy: -PERSISTENT\_PARTITION -</div></td> -<td><p><span class="keyword parmname">Eviction Attributes</span></p> -<div id="reference_ufj_5kz_4k__p_fcr_jc1_nk" class="p"> -<table> -<tbody> -<tr class="odd"> -<td>eviction-algorithm:</td> -<td>lru-heap-percentage</td> -</tr> -<tr class="even"> -<td>eviction-action:</td> -<td>overflow-to-disk</td> -</tr> -</tbody> -</table> -</div> -<div id="reference_ufj_5kz_4k__p_lcr_jc1_nk" class="p"> -<span class="keyword parmname">Partition Attributes</span> -<table> -<tbody> -<tr class="odd"> -<td>redundant-copies:</td> -<td>1</td> -</tr> -</tbody> -</table> -</div></td> -</tr> -<tr class="even"> -<td><p>[REPLICATE](region_shortcuts_reference.html#reference_wq4_jpy_lk)</p></td> -<td><div id="reference_ufj_5kz_4k__p_tcr_jc1_nk" class="p"> -data-policy: -REPLICATE -scope: -distributed-ack -</div></td> -<td> </td> -</tr> -<tr class="odd"> -<td><p>[REPLICATE\_HEAP\_LRU](region_shortcuts_reference.html#reference_xx4_jpy_lk)</p></td> -<td><div id="reference_ufj_5kz_4k__p_cdr_jc1_nk" class="p"> -data-policy: -PRELOADED -scope: -distributed-ack -</div></td> -<td><p><span class="keyword parmname">Eviction Attributes</span></p> -<div id="reference_ufj_5kz_4k__p_ldr_jc1_nk" class="p"> -<table> -<colgroup> -<col width="50%" /> -<col width="50%" /> -</colgroup> -<tbody> -<tr class="odd"> -<td>eviction-algorithm:</td> -<td>lru-heap-percentage</td> -</tr> -<tr class="even"> -<td>eviction-action:</td> -<td>local-destroy -<div class="note note"> -**Note:** -<p>Normally, you cannot have a <code class="ph codeph">local-destroy</code> 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.</p> -</div></td> -</tr> -</tbody> -</table> -</div> -<span class="keyword parmname">Subscription Attributes</span> -<div id="reference_ufj_5kz_4k__p_pdr_jc1_nk" class="p"> -<table> -<tbody> -<tr class="odd"> -<td>interest-policy:</td> -<td>all</td> -</tr> -</tbody> -</table> -</div></td> -</tr> -<tr class="even"> -<td><p>[REPLICATE_OVERFLOW](region_shortcuts_reference.html#reference_t2p_jpy_lk)</p></td> -<td><div id="reference_ufj_5kz_4k__p_wdr_jc1_nk" class="p"> -data-policy: -REPLICATE -scope: -distributed-ack -</div></td> -<td><p><span class="keyword parmname">Eviction Attributes</span></p> -<div id="reference_ufj_5kz_4k__p_f2r_jc1_nk" class="p"> -<table> -<tbody> -<tr class="odd"> -<td>eviction-algorithm:</td> -<td>lru-heap-percentage</td> -</tr> -<tr class="even"> -<td>eviction-action:</td> -<td>overflow-to-disk</td> -</tr> -</tbody> -</table> -</div></td> -</tr> -<tr class="odd"> -<td><p>[REPLICATE_PERSISTENT](region_shortcuts_reference.html#reference_emp_jpy_lk)</p></td> -<td><div id="reference_ufj_5kz_4k__p_n2r_jc1_nk" class="p"> -data-policy: -PERSISTENT\_REPLICATE -scope: -distributed-ack -</div></td> -<td> </td> -</tr> -<tr class="even"> -<td><p>[REPLICATE\_PERSISTENT\_OVERFLOW](region_shortcuts_reference.html#reference_tsp_jpy_lk)</p></td> -<td><div id="reference_ufj_5kz_4k__p_w2r_jc1_nk" class="p"> -data-policy: -PERSISTENT\_REPLICATE -scope: -distributed-ack -</div></td> -<td><p><span class="keyword parmname">Eviction Attributes</span></p> -<div id="reference_ufj_5kz_4k__p_gfr_jc1_nk" class="p"> -<table> -<tbody> -<tr class="odd"> -<td>eviction-algorithm:</td> -<td>lru-heap-percentage</td> -</tr> -<tr class="even"> -<td>eviction-action:</td> -<td>overflow-to-disk</td> -</tr> -</tbody> -</table> -</div></td> -</tr> -<tr class="odd"> -<td><p>[REPLICATE_PROXY](region_shortcuts_reference.html#reference_n1q_jpy_lk)</p></td> -<td><div id="reference_ufj_5kz_4k__p_pfr_jc1_nk" class="p"> -data-policy: -EMPTY -scope: -distributed-ack -</div></td> -<td> </td> -</tr> -</tbody> -</table> - -<span class="tablecap">Table 1. Region Shortcuts Default Configurations</span> - - http://git-wip-us.apache.org/repos/asf/geode-native/blob/ff80a931/geode-docs/rest_apps/book_intro.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/book_intro.html.md.erb b/geode-docs/rest_apps/book_intro.html.md.erb deleted file mode 100644 index a1cf48a..0000000 --- a/geode-docs/rest_apps/book_intro.html.md.erb +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Developing REST Applications for Apache Geode ---- - -*Developing REST Applications for Apache Geode* provides background and instructions on how to program REST applications with Apache Geode. Geode REST APIs allow you to access region data, queries and functions in your Geode deployment in wide variety of programming languages. - -**Note:** -This documentation covers the **v1** release of Geode REST APIs for developing applications. - -- **[Geode REST API Overview](../rest_apps/chapter_overview.html)** - - By using the Geode REST application interface, you can immediately access Geode's data management capabilities in languages other than the natively supported Java language. - -- **[Prerequisites and Limitations for Writing REST Applications](../rest_apps/rest_prereqs.html)** - - Before development, understand the prerequisites and limitations of the current REST implementation in Geode. - -- **[Setup and Configuration](../rest_apps/setup_config.html)** - - The Apache Geode developer REST interface runs as an embedded HTTP or HTTPS service (Jetty server) within a Geode data node. - -- **[Using the Swagger UI to Browse REST APIs](../rest_apps/using_swagger.html)** - - Apache Geode Developer REST APIs are integrated with the Swagger⢠framework. This framework provides a browser-based test client that allows you to visualize and try out Geode REST APIs. - -- **[Developing REST Applications](../rest_apps/develop_rest_apps.html)** - - This section provides guidelines on writing REST client applications for Geode. - -- **[Sample REST Applications](../rest_apps/rest_examples.html)** - - This section provides examples that illustrate how multiple clients, both REST and native, can access the same Geode region data. - -- **[Troubleshooting and FAQ](../rest_apps/troubleshooting.html)** - - This section provides troubleshooting guidance and frequently asked questions about Geode Developer REST APIs. - -- **[Apache Geode REST API Reference](../rest_apps/rest_api_reference.html)** - - This section summarizes all available Apache Geode REST API resources and endpoints. - - http://git-wip-us.apache.org/repos/asf/geode-native/blob/ff80a931/geode-docs/rest_apps/chapter_overview.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/chapter_overview.html.md.erb b/geode-docs/rest_apps/chapter_overview.html.md.erb deleted file mode 100644 index 10dfe77..0000000 --- a/geode-docs/rest_apps/chapter_overview.html.md.erb +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Geode REST API Overview ---- - -By using the Geode REST application interface, you can immediately access Geode's data management capabilities in languages other than the natively supported Java language. - -You can write REST-enabled client applications for Geode in a variety of languages that use the open and standard HTTP protocol-- for example, Ruby, Python, JavaScript and Scala, as well as already supported languages such as Java. - -When you access Geode through the REST interface, objects are stored in Geode as PdxInstances. A PdxInstance is a light-weight wrapper around PDX serialized bytes. It provides applications with run-time access to fields of a PDX serialized object. This interoperable format allows your Java applications to operate on the same data as your REST applications. - -As an added benefit, because Geode's REST interface stores objects as PdxInstances, you do not need to write corresponding Java classes to translate JSON data (which you must do with other REST interface providers such as Oracle Coherence.) For example, consider the use case where a non-Java REST client application (Python, Ruby or Scala) performs Geode region operations with JSON data that represents employee data. Since the object is stored in Geode as a PdxInstance that can be automatically mapped to JSON, the user does not need to write a corresponding Employee.java class and also does not need to worry about related issues such as keeping the Employee object in the CLASSPATH. - -See [Geode PDX Serialization](../developing/data_serialization/gemfire_pdx_serialization.html#gemfire_pdx_serialization) for more information on PDX serialization. - - http://git-wip-us.apache.org/repos/asf/geode-native/blob/ff80a931/geode-docs/rest_apps/delete_all_data.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/delete_all_data.html.md.erb b/geode-docs/rest_apps/delete_all_data.html.md.erb deleted file mode 100644 index af2f2be..0000000 --- a/geode-docs/rest_apps/delete_all_data.html.md.erb +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: DELETE /gemfire-api/v1/{region} ---- - -Delete all entries in the region. - -## Resource URL - -``` pre -http://<hostname_or_http-service-bind-address>:<http-service-port>/gemfire-api/v1/{region} -``` - -## Parameters - -None. - -## Example Request - -``` pre -Request Payload: null -DELETE /gemfire-api/v1/orders -Accept: application/json -``` - -## Example Success Response - -``` pre -Response Payload: null -200 OK -``` - -## Error Codes - -| Status Code | Description | -|---------------------------|----------------------------------------------------------------------------------------------------------------------------------| -| 404 NOT FOUND | Returned if the region is not found. | -| 500 INTERNAL SERVER ERROR | Error encountered at Geode server. Check the HTTP response body for a stack trace of the exception. | - - http://git-wip-us.apache.org/repos/asf/geode-native/blob/ff80a931/geode-docs/rest_apps/delete_data_for_key.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/delete_data_for_key.html.md.erb b/geode-docs/rest_apps/delete_data_for_key.html.md.erb deleted file mode 100644 index 4be5fa8..0000000 --- a/geode-docs/rest_apps/delete_data_for_key.html.md.erb +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: DELETE /gemfire-api/v1/{region}/{key} ---- - -Delete entry for specified key in the region. - -## Resource URL - -``` pre -http://<hostname_or_http-service-bind-address>:<http-service-port>/gemfire-api/v1/{region}/{key} -``` - -## Parameters - -None. - -## Example Request - -``` pre -Request Payload: null -DELETE /gemfire-api/v1/orders/11 -Accept: application/json -``` - -## Example Success Response - -``` pre -Response Payload: null -200 OK -``` - -## Error Codes - -| Status Code | Description | -|---------------------------|----------------------------------------------------------------------------------------------------------------------------------| -| 404 NOT FOUND | Returned if the region or specified key is not found. | -| 500 INTERNAL SERVER ERROR | Error encountered at Geode server. Check the HTTP response body for a stack trace of the exception. | - - http://git-wip-us.apache.org/repos/asf/geode-native/blob/ff80a931/geode-docs/rest_apps/delete_data_for_multiple_keys.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/delete_data_for_multiple_keys.html.md.erb b/geode-docs/rest_apps/delete_data_for_multiple_keys.html.md.erb deleted file mode 100644 index 7a2ec38..0000000 --- a/geode-docs/rest_apps/delete_data_for_multiple_keys.html.md.erb +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: DELETE /gemfire-api/v1/{region}/{key1},{key2},...{keyN} ---- - -Delete entries for multiple keys in the region. - -## Resource URL - -``` pre -http://<hostname_or_http-service-bind-address>:<http-service-port>/gemfire-api/v1/{region}/{key1},{key2},...{keyN} -``` - -## Parameters - -None. - -## Example Request - -``` pre -Request Payload: null -DELETE /gemfire-api/v1/orders/12,13 -Accept: application/json -``` - -## Example Success Response - -``` pre -Response Payload: null -200 OK -``` - -## Error Codes - -| Status Code | Description | -|---------------------------|----------------------------------------------------------------------------------------------------------------------------------| -| 404 NOT FOUND | Returned if either the region or one or more of the specified keys is not found. | -| 500 INTERNAL SERVER ERROR | Error encountered at Geode server. Check the HTTP response body for a stack trace of the exception. | - - http://git-wip-us.apache.org/repos/asf/geode-native/blob/ff80a931/geode-docs/rest_apps/delete_named_query.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/rest_apps/delete_named_query.html.md.erb b/geode-docs/rest_apps/delete_named_query.html.md.erb deleted file mode 100644 index e8b520f..0000000 --- a/geode-docs/rest_apps/delete_named_query.html.md.erb +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: DELETE /gemfire-api/v1/queries/{queryId} ---- - -Delete the specified named query. - -## Resource URL - -``` pre -http://<hostname_or_http-service-bind-address>:<http-service-port>/gemfire-api/v1/queries/{query} -``` - -## Parameters - -| Parameter | Description | Example Values | -|-----------|------------------------------------|----------------| -| {queryId} | QueryID for named query to delete. | selectOrders | - -## Example Request - -``` pre -DELETE /gemfire-api/v1/queries/selectOrders - -Accept: application/json -Content-Type: application/json -``` - -## Example Success Response - -``` pre -Response Payload: application/json - -200 OK -``` - -## Error Codes - -| Status Code | Description | -|---------------------------|-----------------------------------------------------------------------------------------------| -| 404 NOT FOUND | Query with specified ID could not be found. | -| 500 INTERNAL SERVER ERROR | Encountered error at server. Check the HTTP response body for a stack trace of the exception. | - -
