GEODE-2045 Improve docs of region shortcuts - Make sure that partitioned regions do not say or imply that they have local scope. - Fix labels with anchors, such that links work. - Remove reference links to general descriptions of the attributes used by the shortcuts.
Project: http://git-wip-us.apache.org/repos/asf/incubator-geode/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-geode/commit/820f33e4 Tree: http://git-wip-us.apache.org/repos/asf/incubator-geode/tree/820f33e4 Diff: http://git-wip-us.apache.org/repos/asf/incubator-geode/diff/820f33e4 Branch: refs/heads/feature/GEODE-1930 Commit: 820f33e40db18d743663fee0ddbec974288671c4 Parents: 6d78cf2 Author: Karen Miller <kmil...@pivotal.io> Authored: Mon Oct 31 12:12:28 2016 -0700 Committer: Karen Miller <kmil...@pivotal.io> Committed: Tue Nov 1 09:30:25 2016 -0700 ---------------------------------------------------------------------- .../region_shortcuts_reference.html.md.erb | 387 ++++++------------- .../topics/region_shortcuts_table.html.md.erb | 2 +- 2 files changed, 126 insertions(+), 263 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/820f33e4/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 index d5cb2fa..d1af590 100644 --- a/geode-docs/reference/topics/region_shortcuts_reference.html.md.erb +++ b/geode-docs/reference/topics/region_shortcuts_reference.html.md.erb @@ -21,18 +21,13 @@ limitations under the License. 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" class="no-quick-link"></a>LOCAL -### <a id="reference_w2h_3cd_lk__section_36EBE4321D89491A96865922A41813FB" class="no-quick-link"></a>Description +### 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 +### Default Attributes <span class="keyword parmname">Region Attributes</span> @@ -41,7 +36,7 @@ For more information, see: | scope: | local | | data-policy: | NORMAL | -### <a id="reference_w2h_3cd_lk__section_FF6CC3A9EB9D4705A68ED9B345900D6A" class="no-quick-link"></a>gfsh Command Example +### gfsh Command Example ``` pre gfsh>create region --name=myLOCALregion --type=LOCAL @@ -63,7 +58,7 @@ 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> +### XML Definition of <span class="keyword parmname">LOCAL</span> ``` pre <region name="myLOCALregion"> @@ -71,18 +66,13 @@ Region | data-policy | NORMAL </region> ``` -## <span class="keyword parmname">LOCAL\_HEAP\_LRU</span> +## <a id="reference_wd5_lpy_lk" class="no-quick-link"></a>LOCAL\_HEAP\_LRU -### <a id="reference_wd5_lpy_lk__section_2FA756DED1494EADA5E0061B365638EF" class="no-quick-link"></a>Description +### 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 +### Default Attributes <span class="keyword parmname">Region Attributes</span> @@ -98,7 +88,7 @@ For more information, see: | 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 +### gfsh Command Example ``` pre gfsh>create region --name=myLHLregion --type=LOCAL_HEAP_LRU @@ -122,7 +112,7 @@ 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> +### XML Definition of <span class="keyword parmname">LOCAL\_HEAP\_LRU</span> ``` pre <region name="myLHLregion"> @@ -140,19 +130,13 @@ Eviction | eviction-algorithm | lru-heap-percentage </region> ``` -## <span class="keyword parmname">LOCAL\_OVERFLOW</span> +## <a id="reference_adk_y4y_lk" class="no-quick-link"></a>LOCAL\_OVERFLOW -### <a id="reference_adk_y4y_lk__section_7EDCA6AB41E24F4BA63EC083224E93B5" class="no-quick-link"></a>Description +### 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 +### Default Attributes <span class="keyword parmname">Region Attributes</span> @@ -168,7 +152,7 @@ For more information, see: | 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 +### gfsh Command Example ``` pre gfsh>create region --name=myLOregion --type=LOCAL_OVERFLOW @@ -192,7 +176,7 @@ 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> +### XML Definition of <span class="keyword parmname">LOCAL\_OVERFLOW</span> ``` pre <region name="myLOregion"> @@ -206,18 +190,13 @@ Eviction | eviction-algorithm | lru-heap-percentage </region> ``` -## <span class="keyword parmname">LOCAL\_PERSISTENT</span> +## <a id="reference_l5r_y4y_lk" class="no-quick-link"></a>LOCAL\_PERSISTENT -### <a id="reference_l5r_y4y_lk__section_CBC85A6AEF944EBC9C7B7A414D90B286" class="no-quick-link"></a>Description +### 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 +### Default Attributes <span class="keyword parmname">Region Attributes</span> @@ -226,7 +205,7 @@ For more information, see: | scope: | local | | data-policy: | PERSISTENT_REPLICATE | -### <a id="reference_l5r_y4y_lk__section_E41981F332664D48A3914D4BEEC50902" class="no-quick-link"></a>gfsh Command Example +### gfsh Command Example ``` pre gfsh>create region --name=myLPregion --type=LOCAL_PERSISTENT @@ -249,7 +228,7 @@ Non-Default Attributes Shared By Hosting Members 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> +### XML Definition of <span class="keyword parmname">LOCAL\_PERSISTENT</span> ``` pre <region name="myLPregion"> @@ -259,18 +238,14 @@ Region | size | 0 </region> ``` -## <span class="keyword parmname">LOCAL\_PERSISTENT\_OVERFLOW</span> +## <a id="reference_a45_y4y_lk" class="no-quick-link"></a>LOCAL\_PERSISTENT\_OVERFLOW -### <a id="reference_a45_y4y_lk__section_9D76AA9F92AC461C8702945AE990303E" class="no-quick-link"></a>Description +### 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 +### Default Attributes <span class="keyword parmname">Region Attributes</span> @@ -286,7 +261,7 @@ For more information, see: | 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 +### gfsh Command Example ``` pre gfsh>create region --name=myLPOregion --type=LOCAL_PERSISTENT_OVERFLOW @@ -311,7 +286,7 @@ 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> +### XML Definition of <span class="keyword parmname">LOCAL\_PERSISTENT\_OVERFLOW</span> ``` pre <region name="myLPOregion"> @@ -325,20 +300,13 @@ Eviction | eviction-algorithm | lru-heap-percentage </region-attributes> </region> ``` +## <a id="reference_ow5_4qy_lk" class="no-quick-link"></a>PARTITION -## <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: +### Description -- [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 region configured with the <span class="keyword parmname">PARTITION</span> region shortcut is partitioned across each peer member that created the region. -### <a id="reference_ow5_4qy_lk__section_8F8F7C54F95B41D79ED814717E62961E" class="no-quick-link"></a>Default Attributes +### Default Attributes <span class="keyword parmname">Region Attributes</span> @@ -346,7 +314,7 @@ For more information, see: |----|----| | data-policy: | PARTITION | -### <a id="reference_ow5_4qy_lk__section_7989417AE95E4B5F8569CD545663A33D" class="no-quick-link"></a>gfsh Command Example +### gfsh Command Example ``` pre gfsh>create region --name=myPregion --type=PARTITION @@ -369,7 +337,7 @@ Non-Default Attributes Shared By Hosting Members 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> +### XML Definition of PARTITION ``` pre <region name="myPregion"> @@ -378,20 +346,13 @@ Region | size | 0 </region> ``` -## <span class="keyword parmname">PARTITION\_HEAP\_LRU</span> +## <a id="reference_twx_y4y_lk" class="no-quick-link"></a>PARTITION\_HEAP\_LRU -### <a id="reference_twx_y4y_lk__section_AC539D91DDBC4CC5B7F5E12190ECAD01" class="no-quick-link"></a>Description +### 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. +A region configured with <span class="keyword parmname">PARTITION\_HEAP\_LRU</span> 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 +### Default Attributes <span class="keyword parmname">Region Attributes</span> @@ -406,7 +367,7 @@ For more information, see: | 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 +### gfsh Command Example ``` pre gfsh>create region --name=myPHLregion --type=PARTITION_HEAP_LRU @@ -431,7 +392,7 @@ 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> +### XML Definition of <span class="keyword parmname">PARTITION\_HEAP\_LRU</span> ``` pre <region name="myPHLregion"> @@ -447,20 +408,13 @@ Eviction | eviction-algorithm | lru-heap-percentage </region> ``` -## <span class="keyword parmname">PARTITION\_OVERFLOW</span> - -### <a id="reference_js1_z4y_lk__section_2D3C2F9081DF4102826B8A1273FE1A4D" class="no-quick-link"></a>Description +## <a id="reference_js1_z4y_lk" class="no-quick-link"></a>PARTITION\_OVERFLOW -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. +### Description -For more information, see: +A region configured with the <span class="keyword parmname">PARTITION\_OVERFLOW</span> region shortcut has state that is partitioned across each peer member that creates the region. The region moves the values of entries to disk when it detects that the JVM is running low on memory. -- [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 +### Default Attributes <span class="keyword parmname">Region Attributes</span> @@ -475,7 +429,7 @@ For more information, see: | 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 +### gfsh Command Example ``` pre gfsh>create region --name=myPOregion --type=PARTITION_OVERFLOW @@ -500,7 +454,7 @@ 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> +### XML Definition of <span class="keyword parmname">PARTITION\_OVERFLOW</span> ``` pre <region name="myPOregion"> @@ -514,20 +468,13 @@ Eviction | eviction-algorithm | lru-heap-percentage </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. +## <a id="reference_d4k_jpy_lk" class="no-quick-link"></a>PARTITION\_PERSISTENT -For more information, see: +### Description -- [RegionShortcuts for Peers and Servers](../../basic_config/data_regions/region_shortcuts.html#region_shortcuts__section_D0975C76572E41F79C1A6EE7CF371251) +A region configured with the <span class="keyword parmname">PARTITION\_PERSISTENT</span> region shortcut has state that is partitioned across each peer member that creates the region. The region writes its state to disk and can recover that state when the member restarts. -- [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 +### Default Attributes <span class="keyword parmname">Region Attributes</span> @@ -535,7 +482,7 @@ For more information, see: |----|----| | data-policy: | PERSISTENT_PARTITION | -### <a id="reference_d4k_jpy_lk__section_F2B651B4803341E3991F554544EF8551" class="no-quick-link"></a>gfsh Command Example +### gfsh Command Example ``` pre gfsh>create region --name=myPPregion --type=PARTITION_PERSISTENT @@ -558,7 +505,7 @@ Non-Default Attributes Shared By Hosting Members 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> +### XML Definition of <span class="keyword parmname">PARTITION\_PERSISTENT</span> ``` pre <region name="myPPregion"> @@ -567,19 +514,13 @@ Region | size | 0 </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. +## <a id="reference_v5l_jpy_lk" class="no-quick-link"></a>PARTITION\_PERSISTENT\_OVERFLOW -For more information, see: +### Description -- [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 region configured with the <span class="keyword parmname">PARTITION\_PERSISTENT\_OVERFLOW</span> region shortcut has state that is partitioned across each peer member that creates 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. -### <a id="reference_v5l_jpy_lk__section_3A5BF41715ED499193A42119F9F4C8B8" class="no-quick-link"></a>Default Attributes +### Default Attributes <span class="keyword parmname">Region Attributes</span> @@ -594,7 +535,7 @@ For more information, see: | 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 +### gfsh Command Example ``` pre gfsh>create region --name=myPPOregion --type=PARTITION_PERSISTENT_OVERFLOW @@ -619,7 +560,7 @@ 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> +### XML Definition of <span class="keyword parmname">PARTITION\_PERSISTENT\_OVERFLOW</span> ``` pre <region name="myPPOregion"> @@ -633,18 +574,13 @@ Eviction | eviction-algorithm | lru-heap-percentage </region> ``` -## <span class="keyword parmname">PARTITION\_PROXY</span> +## <a id="reference_v4m_jpy_lk" class="no-quick-link"></a>PARTITION\_PROXY -### <a id="reference_v4m_jpy_lk__section_90846BE9CEC64883B03F83312A0876FB" class="no-quick-link"></a>Description +### 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 +### Default Attributes <span class="keyword parmname">Region Attributes</span> @@ -658,7 +594,7 @@ See: |-------------------|-----| | local-max-memory: | 0 | -### <a id="reference_v4m_jpy_lk__section_1BDB4F2D00644B0B9C69D2F1F89C409E" class="no-quick-link"></a>gfsh Command Example +### gfsh Command Example ``` pre gfsh>create region --name=myPPXYregion --type=PARTITION_PROXY @@ -682,7 +618,7 @@ 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> +### XML Definition of <span class="keyword parmname">PARTITION\_PROXY</span> ``` pre <region name="myPPXYregion"> @@ -694,18 +630,13 @@ Partition | local-max-memory | 0 </region> ``` -## <span class="keyword parmname">PARTITION\_PROXY\_REDUNDANT</span> +## <a id="reference_c1n_jpy_lk" class="no-quick-link"></a>PARTITION\_PROXY\_REDUNDANT -### <a id="reference_c1n_jpy_lk__section_DB38EA21A67C42AFB10FBA19320F9F2C" class="no-quick-link"></a>Description +### 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 +### Default Attributes <span class="keyword parmname">Region Attributes</span> @@ -720,7 +651,7 @@ See: | redundant-copies: | 1 | | local-max-memory | 0 | -### <a id="reference_c1n_jpy_lk__section_D385EB36652A4E25B240C0A1BF91117E" class="no-quick-link"></a>gfsh Command Example +### gfsh Command Example ``` pre gfsh>create region --name=myPPRregion --type=PARTITION_PROXY_REDUNDANT @@ -745,7 +676,7 @@ 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> +### XML Definition of <span class="keyword parmname">PARTITION\_PROXY\_REDUNDANT</span> ``` pre <region name="myPPRregion"> @@ -758,18 +689,13 @@ Partition | redundant-copies | 1 </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. +## <a id="reference_shn_jpy_lk" class="no-quick-link"></a>PARTITION\_REDUNDANT -See: +### Description -- [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 region configured with the <span class="keyword parmname">PARTITION\_REDUNDANT</span> region shortcut has state that is partitioned across each peer member that creates the region. The region maintains an extra copy of the data in memory. -### <a id="reference_shn_jpy_lk__section_5F453E9AC5094AE6AA4FF111A7E5DB75" class="no-quick-link"></a>Default Attributes +### Default Attributes <span class="keyword parmname">Region Attributes</span> @@ -783,7 +709,7 @@ See: |-------------------|-----| | redundant-copies: | 1 | -### <a id="reference_shn_jpy_lk__section_75BDE5C09ABD40CCBBC61B3D1D2DF7CA" class="no-quick-link"></a>gfsh Command Example +### gfsh Command Example ``` pre gfsh>create region --name=myPRregion --type=PARTITION_REDUNDANT @@ -807,7 +733,7 @@ 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> +### XML Definition of <span class="keyword parmname">PARTITION\_REDUNDANT</span> ``` pre <region name="myPRregion"> @@ -819,21 +745,13 @@ Partition | redundant-copies | 1 </region> ``` -## <span class="keyword parmname">PARTITION\_REDUNDANT\_HEAP\_LRU</span> +## <a id="reference_m4n_jpy_lk" class="no-quick-link"></a>PARTITION\_REDUNDANT\_HEAP\_LRU -### <a id="reference_m4n_jpy_lk__section_3EE028397BF149C98156ECF677D10802" class="no-quick-link"></a>Description +### 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. +A region configured with the <span class="keyword parmname">PARTITION\_REDUNDANT\_HEAP\_LRU</span> region shortcut has state that is partitioned across each peer member that creates 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 +### Default Attributes <span class="keyword parmname">Region Attributes</span> @@ -854,7 +772,7 @@ For more information, see: |-------------------|-----| | redundant-copies: | 1 | -### <a id="reference_m4n_jpy_lk__section_A3C8919EF7DF4B17AD0C3F31254B7340" class="no-quick-link"></a>gfsh Command Example +### gfsh Command Example ``` pre gfsh>create region --name=myPRHLregion --type=PARTITION_REDUNDANT_HEAP_LRU @@ -880,7 +798,7 @@ Eviction | eviction-algorithm | lru-heap-percentage 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> +### XML Definition of <span class="keyword parmname">PARTITION\_REDUNDANT\_HEAP\_LRU</span> ``` pre <region name="myPRHLregion"> @@ -898,21 +816,13 @@ Partition | redundant-copies | 1 </region> ``` -## <span class="keyword parmname">PARTITION\_REDUNDANT\_OVERFLOW</span> - -### <a id="reference_own_jpy_lk__section_B547C6D2F1B140A1ABAB1F45AD0D92F2" class="no-quick-link"></a>Description +## <a id="reference_own_jpy_lk" class="no-quick-link"></a>PARTITION\_REDUNDANT\_OVERFLOW -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. +### Description -For more information, see: +A region configured with the <span class="keyword parmname">PARTITION\_REDUNDANT\_OVERFLOW</span> region shortcut has state that is partitioned across each peer member that creates 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. -- [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 +### Default Attributes <span class="keyword parmname">Region Attributes</span> @@ -933,7 +843,7 @@ For more information, see: |-------------------|-----| | redundant-copies: | 1 | -### <a id="reference_own_jpy_lk__section_C131CE53EFAF4C6DA03D3B30607FB715" class="no-quick-link"></a>gfsh Command Example +### gfsh Command Example ``` pre gfsh>create region --name=myPROregion --type=PARTITION_REDUNDANT_OVERFLOW @@ -959,7 +869,7 @@ Eviction | eviction-algorithm | lru-heap-percentage 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> +### XML Definition of <span class="keyword parmname">PARTITION\_REDUNDANT\_OVERFLOW</span> ``` pre <region name="myPROregion"> @@ -975,19 +885,13 @@ Partition | redundant-copies | 1 </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. +## <a id="reference_bd4_jpy_lk" class="no-quick-link"></a>PARTITION\_REDUNDANT\_PERSISTENT -For more information, see: +### Description -- [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 region configured with the <span class="keyword parmname">PARTITION\_REDUNDANT\_PERSISTENT</span> region shortcut has state that is partitioned across each peer member that creates 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. -### <a id="reference_bd4_jpy_lk__section_390DABC994794F9C9FF19A50B8E53D71" class="no-quick-link"></a>Default Attributes +### Default Attributes <span class="keyword parmname">Region Attributes</span> @@ -1001,7 +905,7 @@ For more information, see: |-------------------|-----| | redundant-copies: | 1 | -### <a id="reference_bd4_jpy_lk__section_8D226B0DB7B04878850B2A14BE0EA409" class="no-quick-link"></a>gfsh Command Example +### gfsh Command Example ``` pre gfsh>create region --name=myPRPregion --type=PARTITION_REDUNDANT_PERSISTENT @@ -1025,7 +929,7 @@ 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> +### XML Definition of <span class="keyword parmname">PARTITION\_REDUNDANT\_PERSISTENT</span> ``` pre <region name="myPRPregion"> @@ -1037,19 +941,13 @@ Partition | redundant-copies | 1 </region> ``` -## <span class="keyword parmname">PARTITION\_REDUNDANT\_PERSISTENT\_OVERFLOW</span> +## <a id="reference_xqq_tvc_lk" class="no-quick-link"></a>PARTITION\_REDUNDANT\_PERSISTENT\_OVERFLOW -### <a id="reference_xqq_tvc_lk__section_27D3FA56EF3D4A6F9BF1EFF86C0EBBC2" class="no-quick-link"></a>Description +### 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. +A region configured with the <span class="keyword parmname">PARTITION\_REDUNDANT\_PERSISTENT\_OVERFLOW</span> region shortcut has state that is partitioned across each peer member that creates 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 +### Default Attributes <span class="keyword parmname">Region Attributes</span> @@ -1070,7 +968,7 @@ For more information, see: |-------------------|-----| | redundant-copies: | 1 | -### <a id="reference_xqq_tvc_lk__section_7D4A02096A9D4F119C58125D3ECA1965" class="no-quick-link"></a>gfsh Command Example +### gfsh Command Example ``` pre create region --name=myPRPOregion --type=PARTITION_REDUNDANT_PERSISTENT_OVERFLOW @@ -1094,7 +992,7 @@ Eviction | eviction-algorithm | lru-heap-percentage 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> +### XML Definition of <span class="keyword parmname">PARTITION\_REDUNDANT\_PERSISTENT\_OVERFLOW</span> ``` pre <region name="myPRPOregion"> @@ -1110,19 +1008,13 @@ Partition | redundant-copies | 1 </region> ``` -## <span class="keyword parmname">REPLICATE</span> +## <a id="reference_wq4_jpy_lk" class="no-quick-link"></a>REPLICATE -### <a id="reference_wq4_jpy_lk__section_FBCA755812B9401D8EB1F94C062A207D" class="no-quick-link"></a>Description +### 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 +### Default Attributes <span class="keyword parmname">Region Attributes</span> @@ -1131,7 +1023,7 @@ For more information, see: | scope: | distributed-ack | | data-policy: | REPLICATE | - ### <a id="reference_wq4_jpy_lk__section_91941611D45D45609402EF2D1E5A7885" class="no-quick-link"></a>gfsh Command Example +### gfsh Command Example ``` pre gfsh>create region --name=myRregion --type=REPLICATE @@ -1146,7 +1038,7 @@ 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> +### XML Definition of <span class="keyword parmname">REPLICATE</span> ``` pre <region name="myRregion"> @@ -1156,22 +1048,16 @@ server2 | Region "/myRregion" created on "server2" </region> ``` -## <span class="keyword parmname">REPLICATE\_HEAP\_LRU</span> +## <a id="reference_xx4_jpy_lk" class="no-quick-link"></a>REPLICATE\_HEAP\_LRU -### <a id="reference_xx4_jpy_lk__section_DEAA6152FA324D5B8A266294FA8ADBF7" class="no-quick-link"></a>Description +### 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 +### Default Attributes <span class="keyword parmname">Region Attributes</span> @@ -1207,7 +1093,7 @@ For more information, see: |------------------|-----| | interest-policy: | all | -### <a id="reference_xx4_jpy_lk__section_34CA13FA44C94181B57AF30A9CE5A0FD" class="no-quick-link"></a>gfsh Command Example +### gfsh Command Example ``` pre gfsh>create region --name=myRHLregion --type=REPLICATE_HEAP_LRU @@ -1232,7 +1118,7 @@ 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> +### XML Definition of <span class="keyword parmname">REPLICATE\_HEAP\_LRU</span> ``` pre <region name="myRHLregion"> @@ -1251,19 +1137,13 @@ Eviction | eviction-algorithm | lru-heap-percentage </region> ``` -## <span class="keyword parmname">REPLICATE\_OVERFLOW</span> +## <a id="reference_t2p_jpy_lk" class="no-quick-link"></a>REPLICATE\_OVERFLOW -### <a id="reference_t2p_jpy_lk__section_7980E9B8EE1049CEB7ABF243B068E1BB" class="no-quick-link"></a>Description +### 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 +### Default Attributes <span class="keyword parmname">Region Attributes</span> @@ -1279,7 +1159,7 @@ For more information, see: | 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 +### gfsh Command Example ``` pre gfsh>create region --name=myROregion --type=REPLICATE_OVERFLOW @@ -1304,7 +1184,7 @@ 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> +### XML Definition of <span class="keyword parmname">REPLICATE\_OVERFLOW</span> ``` pre <region name="myROregion"> @@ -1319,19 +1199,13 @@ Eviction | eviction-algorithm | lru-heap-percentage </region> ``` -## <span class="keyword parmname">REPLICATE\_PERSISTENT</span> +## <a id="reference_emp_jpy_lk" class="no-quick-link"></a>REPLICATE\_PERSISTENT -### <a id="reference_emp_jpy_lk__section_4DCA5EAD6CDB482CB0BC7F543686C9B2" class="no-quick-link"></a>Description +### 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 +### Default Attributes <span class="keyword parmname">Region Attributes</span> @@ -1340,7 +1214,7 @@ For more information, see: | scope: | distributed-ack | | data-policy: | PERSISTENT_REPLICATE | -### <a id="reference_emp_jpy_lk__section_71C90F066BDC4013B8AB7B68D4766B5B" class="no-quick-link"></a>gfsh Command Example +### gfsh Command Example ``` pre gfsh>create region --name=myRPregion --type=REPLICATE_PERSISTENT @@ -1363,7 +1237,7 @@ Non-Default Attributes Shared By Hosting Members 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> +### XML Definition of <span class="keyword parmname">REPLICATE\_PERSISTENT</span> ``` pre <region name="myRPregion"> @@ -1373,19 +1247,13 @@ Region | size | 0 </region> ``` -## <span class="keyword parmname">REPLICATE\_PERSISTENT\_OVERFLOW</span> +## <a id="reference_tsp_jpy_lk" class="no-quick-link"></a>REPLICATE\_PERSISTENT\_OVERFLOW -### <a id="reference_tsp_jpy_lk__section_74EF03750D3A4531A6276F88071E62F0" class="no-quick-link"></a>Description +### 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 +### Default Attributes <span class="keyword parmname">Region Attributes</span> @@ -1401,7 +1269,7 @@ For more information, see: | 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 +### gfsh Command Example ``` pre gfsh>create region --name=myRPOregion --type=REPLICATE_PERSISTENT @@ -1430,7 +1298,7 @@ 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> +### XML Definition of <span class="keyword parmname">REPLICATE\_PERSISTENT\_OVERFLOW</span> ``` pre <region name="myRPOregion"> @@ -1445,18 +1313,13 @@ Eviction | eviction-algorithm | lru-heap-percentage </region> ``` -## <span class="keyword parmname">REPLICATE\_PROXY</span> +## <a id="reference_n1q_jpy_lk" class="no-quick-link"></a>REPLICATE\_PROXY</span> -### <a id="reference_n1q_jpy_lk__section_71E08A97BCFD4CD59032843064BD202A" class="no-quick-link"></a>Description +### 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 +### Default Attributes <span class="keyword parmname">Region Attributes</span> @@ -1465,7 +1328,7 @@ For more information, see: | scope: | distributed-ack | | data-policy: | EMPTY | -### <a id="reference_n1q_jpy_lk__section_4AE0D8F15CAC4CFD8198007BCF91FA85" class="no-quick-link"></a>gfsh Command Example +### gfsh Command Example ``` pre gfsh>create region --name=myRPXYregion --type=REPLICATE_PROXY @@ -1488,7 +1351,7 @@ Non-Default Attributes Shared By Accessor Members 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> +### XML Definition of <span class="keyword parmname">REPLICATE\_PROXY</span> ``` pre <region name="myRPXYregion"> http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/820f33e4/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 index c0ead67..2571846 100644 --- a/geode-docs/reference/topics/region_shortcuts_table.html.md.erb +++ b/geode-docs/reference/topics/region_shortcuts_table.html.md.erb @@ -42,7 +42,7 @@ This section provides a quick reference for all region shortcuts. </thead> <tbody> <tr class="odd"> -<td><p><a href="region_shortcuts_reference.html#reference_w2h_3cd_lk)">LOCAL</a></p></td> +<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 />
