blob: 681c531aa60acb7065914358a3c7ecd4586ffb05 [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 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>State (Storm 2.4.0 API)</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="State (Storm 2.4.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/State.html">Use</a></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/storm/trident/state/Serializer.html" title="interface in org.apache.storm.trident.state"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/storm/trident/state/StateFactory.html" title="interface in org.apache.storm.trident.state"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/storm/trident/state/State.html" target="_top">Frames</a></li>
<li><a href="State.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>
<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.storm.trident.state</div>
<h2 title="Interface State" class="title">Interface State</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../org/apache/storm/trident/state/map/MapState.html" title="interface in org.apache.storm.trident.state.map">MapState</a>&lt;T&gt;, <a href="../../../../../org/apache/storm/trident/state/map/ReadOnlyMapState.html" title="interface in org.apache.storm.trident.state.map">ReadOnlyMapState</a>&lt;T&gt;, <a href="../../../../../org/apache/storm/trident/state/snapshot/ReadOnlySnapshottable.html" title="interface in org.apache.storm.trident.state.snapshot">ReadOnlySnapshottable</a>&lt;T&gt;, <a href="../../../../../org/apache/storm/trident/state/map/RemovableMapState.html" title="interface in org.apache.storm.trident.state.map">RemovableMapState</a>&lt;T&gt;, <a href="../../../../../org/apache/storm/trident/state/snapshot/Snapshottable.html" title="interface in org.apache.storm.trident.state.snapshot">Snapshottable</a>&lt;T&gt;</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/storm/cassandra/trident/state/CassandraState.html" title="class in org.apache.storm.cassandra.trident.state">CassandraState</a>, <a href="../../../../../org/apache/storm/starter/trident/DebugMemoryMapState.html" title="class in org.apache.storm.starter.trident">DebugMemoryMapState</a>, <a href="../../../../../org/apache/storm/hbase/trident/state/HBaseState.html" title="class in org.apache.storm.hbase.trident.state">HBaseState</a>, <a href="../../../../../org/apache/storm/hdfs/trident/HdfsState.html" title="class in org.apache.storm.hdfs.trident">HdfsState</a>, <a href="../../../../../org/apache/storm/hive/trident/HiveState.html" title="class in org.apache.storm.hive.trident">HiveState</a>, <a href="../../../../../org/apache/storm/jdbc/trident/state/JdbcState.html" title="class in org.apache.storm.jdbc.trident.state">JdbcState</a>, <a href="../../../../../org/apache/storm/jms/trident/JmsState.html" title="class in org.apache.storm.jms.trident">JmsState</a>, <a href="../../../../../org/apache/storm/trident/testing/LRUMemoryMapState.html" title="class in org.apache.storm.trident.testing">LRUMemoryMapState</a>, <a href="../../../../../org/apache/storm/trident/testing/MemoryMapState.html" title="class in org.apache.storm.trident.testing">MemoryMapState</a>, <a href="../../../../../org/apache/storm/mongodb/trident/state/MongoState.html" title="class in org.apache.storm.mongodb.trident.state">MongoState</a>, <a href="../../../../../org/apache/storm/trident/state/map/NonTransactionalMap.html" title="class in org.apache.storm.trident.state.map">NonTransactionalMap</a>, <a href="../../../../../org/apache/storm/trident/state/map/OpaqueMap.html" title="class in org.apache.storm.trident.state.map">OpaqueMap</a>, <a href="../../../../../org/apache/storm/opentsdb/trident/OpenTsdbState.html" title="class in org.apache.storm.opentsdb.trident">OpenTsdbState</a>, <a href="../../../../../org/apache/storm/trident/state/ReadOnlyState.html" title="class in org.apache.storm.trident.state">ReadOnlyState</a>, <a href="../../../../../org/apache/storm/redis/trident/state/RedisClusterState.html" title="class in org.apache.storm.redis.trident.state">RedisClusterState</a>, <a href="../../../../../org/apache/storm/redis/trident/state/RedisState.html" title="class in org.apache.storm.redis.trident.state">RedisState</a>, <a href="../../../../../org/apache/storm/rocketmq/trident/state/RocketMqState.html" title="class in org.apache.storm.rocketmq.trident.state">RocketMqState</a>, <a href="../../../../../org/apache/storm/trident/state/map/SnapshottableMap.html" title="class in org.apache.storm.trident.state.map">SnapshottableMap</a>, <a href="../../../../../org/apache/storm/solr/trident/SolrState.html" title="class in org.apache.storm.solr.trident">SolrState</a>, <a href="../../../../../org/apache/storm/trident/state/map/TransactionalMap.html" title="class in org.apache.storm.trident.state.map">TransactionalMap</a>, <a href="../../../../../org/apache/storm/kafka/trident/TridentKafkaState.html" title="class in org.apache.storm.kafka.trident">TridentKafkaState</a>, <a href="../../../../../org/apache/storm/starter/trident/TridentReach.StaticSingleKeyMapState.html" title="class in org.apache.storm.starter.trident">TridentReach.StaticSingleKeyMapState</a>, <a href="../../../../../org/apache/storm/trident/windowing/WindowsState.html" title="class in org.apache.storm.trident.windowing">WindowsState</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">State</span></pre>
<div class="block"><p>There&rsquo;s 3 different kinds of state:</p><p><p>1. non-transactional: ignores commits, updates are permanent. no rollback. a cassandra incrementing state would be like this 2. repeat-transactional: idempotent as long as all batches for a txid are identical 3. opaque-transactional: the most general kind of state. updates are always done based on the previous version of the value if the current commit = latest stored commit Idempotent even if the batch for a txid can change.</p><p><p>repeat transactional is idempotent for transactional spouts opaque transactional is idempotent for opaque or transactional spouts</p><p><p>Trident should log warnings when state is idempotent but updates will not be idempotent because of spout</p></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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/trident/state/State.html#beginCommit-java.lang.Long-">beginCommit</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&nbsp;txid)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/trident/state/State.html#commit-java.lang.Long-">commit</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&nbsp;txid)</code>&nbsp;</td>
</tr>
</table>
</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="beginCommit-java.lang.Long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beginCommit</h4>
<pre>void&nbsp;beginCommit(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&nbsp;txid)</pre>
</li>
</ul>
<a name="commit-java.lang.Long-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>commit</h4>
<pre>void&nbsp;commit(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&nbsp;txid)</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= 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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/State.html">Use</a></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 class="aboutLanguage"><script type="text/javascript" src="../../../../../highlight.pack.js"></script>
<script type="text/javascript"><!--
hljs.initHighlightingOnLoad();
//--></script></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/storm/trident/state/Serializer.html" title="interface in org.apache.storm.trident.state"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/storm/trident/state/StateFactory.html" title="interface in org.apache.storm.trident.state"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/storm/trident/state/State.html" target="_top">Frames</a></li>
<li><a href="State.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>
<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 ======= -->
<p class="legalCopy"><small>Copyright &#169; 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>