Skip to content

Commit

Permalink
GEODE-4984 Add new Use Cases section to docs (#1733)
Browse files Browse the repository at this point in the history
- add the start of a subsection on using Geode as an inline cache
  • Loading branch information
karensmolermiller authored Apr 4, 2018
1 parent 425f371 commit 93a484d
Show file tree
Hide file tree
Showing 4 changed files with 84 additions and 0 deletions.
8 changes: 8 additions & 0 deletions geode-book/master_middleman/source/subnavs/geode-subnav.erb
Original file line number Diff line number Diff line change
Expand Up @@ -2335,6 +2335,14 @@ gfsh</a>
</li>
</ul>
</li>
<li class="has_submenu">
<a href="/docs/guide/<%=vars.product_version_nodot%>/use_cases/book_intro.html">Use Cases</a>
<ul>
<li>
<a href="/docs/guide/<%=vars.product_version_nodot%>/use_cases/inline-cache.html">The Inline Cache</a>
</li>
</ul>
</li>
<li class="has_submenu">
<a href="/docs/guide/<%=vars.product_version_nodot%>/reference/book_intro.html">Reference</a>
<ul>
Expand Down
Binary file added geode-docs/images/inline-cache.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 32 additions & 0 deletions geode-docs/use_cases/book_intro.html.md.erb
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: Use Cases
---

<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

<%=vars.product_name%> may be used to implement a wide variety
of designs. This section introduces designs and informs developers how to
implement and configure those designs.

<a id="Use_Cases"></a>

- **[The Inline Cache](inline-cache.html)**

This classic caching structure causes a backend data store lookup
upon a cache miss.

44 changes: 44 additions & 0 deletions geode-docs/use_cases/inline-cache.html.md.erb
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: The Inline Cache
---
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

An inline cache holds region entries for a client application.

## Description of an Inline Cache

A cache is formed from a region within a <%=vars.product_name%> cluster,
and the cache sits between the client application and a
backing data store.

<img src="../images/inline-cache.png" id="inline-cache-png" class="image" />

The client application's cache lookup is a region get
operation, and a cache write is a region put operation.

When the cache (region) has the requested region entry,
it quickly responds with the value for a lookup operation.
This is a cache hit.
If the requested region entry is not in the region,
it is a cache miss,
and code that has been deployed to the server acquires the
entry from the data store.
The acquired region entry is written to the region
such that future lookups will cause a cache hit.

## Implementation and Configuration

0 comments on commit 93a484d

Please sign in to comment.