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 2016/10/05 00:09:53 UTC
[11/51] [partial] incubator-geode git commit: GEODE-1964: native
client documentation (note: contains references to images in the geode-docs
directories)
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/ff80a931/geode-docs/reference/topics/chapter_overview_cache_xml.html.md.erb
----------------------------------------------------------------------
diff --git a/geode-docs/reference/topics/chapter_overview_cache_xml.html.md.erb b/geode-docs/reference/topics/chapter_overview_cache_xml.html.md.erb
deleted file mode 100644
index 02e54f1..0000000
--- a/geode-docs/reference/topics/chapter_overview_cache_xml.html.md.erb
+++ /dev/null
@@ -1,30 +0,0 @@
----
-title: cache.xml
----
-
-Use the cache.xml file to set up general cache facilities and behavior and to create and initialize cached data regions. These sections document cache.xml requirements; provide hierarchical diagrams of `<cache>` and `<client-cache> `elements; and describe the function of each element.
-
-**Note:**
-You can configure most elements of the cache.xml file and apply it to your entire cluster by using the [gfsh](../../tools_modules/gfsh/chapter_overview.html) and [cluster configuration service](../../configuring/cluster_config/gfsh_persist.html). See [gfsh Limitations](../../configuring/cluster_config/gfsh_persist.html#concept_r22_hyw_bl__section_bn3_23p_y4) for a list of items you cannot configure in gfsh and must still configure in cache.xml.
-
-- **[cache.xml Quick Reference](../../reference/topics/elements_ref.html)**
-
- This section documents cache.xml file requirements and variables. It also points you to specific element sections for server, client, and WAN configuration.
-
-- **[<cache> Element Hierarchy](../../reference/topics/cache-elements-list.html)**
-
- This section shows the hierarchy of `<cache>` element sub-elements that you use to configure Geode caches and servers.
-
-- **[<cache> Element Reference](../../reference/topics/cache_xml.html#cache_xml_cache)**
-
- This section documents the `cache.xml` sub-elements used for Geode server configuration. All elements are sub-elements of the `<cache>` element.
-
-- **[<client-cache> Element Hierarchy](../../reference/topics/client-cache-elements-list.html)**
-
- This section shows the hierarchy of `<client-cache>` element sub-elements that you use to configure Geode caches and clients.
-
-- **[<client-cache> Element Reference](../../reference/topics/client-cache.html)**
-
- This section documents all `cache.xml` elements that you use to configure Geode clients. All elements are sub-elements of the `<client-cache>` element.
-
-
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/ff80a931/geode-docs/reference/topics/chapter_overview_regionshortcuts.html.md.erb
----------------------------------------------------------------------
diff --git a/geode-docs/reference/topics/chapter_overview_regionshortcuts.html.md.erb b/geode-docs/reference/topics/chapter_overview_regionshortcuts.html.md.erb
deleted file mode 100644
index dec958d..0000000
--- a/geode-docs/reference/topics/chapter_overview_regionshortcuts.html.md.erb
+++ /dev/null
@@ -1,90 +0,0 @@
----
-title: Region Shortcuts
----
-
-This topic describes the various region shortcuts you can use to configure Geode regions.
-
-Region shortcuts are groupings of pre-configured attributes that define the characteristics of a region. You can use a region shortcut as a starting point when configuring regions and you can add additional configurations to customize your application. To reference a region shortcut in a Geode `cache.xml` file, use the `refid` attribute of the `<region>` element. For example:
-
-``` pre
-<region name="myRegion" refid="PARTITION_REDUNDANT"/>
-```
-
-You can override the default values and add additional configurations within a `<region-attributes>` element of the `cache.xml` file. For example, the following configuration overrides the <span class="keyword parmname">local-max-memory</span> setting and adds the <span class="keyword parmname">recovery-delay</span> attribute:
-
-``` pre
-<region name="myRegion" refid="PARTITION_REDUNDANT">
- <region-attributes>
- <partition-attributes
- local-max-memory="512"
- recovery-delay=-1/>
- </region-attributes>
-</region>
-```
-
-You can also create your own, named region shortcuts for common custom configurations. See [Region Shortcuts and Custom Named Region Attributes](../../basic_config/data_regions/region_shortcuts.html).
-
-To configure a region using the gfsh command-line tool, specify the shortcut name with the `--type` argument. For example:
-
-``` pre
-gfsh>create region --name=myRegion --type=PARTITION_REDUNDANT
-```
-
-**Note:**
-If you change the cache.xml file that defines a region, you must restart the member before the changes take effect.
-
-For more information about configuring regions, see [Data Region Management](../../basic_config/data_regions/managing_data_regions.html#data_regions).
-
-For more information about using the various types of Geode regions and when to use them, see [Region Types](../../developing/region_options/region_types.html#region_types).
-
-- **[Region Shortcuts Quick Reference](../../reference/topics/region_shortcuts_table.html)**
-
- This section provides a quick reference for all region shortcuts.
-
-- **[LOCAL](../../reference/topics/region_shortcuts_reference.html#reference_w2h_3cd_lk)**
-
-- **[LOCAL\_HEAP\_LRU](../../reference/topics/region_shortcuts_reference.html#reference_wd5_lpy_lk)**
-
-- **[LOCAL\_OVERFLOW](../../reference/topics/region_shortcuts_reference.html#reference_adk_y4y_lk)**
-
-- **[LOCAL\_PERSISTENT](../../reference/topics/region_shortcuts_reference.html#reference_l5r_y4y_lk)**
-
-- **[LOCAL\_PERSISTENT\_OVERFLOW](../../reference/topics/region_shortcuts_reference.html#reference_a45_y4y_lk)**
-
-- **[PARTITION](../../reference/topics/region_shortcuts_reference.html#reference_ow5_4qy_lk)**
-
-- **[PARTITION\_HEAP\_LRU](../../reference/topics/region_shortcuts_reference.html#reference_twx_y4y_lk)**
-
-- **[PARTITION\_OVERFLOW](../../reference/topics/region_shortcuts_reference.html#reference_js1_z4y_lk)**
-
-- **[PARTITION\_PERSISTENT](../../reference/topics/region_shortcuts_reference.html#reference_d4k_jpy_lk)**
-
-- **[PARTITION\_PERSISTENT\_OVERFLOW](../../reference/topics/region_shortcuts_reference.html#reference_v5l_jpy_lk)**
-
-- **[PARTITION\_PROXY](../../reference/topics/region_shortcuts_reference.html#reference_v4m_jpy_lk)**
-
-- **[PARTITION\_PROXY\_REDUNDANT](../../reference/topics/region_shortcuts_reference.html#reference_c1n_jpy_lk)**
-
-- **[PARTITION\_REDUNDANT](../../reference/topics/region_shortcuts_reference.html#reference_shn_jpy_lk)**
-
-- **[PARTITION\_REDUNDANT\_HEAP\_LRU](../../reference/topics/region_shortcuts_reference.html#reference_m4n_jpy_lk)**
-
-- **[PARTITION\_REDUNDANT\_OVERFLOW](../../reference/topics/region_shortcuts_reference.html#reference_own_jpy_lk)**
-
-- **[PARTITION\_REDUNDANT\_PERSISTENT](../../reference/topics/region_shortcuts_reference.html#reference_bd4_jpy_lk)**
-
-- **[PARTITION\_REDUNDANT\_PERSISTENT\_OVERFLOW](../../reference/topics/region_shortcuts_reference.html#reference_xqq_tvc_lk)**
-
-- **[REPLICATE](../../reference/topics/region_shortcuts_reference.html#reference_wq4_jpy_lk)**
-
-- **[REPLICATE\_HEAP\_LRU](../../reference/topics/region_shortcuts_reference.html#reference_xx4_jpy_lk)**
-
-- **[REPLICATE\_OVERFLOW](../../reference/topics/region_shortcuts_reference.html#reference_t2p_jpy_lk)**
-
-- **[REPLICATE\_PERSISTENT](../../reference/topics/region_shortcuts_reference.html#reference_emp_jpy_lk)**
-
-- **[REPLICATE\_PERSISTENT\_OVERFLOW](../../reference/topics/region_shortcuts_reference.html#reference_tsp_jpy_lk)**
-
-- **[REPLICATE\_PROXY](../../reference/topics/region_shortcuts_reference.html#reference_n1q_jpy_lk)**
-
-
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/ff80a931/geode-docs/reference/topics/client-cache-elements-list.html.md.erb
----------------------------------------------------------------------
diff --git a/geode-docs/reference/topics/client-cache-elements-list.html.md.erb b/geode-docs/reference/topics/client-cache-elements-list.html.md.erb
deleted file mode 100644
index ee986b3..0000000
--- a/geode-docs/reference/topics/client-cache-elements-list.html.md.erb
+++ /dev/null
@@ -1,120 +0,0 @@
----
-title: "<client-cache> Element Hierarchy"
----
-
-This section shows the hierarchy of `<client-cache>` element sub-elements that you use to configure Geode caches and clients.
-
-For details, see [<client-cache> Element Reference.](client-cache.html)
-
-``` pre
-<client-cache>
- <cache-transaction-manager>
- <transaction-listener>
- <transaction-writer>
- <pool>
- <locator>
- <server>
- <disk-store>
- <disk-dirs>
- <disk-dir>
- <pdx>
- <pdx-serializer>
- <class-name>
- <parameter>
- <string>
- <declarable>
- <region-attributes>
- <key-constraint>
- <value-constraint>
- <region-time-to-live>
- <expiration-attributes>
- <custom-expiry>
- <class-name>
- <parameter>
- <string>
- <declarable>
- <region-idle-time>
- <expiration-attributes>
- <custom-expiry>
- <class-name>
- <parameter>
- <string>
- <declarable>
- <entry-time-to-live>
- <expiration-attributes>
- <custom-expiry>
- <class-name>
- <parameter>
- <string>
- <declarable>
- <entry-idle-time>
- <expiration-attributes>
- <custom-expiry>
- <class-name>
- <parameter>
- <string>
- <declarable>
- <cache-loader>
- <class-name>
- <parameter>
- <string>
- <declarable>
- <cache-writer>
- <class-name>
- <parameter>
- <string>
- <declarable>
- <cache-listener>
- <class-name>
- <parameter>
- <string>
- <declarable>
- <eviction-attributes>
- <lru-entry-count>
- <lru-heap-percentage>
- <class-name>
- <parameter>
- <string>
- <declarable>
- <lru-memory-size>
- <class-name>
- <parameter>
- <string>
- <declarable>
- <jndi-bindings>
- <jndi-binding>
- <config-property>
- <config-property-name>
- <config-property-type>
- <config-property-value>
- <region>
- <region-attributes>
- <index>
- <entry>
- <key>
- <string>
- <declarable>
- <value>
- <string>
- <declarable>
- <region>
- <function-service>
- <function>
- <class-name>
- <parameter>
- <string>
- <declarable>
- <resource-manager>
- <serialization-registration>
- <serializer>
- <class-name>
- <instantiator>
- <class-name>
- <initializer>
- <class-name>
- <parameter>
- <string>
- <declarable>
-</client-cache>
-
-```