You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@geode.apache.org by db...@apache.org on 2021/06/17 16:56:14 UTC
[geode] branch support/1.14 updated: GEODE-7968: UG - Fix region
shortcut table format issues (#6566)
This is an automated email from the ASF dual-hosted git repository.
dbarnes pushed a commit to branch support/1.14
in repository https://gitbox.apache.org/repos/asf/geode.git
The following commit(s) were added to refs/heads/support/1.14 by this push:
new 2424003 GEODE-7968: UG - Fix region shortcut table format issues (#6566)
2424003 is described below
commit 24240037293a9bb0ead74423e09a5a9e3f46b23a
Author: Alberto Bustamante Reyes <al...@est.tech>
AuthorDate: Thu Jun 17 18:51:56 2021 +0200
GEODE-7968: UG - Fix region shortcut table format issues (#6566)
---
.../topics/region_shortcuts_table.html.md.erb | 515 ++-------------------
1 file changed, 27 insertions(+), 488 deletions(-)
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 6b99e74..e030416 100644
--- a/geode-docs/reference/topics/region_shortcuts_table.html.md.erb
+++ b/geode-docs/reference/topics/region_shortcuts_table.html.md.erb
@@ -26,494 +26,33 @@ This section provides a quick reference for all region shortcuts.
<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>
-<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>
-<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>
-<td>eviction-algorithm:</td>
-<td>lru-heap-percentage</td>
-</tr>
-<tr>
-<td>eviction-action:</td>
-<td>local-destroy</td>
-</tr>
-</tbody>
-</table>
-</div></td>
-</tr>
-<tr>
-<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>
-<td>eviction-algorithm:</td>
-<td>lru-heap-percentage</td>
-</tr>
-<tr>
-<td>eviction-action:</td>
-<td>overflow-to-disk</td>
-</tr>
-</tbody>
-</table>
-</div></td>
-</tr>
-<tr>
-<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>
-<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>
-<td>eviction-algorithm:</td>
-<td>lru-heap-percentage</td>
-</tr>
-<tr>
-<td>eviction-action:</td>
-<td>overflow-to-disk</td>
-</tr>
-</tbody>
-</table>
-</div></td>
-</tr>
-<tr>
-<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>
-<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>
-<td>eviction-algorithm:</td>
-<td>lru-heap-percentage</td>
-</tr>
-<tr>
-<td>eviction-action:</td>
-<td>local-destroy</td>
-</tr>
-</tbody>
-</table>
-</div></td>
-</tr>
-<tr>
-<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>
-<td>eviction-algorithm:</td>
-<td>lru-heap-percentage</td>
-</tr>
-<tr>
-<td>eviction-action:</td>
-<td>overflow-to-disk</td>
-</tr>
-</tbody>
-</table>
-</div></td>
-</tr>
-<tr>
-<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>
-<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>
-<td>eviction-algorithm:</td>
-<td>lru-heap-percentage</td>
-</tr>
-<tr>
-<td>eviction-action:</td>
-<td>overflow-to-disk</td>
-</tr>
-</tbody>
-</table>
-</div></td>
-</tr>
-<tr>
-<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>
-<td>local-max-memory:</td>
-<td>0</td>
-</tr>
-</tbody>
-</table>
-</div></td>
-</tr>
-<tr>
-<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>
-<td>redundant-copies:</td>
-<td>1</td>
-</tr>
-<tr>
-<td>local-max-memory</td>
-<td>0</td>
-</tr>
-</tbody>
-</table>
-</div></td>
-</tr>
-<tr>
-<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>
-<td>redundant-copies:</td>
-<td>1</td>
-</tr>
-</tbody>
-</table>
-</div></td>
-</tr>
-<tr>
-<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>
-<td>eviction-algorithm:</td>
-<td>lru-heap-percentage</td>
-</tr>
-<tr>
-<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>
-<td>redundant-copies:</td>
-<td>1</td>
-</tr>
-</tbody>
-</table>
-</div></td>
-</tr>
-<tr>
-<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>
-<td>eviction-algorithm:</td>
-<td>lru-heap-percentage</td>
-</tr>
-<tr>
-<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>
-<td>redundant-copies:</td>
-<td>1</td>
-</tr>
-</tbody>
-</table>
-</div></td>
-</tr>
-<tr>
-<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>
-<td>redundant-copies:</td>
-<td>1</td>
-</tr>
-</tbody>
-</table>
-</div></td>
-</tr>
-<tr>
-<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>
-<td>eviction-algorithm:</td>
-<td>lru-heap-percentage</td>
-</tr>
-<tr>
-<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>
-<td>redundant-copies:</td>
-<td>1</td>
-</tr>
-</tbody>
-</table>
-</div></td>
-</tr>
-<tr>
-<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>
-<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>
-<td>eviction-algorithm:</td>
-<td>lru-heap-percentage</td>
-</tr>
-<tr>
-<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>
-<td>interest-policy:</td>
-<td>all</td>
-</tr>
-</tbody>
-</table>
-</div></td>
-</tr>
-<tr>
-<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>
-<td>eviction-algorithm:</td>
-<td>lru-heap-percentage</td>
-</tr>
-<tr>
-<td>eviction-action:</td>
-<td>overflow-to-disk</td>
-</tr>
-</tbody>
-</table>
-</div></td>
-</tr>
-<tr>
-<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>
-<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>
-<td>eviction-algorithm:</td>
-<td>lru-heap-percentage</td>
-</tr>
-<tr>
-<td>eviction-action:</td>
-<td>overflow-to-disk</td>
-</tr>
-</tbody>
-</table>
-</div></td>
-</tr>
-<tr>
-<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>
+Table 1. Region Shortcuts Default Configurations
+
+| Region Shortcut | Region Attributes | Other Attributes |
+|------------------|--------------------|-------------------|
+| [LOCAL](region_shortcuts_reference.html#reference_w2h_3cd_lk) | scope: local<br/>data-policy: NORMAL | |
+| [LOCAL_HEAP_LRU](region_shortcuts_reference.html#reference_wd5_lpy_lk) | scope: local<br/>data-policy: NORMAL | **Eviction Attributes**<p>eviction-algorithm: lru-heap-percentage</p><p>eviction-action: local-destroy</p> |
+| [LOCAL_OVERFLOW](region_shortcuts_reference.html#reference_adk_y4y_lk) | scope: local<br/>data-policy: NORMAL | **Eviction Attributes**<p>eviction-algorithm: lru-heap-percentage</p><p>eviction-action: overflow-to-disk</p> |
+| [LOCAL_PERSISTENT](region_shortcuts_reference.html#reference_l5r_y4y_lk) | scope: local<br/>data-policy: PERSISTENT\_REPLICATE | |
+| [LOCAL_PERSISTENT_OVERFLOW](region_shortcuts_reference.html#reference_a45_y4y_lk) | scope: local<br/>data-policy: PERSISTENT\_REPLICATE | **Eviction Attributes**<p>eviction-algorithm: lru-heap-percentage</p><p>eviction-action: overflow-to-disk</p> |
+| [PARTITION](region_shortcuts_reference.html#reference_ow5_4qy_lk) | data-policy: PARTITION | |
+| [PARTITION_HEAP_LRU](region_shortcuts_reference.html#reference_twx_y4y_lk) | data-policy: PARTITION | **Eviction Attributes**<p>eviction-algorithm: lru-heap-percentage</p><p>eviction-action: local-destroy</p> |
+| [PARTITION_OVERFLOW](region_shortcuts_reference.html#reference_js1_z4y_lk) | data-policy: PARTITION | **Eviction Attributes**<p>eviction-algorithm: lru-heap-percentage</p><p>eviction-action: overflow-to-disk</p> |
+| [PARTITION_PERSISTENT](region_shortcuts_reference.html#reference_d4k_jpy_lk) | data-policy: PERSISTENT_PARTITION | |
+| [PARTITION_PERSISTENT_OVERFLOW](region_shortcuts_reference.html#reference_v5l_jpy_lk) | data-policy: PERSISTENT_PARTITION | **Eviction Attributes**<p>eviction-algorithm: lru-heap-percentage</p><p>eviction-action: overflow-to-disk</p> |
+| [PARTITION_PROXY](region_shortcuts_reference.html#reference_v4m_jpy_lk) | data-policy: PARTITION | **Partition Attributes**<p>local-max-memory: 0</p>|
+| [PARTITION_PROXY_REDUNDANT](region_shortcuts_reference.html#reference_c1n_jpy_lk) | data-policy: PARTITION | **Partition Attributes**<p>local-max-memory: 0</p><p>redundant-copies: 1|
+| [PARTITION_REDUNDANT](region_shortcuts_reference.html#reference_shn_jpy_lk) | data-policy: PARTITION | **Partition Attributes**<p>redundant-copies: 1|
+| [PARTITION_REDUNDANT_HEAP_LRU](region_shortcuts_reference.html#reference_m4n_jpy_lk) | data-policy: PARTITION | **Eviction Attributes**<p>eviction-algorithm: lru-heap-percentage</p><p>eviction-action: local-destroy</p><br/>**Partition Attributes**<p>redundant-copies: 1</p> |
+| [PARTITION_REDUNDANT_OVERFLOW](region_shortcuts_reference.html#reference_own_jpy_lk) | data-policy: PARTITION | **Eviction Attributes**<p>eviction-algorithm: lru-heap-percentage</p><p>eviction-action: overflow-to-disk</p><br/>**Partition Attributes**<p>redundant-copies: 1 |
+| [PARTITION_REDUNDANT_PERSISTENT](region_shortcuts_reference.html#reference_bd4_jpy_lk) | data-policy: PERSISTENT_PARTITION | **Partition Attributes**<p>redundant-copies: 1 |
+| [PARTITION_REDUNDANT_PERSISTENT_OVERFLOW](region_shortcuts_reference.html#reference_xqq_tvc_lk) | data-policy: PERSISTENT_PARTITION | **Eviction Attributes**<p>eviction-algorithm: lru-heap-percentage</p><p>eviction-action: overflow-to-disk</p><br/>**Partition Attributes**<p>redundant-copies: 1 |
+| [REPLICATE](region_shortcuts_reference.html#reference_wq4_jpy_lk) | data-policy: REPLICATE<br/>scope: distributed-ack | |
+| [REPLICATE_HEAP_LRU](region_shortcuts_reference.html#reference_xx4_jpy_lk) | data-policy: PRELOADED<br/>scope: distributed-ack | **Eviction Attributes**<p>eviction-algorithm: lru-heap-percentage</p><p>eviction-action: local-destroy</p><p>*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 registe [...]
+| [REPLICATE_OVERFLOW](region_shortcuts_reference.html#reference_t2p_jpy_lk) | data-policy: REPLICATE<br/>scope: distributed-ack | **Eviction Attributes**<p>eviction-algorithm: lru-heap-percentage</p><p>eviction-action: overflow-to-disk</p>|
+| [REPLICATE_PERSISTENT](region_shortcuts_reference.html#reference_emp_jpy_lk) | data-policy: PERSISTENT_REPLICATE<br/>scope: distributed-ack | |
+| [REPLICATE_PERSISTENT_OVERFLOW](region_shortcuts_reference.html#reference_tsp_jpy_lk) | data-policy: PERSISTENT_REPLICATE<br/>scope: distributed-ack | **Eviction Attributes**<p>eviction-algorithm: lru-heap-percentage</p><p>eviction-action: overflow-to-disk</p>|
+| [REPLICATE_PROXY](region_shortcuts_reference.html#reference_n1q_jpy_lk) | data-policy: EMPTY<br/>scope: distributed-ack | |
-<span class="tablecap">Table 1. Region Shortcuts Default Configurations</span>