Google Git
Sign in
apache / geode-site / e34feab93a412b3a69cbf8fa62066688ee68dae4 / . / releases / latest / javadoc / org / apache / geode / cache / snapshot / package-summary.html
blob: 8f925258f6e6486ef2d42f50371b36d2f553259b [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.apache.geode.cache.snapshot (Apache Geode 1.15.1)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.geode.cache.snapshot (Apache Geode 1.15.1)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/geode/cache/server/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/geode/cache/util/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/geode/cache/snapshot/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.geode.cache.snapshot</h1>
<div class="docSummary">
<div class="block">Provides API's for importing and exporting cached data into snapshot files.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/geode/cache/snapshot/CacheSnapshotService.html" title="interface in org.apache.geode.cache.snapshot">CacheSnapshotService</a></td>
<td class="colLast">
<div class="block">Allows a snapshot of cache data to be imported and exported.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/geode/cache/snapshot/RegionSnapshotService.html" title="interface in org.apache.geode.cache.snapshot">RegionSnapshotService</a>&lt;K,V&gt;</td>
<td class="colLast">
<div class="block">Allows a snapshot of region data to be imported and exported.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/geode/cache/snapshot/SnapshotFilter.html" title="interface in org.apache.geode.cache.snapshot">SnapshotFilter</a>&lt;K,V&gt;</td>
<td class="colLast">
<div class="block">Filters region entries for inclusion into a snapshot.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/geode/cache/snapshot/SnapshotIterator.html" title="interface in org.apache.geode.cache.snapshot">SnapshotIterator</a>&lt;K,V&gt;</td>
<td class="colLast">
<div class="block">Iterates over the entries in a region snapshot.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html" title="interface in org.apache.geode.cache.snapshot">SnapshotOptions</a>&lt;K,V&gt;</td>
<td class="colLast">
<div class="block">Provides a way to configure the behavior of snapshot operations.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/geode/cache/snapshot/SnapshotReader.html" title="class in org.apache.geode.cache.snapshot">SnapshotReader</a></td>
<td class="colLast">
<div class="block">Provides utilities for reading cache data.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.SnapshotFormat.html" title="enum in org.apache.geode.cache.snapshot">SnapshotOptions.SnapshotFormat</a></td>
<td class="colLast">
<div class="block">Defines the available snapshot file formats.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.geode.cache.snapshot Description">Package org.apache.geode.cache.snapshot Description</h2>
<div class="block"><p>Provides API's for importing and exporting cached data into snapshot files.
Each snapshot file contains the cache entries (key/value pairs) for a given
region.</p>
<p>The <a href="../../../../../org/apache/geode/cache/snapshot/RegionSnapshotService.html" title="interface in org.apache.geode.cache.snapshot"><code>RegionSnapshotService</code></a> can be
obtained for an individual region using
<a href="../../../../../org/apache/geode/cache/Region.html#getSnapshotService--"><code>Region.getSnapshotService()</code></a>. To obtain a
<a href="../../../../../org/apache/geode/cache/snapshot/CacheSnapshotService.html" title="interface in org.apache.geode.cache.snapshot"><code>CacheSnapshotService</code></a> (across all
regions), invoke <a href="../../../../../org/apache/geode/cache/Cache.html#getSnapshotService--"><code>Cache.getSnapshotService()</code></a>.</p>
<p>The <a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html" title="interface in org.apache.geode.cache.snapshot"><code>SnapshotOptions</code></a> can be used to
configure the behavior of import and export operations.</p>
<p>The <a href="../../../../../org/apache/geode/cache/snapshot/SnapshotReader.html" title="class in org.apache.geode.cache.snapshot"><code>SnapshotReader</code></a> can be used to
programmatically read a snapshot created using the GEMFIRE
<a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.SnapshotFormat.html" title="enum in org.apache.geode.cache.snapshot"><code>SnapshotOptions.SnapshotFormat</code></a>
format.</p>
Example usage:
<pre>
// obtain the snapshot service
RegionSnapshotService snapshot = region.getSnapshotService();
// export the region
snapshot.save(new File("myregion.snapshot"), SnapshotFormat.GEMFIRE);
// import the data
snapshot.load(new File("myregion.snapshot"), SnapshotFormat.GEMFIRE);
</pre></div>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/geode/cache/server/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/geode/cache/util/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/geode/cache/snapshot/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>