Google Git
Sign in
apache / kafka-site / refs/heads/asf-site / . / 0100 / javadoc / org / apache / kafka / streams / state / KeyValueStore.html
blob: df5732fd2a891835356572612d7abc21144553cf [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 (version 1.7.0_80) on Thu Aug 04 13:19:29 BST 2016 -->
<title>KeyValueStore (kafka 0.10.0.1 API)</title>
<meta name="date" content="2016-08-04">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="KeyValueStore (kafka 0.10.0.1 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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/kafka/streams/state/KeyValueIterator.html" title="interface in org.apache.kafka.streams.state"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/kafka/streams/state/StateSerdes.html" title="class in org.apache.kafka.streams.state"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/kafka/streams/state/KeyValueStore.html" target="_top">Frames</a></li>
<li><a href="KeyValueStore.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All 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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.kafka.streams.state</div>
<h2 title="Interface KeyValueStore" class="title">Interface KeyValueStore&lt;K,V&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>K</code> - The key type</dd><dd><code>V</code> - The value type</dd></dl>
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../org/apache/kafka/streams/processor/StateStore.html" title="interface in org.apache.kafka.streams.processor">StateStore</a></dd>
</dl>
<hr>
<br>
<pre>@InterfaceStability.Unstable
public interface <span class="strong">KeyValueStore&lt;K,V&gt;</span>
extends <a href="../../../../../org/apache/kafka/streams/processor/StateStore.html" title="interface in org.apache.kafka.streams.processor">StateStore</a></pre>
<div class="block">A key-value store that supports put/get/delete and range queries.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/kafka/streams/state/KeyValueIterator.html" title="interface in org.apache.kafka.streams.state">KeyValueIterator</a>&lt;<a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>,<a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">V</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html#all()">all</a></strong>()</code>
<div class="block">Return an iterator over all keys in the database.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">V</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html#delete(K)">delete</a></strong>(<a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>&nbsp;key)</code>
<div class="block">Delete the value from the store (if there is one)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">V</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html#get(K)">get</a></strong>(<a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>&nbsp;key)</code>
<div class="block">Get the value corresponding to this key</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html#put(K,%20V)">put</a></strong>(<a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>&nbsp;key,
<a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">V</a>&nbsp;value)</code>
<div class="block">Update the value associated with this key</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html#putAll(java.util.List)">putAll</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/kafka/streams/KeyValue.html" title="class in org.apache.kafka.streams">KeyValue</a>&lt;<a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>,<a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">V</a>&gt;&gt;&nbsp;entries)</code>
<div class="block">Update all the given key/value pairs</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">V</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html#putIfAbsent(K,%20V)">putIfAbsent</a></strong>(<a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>&nbsp;key,
<a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">V</a>&nbsp;value)</code>
<div class="block">Update the value associated with this key, unless a value
is already associated with the key</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/kafka/streams/state/KeyValueIterator.html" title="interface in org.apache.kafka.streams.state">KeyValueIterator</a>&lt;<a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>,<a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">V</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html#range(K,%20K)">range</a></strong>(<a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>&nbsp;from,
<a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>&nbsp;to)</code>
<div class="block">Get an iterator over a given range of keys.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.kafka.streams.processor.StateStore">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.kafka.streams.processor.<a href="../../../../../org/apache/kafka/streams/processor/StateStore.html" title="interface in org.apache.kafka.streams.processor">StateStore</a></h3>
<code><a href="../../../../../org/apache/kafka/streams/processor/StateStore.html#close()">close</a>, <a href="../../../../../org/apache/kafka/streams/processor/StateStore.html#flush()">flush</a>, <a href="../../../../../org/apache/kafka/streams/processor/StateStore.html#init(org.apache.kafka.streams.processor.ProcessorContext,%20org.apache.kafka.streams.processor.StateStore)">init</a>, <a href="../../../../../org/apache/kafka/streams/processor/StateStore.html#name()">name</a>, <a href="../../../../../org/apache/kafka/streams/processor/StateStore.html#persistent()">persistent</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="get(java.lang.Object)">
<!-- -->
</a><a name="get(K)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre><a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">V</a>&nbsp;get(<a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>&nbsp;key)</pre>
<div class="block">Get the value corresponding to this key</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - The key to fetch</dd>
<dt><span class="strong">Returns:</span></dt><dd>The value or null if no value is found.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - If null is used for key.</dd></dl>
</li>
</ul>
<a name="put(java.lang.Object,java.lang.Object)">
<!-- -->
</a><a name="put(K, V)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>put</h4>
<pre>void&nbsp;put(<a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>&nbsp;key,
<a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">V</a>&nbsp;value)</pre>
<div class="block">Update the value associated with this key</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - They key to associate the value to</dd><dd><code>value</code> - The value</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - If null is used for key or value.</dd></dl>
</li>
</ul>
<a name="putIfAbsent(java.lang.Object,java.lang.Object)">
<!-- -->
</a><a name="putIfAbsent(K, V)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putIfAbsent</h4>
<pre><a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">V</a>&nbsp;putIfAbsent(<a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>&nbsp;key,
<a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">V</a>&nbsp;value)</pre>
<div class="block">Update the value associated with this key, unless a value
is already associated with the key</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - They key to associate the value to</dd><dd><code>value</code> - The value</dd>
<dt><span class="strong">Returns:</span></dt><dd>The old value or null if there is no such key.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - If null is used for key or value.</dd></dl>
</li>
</ul>
<a name="putAll(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putAll</h4>
<pre>void&nbsp;putAll(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/kafka/streams/KeyValue.html" title="class in org.apache.kafka.streams">KeyValue</a>&lt;<a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>,<a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">V</a>&gt;&gt;&nbsp;entries)</pre>
<div class="block">Update all the given key/value pairs</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>entries</code> - A list of entries to put into the store.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - If null is used for any key or value.</dd></dl>
</li>
</ul>
<a name="delete(java.lang.Object)">
<!-- -->
</a><a name="delete(K)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>delete</h4>
<pre><a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">V</a>&nbsp;delete(<a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>&nbsp;key)</pre>
<div class="block">Delete the value from the store (if there is one)</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - The key</dd>
<dt><span class="strong">Returns:</span></dt><dd>The old value or null if there is no such key.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - If null is used for key.</dd></dl>
</li>
</ul>
<a name="range(java.lang.Object,java.lang.Object)">
<!-- -->
</a><a name="range(K, K)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>range</h4>
<pre><a href="../../../../../org/apache/kafka/streams/state/KeyValueIterator.html" title="interface in org.apache.kafka.streams.state">KeyValueIterator</a>&lt;<a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>,<a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">V</a>&gt;&nbsp;range(<a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>&nbsp;from,
<a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>&nbsp;to)</pre>
<div class="block">Get an iterator over a given range of keys. This iterator MUST be closed after use.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>from</code> - The first key that could be in the range</dd><dd><code>to</code> - The last key that could be in the range</dd>
<dt><span class="strong">Returns:</span></dt><dd>The iterator for this range.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - If null is used for from or to.</dd></dl>
</li>
</ul>
<a name="all()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>all</h4>
<pre><a href="../../../../../org/apache/kafka/streams/state/KeyValueIterator.html" title="interface in org.apache.kafka.streams.state">KeyValueIterator</a>&lt;<a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">K</a>,<a href="../../../../../org/apache/kafka/streams/state/KeyValueStore.html" title="type parameter in KeyValueStore">V</a>&gt;&nbsp;all()</pre>
<div class="block">Return an iterator over all keys in the database. This iterator MUST be closed after use.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>An iterator of all key/value pairs in the store.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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/kafka/streams/state/KeyValueIterator.html" title="interface in org.apache.kafka.streams.state"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/kafka/streams/state/StateSerdes.html" title="class in org.apache.kafka.streams.state"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/kafka/streams/state/KeyValueStore.html" target="_top">Frames</a></li>
<li><a href="KeyValueStore.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All 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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>